IMVColor

This interface is exposed to allow programmatic control of the filter. Read the  filter description to see how the filter is used. Read the remarks for implementation details.

Header file: iMVColor.h
Interface definition language file: iMVColor.idl
Typelib: MVColor
Interface ID:IID_IMVColor

HRESULT get_UpperThreshold( [out, retval] double *pdUpperThreshold );

Returns the value for the filter's upper color threshold. See the MV Color filter for channel sequences and ranges.
Example: If the filter method is set to band reject, all color values above the upper threshold are left unmodified and all color values between the lower and the upper threshold are modified.

Parameter:

HRESULT put_UpperThreshold( [in ] double dUpperThreshold );

Sets the value for the filter's upper color threshold. See the MV Color filter for channel sequences and ranges.
Example: If the filter method is set to band reject, all color values above the upper threshold are left unmodified and all color values between the lower and the upper threshold are modified.

Parameter:

HRESULT get_LowerThreshold( [out, retval] double *pdLowerThreshold );

Returns the value for the filter's lower color threshold. See the MV Color filter for channel sequences and ranges.
Example: If the filter method is set to band reject, all color values below the lower threshold are left unmodified and all color values between the lower and the upper threshold are modified.

Parameter:

HRESULT put_LowerThreshold( [in ] double dLowerThreshold );

Sets the value for the filter's lower color threshold. See the MV Color filter for channel sequences and ranges.
Example: If the filter method is set to band reject, all color values below the lower threshold are left unmodified and all color values between the lower and the upper threshold are modified.

Parameter:

HRESULT get_FilterMethod( [out, retval] int *piMethod );

Returns the filter method that is used by the image processing algorithm, that is either band pass or band reject.

Parameter:

HRESULT put_FilterMethod( [in ] int iMethod );

Sets the filter method that is used by the image processing algortihm, that is either band pass or band reject.

Parameter:

HRESULT get_PixelColorTo( [out, retval] int *piResult );

Returns the method that is used to modify the pixel channels that are filtered out by the filter method. Either the filtered out channels are set to the maximum or to the minimum of the currently selected color system.
Example: If the selected color system is RGB and the filtered out pixel channels are to be set to the maximum, the channels will be set to 255.

Parameter:

HRESULT put_PixelColorTo( [in ] int iResult );

Returns the method that is used to modify the pixel channels that are filtered out by the filter method. Either the filtered out channels are set to the maximum or to the minimum of the currently selected color system.
Example: If the selected color system is RGB and the filtered out pixel channels are to be set to the maximum, the channels will be set to 255.

Parameter:

HRESULT get_ModifyPixel( [out, retval] int *piWholePixel );

Returns the pixel modification method. Either only the currently selected channel of the pixel that is filtered out is modified or all channels of the pixel are modified.

Parameter:

HRESULT put_ModifyPixel( [in ] int iWholePixel );

Sets the pixel modification method. Either only the currently selected channel of the pixel that is filtered out is modified or all channels of the pixel are modified.

Parameter:

HRESULT get_ColorChannel( [out, retval] int *piChannel );

Returns the color channel that is currently modified by the image processing algorithm. See the MV Color filter for channel sequences and ranges.

Parameter:

HRESULT put_ColorChannel( [in ] int iChannel );

Sets the color channel that is to be modified by the image processing algorithm. See the MV Color filter for channel sequences and ranges.

Parameter:

HRESULT get_ColorModel( [out, retval] int *piSystem );

Returns the current color system.

Parameter:

HRESULT put_ColorModel( [out, retval] int iSystem );

Sets the current color system.

Parameter:

HRESULT Reset();

Resets the color filter's parameters to their initial state.

Filter specific structures and enumerators

typedef enum _MV_COLOR_SYSTEM
{
    MV_COLOR_RGB,
    MV_COLOR_HSV,
    MV_COLOR_HLS,
    MV_COLOR_XYZ,
    MV_COLOR_YCrCb,
    MV_COLOR_YUV
} MV_COLOR_SYSTEM;

typedef enum _MV_COLOR_FILTER
{
    MV_BAND_REJECT,
    MV_BAND_PASS
} MV_COLOR_FILTER;

typedef enum _MV_COLOR_METHOD
{
    MV_MODIFY_SELECTED_PIXEL_COLOR,
    MV_MODIFY_ALL_PIXEL_COLORS
} MV_COLOR_METHOD;

typedef enum _MV_COLOR_RESULT
{
    MV_COLOR_MINIMUM,
    MV_COLOR_MAXIMUM
} MV_COLOR_RESULT;

typedef enum _MV_COLOR_CHANNEL_NUM
{
    MV_CHANNEL_1,
    MV_CHANNEL_2,
    MV_CHANNEL_3
} _MV_COLOR_CHANNEL_NUM;

Remarks

The following is an example sequence, that is used to set all channels of a pixel in a RGB image to zero, if the red value of the pixel is higher than 200.

IMVColor *pIColor;

...

// RGB color system
pIColor->put_ColorModel( MV_COLOR_RGB );
// Red color channel
pIColor->put_ColorChannel( MV_CHANNEL_3 );
// Pass through all values between 0 and 200
pIColor->put_LowerThreshold( 0.0 );
pIColor->put_UpperThreshold( 200.0 );
// Work as a band pass
pIColor->put_FilterMethod( MV_BAND_PASS );
// Modify all channels of filtered pixels
pIColor->put_ModifyPixel( MV_MODIFY_ALL_PIXEL_COLORS );
// Set the filtered pixel channels to zero
pIColor->put_PixelColorTo( MV_COLOR_MINIMUM );