CImage Class
The CImage class encapsulates functionality for working with images. Included in this huge class are tools for working with image files, doing image math operations, changing image geometry, making measurements, and working with header data. Additional methods for combining and merging images are found in the CImCombine class.
Construction |
Object = CImage:new() |
Destruction |
Object:delete() |
ptr |
A pointer to the Mira image object in memory. The pointer is nil if no image is open, created, or attached to the CImage object. Note: It is usually not safe practice to work directly with the value of ptr. Instead, use the GetImagePtr or Attach method. |
Create, copy, and delete CImage objects |
|
Work with pixel and world coordinates, distances, and measurements. |
|
Perform filtering operations such as smoothing and enhancing. |
|
Open files, Create, Save, and Attach images, etc. |
|
These methods perform high level operations for calibrating CCD images. |
|
Perform geometric operations such as scale, rotate, expand, etc. |
|
Retrieve image properties such as name, columns, exposure time, filter, image type, etc. |
|
Work with image headers; retrieve and set header keywords. |
|
Perform math operations such as multiple, exp, etc. |
|
Perform image measurements including distance, angle, and luminance. |
Creates a new instance of the CImage class. Various constructors are available. |
|
Deletes the instance of the CImage object and deletes its image from memory. |
|
Copies the image to a new image. |
|
Attaches the pointer from an image in a CImageView. |
|
Creates a new CImage and attaches an image selected from the list of images in a CImageView. |
Closes the image and deletes it from memory. |
|
Creates a new image of specified size and data type. |
|
Displays an image in a new image view window. |
|
Returns a pointer to the Mira image object. |
|
Opens an image from a file. |
|
Saves the image to its file. |
|
Saves the image to a new file name by prompting the user. |
|
Saves the image to a new file name without prompting. |
Returns the number of image axes. |
|
Returns the number of bytes in the image pixel data. |
|
Returns the number of image columns. |
|
Returns the dark integration time for the image. |
|
Returns the date the image was acquired, in days. |
|
Returns the date of image acquisition as a string. |
|
Returns the image data type as a string. |
|
Returns the image data type as a numeric index. |
|
Returns the image exposure time in seconds. |
|
Returns the name of the filter used for image acquisition. |
|
Returns the inverse gain in electrons per ADU. |
|
Returns the type of image, usually the value of the IMAGETYP keyword. |
|
Returns true if the image is a color data type. |
|
Returns true if the image is an integer data type. |
|
Returns true if the image is a numeric data type. |
|
Returns true if the image is a real (floating point) data type. |
|
Returns the object description. |
|
Returns the image file path. |
|
Returns the number of bytes per pixel. |
|
Returns the number of pixels in the image. |
|
Returns the number of image rows. |
|
Returns the time of image acquisition as a number of seconds. |
|
Returns the time of image acquisition as a string. |
Returns the angle formed by the line between 2 pixel coordinates. |
|
Returns the angle formed by the line between 2 world coordinates. |
|
Returns the world coordinate units for area measurements. |
|
Returns the distance between 2 world coordinates. |
|
Returns the distance between 2 pixel coordinates. |
|
Returns the world coordinate units for distance measurements. |
|
Returns as a string the distance between 2 world coordinates. |
|
Returns the pixel value at a pixel coordinate in the form of a number. |
|
Returns the image value at a pixel coordinate in the form of a string. |
Returns the coordinate units for an image axis. |
|
Returns the coordinate label for an image axis. |
|
Returns the image scale in world coordinates per pixel. |
|
Returns the x and y axis image scale of the x and y axis in world coordinates per pixel. |
|
Returns true if a pixel coordinate is inside the image. |
|
For a world coordinate, returns the pixel coordinate. |
|
Returns true if the image has an equatorial world coordinate calibration. |
|
For a pixel coordinate, returns the world coordinate in numeric form. |
|
For a pixel coordinate, returns the world coordinate in string form. |
Computes the absolute value of the image pixels. |
|
Adds an operand image. |
|
Adds Gaussian random noise to a region. |
|
Adds a numeric value. |
|
Blends the values of the image with an operand image. |
|
Blends the image values with a numeric value. |
|
Swaps the byte order of the pixels. |
|
Changes the sign of the image values. |
|
Divides by an operand image. |
|
Divides by a numeric value. |
|
Raises base e to powers specified by the image pixels. |
|
Extracts an image consisting of a specific byte plane. |
|
Computes the base-e logarithm of the pixel values. |
|
Computes the base-10 logarithm of the pixel values. |
|
Calculates the remainder of division by an operand image. |
|
Computes the remainder of division by a numeric value. |
|
Multiplies by an operand image. |
|
Multiplies by a numeric value. |
|
Returns the coordinate of the first pixel with value >= target value. |
|
Returns the coordinate of the first pixel with value >= value or <= value 2. |
|
Fits and subtracts a polynomial from the image. |
|
Fits and divides a polynomial into the image. |
|
Fit a polynomial and evaluate it in the image. |
|
Raises the image values to a power. |
|
Raises a base value to powers specified by the image pixels. |
|
Raises the image pixels to the power defined by the pixels of an operand image. |
|
Computes the reciprocal of the pixel values. |
|
Creates an image consisting of a color channel from an RGB image. |
|
Applies a linear scaling to the pixel values. |
|
Applies a polynomial intensity correction. |
|
Changes the image Data type specified by an index value. |
|
Sets the values of pixels inside a rectangular region. |
|
Sets the pixel value at a pixel coordinate. |
|
Computes the square root of the image values. |
|
Subtracts an operand image. |
|
Subtracts a numeric value. |
|
Divides the image values into a numeric value. |
|
Subtracts the image values from a numeric value. |
Applies an affine transformation of shift, scale, and rotation. |
|
Averages pixel values into m x n super-pixels. |
|
Sums pixel values into m x n super-pixels. |
|
Crops a smaller piece from the image. |
|
Tests whether 2 images have the same dimensions. |
|
Expands the image into a larger canvas with specified border value and optional random noise. |
|
Flips the image horizontally. |
|
Imbed the image at a specific location in another image. |
|
Reorients the image in various quadrant transformations. |
|
Rotates the image 180 degrees. |
|
Rotates the image 270 degrees. |
|
Rotates the image 90 degrees. |
|
Rotates the image by an angle about its center. |
|
Rotates the image by an angle about a point. |
|
Scales the image by a magnification factor. |
|
Scales the image independently by magnification factors in the x and y directions. |
|
Shifts the image horizontally and vertically. |
|
Flips the image about its main diagonal. |
|
Flips the image vertically. |
Deletes a keyword from the image header. |
|
Returns true if the named keyword exists in the image header. |
|
Returns a properly formatted angle string for a keyword value given in degrees, minutes, and seconds. Use this for keywords not in the standard format using : as a field delimiter. |
|
Returns a DMS angle for a string keyword plus a boolean flag indicating that the keyword is in the image header. |
|
Returns a MHS time string for a string keyword value given in hours, minutes, and seconds. Use this for keywords not in the standard format using : as a field delimiter. |
|
Returns an HMS time for a string keyword plus a boolean flag indicating that the keyword is in the image header. |
|
Returns a numeric value keyword. |
|
Returns a numeric value keyword plus a boolean flag indicating that the keyword is in the image header. |
|
Returns the 4 column and row limits stored in a region section keyword, like BIASSEC. |
|
Returns the 4 column and row limits stored in a region section keyword (e.g., BIASSEC), plus a boolean flag indicating that the keyword is in the image header. |
|
Returns a string value keyword. |
|
Returns a string value keyword plus a boolean flag indicating that the keyword is in the image header. |
|
Returns the value of a keyword in any format (string, number, etc.) as a string. |
|
Returns the value of a keyword in any format (string, number, etc.) as a string and also a boolean flag indicating that the keyword is in the header. |
|
Adds a blank keyword to the image header. |
|
Adds a blank keyword with string value to the image header. |
|
Sets the value of a boolean T/F keyword or adds the keyword to the image header. |
|
Adds a comment keyword to the image header. |
|
Sets the value of a date keyword or adds the keyword to the image header. |
|
Adds a history keyword to the image header. |
|
Sets the value of a numeric keyword or adds the keyword to the image header. |
|
Sets a region section keyword (e.g., BIASSEC) using the 4 column and row limits passed as numbers |
|
Sets the value of a string keyword or adds the keyword to the image header. |
|
Sets the value of a time keyword or adds the keyword to the image header. |
|
Sets the value of a keyword or adds the keyword to the image header. |
Applies a pixel mask to repair image blemishes. |
|
Creates a mask file for pixels above or below threshold values. |
|
Creates a mask file for pixels above a threshold value. |
|
Creates a mask file for pixels below a threshold value. |
|
Sets pixel values at coordinates identified in a pixel mask. |
|
Subtract a bias frame from the image. |
|
Subtract a bias value from the image. |
|
Subtract a reference bias value stored in a header keyword. |
|
Compute and apply a column bias correction. |
|
Compute and apply a row bias correction. |
|
Subtracts a dark frame from the image. |
|
Subtracts a time-scaled dark frame from the image. |
|
Subtracts a statistically optimized dark frame from the image. |
|
Divides the image by a flat field frame. |
|
Divides the image by a flat field frame while normalizing the flat during the calculation. |
Smooths the image using a binomial weight rectangular kernel. |
|
Replaces pixel values above a threshold value. |
|
Replaces pixel values below a threshold value. |
|
Smooths the image using an equal weight elliptical kernel. |
|
Smooths the image using a Gaussian weight elliptical kernel. |
|
Applies a directional derivative gradient filter. |
|
Applies a user-defined kernel. |
|
Applies a Laplacian filter, usually for edge detection. |
|
Applies a directional line selection kernel. |
|
Applies a maximum value filter. |
|
Applies a median filter. |
|
Applies a minimum value filter. |
|
Applies a Prewitt directional gradient mask. |
|
Applies a rank value filter. |
|
Smooths the image using an equal weight rectangular kernel. |
|
Applies a rotational gradient filter to enhance rotational or "spoked" features. |
|
Sharpens the image using a crispening filter. |
|
Applies a Sobel edge filter. |
|
Sharpens the image using unsharp masking. |
Script Classes, CImageSet, CImageView, CImCombine, Image Coordinate System, Subpixel Coordinate Definition