MmeasControl

See also

User Guide:

Reference:

MmeasAllocContext MmeasAllocResult MmeasCalculate MmeasDraw MmeasFindMarker MmeasGetResult MmeasGetResultSingle MmeasSetMarker

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

Function Map

Table:

For specifying the measurement context or result buffer identifier

- ControlType

- ControlValue

Parameter Associations

Table:	For a measurement context
Table:	For a measurement result buffer

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

Compilation information

Synopsis

Control a measurement context or result buffer setting.

Syntax

void MmeasControl(

MIL_ID ContextOrResultId,	//in
MIL_INT64 ControlType,	//in
MIL_DOUBLE ControlValue	//in

)

Description

This function allows you to control a measurement context or result buffer setting. These settings control the behavior of measurement operations (MmeasFindMarker() and MmeasCalculate()), which subsequently affects the results that you obtain (MmeasGetResult() or MmeasGetResultSingle()) or draw (MmeasDraw()).

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

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 measurement context or result buffer.

For specifying the measurement context or result buffer identifier
Value	Description
Measurement context ID	Specifies a valid measurement context, previously allocated using MmeasAllocContext().
Measurement result buffer ID	Specifies a valid measurement result buffer, previously allocated using MmeasAllocResult().

ControlType

Specifies the type of control to set.

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

ControlValue

Specifies the required value for the control.

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 a measurement context
For a measurement result buffer

The following ControlType and corresponding ControlValue parameter settings can be specified for a measurement context. In this case, you must set the ContextOrResultId parameter to a measurement context.

For a measurement context
ControlType		Description
	ControlValue	Description
M_PIXEL_ASPECT_RATIO		Sets the pixel width to pixel height ratio. INQ (summarize) Sets the pixel width to pixel height ratio. INQ (more details...)
	Value	Specifies the ratio. The default value is 1.0. (summarize) Specifies the ratio. (more details...)
M_PIXEL_ASPECT_RATIO_INPUT		Sets whether to use M_PIXEL_ASPECT_RATIO to correct measurement inputs. INQ (summarize) Sets whether to use M_PIXEL_ASPECT_RATIO to correct measurement inputs. INQ (more details...)
	M_CORRECTED	Specifies to correct measurement inputs with the specified aspect ratio. This is the default value. (summarize) Specifies to correct measurement inputs with the specified aspect ratio. (more details...)
	M_NORMAL	Specifies to not correct measurement inputs (ratio of 1.0).
M_PIXEL_ASPECT_RATIO_OUTPUT		Sets whether to use M_PIXEL_ASPECT_RATIO to correct measurement results (output data). INQ (summarize) Sets whether to use M_PIXEL_ASPECT_RATIO to correct measurement results (output data). INQ (more details...)
	M_CORRECTED	Specifies to correct measurement results with the specified aspect ratio. This is the default value. (summarize) Specifies to correct measurement results with the specified aspect ratio. (more details...)
	M_NORMAL	Specifies to not correct measurement results (ratio of 1.0).

The following ControlType and corresponding ControlValue parameter settings can be specified for a measurement result buffer. In this case, you must set the ContextOrResultId parameter to a measurement result buffer.

For a measurement result buffer
ControlType		Description
	ControlValue	Description
M_RESULT_OUTPUT_UNITS		Sets whether to return results of MmeasCalculate() in pixels or world units. This essentially sets the output coordinate system to use. The setting of this control type will only affect functions within this module which return positional results. This control type can be changed at any time to return results in the required output units. Use MmeasSetMarker() with M_RESULT_OUTPUT_UNITS to control the units in which results found using MmeasFindMarker() are returned. INQ (summarize) Sets whether to return results of MmeasCalculate() in pixels or world units. INQ (more details...)
	M_DEFAULT	Same as M_ACCORDING_TO_CALIBRATION.
	M_ACCORDING_TO_CALIBRATION	Specifies that results are returned in world units if the result was calculated on an image associated with a camera calibration context; otherwise, specifies that results are returned in pixel units.
	M_PIXEL	Specifies that results are returned in pixel units, with respect to the pixel coordinate system.
	M_WORLD	Specifies that results are returned in world units, with respect to the relative coordinate system. If world units are specified, calling MmeasGetResult() or MmeasGetResultSingle() generates an error if the result was not calculated on a calibrated image. (summarize) Specifies that results are returned in world units, with respect to the relative coordinate system. (more details...)

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

void MmeasControlInt64 (MIL_ID ContextOrResultId, MIL_INT64 ControlType, MIL_INT64 ControlValue)

Details

Parameters

ContextOrResultId

See ContextOrResultId 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 MmeasControlDouble (MIL_ID ContextOrResultId, MIL_INT64 ControlType, MIL_DOUBLE ControlValue)

Details

Parameters

ContextOrResultId

See ContextOrResultId 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; milmeas.lib.
DLL	Requires mil.dll; milmeas.dll.