Script Classes


The following table describes all script classes included in this version of the Mira Pro Script language. The table links to the class description pages containing all information about the class and its methods and properties.

Note: For class objects, remember that class methods are always specified using the colon operator whereas class properties are specified using the dot operator.

Classes in the Mira Pro Script Library

CApphot

Used for performing aperture photometry measurements on images.

CArray

Used for working with indexed arrays, such as vectors of numbers. However, members can be numbers, strings, or other types of objects.

CCentroid

Used for measuring centroid positions. Holds data that controls centroid measurement and provides methods for computing the centroid.

CColorRef

Used for working with colors. Holds color properties and provides methods for working with the colors.

CFile

Used for working with text files (not usually for image files).

CFileDlg

Creates configurable Open and Save dialogs for gathering file names for oprning or saving files.

CFileList

Opens and processes a Mira File List.

CFindFiles

Searches for files in a folder having names that match a template.

CFwhm

Used for computing the FWHM and related parameters in images.

CGrid

Used for creating a grid and opening it in a dialog window.

CGridView

Used for creating a grid object and opening it in a view window or working with an existing grid view window.

CHistogram

Creates a histogram of array data.

CImage

Used for working with images. Interfaces to the Mira image object and provides a large number of methods for processing, measuring, and interrogating images.

CImageSet

Maintains a list of images, used by some methods or classes that work with a list of images rather than a single image.

CImageView

Used for displaying images in a MIRA image view window. This class also access the CImageSet of the window, which maintains multiple images in the window. The class also provides access to Image window components such as the image cursor and display tools.

CImCombine

Performs image combining, or merging procedures on the images of a CImageSet.

CImExtract

Implements the ImExtract package. This opens the MExtract toolbar in Mira.

CLabels

Adds markers and labels to displayed images. This opens the Labeling toolbar in Mira.

CLsqFit

Implements a general weighted, multivariate linear least squares fitting package. This class can fit up to 100 coefficients and up to 10 independent variables for numeric and multi-channel RGB data.

CMatrix

Used for working with 2-dimensional indexed arrays as a sparse matrix. Matrix elements may be numbers, strings, or other types of values.

CMeasureAngles

Draws angle markers between a vertex and two points on a displayed image. This opens the Angle Measurement toolbar in Mira.

CMeasureLines

Draws line markers between pairs of points on a displayed image. This opens the Line Measurement Toolbar in Mira.

CMeasurePoints

Draws point markers on a displayed image. This opens the Point Measurement toolbar in Mira.

CMeasureRegions

Draws regular or irregular regions on a displayed image. This opens the Region Measurement toolbar in Mira.

CPlotView

Used for plotting 1-dimensional data from images, displayed images, matrices, and data sets.

CPlot

Accesses point data in a plot series drawn in a CPlotView window.

CPoint

Manages a point object containing two numbers and provided simple syntax for working with them as a single value..

CPolynomial

Manages a set of polynomial coefficients.

CRect

Used for working with rectangles. Includes descriptive data and numerous methods for creating, interrogating, and doing math on rectangles.

CRegistry

Methods for saving and retrieving values using the Windows Registry.

CSplitpath

Used for working with path components such as the file name, folder, extension, etc.

CSet

Used for working with lists using insertion and removal to manipulate the set. Members can be numbers, strings, or other types of objects.

CStats

Used for measuring statistics inside a rectangular region of an image. Includes methods for many types of statistics.

CStrTok

Parses strings into shorter strings (tokens) based on separator characters.

CValueSet

Creates a keyed set of values. Each set item consists of a string and value.

CTextView

Manages Mira Text Editor windows used for displaying text output and messages.

Related Topics

Contents

Non-class Creator Functions

Using Classes in your Scripts

Comparison with C and C++

Script Editor Window

 


Mira Pro x64 Script User's Guide, Copyright Ⓒ 2023 Mirametrics, Inc. All Rights Reserved.