FArithmetic Control Reference 14.0
Properties

Variables

double ConstB
 Some of the arithmetic operations supported by the FArithmetic OCX require constant with which to perform the operation. Therefore the FArithmetic OCX has three constants, ConstR, ConstG, ConstB, for these operations to work with. More...
 
double ConstG
 Some of the arithmetic operations supported by the FArithmetic OCX require constant with which to perform the operation. Therefore the FArithmetic OCX has three constants, ConstR, ConstG, ConstB, for these operations to work with. More...
 
double ConstR
 Some of the arithmetic operations supported by the FArithmetic OCX require constant with which to perform the operation. Therefore the FArithmetic OCX has three constants, ConstR, ConstG, ConstB, for these operations to work with. 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 arithmetic operation. More...
 
__int3264 ImageIn1
 Specifies the (first) input image object for all arithmetic operations. More...
 
__int3264 ImageIn2
 Specifies the second input image for the arithmetic operations working on two images. More...
 
__int3264 ImageOut
 Handle to the resulting image after applying the Execute method. More...
 
TArithmeticOperation Operation
 Determines which operation is applied to the input image(s) when the Execute method is called. More...
 
boolean ScaleResults
 Scales the resulting pixel values to the full dynamic range of the output image. Some operations like MultiplyImages, AddImages, etc. may lead to pixel values that are higher than the maximum allowable gray value. Others (DivideImages, SquareRootImage) provide output data with very low intensity. More...
 
double X0
 Defines the X-coordinate of the top left corner of the rectangular area of interest (AOI). The properties X0, X1, Y0 and Y1 define the area of interest in which the control applies the operations on the input image(s) (if the selected operation has two input images, the area of interest is applied to both input images). More...
 
double X1
 Defines the X-coordinate of the bottom right corner of the rectangular area of interest (AOI). The properties X0, X1, Y0 and Y1 define the area of interest in which the control applies the operations on the input image(s) (if the selected operation has two input images, the area of interest is applied to both input images). More...
 
double Y0
 Defines the Y-coordinate of the top left corner of the rectangular area of interest (AOI). The properties X0, X1, Y0 and Y1 define the area of interest in which the control applies the operations on the input image(s) (if the selected operation has two input images, the area of interest is applied to both input images). More...
 
double Y1
 Defines the Y-coordinate of the bottom right corner of the rectangular area of interest (AOI). The properties X0, X1, Y0 and Y1 define the area of interest in which the control applies the operations on the input image(s) (if the selected operation has two input images, the area of interest is applied to both input images). More...
 

Detailed Description

Variable Documentation

◆ ConstB

double ConstB
property

Some of the arithmetic operations supported by the FArithmetic OCX require constant with which to perform the operation. Therefore the FArithmetic OCX has three constants, ConstR, ConstG, ConstB, for these operations to work with.

Attention
For monochrome images use only the ConstR value.
Parameters
[in,out]ConstBOne of three constants that are used to process images.
Returns
One of three constants that are used to process images.
Supported platforms:
Win32
Win64
Related Topics:
Operation property, ConstR,ConstG

◆ ConstG

double ConstG
property

Some of the arithmetic operations supported by the FArithmetic OCX require constant with which to perform the operation. Therefore the FArithmetic OCX has three constants, ConstR, ConstG, ConstB, for these operations to work with.

Attention
For monochrome images use only the ConstR value.
Parameters
[in,out]ConstGOne of three constants that are used to process images.
Returns
One of three constants that are used to process images.
Supported platforms:
Win32
Win64
Related Topics:
Operation property, ConstR, ConstB

◆ ConstR

double ConstR
property

Some of the arithmetic operations supported by the FArithmetic OCX require constant with which to perform the operation. Therefore the FArithmetic OCX has three constants, ConstR, ConstG, ConstB, for these operations to work with.

Attention
For monochrome images use only the ConstR value.
Parameters
[in,out]ConstROne of three constants that are used to process images.
Returns
One of three constants that are used to process images.
Supported platforms:
Win32
Win64
Related Topics:
Operation property, ConstG, ConstB

◆ 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 arithmetic operation.

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

◆ ImageIn1

__int3264 ImageIn1
property

Specifies the (first) input image object for all arithmetic operations.

Attention
Some arithmetic operations require two input images, in which case also the property ImageIn2 must be set.
Parameters
[in,out]ImageIn1Handle of the image object.
Returns
Image object handle.
Supported platforms:
Win32
Win64
Related Topics:
ImageIn2

◆ ImageIn2

__int3264 ImageIn2
property

Specifies the second input image for the arithmetic operations working on two images.

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

◆ ImageOut

__int3264 ImageOut
propertyreadonly

Handle to the resulting image after applying the Execute method.

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

◆ Operation

TArithmeticOperation Operation
property

Determines which operation is applied to the input image(s) when the Execute method is called.

Attention
Depending on the used compiler, the value for Operation may be given as an enumerated named constant or as an integer number (Visual C++ 6).
Parameters
[in,out]OperationOperation which is applied to the input image(s). See TArithmeticOperation for possible operations.
Returns
Operation which is applied to the input image(s).
Supported platforms:
Win32
Win64
Related Topics:
ConstR, ConstG, ConstB, TArithmeticOperation

◆ ScaleResults

boolean ScaleResults
property

Scales the resulting pixel values to the full dynamic range of the output image. Some operations like MultiplyImages, AddImages, etc. may lead to pixel values that are higher than the maximum allowable gray value. Others (DivideImages, SquareRootImage) provide output data with very low intensity.

Parameters
[in,out]ScaleResultsTRUE indicates that the resulting pixel values of these operations will be scaled to use the full dynamic range of the output image. FALSE means that the values will be cut off at 255 if bigger and are otherwise left unchanged.
Returns
TRUE scales the resulting pixel values, otherwise FALSE will cut off the pixels e.g. at 255.
Supported platforms:
Win32
Win64

◆ X0

double X0
property

Defines the X-coordinate of the top left corner of the rectangular area of interest (AOI). The properties X0, X1, Y0 and Y1 define the area of interest in which the control applies the operations on the input image(s) (if the selected operation has two input images, the area of interest is applied to both input images).

Attention
If the Entire property is set to TRUE these values will be ignored and the complete image will be used.
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 X0, X1, Y0 and Y1 define the area of interest in which the control applies the operations on the input image(s) (if the selected operation has two input images, the area of interest is applied to both input images).

Attention
If the Entire property is set to TRUE these values will be ignored and the complete image will be used.
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 X0, X1, Y0 and Y1 define the area of interest in which the control applies the operations on the input image(s) (if the selected operation has two input images, the area of interest is applied to both input images).

Attention
If the Entire property is set to TRUE these values will be ignored and the complete image will be used.
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 X0, X1, Y0 and Y1 define the area of interest in which the control applies the operations on the input image(s) (if the selected operation has two input images, the area of interest is applied to both input images).

Attention
If the Entire property is set to TRUE these values will be ignored and the complete image will be used.
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)