FColorSpace Control Reference 14.0
Properties

Variables

double A11
 Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model: More...
 
double A12
 Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model: More...
 
double A13
 Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model: More...
 
double A14
 Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model: More...
 
double A21
 Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model: More...
 
double A22
 Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model: More...
 
double A23
 Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model: More...
 
double A24
 Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model: More...
 
double A31
 Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model: More...
 
double A32
 Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model: More...
 
double A33
 Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model: More...
 
double A34
 Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model: More...
 
boolean Entire
 If this property is set to TRUE the area passed by the X0, X1, Y0 and Y1 properties is ignored and the complete image will be used for the conversion. More...
 
__int3264 ImageIn
 Defines the input image object for the conversion. The image should be assigned prior to calling the Execute method. More...
 
__int3264 ImageOut
 Handle to the result image of the last color conversion operation. More...
 
OCXColorModel InputColorModel
 Returns the color model of the incoming image. More...
 
OCXColorModel OutputColorModel
 Determines the color model the result image should have. The default setting is: CM_RGB = 2. If set to CM_CUSTOM the color twist matrix defined by the coefficients A11 to A34 will be defined. More...
 
double X0
 Defines the X-coordinate of the top left corner of the rectangular area of interest (AOI).
More...
 
double X1
 Defines the X-coordinate of the bottom right corner of the rectangular area of interest (AOI).
More...
 
double Y0
 Defines the Y-coordinate of the top left corner of the rectangular area of interest (AOI). More...
 
double Y1
 Defines the Y-coordinate of the bottom right corner of the rectangular area of interest (AOI). More...
 

Detailed Description

Variable Documentation

◆ A11

double A11
property

Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model:

Color Twist Matrix

 

 

 

 

 

Alternatively it may be used to apply separate gain and offset to an RGB image.

Parameters
[in,out]A11Coefficient of the color twist matrix.
Returns
Coefficient of the color twist matrix.
Supported platforms:
Win32
Win64
Related Topics:
A11, A12, A13, A14
A21, A22, A23, A24
A31, A32, A33, A34

◆ A12

double A12
property

Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model:

Color Twist Matrix

 

 

 

 

 

Alternatively it may be used to apply separate gain and offset to an RGB image.

Parameters
[in,out]A12Coefficient of the color twist matrix.
Returns
Coefficient of the color twist matrix.
Supported platforms:
Win32
Win64
Related Topics:
A11, A12, A13, A14
A21, A22, A23, A24
A31, A32, A33, A34

◆ A13

double A13
property

Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model:

Color Twist Matrix

 

 

 

 

 

Alternatively it may be used to apply separate gain and offset to an RGB image.

Parameters
[in,out]A13Coefficient of the color twist matrix.
Returns
Coefficient of the color twist matrix.
Supported platforms:
Win32
Win64
Related Topics:
A11, A12, A13, A14
A21, A22, A23, A24
A31, A32, A33, A34

◆ A14

double A14
property

Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model:

Color Twist Matrix

 

 

 

 

 

Alternatively it may be used to apply separate gain and offset to an RGB image.

Parameters
[in,out]A14Coefficient of the color twist matrix.
Returns
Coefficient of the color twist matrix.
Supported platforms:
Win32
Win64
Related Topics:
A11, A12, A13, A14
A21, A22, A23, A24
A31, A32, A33, A34

◆ A21

double A21
property

Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model:

Color Twist Matrix

 

 

 

 

 

Alternatively it may be used to apply separate gain and offset to an RGB image.

Parameters
[in,out]A21Coefficient of the color twist matrix.
Returns
Coefficient of the color twist matrix.
Supported platforms:
Win32
Win64
Related Topics:
A11, A12, A13, A14
A21, A22, A23, A24
A31, A32, A33, A34

◆ A22

double A22
property

Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model:

Color Twist Matrix

 

 

 

 

 

Alternatively it may be used to apply separate gain and offset to an RGB image.

Parameters
[in,out]A22Coefficient of the color twist matrix.
Returns
Coefficient of the color twist matrix.
Supported platforms:
Win32
Win64
Related Topics:
A11, A12, A13, A14
A21, A22, A23, A24
A31, A32, A33, A34

◆ A23

double A23
property

Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model:

Color Twist Matrix

 

 

 

 

 

Alternatively it may be used to apply separate gain and offset to an RGB image.

Parameters
[in,out]A23Coefficient of the color twist matrix.
Returns
Coefficient of the color twist matrix.
Supported platforms:
Win32
Win64
Related Topics:
A11, A12, A13, A14
A21, A22, A23, A24
A31, A32, A33, A34

◆ A24

double A24
property

Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model:

Color Twist Matrix

 

 

 

 

 

Alternatively it may be used to apply separate gain and offset to an RGB image.

Parameters
[in,out]A24Coefficient of the color twist matrix.
Returns
Coefficient of the color twist matrix.
Supported platforms:
Win32
Win64
Related Topics:
A11, A12, A13, A14
A21, A22, A23, A24
A31, A32, A33, A34

◆ A31

double A31
property

Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model:

Color Twist Matrix

 

 

 

 

 

Alternatively it may be used to apply separate gain and offset to an RGB image.

Parameters
[in,out]A31Coefficient of the color twist matrix.
Returns
Coefficient of the color twist matrix.
Supported platforms:
Win32
Win64
Related Topics:
A11, A12, A13, A14
A21, A22, A23, A24
A31, A32, A33, A34

◆ A32

double A32
property

Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model:

Color Twist Matrix

 

 

 

 

 

Alternatively it may be used to apply separate gain and offset to an RGB image.

Parameters
[in,out]A32Coefficient of the color twist matrix.
Returns
Coefficient of the color twist matrix.
Supported platforms:
Win32
Win64
Related Topics:
A11, A12, A13, A14
A21, A22, A23, A24
A31, A32, A33, A34

◆ A33

double A33
property

Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model:

Color Twist Matrix

 

 

 

 

 

Alternatively it may be used to apply separate gain and offset to an RGB image.

Parameters
[in,out]A33Coefficient of the color twist matrix.
Returns
Coefficient of the color twist matrix.
Supported platforms:
Win32
Win64
Related Topics:
A11, A12, A13, A14
A21, A22, A23, A24
A31, A32, A33, A34

◆ A34

double A34
property

Coefficient of the color twist matrix. The color twist matrix allows you to generate an user-defined color model:

Color Twist Matrix

 

 

 

 

 

Alternatively it may be used to apply separate gain and offset to an RGB image.

Parameters
[in,out]A34Coefficient of the color twist matrix.
Returns
Coefficient of the color twist matrix.
Supported platforms:
Win32
Win64
Related Topics:
A11, A12, A13, A14
A21, A22, A23, A24
A31, A32, A33, A34

◆ Entire

boolean Entire
property

If this property is set to TRUE the area passed by the X0, X1, Y0 and Y1 properties is ignored and the complete image will be used for the conversion.

Parameters
[in,out]EntireTRUE indicates that the complete image will be used, FALSE otherwise.
Returns
TRUE indicates that the complete image will be used, FALSE otherwise.
Supported platforms:
Win32
Win64
Related Topics:
X0, Y0, X1, Y1

◆ ImageIn

__int3264 ImageIn
property

Defines the input image object for the conversion. The image should be assigned prior to calling the Execute method.

Parameters
[in,out]ImageInHandle of the image object.
Returns
Image object handle.
Supported platforms:
Win32
Win64
Related Topics:
ImageOut

◆ ImageOut

__int3264 ImageOut
propertyreadonly

Handle to the result image of the last color conversion operation.

Parameters
[out]ImageOutHandle of the result image object.
Returns
Image object handle.
Supported platforms:
Win32
Win64
Related Topics:
ImageIn

◆ InputColorModel

OCXColorModel InputColorModel
propertyreadonly

Returns the color model of the incoming image.

Parameters
[out]InputColorModelColor model of the incoming image. See OCXColorModel for possible color models.
Returns
Color model.
Supported platforms:
Win32
Win64
Related Topics:
OCXColorModel

◆ OutputColorModel

OCXColorModel OutputColorModel
property

Determines the color model the result image should have. The default setting is: CM_RGB = 2. If set to CM_CUSTOM the color twist matrix defined by the coefficients A11 to A34 will be defined.

Attention
It should be assigned prior to calling the Execute method.
Parameters
[in,out]OutputColorModelColor model of the output image. Following values are possible:
CM_CUSTOM = 0
CM_Mono = 1
CM_RGB = 2
CM_YUV = 3
CM_HSI = 4
CM_YCbCr = 5
CM_LUV = 6
CM_Lab = 7
CM_HLS = 8
CM_YCC = 9
CM_HSV = 10
CM_XYZ = 11
Returns
Output color model.
Supported platforms:
Win32
Win64
Related Topics:
OCXColorModel, InputColorModel

◆ X0

double X0
property

Defines the X-coordinate of the top left corner of the rectangular area of interest (AOI).

The properties \ref X0, \ref X1, \ref Y0 and \ref Y1 define the area of the input image that will be processed.
Attention
If the Entire property is set to TRUE these values will be ignored and the complete image will be used for the conversion.
Parameters
[in,out]X0X-coordinate of the top left corner of the rectangular AOI.
Returns
X-coordinate of the top left corner.
Supported platforms:
Win32
Win64
Related Topics:
Entire property, Y0, X1, Y1, Area of interest (AOI)

◆ X1

double X1
property

Defines the X-coordinate of the bottom right corner of the rectangular area of interest (AOI).

The properties \ref X0, \ref X1, \ref Y0 and \ref Y1 define the area of the input image that will be processed.
Attention
If the Entire property is set to TRUE these values will be ignored and the complete image will be used for the conversion.
Parameters
[in,out]X1X-coordinate of the bottom right corner of the rectangular AOI.
Returns
X-coordinate of the bottom right corner.
Supported platforms:
Win32
Win64
Related Topics:
Entire property, X0, Y0, Y1, Area of interest (AOI)

◆ Y0

double Y0
property

Defines the Y-coordinate of the top left corner of the rectangular area of interest (AOI).

The properties \ref X0, \ref X1, \ref Y0 and \ref Y1 define the area of the input image that will be processed.
Attention
If the Entire property is set to TRUE these values will be ignored and the complete image will be used for the conversion.
Parameters
[in,out]Y0Y-coordinate of the top left corner of the rectangular AOI.
Returns
Y-coordinate of the top left corner.
Supported platforms:
Win32
Win64
Related Topics:
Entire property, X0, X1, Y1, Area of interest (AOI)

◆ Y1

double Y1
property

Defines the Y-coordinate of the bottom right corner of the rectangular area of interest (AOI).

The properties \ref X0, \ref X1, \ref Y0 and \ref Y1 define the area of the input image that will be processed.
Attention
If the Entire property is set to TRUE these values will be ignored and the complete image will be used for the conversion.
Parameters
[in,out]Y1Y-coordinate of the bottom right corner of the rectangular AOI.
Returns
Y-coordinate of the bottom right corner.
Supported platforms:
Win32
Win64
Related Topics:
Entire property, X0, Y0, X1, Area of interest (AOI)