| Customize Help
| Save Settings

McolInquire



Function Map
Synopsis
Inquire information about a color matching or relative color calibration context, color-sample, color element, or a color matching result.
Syntax
MIL_INT McolInquire(
MIL_ID ContextOrResultId, //in
MIL_INT IndexOrLabel, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function inquires information about a specified color matching or relative color calibration context, a color-sample contained within the context, a color element contained within a specified color-sample, or a color matching result buffer.

If the inquired setting is set to M_DEFAULT (for example, in McolControl()), McolInquire() will return M_DEFAULT. To inquire the actual default value, add M_DEFAULT to the InquireType parameter.

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see which MIL system’s documentation you should use in its place and any possible differences.
Parameters
This function is not supported on the selected boards.
This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.
Parameters
ContextOrResultId

Specifies the identifier of the context or result buffer about which to inquire information. Both the context and the result buffer must have been previously allocated on the required system using McolAlloc() (with M_COLOR_MATCHING or M_COLOR_CALIBRATION_RELATIVE) or McolAllocResult().

IndexOrLabel

Specifies what to inquire.

For inquiring about a context or result, set this parameter to one of the following values.

function map For inquiring about a context or result
Click to summarizeValue Description
Click to summarize M_DEFAULT

Specifies the default.

If ContextOrResultId is set to a context, the default is the same as M_CONTEXT.

If ContextOrResultId is set to a color matching result, the default is the same as M_GENERAL.

(summarize)
Click to summarize M_CONTEXT

Inquires information about a global setting of either a color matching or relative color calibration context, depending on the ContextOrResultId parameter setting.

Click to summarize M_GENERAL

Inquires information about a setting of a color matching result buffer. In this case, ContextOrResultId must specify a color matching result buffer.

(summarize)

For inquiring about a color-sample or color element therein, set this parameter to one of the following values. Unless otherwise specified, the ContextOrResultId parameter can specify a color matching or relative color calibration context.

function map For inquiring about a color-sample or color element
Click to summarizeValue Description
Click to summarize

Specifies the index of a color element (item), relative to the reference color-sample. This value only applies to relative color calibration contexts (ContextOrResultId).

(summarize)
Parameters

Specifies the index of a color element (item). The index value must be greater than or equal to 0.

Click to summarize

Specifies the index of a color-sample.

(summarize)
Parameters

Specifies an index value greater than or equal to 0.

Click to summarize

Specifies the index of a color element (item), relative to a color-sample index.

(summarize)
Parameters

Specifies the index of the color-sample that holds the color element (item). The index must be greater than or equal to 0.

Specifies the index of the color element (item). The index value must be greater than or equal to 0.

Click to summarize

Specifies the label of a color-sample.

(summarize)
Parameters

Specifies a label value greater than 0.

Click to summarize

Specifies the index of a color element (item), relative to a color-sample label.

(summarize)
Parameters

Specifies the label of the color-sample that holds the color element (item). The label value must be greater than 0.

Specifies the index of the color element (item). The index value must be greater than or equal to 0.

Click to summarize M_REFERENCE_SAMPLE

Specifies the reference color-sample. This value only applies to relative color calibration contexts (ContextOrResultId).

(summarize)
InquireType

Specifies the type of setting about which to inquire.

See the Parameter associations section for possible values that can be specified.

UserVarPtr
Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):
  • MIL_DOUBLE
  • MIL_FLOAT
  • MIL_ID
  • MIL_INT
  • MIL_INT16
  • MIL_INT32
  • MIL_INT64

Specifies the address in which to write the requested information. Since the McolInquire() function also returns the requested information, you can set this parameter to M_NULL.

See the Parameter associations section for possible values that can be returned.

To inquire about general settings of a context, set the InquireType parameter to one of the following values. In this case, you must set the IndexOrLabel parameter to M_CONTEXT and the ContextOrResultId parameter to a color matching or relative color calibration context, as required by the setting. Unless otherwise specified, the following settings only apply to color matching contexts.

function map For inquiring general settings about a context
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_ACCEPTANCE +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_DEFAULT

Specifies the default value; the default value is 0.0 %.

Click to summarize 0.0 <= Value <= 100.0

Specifies an acceptable score, as a percentage.

Click to summarize M_ACCEPTANCE_RELEVANCE +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_DEFAULT

Specifies the default value; the default value is 0.0 %.

Click to summarize 0.0 <= Value <= 100.0

Specifies an acceptable relevance score, as a percentage.

Click to summarize M_BACKGROUND_DRAW_COLOR +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_TRANSPARENT.

Click to summarize M_TRANSPARENT

Specifies not to change the background. INFO

Click to summarize Byte-encoded RGB value

Specifies an encoded RGB value. To verify if the value is a byte-encoded RGB value, use the M_IS_RGB888 macro. To retrieve the R, G, and B components, use the M_RGB888_R, M_RGB888_G, and M_RGB888_B macros.

(summarize)
Click to summarize Value > 0

Specifies a grayscale value for the background pixels, as a double or integer. INFO

Click to summarize M_BAND_MODE +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_ALL_BANDS.

Click to summarize M_ALL_BANDS

Specifies to use all bands.

Click to summarize M_COLOR_BAND_0

Specifies to use band 0.

Click to summarize M_COLOR_BAND_0 + M_COLOR_BAND_1

Specifies to use bands 0 and 1.

Click to summarize M_COLOR_BAND_0 + M_COLOR_BAND_2

Specifies to use bands 0 and 2.

Click to summarize M_COLOR_BAND_1

Specifies to use band 1.

Click to summarize M_COLOR_BAND_1 + M_COLOR_BAND_2

Specifies to use bands 1 and 2.

Click to summarize M_COLOR_BAND_2

Specifies to use band 2.

Click to summarize M_CALIBRATION_COMPUTE_OPTION +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_COMPUTE_ITEM_PIXELS.

Click to summarize M_COMPUTE_ITEM_PIXELS

Specifies that MIL uses all pixel values (in the reference color-sample and the color-samples) to generate the color information that the operation requires.

Click to summarize M_COMPUTE_ITEM_STAT

Specifies that MIL uses color statistics (in the reference color-sample and the color-samples) to generate the color information that the operation requires. INFO

Click to summarize M_CALIBRATION_INTENT +

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

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Specifies the default color calibration intent. INFO

Click to summarize M_BALANCE

Specifies that the operation considers a moderate amount of color information to establish the mapping. INFO

Click to summarize M_GENERALIZATION

Specifies that the operation considers a minimal amount of color information to establish the mapping. INFO

Click to summarize M_PRECISION

Specifies that the operation considers a high amount of color information to establish the mapping. INFO

Click to summarize M_CALIBRATION_MODE +

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

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_HISTOGRAM_BASED.

Click to summarize M_COLOR_TO_COLOR

Specifies that a color-sample's mapping is based on transforming its color to the color of the reference color-sample on a point-to-point basis. INFO

Click to summarize M_GLOBAL_MEAN_VARIANCE

Specifies that a color-sample's mapping is based on transforming its mean and variance (standard deviation) to resemble the mean and variance of the reference color-sample. INFO

Click to summarize M_HISTOGRAM_BASED

Specifies that a color-sample's mapping is based on using enhanced color distribution information to transform its color data to better resemble the color data of the reference color-sample. INFO

Click to summarize M_COLOR_SPACE +

Inquires the context's color space. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_RGB.

Click to summarize M_CIELAB

Specifies a CIELAB (or LAB) color space. INFO

Click to summarize M_HSL

Specifies an HSL color space. INFO

Click to summarize M_RGB

Specifies an RGB color space. INFO

Click to summarize M_CONTEXT_TYPE +

Inquires the type of context used.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_COLOR_CALIBRATION_RELATIVE

Specifies a context for transforming color data using relative color calibration (McolTransform()).

Click to summarize M_COLOR_MATCHING

Specifies a context for color matching (McolMatch()).

Click to summarize M_CONVERSION_GAMMA +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_ENABLE.

Click to summarize M_DISABLE

Specifies not to remove gamma correction. INFO

Click to summarize M_ENABLE

Specifies to remove gamma correction. INFO

Click to summarize M_CONVERSION_MODE +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_NONE.

Click to summarize M_CIELAB

Specifies to internally convert RGB colors to CIELAB before the match operation. INFO

Click to summarize M_HSL

Specifies to internally convert RGB colors to HSL before the match operation.

Click to summarize M_NONE

Specifies no internal conversion.

Click to summarize M_DISTANCE_IMAGE_NORMALIZE +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_DEFAULT

Same as M_NO_NORMALIZE.

Click to summarize M_MAX_NORMALIZE

Specifies to normalize distance values according to the greatest calculated distance. INFO

Click to summarize M_NO_NORMALIZE

Specifies no normalization. INFO

Click to summarize Value > 0.0

Specifies to normalize distance values according to the specified normalization value. INFO

Click to summarize M_DISTANCE_TOLERANCE_MODE +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_ABSOLUTE.

Click to summarize M_ABSOLUTE

Specifies that the M_DISTANCE_TOLERANCE value will be untouched and used as the acceptable distance tolerance.

Click to summarize M_RELATIVE

Specifies a tolerance strategy based on the relative distances between pairs of color-samples. INFO

Click to summarize M_SAMPLE_STDDEV

Specifies a tolerance strategy based on the color-sample's standard deviation. INFO

Click to summarize M_DISTANCE_TYPE +

Inquires the type of distance calculated when matching colors. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Specifies the default distance type. INFO

Click to summarize M_CIE94_GRAPHIC_ARTS

Specifies the CIE94 color distance with weighting factors pertaining to the graphic arts industry, as established by the CIE. INFO

Click to summarize M_CIE94_TEXTILE

Specifies the CIE94 color distance with weighting factors pertaining to the textile industry, as established by the CIE. INFO

Click to summarize M_CIEDE2000

Specifies the CIEDE2000 color distance, as established by the CIE. INFO

Click to summarize M_CMC_ACCEPTABILITY

Specifies the CMC(l: c) color distance that has been adjusted for acceptability evaluation, as established by the CIE. INFO

Click to summarize M_CMC_PERCEPTIBILITY

Specifies the CMC(l: c) color distance that has been adjusted for perceptibility evaluation, as established by the CIE. INFO

Click to summarize M_DELTA_E

Specifies a Delta-E color distance, as defined by the International Commission on Illumination (CIE). INFO

Click to summarize M_EUCLIDEAN

Specifies a Euclidean color distance. INFO

Click to summarize M_MAHALANOBIS

Specifies a Mahalanobis color distance. INFO

Click to summarize M_MANHATTAN

Specifies a Manhattan color distance. INFO

Click to summarize M_NONE

Specifies that no distance calculations are used. INFO

Click to summarize M_GENERATE_DISTANCE_IMAGE +

Inquires whether the distance image was generated. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_DISABLE.

Click to summarize M_DISABLE

Specifies not to generate the image.

Click to summarize M_ENABLE

Specifies to generate the image.

Click to summarize M_GENERATE_PIXEL_MATCH +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_DISABLE.

Click to summarize M_DISABLE

Specifies not to generate the image.

Click to summarize M_ENABLE

Specifies to generate the image.

Click to summarize M_GENERATE_SAMPLE_COLOR_LUT +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_DISABLE.

Click to summarize M_DISABLE

Specifies not to generate the LUT.

Click to summarize M_ENABLE

Specifies to generate the LUT.

Click to summarize M_MATCH_MODE +

Inquires the operation mode used when matching colors. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_STAT_MIN_DIST.

Click to summarize M_HISTOGRAM_MATCHING

Specifies a minimum distance operation, based on color histograms. INFO

Click to summarize M_HISTOGRAM_VOTE

Specifies a match operation based on histogram voting. INFO

Click to summarize M_MIN_DIST_VOTE

Specifies a minimum distance operation, based on pixel voting. INFO

Click to summarize M_STAT_MIN_DIST

Specifies a minimum distance operation, based on pixel statistics. INFO

Click to summarize M_MODIFICATION_COUNT +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the current value of the modification counter.

Click to summarize M_NB_BINS_BAND_0 +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Specifies the default value; the default value is 10.

Click to summarize Value > 0

Specifies the number of histogram bins for color band 0.

Click to summarize M_NB_BINS_BAND_1 +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Specifies the default value; the default value is 10.

Click to summarize Value > 0

Number of histogram bins for color band 1.

Click to summarize M_NB_BINS_BAND_2 +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Specifies the default value; the default value is 10.

Click to summarize Value > 0

Number of histogram bins for color band 2.

Click to summarize M_NUMBER_OF_SAMPLES +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the number of color-samples.

Click to summarize M_OUTLIER_DRAW_COLOR +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Specifies the default value; the default value is 0.

Click to summarize M_TRANSPARENT

Specifies not to change the value of the outlier pixels. INFO

Click to summarize Byte-encoded RGB value

Specifies an encoded RGB value. To verify if the value is a byte-encoded RGB value, use the M_IS_RGB888 macro. To retrieve the R, G, and B components, use the M_RGB888_R, M_RGB888_G, and M_RGB888_B macros.

(summarize)
Click to summarize Value > 0

Specifies a grayscale value for the outlier pixels, as a double or integer. INFO

Click to summarize M_OUTLIER_LABEL +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Specifies the default value; the default value is 0.

Click to summarize Value > 0

Specifies the label of the outlier pixels, as an integer. INFO

Click to summarize M_PREPROCESSED +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_FALSE

Specifies that the context is not preprocessed.

Click to summarize M_TRUE

Specifies that the context is preprocessed.

Click to summarize M_SAMPLE_LABEL_SIZE_BIT +

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).

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize 1

Specifies that the data depth is 1 bit per band.

Click to summarize 8

Specifies that the data depth is 8 bits per band.

Click to summarize 16

Specifies that the data depth is 16 bits per band.

Click to summarize 32

Specifies that the data depth is 32 bits per band.

Click to summarize M_SAMPLE_LUT_SIGN +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_UNSIGNED

Specifies that the data type is unsigned.

Click to summarize M_SAMPLE_LUT_SIZE_BAND +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize 3

Specifies that 3 color bands are required.

Click to summarize M_SAMPLE_LUT_SIZE_BIT +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize 8

Specifies that the data depth is 8 bits per band.

Click to summarize M_SAMPLE_LUT_SIZE_X +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the width of the image buffer, in pixels.

Click to summarize M_SAMPLE_LUT_SIZE_Y +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the height of the image buffer, in pixels.

Click to summarize M_SAMPLE_LUT_TYPE +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_UNSIGNED + 8

Specifies that the data is 8-bit unsigned.

Click to summarize M_SAVE_AREA_IMAGE +

Inquires whether the area identifier image was saved. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_DISABLE.

Click to summarize M_DISABLE

Specifies not to save the image.

Click to summarize M_ENABLE

Specifies to save the image.

To inquire about color matching context settings that are used for color space encoding, set the InquireType parameter to one of the following values. In this case, you must set the IndexOrLabel parameter to M_CONTEXT.

function map For inquiring color matching context settings that are used for color space encoding
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_ENCODING +

Inquires the color space encoding. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_8BIT.

Click to summarize M_8BIT

Specifies an internally defined color space encoding for 8-bit images.

Click to summarize M_10BIT

Specifies an internally defined color space encoding for 10-bit images.

Click to summarize M_12BIT

Specifies an internally defined color space encoding for 12-bit images.

Click to summarize M_14BIT

Specifies an internally defined color space encoding for 14-bit images.

Click to summarize M_16BIT

Specifies an internally defined color space encoding for 16-bit images.

Click to summarize M_USER_DEFINED

Specifies that the color space encoding is defined using M_OFFSET_BAND_n and M_SCALE_BAND_n.

Click to summarize M_OFFSET_BAND_0 +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the offset, as a double.

Click to summarize M_OFFSET_BAND_1 +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the offset, as a double.

Click to summarize M_OFFSET_BAND_2 +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the offset, as a double.

Click to summarize M_SCALE_BAND_0 +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the scale, as a double.

Click to summarize M_SCALE_BAND_1 +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the scale, as a double.

Click to summarize M_SCALE_BAND_2 +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the scale, as a double.

To inquire about a general setting of a color-sample defined in a context, set the InquireType parameter to one of the following values. In this case, you must set the IndexOrLabel parameter to the index or label of a color-sample (not an element of a color-sample). Unless otherwise specified, the following settings apply to color matching and relative color calibration contexts.

function map For inquiring about a general setting of a color-sample defined in a context
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_DISTANCE_TOLERANCE +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_DEFAULT

Same as M_AUTO.

Click to summarize M_AUTO

Specifies the tolerance automatically. INFO

Click to summarize M_INFINITE

Specifies an infinite tolerance.

Click to summarize Value >= 0.0

Specifies the tolerance value. INFO

Click to summarize M_HISTOGRAM_FREQUENCY_THRESHOLD +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_DEFAULT

Specifies the default value; the default value is 1 pixel.

Click to summarize Value > 0

Specifies the minimal frequency, as an integer.

Click to summarize M_MATCH_SAMPLE_COLOR_BAND_0 +

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()).

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the band 0 value of the color-sample.

Click to summarize M_MATCH_SAMPLE_COLOR_BAND_1 +

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()).

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the band 1 value of the color-sample.

Click to summarize M_MATCH_SAMPLE_COLOR_BAND_2 +

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()).

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the band 2 value of the color-sample.

Click to summarize M_NUMBER_OF_COLOR_ITEMS +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the number of color elements in the color-sample.

Click to summarize M_SAMPLE_8BIT_AVERAGE_COLOR_BAND_0 +

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()).

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the average color of the color-sample for band 0.

Click to summarize M_SAMPLE_8BIT_AVERAGE_COLOR_BAND_1 +

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()).

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the average color of the color-sample for band 1.

Click to summarize M_SAMPLE_8BIT_AVERAGE_COLOR_BAND_2 +

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()).

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the average color of the color-sample for band 2.

Click to summarize M_SAMPLE_ABSOLUTE_TOLERANCE +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_INFINITE

Specifies that the maximum distance is infinite. This value is returned when only one color-sample has been defined.

(summarize)
Click to summarize Value

Specifies the maximum distance.

Click to summarize M_SAMPLE_AVERAGE_COLOR_BAND_0 +

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()).

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the band 0 value of the color-sample.

Click to summarize M_SAMPLE_AVERAGE_COLOR_BAND_1 +

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()).

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the band 1 value of the color-sample.

Click to summarize M_SAMPLE_AVERAGE_COLOR_BAND_2 +

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()).

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the band 2 value of the color-sample.

Click to summarize M_SAMPLE_LABEL_VALUE +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the current label of the color-sample.

Click to summarize M_SAMPLE_MOSAIC_DONT_CARE_SIGN +

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().

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_UNSIGNED

Specifies that the color-sample's mask mosaic buffer is of data type unsigned.

Click to summarize M_SAMPLE_MOSAIC_DONT_CARE_SIZE_BAND +

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().

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize 1

Specifies that the color-sample's mask mosaic buffer has 1 band.

Click to summarize M_SAMPLE_MOSAIC_DONT_CARE_SIZE_BIT +

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().

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize 1

Specifies that the data depth is 1 bit per band.

Click to summarize 8

Specifies that the data depth is 8 bits per band.

Click to summarize M_SAMPLE_MOSAIC_DONT_CARE_SIZE_X +

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().

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the X-size (width) of the color-sample's mask mosaic buffer, in pixels.

Click to summarize M_SAMPLE_MOSAIC_DONT_CARE_SIZE_Y +

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().

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the Y-size (height) of the color-sample's mask mosaic buffer, in pixels.

Click to summarize M_SAMPLE_MOSAIC_DONT_CARE_TYPE +

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().

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_UNSIGNED + 1

Specifies that the data is 1-bit unsigned.

Click to summarize M_UNSIGNED + 8

Specifies that the data is 8-bit unsigned.

Click to summarize M_SAMPLE_MOSAIC_SIGN +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_UNSIGNED

Specifies that the color-sample's mosaic buffer is of data type unsigned.

Click to summarize M_SAMPLE_MOSAIC_SIZE_BAND +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize 3

Specifies that the color-sample's mosaic buffer has 3 bands.

Click to summarize M_SAMPLE_MOSAIC_SIZE_BIT +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize 8

Specifies that the data depth is 8 bits per band.

Click to summarize 16

Specifies that the data depth is 16 bits per band.

Click to summarize M_SAMPLE_MOSAIC_SIZE_X +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the X-size (width) of the color-sample's mosaic buffer, in pixels.

Click to summarize M_SAMPLE_MOSAIC_SIZE_Y +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the Y-size (height) of the color-sample's mosaic buffer, in pixels.

Click to summarize M_SAMPLE_MOSAIC_TYPE +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_UNSIGNED + 8

Specifies that the data is 8-bit unsigned.

Click to summarize M_UNSIGNED + 16

Specifies that the data is 16-bit unsigned.

Click to summarize M_SAMPLE_TYPE +

Inquires the type of the color-sample. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_IMAGE

Specifies that the color-sample was added from an image.

Click to summarize M_TRIPLET

Specifies that the color-sample was added from three explicit color component values (RGB, HSL, or CIELAB).

To inquire about a general setting of a color element defined in a color-sample, set the InquireType parameter to one of the following values. In this case, you must set the IndexOrLabel parameter to the index or label of a color-sample element.

function map For inquiring about a general setting of a color element (item) defined in a context
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_SAMPLE_COLOR_BAND_0 +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

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

Click to summarize M_SAMPLE_COLOR_BAND_1 +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

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

Click to summarize M_SAMPLE_COLOR_BAND_2 +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

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

Click to summarize M_SAMPLE_IMAGE_SIGN +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_UNSIGNED

Specifies that the data type is unsigned.

Click to summarize M_SAMPLE_IMAGE_SIZE_BAND +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize 3

Specifies that the image buffer has 3 color bands.

Click to summarize M_SAMPLE_IMAGE_SIZE_BIT +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize 8

Specifies that the data depth is 8 bits per band.

Click to summarize 16

Specifies that the data depth is 16 bits per band.

Click to summarize M_SAMPLE_IMAGE_SIZE_X +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the width of the image, in pixels.

Click to summarize M_SAMPLE_IMAGE_SIZE_Y +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the height of the image, in pixels.

Click to summarize M_SAMPLE_IMAGE_TYPE +

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.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_UNSIGNED + 8

Specifies that the data is 8-bit unsigned.

Click to summarize M_UNSIGNED + 16

Specifies that the data is 16-bit unsigned.

Click to summarize M_SAMPLE_MASK_SIGN +

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().

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_UNSIGNED

Specifies that the data type is unsigned.

Click to summarize M_SAMPLE_MASK_SIZE_BAND +

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().

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize 1

Specifies that there is 1 band in the color element's mask buffer.

Click to summarize M_SAMPLE_MASK_SIZE_BIT +

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().

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize 1

Specifies that the data depth is 1 bit per band.

Click to summarize 8

Specifies that the data depth is 8 bits per band.

Click to summarize M_SAMPLE_MASK_SIZE_X +

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().

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the width of the color element's mask buffer, in pixels.

Click to summarize M_SAMPLE_MASK_SIZE_Y +

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().

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the height of the color element's mask buffer, in pixels.

Click to summarize M_SAMPLE_MASK_TYPE +

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().

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_UNSIGNED + 1

Specifies that the data is 1-bit unsigned.

Click to summarize M_UNSIGNED + 8

Specifies that the data is 8-bit unsigned.

Click to summarize M_SAMPLE_MASKED +

Inquires whether a mask for the color element was defined.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_FALSE

Specifies that a mask was not defined.

Click to summarize M_TRUE

Specifies that a mask was defined.

To inquire information about the principal component analysis (PCA) of a color-sample in a color matching context, set the InquireType parameter to one of the following values. In this case, you must set the IndexOrLabel parameter to M_SAMPLE_INDEX() or M_SAMPLE_LABEL(); you must have also preprocessed the context, using McolPreprocess().

A PCA is a mathematical analysis which, when applied to a color image's data, results in vectors pointing towards the direction of maximum color variance. Each vector is considered a principal component, and there are as many principal components as there are color bands. Since color-samples are based on three bands, the PCA results in three vectors about which to inquire. These PCA values are not applied in the actual operation (for example, McolMatch() and should only be inquired by advanced users who might, for example, want to perform some statistical analysis. Typically, color operations such as McolMatch() and McolProject() use what is referred to as the first principal component, which is the strongest principal component computed from a PCA. If no principal component is the strongest, one is arbitrarily considered the first principal component.

MIL calculates the PCA values according to the context's source color space; these values are not available when using M_HSL.

function map For inquiring information about the PCA of a color-sample in a color matching context
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_SAMPLE_PCA_VAR1 +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the variance.

Click to summarize M_SAMPLE_PCA_VAR2 +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the variance.

Click to summarize M_SAMPLE_PCA_VAR3 +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the variance.

Click to summarize M_SAMPLE_PCA_VECTOR1_1 +

Inquires the first element of the color-sample's first principal component vector.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the vector element.

Click to summarize M_SAMPLE_PCA_VECTOR1_2 +

Inquires the second element of the color-sample's first principal component vector.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the vector element.

Click to summarize M_SAMPLE_PCA_VECTOR1_3 +

Inquires the third element of the color-sample's first principal component vector.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the vector element.

Click to summarize M_SAMPLE_PCA_VECTOR2_1 +

Inquires the first element of the color-sample's second principal component vector.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the vector element.

Click to summarize M_SAMPLE_PCA_VECTOR2_2 +

Inquires the second element of the color-sample's second principal component vector.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the vector element.

Click to summarize M_SAMPLE_PCA_VECTOR2_3 +

Inquires the third element of the color-sample's second principal component vector.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize