M3dmetInquire

See also

Reference:

M3dmetAlloc M3dmetControl M3dmetGetResult M3dmetStat

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

None.

Function Map

Parameter Associations

Table:	For inquiring about a statistics 3D metrology context
Table:	For inquiring about a fit 3D metrology context
+ combination:	For inquiring about the default value
+ combination:	To inquire whether an inquire type is supported
+ combination:	To specify the data type

Return value

Compilation information

Synopsis

Inquire information about a 3D metrology context.

Syntax

MIL_INT64 M3dmetInquire(

MIL_ID Context3dmetId,	//in
MIL_INT64 InquireType,	//in
void *UserVarPtr	//out

)

Description

This function inquires information about a 3D metrology context.

To retrieve results from a 3D metrology result buffer, use M3dmetGetResult().

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

Context3dmetId

Specifies the identifier of the 3D metrology context to inquire. The 3D metrology context must have been previously allocated on the required system using M3dmetAlloc().

InquireType

Specifies the type of information 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):

defined-elsewhere-in-parameter
MIL_DOUBLE
MIL_FLOAT
MIL_INT
MIL_INT32
MIL_INT64

Specifies the address of the variable in which to write the requested information. Since the M3dmetInquire() 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.

Parameter associations

The tables below list possible values for the InquireType parameter and possible values returned to the UserVarPtr parameter.

For inquiring about a statistics 3D metrology context
For inquiring about a fit 3D metrology context

For a statistics 3D metrology context, the InquireType parameter can be set to one of the following.

For inquiring about a statistics 3D metrology context
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_STAT_MAX +		Inquires whether the maximum distance between the point cloud or depth map, and the specified reference object will be calculated. SET (summarize) Inquires whether the maximum distance between the point cloud or depth map, and the specified reference object will be calculated. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_DISABLE	Specifies not to calculate the maximum distance.
	M_ENABLE	Specifies to calculate the maximum distance.
M_STAT_MAX_ABS +		Inquires whether the maximum absolute distance between the point cloud or depth map, and the specified reference object will be calculated. SET (summarize) Inquires whether the maximum absolute distance between the point cloud or depth map, and the specified reference object will be calculated. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_DISABLE	Specifies not to calculate the maximum absolute distance.
	M_ENABLE	Specifies to calculate the maximum absolute distance.
M_STAT_MEAN +		Inquires whether the average distance between the point cloud or depth map, and the specified reference object will be calculated. SET (summarize) Inquires whether the average distance between the point cloud or depth map, and the specified reference object will be calculated. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_DISABLE	Specifies not to calculate the average distance.
	M_ENABLE	Specifies to calculate the average distance.
M_STAT_MIN +		Inquires whether the minimum distance between the point cloud or depth map, and the specified reference object will be calculated. SET (summarize) Inquires whether the minimum distance between the point cloud or depth map, and the specified reference object will be calculated. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_DISABLE	Specifies not to calculate the minimum distance.
	M_ENABLE	Specifies to calculate the minimum distance.
M_STAT_MIN_ABS +		Inquires whether the minimum absolute distance between the point cloud or depth map, and the specified reference object will be calculated. SET (summarize) Inquires whether the minimum absolute distance between the point cloud or depth map, and the specified reference object will be calculated. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_DISABLE	Specifies not to calculate the minimum absolute distance.
	M_ENABLE	Specifies to calculate the minimum absolute distance.
M_STAT_NUMBER +		Inquires whether to record the number of points that meet the condition specified when calling M3dmetStat() (using the Condition, CondLow and CondHigh parameters). SET (summarize) Inquires whether to record the number of points that meet the condition specified when calling M3dmetStat() (using the Condition, CondLow and CondHigh parameters). SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_DISABLE	Specifies not to record the number of points that meet the specified condition.
	M_ENABLE	Specifies to record the number of points that meet the specified condition.
M_STAT_RMS +		Inquires whether the root-mean-square (RMS) error between the point cloud or depth map, and the specified reference object will be calculated. SET (summarize) Inquires whether the root-mean-square (RMS) error between the point cloud or depth map, and the specified reference object will be calculated. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_DISABLE	Specifies not to calculate the RMS error.
	M_ENABLE	Specifies to calculate the RMS error.
M_STAT_STANDARD_DEVIATION +		Inquires whether the standard deviation of all the distances calculated between the point cloud or depth map, and the specified reference object will be calculated. SET (summarize) Inquires whether the standard deviation of all the distances calculated between the point cloud or depth map, and the specified reference object will be calculated. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_DISABLE	Specifies not to calculate the standard deviation.
	M_ENABLE	Specifies to calculate the standard deviation.
M_STAT_SUM +		Inquires whether the sum of all the distances calculated between the point cloud or depth map, and the specified reference object will be calculated. SET (summarize) Inquires whether the sum of all the distances calculated between the point cloud or depth map, and the specified reference object will be calculated. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_DISABLE	Specifies not to calculate the sum of all the distances.
	M_ENABLE	Specifies to calculate the sum of all the distances.
M_STAT_SUM_ABS +		Inquires whether the sum of all the absolute distances calculated between the point cloud or depth map, and the specified reference object will be calculated. SET (summarize) Inquires whether the sum of all the absolute distances calculated between the point cloud or depth map, and the specified reference object will be calculated. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_DISABLE	Specifies not to calculate the sum of all absolute distances.
	M_ENABLE	Specifies to calculate the sum of all absolute distances.
M_STAT_SUM_OF_SQUARES +		Inquires whether the sum of squared distances between the point cloud or depth map, and the specified reference object will be calculated. SET (summarize) Inquires whether the sum of squared distances between the point cloud or depth map, and the specified reference object will be calculated. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_DISABLE	Specifies not to calculate the sum of squared distances.
	M_ENABLE	Specifies to calculate the sum of squared distances.

For a fit 3D metrology context, the InquireType parameter can be set to one of the following:

For inquiring about a fit 3D metrology context
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_ESTIMATION_MODE +		Inquires how to compute an initial fit estimate between the point cloud or depth map, and the specified reference object. SET (summarize) Inquires how to compute an initial fit estimate between the point cloud or depth map, and the specified reference object. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_FROM_GEOMETRY	Specifies that an initial fit estimate is determined using a geometry object.
	M_NO_SAMPLING	Specifies that an initial fit estimate is calculated using all available points in a point cloud or depth map.
	M_RANDOM_SAMPLING	Specifies that an initial fit estimate is determined using a random sampling consensus (RANSAC) algorithm.
M_EXPECTED_OUTLIER_PERCENTAGE +		Inquires the expected percentage of outliers among the points of the point cloud or depth map to be fitted. SET (summarize) Inquires the expected percentage of outliers among the points of the point cloud or depth map to be fitted. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_DOUBLE Data type: address of a MIL_DOUBLE Data type info: Data type: address of a MIL_DOUBLE Data type: address of a MIL_DOUBLE
	0.0 < Value < 100.0	Specifies the expected percentage of outliers among the points of the point cloud or depth map to be fitted.
M_FIT_ITERATIONS_MAX +		Inquires the maximum number of iterations to use during the fit operation. SET (summarize) Inquires the maximum number of iterations to use during the fit operation. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	Value >= 0	Specifies the maximum number of iterations to use during the fit operation.
M_INLIER_AMOUNT_THRESHOLD +		Inquires the minimum number of inliers required for the fit operation to end. SET (summarize) Inquires the minimum number of inliers required for the fit operation to end. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_INFINITE	Specifies that there is no minimum number of inliers.
	Value >= 0	Specifies the minimum number of inliers.
M_RMS_ERROR_THRESHOLD +		Inquires the maximum RMS error required for the fit operation to end. SET (summarize) Inquires the maximum RMS error required for the fit operation to end. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_DOUBLE Data type: address of a MIL_DOUBLE Data type info: Data type: address of a MIL_DOUBLE Data type: address of a MIL_DOUBLE
	Value >= 0.0	Specifies the maximum RMS error.

Combination values for the values listed in For inquiring about a statistics 3D metrology context; the values listed in For inquiring about a fit 3D metrology context.

You can add one of the following values to the above-mentioned values to get information about the default value of an inquire type, regardless of the current value of the inquire type.

For inquiring about the default value
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_DEFAULT		Inquires the default value of the specified inquire type. (summarize) Inquires the default value of the specified inquire type. (more details...)
	UserVarPtr extra info	Data type info: Data type: defined elsewhere Data type: defined elsewhere Data type info: Data type: defined elsewhere Data type: defined elsewhere
M_IS_SET_TO_DEFAULT		Inquires whether the specified inquire type is set to its default value. (summarize) Inquires whether the specified inquire type is set to its default value. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_FALSE	Specifies that the inquire type is not set to its default value.
	M_TRUE	Specifies that the inquire type is set to its default value.

Combination value for the values listed in For inquiring about a statistics 3D metrology context; the values listed in For inquiring about a fit 3D metrology context.

You can add the following value to the above-mentioned values to determine whether an inquire type is supported.

To inquire whether an inquire type is supported
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_SUPPORTED		Inquires whether the specified inquire type is supported for the 3D metrology context. (summarize) Inquires whether the specified inquire type is supported for the 3D metrology context. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_NULL	Specifies that the inquire type is not supported.
	Value != 0	Specifies that the inquire type is supported.

Combination values for the values listed in For inquiring about a statistics 3D metrology context; the values listed in For inquiring about a fit 3D metrology context.

You can add one of the following values to the above-mentioned values to cast the requested information to a required data type.

To specify the data type
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_TYPE_MIL_DOUBLE		Casts the requested information to a MIL_DOUBLE. (summarize) Casts the requested information to a MIL_DOUBLE. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_DOUBLE MORE Data type: address of a MIL_DOUBLE Note: When a single inquire. Data type info: Data type: address of a MIL_DOUBLE MORE Data type: address of a MIL_DOUBLE Note: When a single inquire.
M_TYPE_MIL_FLOAT		Casts the requested information to a MIL_FLOAT. (summarize) Casts the requested information to a MIL_FLOAT. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_FLOAT MORE Data type: address of a MIL_FLOAT Note: When a single result. Data type info: Data type: address of a MIL_FLOAT MORE Data type: address of a MIL_FLOAT Note: When a single result.
M_TYPE_MIL_INT		Casts the requested information to a MIL_INT. (summarize) Casts the requested information to a MIL_INT. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT MORE Data type: address of a MIL_INT Note: When a single inquire. Data type info: Data type: address of a MIL_INT MORE Data type: address of a MIL_INT Note: When a single inquire.
M_TYPE_MIL_INT32		Casts the requested information to a MIL_INT32. (summarize) Casts the requested information to a MIL_INT32. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT32 MORE Data type: address of a MIL_INT32 Note: When a single inquire. Data type info: Data type: address of a MIL_INT32 MORE Data type: address of a MIL_INT32 Note: When a single inquire.
M_TYPE_MIL_INT64		Casts the requested information to a MIL_INT64. (summarize) Casts the requested information to a MIL_INT64. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT64 MORE Data type: address of a MIL_INT64 Note: When a single inquire. Data type info: Data type: address of a MIL_INT64 MORE Data type: address of a MIL_INT64 Note: When a single inquire.

Return value

The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLE or if it is a MIL_INT64 on a 32-bit system, this function will return M_NULL.

Compilation information

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