CImage:ImageType

CImage:ImageType

The ImageType method returns a string describing the type of image (e.g., normal, bias, dark, or flat). For a FITS format image, this is traditionally the value of the IMAGETYP keyword.

Syntax

sImageType = CImage:ImageType()

where sImageType is a string describing the type of image.
On failure, this method returns nil.

Remarks

The IMAGETYP keyword is used by FITS format images to signify the type of calibration or normal image. The standard values are 'normal', 'zero', 'dark', and 'flat', although other types are allowed. The name 'zero' is typically used to represent a bias frame. The value of this keyword is commonly use for selecting images used in creating or applying data calibration procedures.

Example

Suppose a CImage object I is attached to an image that is a dark frame. Then

Printf( "Image Type: '%s'", I:ImageType() )

prints the following:

Image Type: 'dark'