McolInquire

Inquires the acceptance level for the color-sample's score. SET

Inquires the acceptance level for the target area's relevance score. SET

Inquires the background pixel color, when applicable. This value applies to McolDraw() or McolMatch() with M_DRAW_AREA_MATCH_USING_COLOR, M_DRAW_PIXEL_MATCH_USING_COLOR, or M_DRAW_DISTANCE. SET

Inquires the color bands to use when performing McolMatch(). SET

Inquires whether the relative color calibration was performed using pixel values or color statistics.

This inquire type is only available for relative color calibration contexts. SET

Inquires the transformation precision with which to perform relative color calibration.

This inquire type is only available for relative color calibration contexts. SET

Inquires the transformation operation with which to perform relative color calibration.

This inquire type is only available for relative color calibration contexts. SET

Inquires the context's color space. SET

Inquires the type of context used.

Inquires whether gamma correction is performed when converting colors before the match operation. SET

Inquires the mode used to internally convert colors before the matching operation. SET

Inquires the normalization factor when drawing or generating M_DRAW_DISTANCE, using McolDraw() or McolMatch(). SET

Inquires the strategy used to calculate the tolerance for an acceptable color distance between the color-sample and a target area. SET

Inquires the type of distance calculated when matching colors. SET

Inquires whether the distance image was generated. SET

Inquires whether the image containing the color-sample label for which each pixel voted was generated. SET

Inquires whether the color-sample label LUT was generated. SET

Inquires the operation mode used when matching colors. SET

Inquires the current value of the modification counter. The modification counter is increased by one each time settings for the context are modified.

Although you cannot identify the modification counter's contents, you can compare them throughout your application to inquire if the context has been altered. If the modification counter has changed you can, for example, prompt the user to save before closing the application.

This inquire type is available for color matching and relative color calibration contexts.

Inquires the number of histogram bins for color band 0. Relevant only when matching colors using McolSetMethod() with M_HISTOGRAM_MATCHING or M_HISTOGRAM_VOTE. SET

Inquires the number of histogram bins for color band 1. Relevant only when matching colors using McolSetMethod() with M_HISTOGRAM_MATCHING or M_HISTOGRAM_VOTE. SET

Inquires the number of histogram bins for color band 2. Relevant only when matching colors using McolSetMethod() with M_HISTOGRAM_MATCHING or M_HISTOGRAM_VOTE. SET

Inquires the number of color-samples defined in the context (McolDefine()).

This inquire type is available for color matching and relative color calibration contexts.

For relative color calibration contexts, the number of color-samples does not include the reference color-sample.

Inquires the color used for outlier pixels when drawing the color of the best-matched color-sample, the color of the color-sample for which each pixel voted, or the distance between the color of the target area/target pixel and the color of its best-matched color-sample (McolDraw() or McolMatch() with M_DRAW_AREA_MATCH_USING_COLOR, M_DRAW_PIXEL_MATCH_USING_COLOR or M_DRAW_DISTANCE). SET

Inquires the label used for outlier pixels when drawing the label of the best-matched color-sample or the label of the color-sample for which each pixel voted (McolDraw() or McolMatch() with M_DRAW_AREA_MATCH_USING_LABEL or M_DRAW_PIXEL_MATCH_USING_LABEL). SET

Inquires whether the context is preprocessed. The context must be preprocessed (using McolPreprocess()) before calling McolMatch() or McolTransform(). After certain settings of the context are changed (for example, with McolControl() or McolDefine()), this inquire type will indicate that the context is no longer in its preprocessed state.

This inquire type is available for color matching and relative color calibration contexts.

Inquires the depth per band required for the image buffer in which to draw the label of the best-matched color-sample or the label of the color-sample for which each pixel voted (McolDraw() or McolMatch() with M_DRAW_AREA_MATCH_USING_LABEL or M_DRAW_PIXEL_MATCH_USING_LABEL).

Inquires the data type required for the image buffer in which to draw the 3-band color-sample label LUT (McolDraw() with M_DRAW_SAMPLE_COLOR_LUT). This LUT associates the label value of each color-sample with its average color.

Inquires the number of color bands that are required for the image buffer in which to draw the 3-band color-sample label LUT (McolDraw() with M_DRAW_SAMPLE_COLOR_LUT). This LUT associates the label value of each color-sample with its average color.

Inquires the depth per band required for the image buffer in which to draw the 3-band color-sample label LUT (McolDraw() with M_DRAW_SAMPLE_COLOR_LUT). This LUT associates the label value of each color-sample with its average color.

Inquires the width required for the image buffer in which to draw the 3-band color-sample label LUT (McolDraw() with M_DRAW_SAMPLE_COLOR_LUT). This LUT associates the label value of each color-sample with its average color.

Inquires the height required for the image buffer in which to draw the 3-band color-sample label LUT (McolDraw() with M_DRAW_SAMPLE_COLOR_LUT). This LUT associates the label value of each color-sample with its average color.

Inquires the data type and depth required for the image buffer in which to draw the 3-band color-sample label LUT (McolDraw() with M_DRAW_SAMPLE_COLOR_LUT). This LUT associates the label value of each color-sample with its average color.

Inquires whether the area identifier image was saved. SET

Inquires the color space encoding. SET

Inquires the offset for the color space encoding, for band 0.

This inquire is only applicable if you use McolControl() with M_ENCODING set to M_USER_DEFINED. SET

Inquires the offset for the color space encoding, for band 1.

This inquire is only applicable if you use McolControl() with M_ENCODING set to M_USER_DEFINED. SET

Inquires the offset for the color space encoding, for band 2.

This inquire is only applicable if you use McolControl() with M_ENCODING set to M_USER_DEFINED. SET

Inquires the scale for the color space encoding, for band 0.

This inquire is only applicable if you use McolControl() with M_ENCODING set to M_USER_DEFINED. SET

Inquires the scale for the color space encoding, for band 1.

This inquire is only applicable if you use McolControl() with M_ENCODING set to M_USER_DEFINED. SET

Inquires the scale for the color space encoding, for band 2.

This inquire is only applicable if you use McolControl() with M_ENCODING set to M_USER_DEFINED. SET

Inquires the acceptable tolerance for the color distance between the color-sample and a target area.

This inquire type is only available for color matching contexts. SET

Inquires the minimal frequency, in pixels, for a histogram bin to count in the matching process.

This inquire type is only available for color matching contexts. SET

Inquires the band 0 value of the color-sample that will be used with McolMatch().

If you specified a color conversion mode using McolSetMethod(), M_MATCH_SAMPLE_COLOR_BAND_0 returns the converted value. To return the unconverted value, use M_SAMPLE_AVERAGE_COLOR_BAND_0. For example, if you are using RGB images in an RBG color matching context, and you specify an HSL conversion mode (McolSetMethod()), M_MATCH_SAMPLE_COLOR_BAND_0 returns the average value for band 0 (hue) of the HSL color (as used by the match operation), while M_SAMPLE_AVERAGE_COLOR_BAND_0 returns the value for band 0 (red) of the RGB color (as defined in McolDefine()). If you have not performed a color conversion, M_MATCH_SAMPLE_COLOR_BAND_0 returns the same value as M_SAMPLE_AVERAGE_COLOR_BAND_0.

This inquire type is only available for color matching contexts.

This inquire type is only available if you have selected the band (McolControl() with M_BAND_MODE) and have preprocessed the context (McolPreprocess()).

This inquire type is not available if the operation mode is set to M_HISTOGRAM_MATCHING or M_HISTOGRAM_VOTE (McolSetMethod()).

Inquires the band 1 value of the color-sample that will be used with McolMatch(). For more information, see M_MATCH_SAMPLE_COLOR_BAND_0.

This inquire type is only available for color matching contexts.

This inquire type is only available if you have selected the band (McolControl() with M_BAND_MODE) and have preprocessed the context (McolPreprocess()).

This inquire type is not available if the operation mode is set to M_HISTOGRAM_MATCHING or M_HISTOGRAM_VOTE (McolSetMethod()).

Inquires the band 2 value of the color-sample that will be used with McolMatch(). For more information, see M_MATCH_SAMPLE_COLOR_BAND_0.

This inquire type is only available for color matching contexts.

This inquire type is only available if you have selected the band (McolControl() with M_BAND_MODE) and have preprocessed the context (McolPreprocess()).

This inquire type is not available if the operation mode is set to M_HISTOGRAM_MATCHING or M_HISTOGRAM_VOTE (McolSetMethod()).

Inquires the number of color elements items in the specified color-sample.

Inquires the average color of the color-sample for band 0 (as an 8-bit value). This inquire type is useful for displaying the sample's color. This value is not used in the operation (for example, McolMatch().

This inquire type is only available for color matching contexts.

This inquire type is only available if you have preprocessed the context (McolPreprocess()).

Inquires the average color of the color-sample for band 1 (as an 8-bit value). This inquire type is useful for displaying the sample's color. This value is not used in the operation (for example, McolMatch().

This inquire type is only available for color matching contexts.

This inquire type is only available if you have preprocessed the context (McolPreprocess()).

Inquires the average color of the color-sample for band 2 (as an 8-bit value). This inquire type is useful for displaying the sample's color. This value is not used in the operation (for example, McolMatch().

This inquire type is only available for color matching contexts.

This inquire type is only available if you have preprocessed the context (McolPreprocess()).

Inquires the maximum distance a color-sample can have for it to be matched. To retrieve this information, you must first preprocess the context, using McolPreprocess().

This inquire type is only available for color matching contexts.

Inquires the band 0 value of the color-sample, as it was defined using McolDefine(). For color-samples defined from an image (M_IMAGE), the band 0 value returned refers to the estimated version of the color (for example, the average).

If you specified a color conversion mode before the match operation using McolSetMethod(), M_SAMPLE_AVERAGE_COLOR_BAND_0 returns the unconverted value. To return the converted value, use M_MATCH_SAMPLE_COLOR_BAND_0. For example, if you are using RGB images in an RBG color matching context, and you specify an HSL conversion mode (McolSetMethod()), M_SAMPLE_AVERAGE_COLOR_BAND_0 returns the value for band 0 (red) of the RGB color (as defined in McolDefine()), while M_MATCH_SAMPLE_COLOR_BAND_0 returns the average value for band 0 (hue) of the HSL color (as used by the match operation). If you have not performed a color conversion, M_SAMPLE_AVERAGE_COLOR_BAND_0 returns the same value as M_MATCH_SAMPLE_COLOR_BAND_0.

This inquire type is only available for color matching contexts.

This inquire type is only available if you have selected the band (McolControl() with M_BAND_MODE) and have preprocessed the context (McolPreprocess()).

Inquires the band 1 value of the color-sample, as it was defined using McolDefine(). For more information, see M_SAMPLE_AVERAGE_COLOR_BAND_0.

This inquire type is only available for color matching contexts.

This inquire type is only available if you have selected the band (McolControl() with M_BAND_MODE) and have preprocessed the context (McolPreprocess()).

Inquires the band 2 value of the color-sample, as it was defined using McolDefine(). For more information, see M_SAMPLE_AVERAGE_COLOR_BAND_0.

This inquire type is only available for color matching contexts.

This inquire type is only available if you have selected the band (McolControl() with M_BAND_MODE) and have preprocessed the context (McolPreprocess()).

Inquires the current label of the color-sample. SET SET

Inquires the data type of the color-sample's mask mosaic buffer.

This inquire type is only available if you have defined a mask for the color-sample, using McolMask().

Inquires the number of bands of the color-sample's mask mosaic buffer.

This inquire type is only available if you have defined a mask for the color-sample, using McolMask().

Inquires the depth per band of the color-sample's mask mosaic buffer.

This inquire type is only available if you have defined a mask for the color-sample, using McolMask().

Inquires the X-size (width) of the color-sample's mask mosaic buffer.

This inquire type is only available if you have defined a mask for the color-sample, using McolMask().

Inquires the Y-size (height) of the color-sample's mask mosaic buffer.

This inquire type is only available if you have defined a mask for the color-sample, using McolMask().

Inquires the data type and depth of the color-sample's mask buffer.

This inquire type is only available if you have defined a mask for the color-sample, using McolMask().

Inquires the data type of the color-sample's mosaic buffer.

This inquire type is only available for color elements that you define using McolDefine() with M_IMAGE.

Inquires the number of bands of the color-sample's mosaic buffer.

This inquire type is only available for color elements that you define using McolDefine() with M_IMAGE.

Inquires the depth per band of the color-sample's mosaic buffer.

This inquire type is only available for color elements that you define using McolDefine() with M_IMAGE.

Inquires the X-size (width) of the color-sample's mosaic buffer.

This inquire type is only available for color elements that you define using McolDefine() with M_IMAGE.

Inquires the Y-size (height) of the color-sample's mosaic buffer.

This inquire type is only available for color elements that you define using McolDefine() with M_IMAGE.

Inquires the type of the color-sample's mosaic buffer.

This inquire type is only available for color elements that you define using McolDefine() with M_IMAGE.

Inquires the type of the color-sample. SET

Inquires the color value for band 0 of a triplet color element.

This inquire type is only available for color elements that you define using McolDefine() with M_TRIPLET. SET

Inquires the color value for band 1 of a triplet color element.

This inquire type is only available for color elements that you define using McolDefine() with M_TRIPLET. SET

Inquires the color value for band 2 of a triplet color element.

This inquire type is only available for color elements that you define using McolDefine() with M_TRIPLET. SET

Inquires the data type of the image from which the color element was defined.

This inquire type is only available for color elements that you define using McolDefine() with M_IMAGE.

Inquires the number of color bands of the image buffer from which the color element was defined.

This inquire type is only available for color elements that you define using McolDefine() with M_IMAGE.

Inquires the depth per band of the image buffer from which the color element was defined.

This inquire type is only available for color elements that you define using McolDefine() with M_IMAGE.

Inquires the width of the image from which the color element was defined.

This inquire type is only available for color elements that you define using McolDefine() with M_IMAGE.

Inquires the height of the image from which the color element was defined.

This inquire type is only available for color elements that you define using McolDefine() with M_IMAGE.

This inquire type is available for color matching and relative color calibration contexts.

Inquires the data type and depth of the image from which the color element was defined.

This inquire type is only available for color elements that you define using McolDefine() with M_IMAGE.

Inquires the data type of the color element's mask buffer.

This inquire type is only available if you have defined a mask for the color-sample, using McolMask().

Inquires the number of color bands of the color element's mask buffer.

This inquire type is only available if you have defined a mask for the color-sample, using McolMask().

Inquires the depth per band of the color element's mask buffer.

This inquire type is only available if you have defined a mask for the color-sample, using McolMask().

Inquires the width of the color element's mask buffer.

This inquire type is only available if you have defined a mask for the color-sample, using McolMask().

Inquires the height of the color element's mask buffer.

This inquire type is only available if you have defined a mask for the color-sample, using McolMask().

Inquires the data type and depth of the color element's mask buffer.

This inquire type is only available if you have defined a mask for the color-sample, using McolMask().

Inquires whether a mask for the color element was defined.

Inquires the variance in the direction of the color-sample's first principal component vector.