McolControl

See also

User Guide:

Advanced color matching settings and concepts Color matching Color spaces and converting between them Distance between colors Relative color calibration

Reference:

McolAlloc McolDefine McolDraw McolGetResult McolInquire McolMatch McolPreprocess McolSetMethod McolTransform

Availability

Not available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Not supported on:

Not supported on Matrox Indio (Update 53 or Update 68) (w)

Not supported on Matrox Concord PoE with ToE (Update 82) (z)

Fully supported on:

Fully supported on Host system (a)

Fully supported on Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)* (c)

Fully supported on Matrox Morphis (g)

Fully supported on Matrox Morphis QxT (h)

Fully supported on Matrox Orion HD (i)

Fully supported on Matrox Radient eCL (j)

Fully supported on Matrox Radient eV-CXP (MIL 10 or Update 29)* (k)

Fully supported on Matrox Solios eA/XA (l)

Fully supported on Matrox Solios ecl/xcl/ev-cl (m)

Fully supported on Matrox USB3 Vision driver (Update 19) (o)

Fully supported on Matrox RadientPro-CL (Update 7) (p)

Fully supported on Matrox Radient eV-CL (Update 27 or 74) (r)

Fully supported on Matrox Iris GTR (Update 28 or Update 68) (t)

Fully supported on Matrox Clarity UHD (Update 36 or 76) (u)

Fully supported on Matrox GenTL driver (Update 34) (v)

Fully supported on Matrox Rapixo CXP (Update 75 or Update 84) (y)

Fully supported on Matrox Rapixo CL Pro (Update 96) (aa)

* Refer to the MIL system-specific information
in the MIL Reference for the minimum update required.

For any information regarding a MIL system added during a MIL Update, see the MIL system’s release note

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

mcol.cpp
mcol.cs
mcol.vb
utilmatchcolormap.cpp

Function Map

- ContextId

Table:

For specifying what to control

- ControlType

- ControlValue

Parameter Associations

Table:	For controlling general color matching context settings
Table:	For controlling color matching context settings that are used for color space encoding
Table:	For controlling color-samples

Type-specific versions of the function when using a C compiler under 64-bit

Compilation information

Synopsis

Control a color matching context, its color-samples, or the color-samples of a relative color calibration context.

Syntax

void McolControl(

MIL_ID ContextId,	//in
MIL_INT IndexOrLabel,	//in
MIL_INT64 ControlType,	//in
MIL_DOUBLE ControlValue	//in

)

Description

This function sets the specified control type for a color matching context, its color-samples, or the color-samples of a relative color calibration context. These control type settings affect the execution of McolPreprocess(), McolMatch(), McolTransform(), and McolDraw(). Typically, you can inquire the control type setting, using McolInquire().

Changing certain control type settings require you to preprocess the context again, using McolPreprocess(). To know if the context needs to be preprocessed, call McolInquire() with the M_PREPROCESSED inquire type.

Note that when using a C compiler (not a C++ or other compiler) in 64-bit mode, McolControl() internally calls the MIL_DOUBLE version of this function (McolControlDouble()). If you need to pass integer values, call the MIL_INT64 version of this function (McolControlInt64()).

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

ContextId

Specifies the identifier of the color matching or relative color calibration context. The context must have been previously allocated on the required system using McolAlloc() with M_COLOR_MATCHING or M_COLOR_CALIBRATION_RELATIVE.

IndexOrLabel

Specifies what to control. Set this parameter to one of the following values. Unless otherwise specified, these values are only available for color matching contexts.

For specifying what to control
Value	Description
M_DEFAULT	Same as M_CONTEXT.
M_SAMPLE_INDEX( MIL_INT SampleIndex )	Specifies the index of the color-sample to control. This value is available for color matching and relative color calibration contexts. (summarize) Specifies the index of the color-sample to control. (more details...)
		Parameters
		SampleIndex Specifies an index value greater than or equal to 0.
M_SAMPLE_LABEL( MIL_INT SampleLabel )	Specifies the label of the color-sample to control. This value is available for color matching and relative color calibration contexts. (summarize) Specifies the label of the color-sample to control. (more details...)
		Parameters
		SampleLabel Specifies a label value greater than 0.
M_ALL	Specifies to control all color-samples within the color matching context. The specified control type setting must be supported by all the color-samples. (summarize) Specifies to control all color-samples within the color matching context. (more details...)
M_CONTEXT	Specifies to control a global setting of the color matching context.

ControlType

Specifies the setting to change.

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

ControlValue

Specifies the setting's new value.

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

Parameter associations

The tables below list possible values for the ControlType and ControlValue parameters.

For controlling general color matching context settings
For controlling color matching context settings that are used for color space encoding
For controlling color-samples

The following ControlType and corresponding ControlValue parameter settings are used to control general color matching context settings. In this case, you must set the IndexOrLabel parameter to M_CONTEXT. These values are only available for color matching contexts.

For controlling general color matching context settings
ControlType		Description
	ControlValue	Description
M_ACCEPTANCE		Sets the acceptance level for the color-sample's score (M_SCORE with McolGetResult()). This score indicates the similarity between the color of the color-sample and the color of the target area. The higher the acceptance, the closer the colors must be for them to match. For a match, the color-sample must have a score that is greater than or equal to this level. INQ (summarize) Sets the acceptance level for the color-sample's score (M_SCORE with McolGetResult()). INQ (more details...)
	M_DEFAULT	Specifies the default value; the default value is 0.0%.
	0.0 <= Value <= 100.0	Specifies an acceptable score, as a percentage.
M_ACCEPTANCE_RELEVANCE		Sets the acceptance level for the target area's relevance score (M_SCORE_RELEVANCE). This score indicates the significance (relevance) of the match score (M_SCORE). In statistics, this is similar to the confidence level; that is, it represents how confident you can be that the best-matched color-sample actually is the best possible match. For example, a high relevance acceptance indicates that the best-matched color-sample must be vastly superior to all other color-samples, while a low relevance acceptance indicates that the best-matched color-sample only needs to be marginally superior to the other color-samples. A target area can only have a successful matching status (M_STATUS with McolGetResult()) if its relevance score is above the relevance acceptance level. A target area with a successful matching status also requires at least one color-sample score to be above M_ACCEPTANCE. INQ (summarize) Sets the acceptance level for the target area's relevance score (M_SCORE_RELEVANCE). INQ (more details...)
	M_DEFAULT	Specifies the default value; the default value is 0.0%.
	0.0 <= Value <= 100.0	Specifies an acceptable relevance score, as a percentage.
M_BACKGROUND_DRAW_COLOR		Sets the color to use to draw background pixels when drawing or generating the color images (M_DRAW_..._USING_COLOR), the distance image (M_DRAW_DISTANCE), or the grayscale label images (M_DRAW_..._USING_LABEL), using McolDraw() or McolMatch(). A pixel is considered background when it is outside the target areas. For background pixels to exist, you must specify an area identifier image when calling McolMatch(). INQ (summarize) Sets the color to use to draw background pixels when drawing or generating the color images (M_DRAW_..._USING_COLOR), the distance image (M_DRAW_DISTANCE), or the grayscale label images (M_DRAW_..._USING_LABEL), using McolDraw() or McolMatch(). INQ (more details...)
	M_DEFAULT	Same as M_TRANSPARENT.
	M_COLOR888( MIL_INT ComponentBand0, MIL_INT ComponentBand1, MIL_INT ComponentBand2 )	Specifies a 24-bit color value (eight bits per band) with which to set the background pixels. The color value is taken as is (no conversion), according to the source color space. Typically, this should be RGB, since the background color is meant for display. When M_BACKGROUND_DRAW_COLOR is set with M_COLOR888(), only the first component (for example, red) will be used to draw or generate M_DRAW_DISTANCE, which is a grayscale image. (summarize) Specifies a 24-bit color value (eight bits per band) with which to set the background pixels. (more details...)
			Parameters
			ComponentBand0 Specifies the first component, as a value between 0 and 255.
			ComponentBand1 Specifies the second component, as a value between 0 and 255.
			ComponentBand2 Specifies the third component, as a value between 0 and 255.
	M_TRANSPARENT	Specifies not to change the background. Therefore, the background pixels will be those of the specified destination image. (summarize) Specifies not to change the background. (more details...)
	Value > 0	Specifies a grayscale value for the background pixels, as a double or integer. When drawing the distance image (M_DRAW_DISTANCE) in a 32-bit integer buffer, you should keep the M_BACKGROUND_DRAW_COLOR value under 24-bit (that is, less than 16,777,215). (summarize) Specifies a grayscale value for the background pixels, as a double or integer. (more details...)
M_BAND_MODE		Specifies the color bands to use when performing a match. This applies to all color-samples in the context and to the target areas. INQ (summarize) Specifies the color bands to use when performing a match. INQ (more details...)
	M_DEFAULT	Same as M_ALL_BANDS.
	M_ALL_BANDS	Specifies to use all bands.
	M_COLOR_BAND_0	Specifies to use band 0.
	M_COLOR_BAND_0 + M_COLOR_BAND_1	Specifies to use bands 0 and 1.
	M_COLOR_BAND_0 + M_COLOR_BAND_2	Specifies to use bands 0 and 2.
	M_COLOR_BAND_1	Specifies to use band 1.
	M_COLOR_BAND_1 + M_COLOR_BAND_2	Specifies to use bands 1 and 2.
	M_COLOR_BAND_2	Specifies to use band 2.
M_CONVERSION_GAMMA		Specifies whether to remove gamma correction when internally converting RGB source colors before the match using McolSetMethod() with the CIELAB conversion mode. Gamma correction refers to color data that has been processed, typically during data acquisition (that is, by the camera doing the grab), to compensate for a non-linear transformation between a pixel's value and its displayed intensity on the display device. When converting RGB source colors to CIELAB, MIL requires linear color data; that is, data that is uncorrected. Therefore, if gamma correction has been applied on the RGB source color data, you must remove it. Unless you are using the CIELAB conversion mode in an RGB source color space, M_CONVERSION_GAMMA is ignored. INQ (summarize) Specifies whether to remove gamma correction when internally converting RGB source colors before the match using McolSetMethod() with the CIELAB conversion mode. INQ (more details...)
	M_DEFAULT	Same as M_ENABLE.
	M_DISABLE	Specifies not to remove gamma correction. In this case, your RGB color data should not be in a corrected state (it should be linear). For example, the camera capturing the RGB color data has not applied a gamma correction. (summarize) Specifies not to remove gamma correction. (more details...)
	M_ENABLE	Specifies to remove gamma correction. In this case, your RGB color data should be in a corrected state (it should be non-linear). For example, the camera capturing the RGB color data has applied a gamma correction. MIL assumes that your color data has been corrected according to the standards of the context's reference color space, as specified using McolAlloc() with the ColorSpaceProfileId parameter. MIL uses these standards (for example, sRGB) to remove the gamma correction. (summarize) Specifies to remove gamma correction. (more details...)
M_DISTANCE_IMAGE_NORMALIZE		Sets the normalization factor when drawing or generating M_DRAW_DISTANCE, using McolDraw() or McolMatch(). Distance results are always clipped at the distance buffer's maximal possible value, which can occur when specifying M_NO_NORMALIZE or a specific normalization factor. For example, when using an 8-bit unsigned distance buffer, distances higher than 255 will be written as 255. Note that if you specify a distance buffer of type floating-point, distance results would almost never be greater than the buffer's maximal possible value, since its limit is extremely high. MIL ignores M_DISTANCE_IMAGE_NORMALIZE when using McolSetMethod() with M_HISTOGRAM_MATCHING or M_HISTOGRAM_VOTE. INQ (summarize) Sets the normalization factor when drawing or generating M_DRAW_DISTANCE, using McolDraw() or McolMatch(). INQ (more details...)
	M_DEFAULT	Same as M_NO_NORMALIZE.
	M_MAX_NORMALIZE	Specifies to normalize distance values according to the greatest calculated distance. This value corresponds to the result M_MAX_DISTANCE (McolGetResult()). The normalization performed is: (Distance/GreatestCalculatedDistance) x MaximumPossibleValueOfDistBuf (for distance buffer's of type integer). (Distance/GreatestCalculatedDistance) (for distance buffer's of type floating-point). Note that if the distance buffer is of type floating-point, you would typically not normalize the distance results, since all this will do is return a value between 0.0 and 1.0. (summarize) Specifies to normalize distance values according to the greatest calculated distance. (more details...)
	M_NO_NORMALIZE	Specifies no normalization. For distance buffers of type integer, distance values are truncated (no decimals). For distance buffers of type floating-point, distance values are complete (with decimals). (summarize) Specifies no normalization. (more details...)
	Value > 0.0	Specifies to normalize distance values according to the specified normalization value. The normalization performed is: (Distance/NormalizationValue) x MaximumPossibleValueOfDistBuf (for distance buffer's of type integer). (Distance/NormalizationValue) (for distance buffer's of type floating-point). Note that if the distance buffer is of type floating-point, you would typically not normalize the distance results, since all this will do is return a value between 0.0 and 1.0. (summarize) Specifies to normalize distance values according to the specified normalization value. (more details...)
M_DISTANCE_TOLERANCE_MODE		Sets the strategy with which to use the tolerance value (M_DISTANCE_TOLERANCE) to calculate the acceptable (matching) color distance (tolerance) between the color-sample and a target area. When using an M_HISTOGRAM_MATCHING operation mode (McolSetMethod()), you must set M_DISTANCE_TOLERANCE_MODE to M_ABSOLUTE. When using an M_HISTOGRAM_VOTE operation mode, MIL ignores M_DISTANCE_TOLERANCE_MODE. INQ (summarize) Sets the strategy with which to use the tolerance value (M_DISTANCE_TOLERANCE) to calculate the acceptable (matching) color distance (tolerance) between the color-sample and a target area. INQ (more details...)
	M_DEFAULT	Same as M_ABSOLUTE.
	M_ABSOLUTE	Specifies that the M_DISTANCE_TOLERANCE value will be untouched and used as the acceptable distance tolerance.
	M_RELATIVE	Specifies a tolerance strategy based on the relative distances between pairs of color-samples. In this case, MIL establishes the smallest distance between any given color-sample and every other color-sample. Half this value is then multiplied by the M_DISTANCE_TOLERANCE value, and the resulting value serves as the acceptable distance tolerance for the color-sample in question. This process is repeated for each color-sample. (summarize) Specifies a tolerance strategy based on the relative distances between pairs of color-samples. (more details...)
	M_SAMPLE_STDDEV	Specifies a tolerance strategy based on the color-sample's standard deviation. For color-samples that come from an image (McolDefine() with M_IMAGE), the color-sample's standard deviation is computed as the distance between each pixel in the color-sample and the average color of the color-sample. MIL calculates this distance according to the current distance type set with McolSetMethod(). The resulting distance, which in this case is considered to be the color-sample's standard deviation, is multiplied by M_DISTANCE_TOLERANCE and is used as the acceptable distance tolerance. If the computed color-sample's standard deviation is less than 1.0, MIL uses 1.0 as the standard deviation. For triplet color-samples (McolDefine() with M_TRIPLET), MIL uses 1.0 as the standard deviation. In this case, M_DISTANCE_TOLERANCE remains unchanged and is used as the acceptable distance tolerance. (summarize) Specifies a tolerance strategy based on the color-sample's standard deviation. (more details...)
M_GENERATE_DISTANCE_IMAGE		Sets whether to generate the distance image and store it in the result buffer. This image contains the difference between the color of the target area and the color of its best-matched color-sample. MIL ignores M_GENERATE_DISTANCE_IMAGE when using McolSetMethod() with M_HISTOGRAM_MATCHING or M_HISTOGRAM_VOTE. INQ (summarize) Sets whether to generate the distance image and store it in the result buffer. INQ (more details...)
	M_DEFAULT	Same as M_DISABLE.
	M_DISABLE	Specifies not to generate the image.
	M_ENABLE	Specifies to generate the image.
M_GENERATE_PIXEL_MATCH		Sets whether to generate the image containing the label of the color-sample for which each pixel voted. This image is only available if you use McolSetMethod() with M_MIN_DIST_VOTE. INQ (summarize) Sets whether to generate the image containing the label of the color-sample for which each pixel voted. INQ (more details...)
	M_DEFAULT	Same as M_DISABLE.
	M_DISABLE	Specifies not to generate the image.
	M_ENABLE	Specifies to generate the image.
M_GENERATE_SAMPLE_COLOR_LUT		Sets whether to generate the color-sample label LUT and store it in the result buffer. This LUT contains the label value of each color-sample and its associated average color. INQ (summarize) Sets whether to generate the color-sample label LUT and store it in the result buffer. INQ (more details...)
	M_DEFAULT	Same as M_DISABLE.
	M_DISABLE	Specifies not to generate the LUT.
	M_ENABLE	Specifies to generate the LUT.
M_NB_BINS_BAND_0		Sets the number of histogram bins for color band 0. Relevant only when matching colors using McolSetMethod() with M_HISTOGRAM_MATCHING or M_HISTOGRAM_VOTE. The number of bins situated along the axis of band 0 determine the size of the bins for that band. If you multiply the number of bins situated along the axis of each band (M_NB_BINS_BAND_0, M_NB_BINS_BAND_1, and M_NB_BINS_BAND_2) you obtain the total number of bins. INQ (summarize) Sets the number of histogram bins for color band 0. INQ (more details...)
	M_DEFAULT	Specifies the default value; the default value is 10.
	Value > 0	Specifies the number of histogram bins for color band 0.
M_NB_BINS_BAND_1		Sets the number of histogram bins for color band 1. Relevant only when matching colors using McolSetMethod() with M_HISTOGRAM_MATCHING or M_HISTOGRAM_VOTE. The number of bins situated along the axis of band 1 determine the size of the bins for that band. If you multiply the number of bins situated along the axis of each band (M_NB_BINS_BAND_0, M_NB_BINS_BAND_1, and M_NB_BINS_BAND_2) you obtain the total number of bins. INQ (summarize) Sets the number of histogram bins for color band 1. INQ (more details...)
	M_DEFAULT	Specifies the default value; the default value is 10.
	Value > 0	Number of histogram bins for color band 1.
M_NB_BINS_BAND_2		Sets the number of histogram bins for color band 2. Relevant only when matching colors using McolSetMethod() with M_HISTOGRAM_MATCHING or M_HISTOGRAM_VOTE. The number of bins situated along the axis of band 2 determine the size of the bins for that band. If you multiply the number of bins situated along the axis of each band (M_NB_BINS_BAND_0, M_NB_BINS_BAND_1, and M_NB_BINS_BAND_2) you obtain the total number of bins. INQ (summarize) Sets the number of histogram bins for color band 2. INQ (more details...)
	M_DEFAULT	Specifies the default value; the default value is 10.
	Value > 0	Number of histogram bins for color band 2.
M_OUTLIER_DRAW_COLOR		Sets the color to use to draw outlier pixels when drawing or generating the color images (M_DRAW_..._USING_COLOR) or the distance image (M_DRAW_DISTANCE), using McolDraw() or McolMatch(). Outlier pixels are pixels inside a target area that do not match with any color-sample. INQ (summarize) Sets the color to use to draw outlier pixels when drawing or generating the color images (M_DRAW_..._USING_COLOR) or the distance image (M_DRAW_DISTANCE), using McolDraw() or McolMatch(). INQ (more details...)
	M_DEFAULT	Specifies the default value; the default value is 0.
	M_COLOR888( MIL_INT ComponentBand0, MIL_INT ComponentBand1, MIL_INT ComponentBand2 )	Specifies a 24-bit color value (eight bits per band) with which to set the outlier pixels. The color value is taken as is (no conversion), according to the source color space. Typically, this should be RGB, since the outlier color is meant for display. When M_OUTLIER_DRAW_COLOR is set with M_COLOR888(), only the first component (for example, red) will be used to draw or generate M_DRAW_DISTANCE, which is a grayscale image. (summarize) Specifies a 24-bit color value (eight bits per band) with which to set the outlier pixels. (more details...)
			Parameters
			ComponentBand0 Specifies the first component, as a value between 0 and 255.
			ComponentBand1 Specifies the second component, as a value between 0 and 255.
			ComponentBand2 Specifies the third component, as a value between 0 and 255.
	M_TRANSPARENT	Specifies not to change the value of the outlier pixels. Therefore, the outlier pixels will be those of the specified image. (summarize) Specifies not to change the value of the outlier pixels. (more details...)
	Value > 0	Specifies a grayscale value for the outlier pixels, as a double or integer. When drawing the distance image (M_DRAW_DISTANCE) in a 32-bit integer buffer, you should keep the M_OUTLIER_DRAW_COLOR value under 24-bit (that is, less than 16,777,215). (summarize) Specifies a grayscale value for the outlier pixels, as a double or integer. (more details...)
M_OUTLIER_LABEL		Sets the label to use for outlier pixels when drawing or generating the label images (M_DRAW_..._USING_LABEL) using McolDraw() or McolMatch(). Outlier pixels are pixels inside a target area that do not match with any color-sample. Note that the M_OUTLIER_LABEL setting does not represent a valid color-sample and you cannot pass it as a color-sample label to McolInquire(), McolGetResult(), or McolDraw(). INQ (summarize) Sets the label to use for outlier pixels when drawing or generating the label images (M_DRAW_..._USING_LABEL) using McolDraw() or McolMatch(). INQ (more details...)
	M_DEFAULT	Specifies the default value; the default value is 0.
	Value > 0	Specifies the label of the outlier pixels, as an integer. The label must be unique among existing labels, and must be less than 2²⁴ . (summarize) Specifies the label of the outlier pixels, as an integer. (more details...)
M_SAVE_AREA_IMAGE		Sets whether to save the area identifier image in the result buffer. INQ (summarize) Sets whether to save the area identifier image in the result buffer. INQ (more details...)
	M_DEFAULT	Same as M_DISABLE.
	M_DISABLE	Specifies not to save the image.
	M_ENABLE	Specifies to save the image.

The following ControlType and corresponding ControlValue parameter settings are used to control color space encoding, according to the actual dynamic range of your color data. In this case, you must set the IndexOrLabel parameter to M_CONTEXT. These values are only available for color matching contexts.

Color space encoding defines how color is transformed from the range represented in an image buffer to its native (theoretical) range. For example, RGB color space data is represented in an image buffer as values between 0 and 255 (8-bit); these values are then mapped to their native data range, which consists of all real numbers between 0 and 1.

The Color Analysis module allows you to perform this transformation automatically, using M_ENCODING with M_nBIT, which is typically sufficient. You can also use M_USER_DEFINED to explicitly control the transformation according to offset (M_OFFSET_BAND_n) and scale (M_SCALE_BAND_n) values. For more information, see the Color space encoding subsection of the Advanced color matching settings and concepts section of Chapter 19: Color processing and analysis.

For controlling color matching context settings that are used for color space encoding
ControlType		Description
	ControlValue	Description
M_ENCODING		Sets the color space encoding, which defines how color is transformed from the range represented in an image buffer to its native (theoretical) range. INQ (summarize) Sets the color space encoding, which defines how color is transformed from the range represented in an image buffer to its native (theoretical) range. INQ (more details...)
	M_DEFAULT	Same as M_8BIT.
	M_8BIT	Specifies an internally defined color space encoding for 8-bit images.
	M_10BIT	Specifies an internally defined color space encoding for 10-bit images.
	M_12BIT	Specifies an internally defined color space encoding for 12-bit images.
	M_14BIT	Specifies an internally defined color space encoding for 14-bit images.
	M_16BIT	Specifies an internally defined color space encoding for 16-bit images.
	M_USER_DEFINED	Specifies that the color space encoding is defined using M_OFFSET_BAND_n and M_SCALE_BAND_n.
M_OFFSET_BAND_0		Sets the offset for the color space encoding, for band 0. This only applies if M_ENCODING is set to M_USER_DEFINED. INQ (summarize) Sets the offset for the color space encoding, for band 0. INQ (more details...)
	Value	Specifies the offset, as a double.
M_OFFSET_BAND_1		Sets the offset for the color space encoding, for band 1. This only applies if M_ENCODING is set to M_USER_DEFINED. INQ (summarize) Sets the offset for the color space encoding, for band 1. INQ (more details...)
	Value	Specifies the offset, as a double.
M_OFFSET_BAND_2		Sets the offset for the color space encoding, for band 2. This only applies if M_ENCODING is set to M_USER_DEFINED. INQ (summarize) Sets the offset for the color space encoding, for band 2. INQ (more details...)
	Value	Specifies the offset, as a double.
M_SCALE_BAND_0		Sets the scale for the color space encoding, for band 0. This only applies if M_ENCODING is set to M_USER_DEFINED. INQ (summarize) Sets the scale for the color space encoding, for band 0. INQ (more details...)
	Value	Specifies the scale, as a double.
M_SCALE_BAND_1		Sets the scale for the color space encoding, for band 1. This only applies if M_ENCODING is set to M_USER_DEFINED. INQ (summarize) Sets the scale for the color space encoding, for band 1. INQ (more details...)
	Value	Specifies the scale, as a double.
M_SCALE_BAND_2		Sets the scale for the color space encoding, for band 2. This only applies if M_ENCODING is set to M_USER_DEFINED. INQ (summarize) Sets the scale for the color space encoding, for band 2. INQ (more details...)
	Value	Specifies the scale, as a double.

The following ControlType and corresponding ControlValue parameter settings are used to control color-samples defined in the context. In this case, you must set the IndexOrLabel parameter to M_SAMPLE_INDEX() or M_SAMPLE_LABEL(). Unless otherwise specified, these values are only available for color matching contexts.

For controlling color-samples
ControlType		Description
	ControlValue	Description
M_DISTANCE_TOLERANCE		Sets the acceptable tolerance for the color distance between the color-sample and a target area. The tolerance ranges from no color difference to M_DISTANCE_TOLERANCE. The greater the tolerance, the greater the distance (difference) between the colors can be, for them to match. MIL ignores M_DISTANCE_TOLERANCE when using McolSetMethod() with M_HISTOGRAM_VOTE. INQ (summarize) Sets the acceptable tolerance for the color distance between the color-sample and a target area. INQ (more details...)
	M_DEFAULT	Same as M_AUTO.
	M_AUTO	Specifies the tolerance automatically. If you set M_DISTANCE_TOLERANCE_MODE to M_ABSOLUTE, M_AUTO specifies an infinite (M_INFINITE) tolerance. If you set M_DISTANCE_TOLERANCE_MODE to M_RELATIVE, M_AUTO specifies a tolerance of 1. If you set M_DISTANCE_TOLERANCE_MODE to M_SAMPLE_STDDEV, M_AUTO specifies a tolerance of 3. (summarize) Specifies the tolerance automatically. (more details...)
	M_INFINITE	Specifies an infinite tolerance.
	Value >= 0.0	Specifies the tolerance value. Set the tolerance according to the specified tolerance mode (M_DISTANCE_TOLERANCE_MODE) and distance type (McolSetMethod()). For example, a tolerance value of 1 when using an M_MAHALANOBIS distance type is not the same as when using an M_MANHATTAN distance type, even if the tolerance mode is M_ABSOLUTE. (summarize) Specifies the tolerance value. (more details...)
M_HISTOGRAM_FREQUENCY_THRESHOLD		Sets the minimal frequency, in pixels, for a histogram bin to count in the matching process. This setting is only valid when using McolSetMethod() with M_HISTOGRAM_MATCHING or M_HISTOGRAM_VOTE. Increasing the minimal frequency can lead to a faster match while discarding noise in the sample histogram. Bins with a frequency less than the threshold are considered empty. When using triplet color-samples with M_HISTOGRAM_VOTE, it is not recommended to set the frequency threshold to a value other than 1, which is the default. INQ (summarize) Sets the minimal frequency, in pixels, for a histogram bin to count in the matching process. INQ (more details...)
	M_DEFAULT	Specifies the default value; the default value is 1 pixel.
	Value > 0	Specifies the minimal frequency, as an integer.
M_SAMPLE_LABEL_VALUE		Sets the color-sample's label. This value is available for color matching and relative color calibration contexts. Initially, you specify a color-sample's label value when adding a color-sample to the context, using McolDefine(). You can use M_SAMPLE_LABEL_VALUE to change the label afterward. INQ (summarize) Sets the color-sample's label. INQ (more details...)
	Value > 0	Specifies the label, as an integer. The label must be unique among existing labels, and must be less than 2²⁴ . (summarize) Specifies the label, as an integer. (more details...)

Type-specific versions of the function when using a C compiler under 64-bit

void McolControlInt64 (MIL_ID ContextId, MIL_INT IndexOrLabel, MIL_INT64 ControlType, MIL_INT64 ControlValue)

Details

Parameters

ContextId

See ContextId of the main function for a description.

IndexOrLabel

See IndexOrLabel of the main function for a description.

ControlType

See ControlType of the main function for a description.

ControlValue

See ControlValue of the main function for a description.

void McolControlDouble (MIL_ID ContextId, MIL_INT IndexOrLabel, MIL_INT64 ControlType, MIL_DOUBLE ControlValue)

Details

Parameters

ContextId

See ContextId of the main function for a description.

IndexOrLabel

See IndexOrLabel of the main function for a description.

ControlType

See ControlType of the main function for a description.

ControlValue

See ControlValue of the main function for a description.

Compilation information

Header	Include mil.h.
Library	Use mil.lib; milcolor.lib.
DLL	Requires mil.dll; milcolor.dll.