FLUT Control Reference 15.0
Properties

Variables

long Entire
 If Entire is TRUE the currently set area of interest, defined through the properties X0, Y0, X1 and Y1, is ignored and the LUT operation affects the complete input image. More...
 
__int3264 ImageIn
 Specifies the input image for the LUT operations. More...
 
__int3264 ImageOut
 Handle to the resulting image after applying the Execute method. More...
 
long Index
 Specifies the color plane to be used if the image assigned to the control consists of more than one plane. More...
 
long LUTIndex
 Access an individual entry (LUTValue and or LUTLevel) of an array-based or node-based LUT. LUTIndex may range from 0 to NumLUTEntries - 1. More...
 
long LUTLevel
 Changes the level component of a node for the node-based LUT methods. More...
 
TLUTMethod LUTMethod
 Specifies the LUT mode which should be used. More...
 
long LUTValue
 Sets the intensity value in the LUT node or array cell indexed by LUTIndex. More...
 
long NumLUTEntries
 In node-based LUT modes you may use this property to change the number of nodes that define the LUT operation. More...
 
double X0
 X-coordinate of the upper left corner of the rectangular area of interest. The properties X0, Y0, X1 and Y1 define the area of the input image that will be processed. More...
 
double X1
 X-coordinate of the bottom right corner of the rectangular area of interest. The properties X0, Y0, X1 and Y1 define the area of the input image that will be processed. More...
 
double Y0
 Y-coordinate of the upper left corner of the rectangular area of interest. The properties X0, Y0, X1 and Y1 define the area of the input image that will be processed. More...
 
double Y1
 Y-coordinate of the bottom right corner of the rectangular area of interest. The properties X0, Y0, X1 and Y1 define the area of the input image that will be processed. More...
 

Detailed Description

Variable Documentation

◆ Entire

long Entire
property

If Entire is TRUE the currently set area of interest, defined through the properties X0, Y0, X1 and Y1, is ignored and the LUT operation affects the complete input image.

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, X1, Y0, Y1

◆ ImageIn

__int3264 ImageIn
property

Specifies the input image for the LUT operations.

Attention
It 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 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:
ImageIn

◆ Index

long Index
property

Specifies the color plane to be used if the image assigned to the control consists of more than one plane.

Parameters
[in,out]IndexColor plane to be used. Valid values are 0 to ImageDimension(cvFLUT.Image) - 1.
If you specify an invalid value the CVCError event will be fired. (see CVCError headerfile)
Returns
Color plane.
Supported platforms:
Win32
Win64

◆ LUTIndex

long LUTIndex
property

Access an individual entry (LUTValue and or LUTLevel) of an array-based or node-based LUT. LUTIndex may range from 0 to NumLUTEntries - 1.

Attention
Changing the LUTMethod property will automatically change the LUTIndex as well!
Parameters
[in,out]LUTIndexIndex of the array-based or node-based LUT.
Returns
Index in array.
Supported platforms:
Win32
Win64
Related Topics:
NumLUTEntries, LUTLevel, LUTValue, LUTMethod

◆ LUTLevel

long LUTLevel
property

Changes the level component of a node for the node-based LUT methods.

Parameters
[in,out]LUTLevelChanges the level component.
Returns
Level component.
Supported platforms:
Win32
Win64
Related Topics:
NumLUTEntries, LUTValue, LUTIndex, LUTMethod

◆ LUTMethod

TLUTMethod LUTMethod
property

Specifies the LUT mode which should be used.

Parameters
[in,out]LUTMethodDefines the LUT mode. See TLUTMethod for more information.
Returns
LUT mode.
Supported platforms:
Win32
Win64
Related Topics:
TLUTMethod

◆ LUTValue

long LUTValue
property

Sets the intensity value in the LUT node or array cell indexed by LUTIndex.

Parameters
[in,out]LUTValueSets the intensity value in the LUT node or array cell.
Returns
Intensity value.
Supported platforms:
Win32
Win64
Related Topics:
NumLUTEntries, LUTLevel, LUTIndex, LUTMethod

◆ NumLUTEntries

long NumLUTEntries
property

In node-based LUT modes you may use this property to change the number of nodes that define the LUT operation.

Attention
In the array-based LUT mode, this property should not be assigned to and always return 256.
Parameters
[in,out]NumLUTEntriesNumber of entries in the LUT.
Returns
Number of entries.
Supported platforms:
Win32
Win64
Related Topics:
LUTLevel, LUTIndex, LUTValue, LUTMethod
Sample code in Visual C++:
//Fill the LUT using the LUT mode array:
m_cvLUT.SetLUTMode (0); //LUT mode array
for (int i = 0; i < 256; i++)
{
m_cvLUT.SetIndex (i);
m_cvLUT.SetLUTValue (i/2);
}
m_cvLUT.Execute ();
//Fill the LUT using LUT modi Generic, Linear or cubic
m_cvLUT.SetLUTMode (3); //LUT mode Generic, 2 (Linear) or 3 (Cubic) possible
m_cvLUT.SetNumEntries (3); // 3 levels (nodes);
m_cvLUT.SetLUTIndex (0); //first LUT entry
m_cvLUT.SetLUTLevel (0); //first level
m_cvLUT.SetLUTValue (0); //first LUT intensity value at the level (node)
m_cvLUT.SetLUTIndex (1); //second LUT entry
m_cvLUT.SetLUTLevel (128); //second level
m_cvLUT.SetLUTValue (128); //second LUT intensity value at the level (node)
m_cvLUT.SetLUTIndex (2); //third LUT entry
m_cvLUT.SetLUTLevel (256); //third LUT level
m_cvLUT.SetLUTValue (256); //third LUT LUT intensity value at the level (node)
m_cvLUT.Execute ();

◆ X0

double X0
property

X-coordinate of the upper left corner of the rectangular area of interest. The properties X0, Y0, X1 and 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 upper left corner of the area of interest.
Returns
X-coordinate of the upper left corner of the area of interest.
Supported platforms:
Win32
Win64
Related Topics:
Entire property, Area of interest (AOI)

◆ X1

double X1
property

X-coordinate of the bottom right corner of the rectangular area of interest. The properties X0, Y0, X1 and 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 area of interest.
Returns
X-coordinate of the bottom right corner of the area of interest.
Supported platforms:
Win32
Win64
Related Topics:
Entire property, Area of interest (AOI)

◆ Y0

double Y0
property

Y-coordinate of the upper left corner of the rectangular area of interest. The properties X0, Y0, X1 and 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 upper left corner of the area of interest.
Returns
Y-coordinate of the upper left corner of the area of interest.
Supported platforms:
Win32
Win64
Related Topics:
Entire property, Area of interest (AOI)

◆ Y1

double Y1
property

Y-coordinate of the bottom right corner of the rectangular area of interest. The properties X0, Y0, X1 and 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 area of interest.
Returns
Y-coordinate of the bottom right corner of the area of interest.
Supported platforms:
Win32
Win64
Related Topics:
Entire property, Area of interest (AOI)