ToImage Method

Description:

Converts a complex object to an IGPage Object, using the conversion type specified by parameter nConvType. A complex object should be converted to IGPage Object only for displaying purpose; otherwise, it should remain in its original format to retain the data accuracy.

Because an IGComplexObject object contains both real and imaginary data, we need to first combine these two data sets into one in order to store the result in an IGPage Object, using the option specified by the parameter nConvType. Options available include IG_CO_OBJ_CONV_TYPE_REAL, IG_CO_OBJ_CONV_TYPE_IMAGINARY, IG_CO_OBJ_CONV_TYPE_MAGNITUDE, etc. Please see the help page for enumIGCoObjConvType for details.

The dimensions of the converted IGPage Object are determined by those of the complex object, with width and height being the same. The depth of the IGPage Objectcan be 8, 16 or 32, depending on the image size. If the image size is less than or equal to (1 << 8), then the depth will be 8bit; less than or equal to (1 << 16), then 16bit; otherwise, the depth will be 32bit. Of course, the IGPage Object will only have one channel.

Once the bit depth is determined, data are then scaled linearly to occupy the entire range of that bit depth and copied to the buffer of IGPage Object.

If it is desirable to return minimum value before scaling and also scale factor, method ToImageWithParameters() should be used instead .

Syntax:

ToImage(nConvType As enumIGCoObjConvType) As IGPage

Parameters:

Name	Description
nConvType	Conversion type used to convert the object to IGPage Object.

Return Value:

Returns the converted IGPage Object.

Bits Per Pixel:

N/A