Filters
Filter values by
  • 3D reconstruction context
    • For any laser profiling context
    • For a laser profiling context with camera calibration information
    • For a laser profiling context with only depth correction information
  • 3D draw context
  • 3D reconstruction result buffer
    • For depth corrected data
    • For laser calibration data
    • For a point cloud container object
| Customize Help
| Save Settings

M3dmapInquire



Function Map
Synopsis
Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer.
Syntax
MIL_INT M3dmapInquire(
MIL_ID ContextOrResult3dmapId, //in
MIL_INT LabelOrIndex, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function inquires about a specified setting of a profiling 3D reconstruction context, draw 3D reconstruction context, or 3D reconstruction result buffer.

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

An M_POINT_CLOUD_RESULT 3D reconstruction result buffer contains an array of distinct point clouds. You can retrieve results from an individual point cloud in the result buffer, from an aggregate of all point clouds in the result buffer, or from the result buffer itself using the LabelOrIndex 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
ContextOrResult3dmapId

Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information.

LabelOrIndex

Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. Only 3D reconstruction result buffers allocated using M_POINT_CLOUD_RESULT have point clouds that can be specified using this parameter. For other types of 3D reconstruction contexts and result buffers, as well as for 3D draw contexts, set this parameter to M_DEFAULT.

function map For specifying the point cloud(s) or point cloud result buffer
Click to summarizeValue Description
Click to summarize

Specifies the index of a point cloud in the specified 3D reconstruction result buffer about which to inquire.

(summarize)
Parameters

Specifies the index of an existing point cloud.

Click to summarize

Specifies the label of a point cloud in the specified 3D reconstruction result buffer about which to inquire.

(summarize)
Parameters

Specifies the label of an existing point cloud.

Click to summarize M_ALL

Specifies to inquire all point clouds in the specified 3D reconstruction result buffer.

Click to summarize M_GENERAL

Specifies to inquire the specified 3D reconstruction result buffer allocated using M_POINT_CLOUD_RESULT.

InquireType

Specifies the setting 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):
  • array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ]
  • array of type MIL_FLOAT [optionally, in C++: a reference to a std::vector<MIL_FLOAT> ]
  • array of type MIL_ID [optionally, in C++: a reference to a std::vector<MIL_ID> ]
  • array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ]
  • array of type MIL_INT16 [optionally, in C++: a reference to a std::vector<MIL_INT16> ]
  • array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ]
  • array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ]
  • array of type MIL_TEXT_CHAR [optionally, in C++: a reference to a MIL_STRING]
  • 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 M3dmapInquire() function also returns the requested information, you can set this parameter to M_NULL.

When LabelOrIndex is set to M_ALL, you must specify the address of an array with as many elements as point clouds in the point cloud container. You can inquire the number of point clouds using M3dmapInquire() set to M_NUMBER_OF_POINT_CLOUDS.

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

To inquire about the system on which the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer has been allocated, set the InquireType parameter to the value below.

function map For inquiring about the system
Click to summarizeInquireType Description
UserVarPtr
- Possible values returned
Click to summarize M_OWNER_SYSTEM +

Inquires the identifier of the system on which the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer has been allocated. 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 M_DEFAULT_HOST

Specifies the default Host system of the current MIL application.

Click to summarize MIL system identifier

Specifies a valid system identifier, previously allocated using MsysAlloc().

For a profiling 3D reconstruction context of type M_LASER, the InquireType parameter can be set to one of the following:

function map For 3D reconstruction contexts used for laser line profiling
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_CALIBRATION_DEPTHS +

Inquires the calibration depths used to calibrate the profiling 3D reconstruction context. These are the values given specified using M3dmapControl() with M_CORRECTED_DEPTH before each call to M3dmapAddScan().

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize Value

Specifies the calibration depths used to calibrate the profiling 3D reconstruction context.

Click to summarize M_CALIBRATION_STATUS +

Inquires the status of the profiling 3D reconstruction calibration.

(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_CALIBRATED

Specifies that a successful call to M3dmapCalibrate() has been made and the context can now be used to produce calibrated data.

Click to summarize M_GLOBAL_OPTIMIZATION_ERROR

Specifies that the global optimization phase of M3dmapCalibrateMultiple() failed because of a mathematical exception.

Click to summarize M_INTERNAL_ERROR

Specifies that an unexpected error occurred.

Click to summarize M_LASER_LINE_NOT_DETECTED

Specifies that the laser line could not be extracted from the image passed as input to M3dmapAddScan().

Click to summarize M_MATHEMATICAL_EXCEPTION

Specifies that M3dmapCalibrate() could not calibrate properly. Verify that all function parameters, control type settings, and images are consistent.

(summarize)
Click to summarize M_NOT_ENOUGH_MEMORY

Specifies that there was not enough memory for M3dmapCalibrate() to complete its task.

Click to summarize M_NOT_INITIALIZED

Specifies that the context is not calibrated. M3dmapCalibrate() has not been called.

(summarize)
Click to summarize M_CAMERA_IMAGE_SIZE_X +

Inquires the X-size of the image(s) with which this profiling 3D reconstruction context was calibrated. This inquire type is valid only after a successful call to M3dmapCalibrate() on this profiling 3D reconstruction context.

(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 > 0

Specifies the width of the image with which this profiling 3D reconstruction context was calibrated. The width is rounded to the nearest integer.

(summarize)
Click to summarize M_CAMERA_IMAGE_SIZE_Y +

Inquires the Y-size of the image(s) with which this profiling 3D reconstruction context was calibrated. This inquire type is valid only after a successful call to M3dmapCalibrate() on this profiling 3D reconstruction context.

(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 > 0

Specifies the height of the image with which this profiling 3D reconstruction context was calibrated. The height is rounded to the nearest integer.

(summarize)
Click to summarize M_CORRECTED_DEPTH +

Inquires depth information about the next laser line image added.

For a profiling 3D reconstruction context allocated using M3dmapAlloc() with M_DEPTH_CORRECTION, this inquire type inquires the gray level corresponding to the depth represented by the next laser line image added (using M3dmapAddScan()) when calibrating your 3D reconstruction setup.

For a profiling 3D reconstruction context allocated using M3dmapAlloc() with M_CALIBRATED_CAMERA_LINEAR_MOTION, this inquire type inquires the depth in world units represented by the next laser line image added (using M3dmapAddScan()) when calibrating your 3D reconstruction setup. 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.

Click to summarize 0 <= GrayValue <= 254

Specifies the gray level that will be used to represent the height of the next reference plane, when M3dmapAlloc() is set to M_DEPTH_CORRECTION. INFO

Click to summarize 0 <= GrayValue <= 65534

Specifies the gray level that will be used to represent the height of the next reference plane, when M3dmapAlloc() is set to M_DEPTH_CORRECTION. INFO

Click to summarize ZCoordinateValue

Specifies the Z-coordinate (in world units) of the next reference plane. INFO

Click to summarize M_EXTRACTION_FIXED_POINT +

Inquires the number of binary digits used for the fractional part of the gray level in the uncorrected depth map, when using M3dmapAddScan() with M_LINE_ALREADY_EXTRACTED. 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.

Click to summarize 0 <= Value <= 7

Specifies the number of binary digits used for the fractional part of gray level values.

Click to summarize M_LASER_CONTEXT_TYPE +

Inquires the profiling 3D reconstruction mode, which determines whether the context can associate with a camera calibration and create a fully corrected depth map. 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_CALIBRATED_CAMERA_LINEAR_MOTION

Specifies that the 3D reconstruction context will include camera calibration information and depth correction information. INFO

Click to summarize M_DEPTH_CORRECTION

Specifies that the 3D reconstruction context will include depth correction information, but will not include camera calibration information. INFO

Click to summarize M_LOCATE_PEAK_1D_CONTEXT_ID +

Inquires the identifier of the internal locate peak 1D context within the profiling 3D reconstruction context.

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

Inquires the number of calibration depths used to calibrate the profiling 3D reconstruction context. This inquire type is valid only after a successful call to M3dmapCalibrate().

(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 > 0

Specifies the number of calibration depths used to calibrate the profiling 3D reconstruction context. Only integer values are accepted.

(summarize)

For profiling 3D reconstruction contexts set to M_CALIBRATED_CAMERA_LINEAR_MOTION, the InquireType parameter can be set to one of the following:

function map For profiling 3D reconstruction contexts set to M_CALIBRATED_CAMERA_LINEAR_MOTION
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_ASSUMED_PERPENDICULAR_TO_MOTION +

Inquires whether the laser plane was assumed to be perpendicular to the object's motion because a single reference plane was provided.

(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_FALSE

Specifies that the laser plane was not assumed perpendicular to the object's motion.

Click to summarize M_TRUE

Specifies that the laser plane was assumed perpendicular to the object's motion.

Click to summarize M_EXTRACTION_CHILD_OFFSET_X +

Inquires the X-offset that M3dmapAddScan() assumes the laser line image buffer to have relative to the top-left pixel of the image buffer used during camera calibration. 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.

Click to summarize Value > 0

Specifies the X-offset, in pixels.

Click to summarize M_EXTRACTION_CHILD_OFFSET_Y +

Inquires the Y-offset that M3dmapAddScan() assumes the laser line image buffer to have relative to the top-left pixel of the image buffer used during camera calibration. 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.

Click to summarize Value > 0

Specifies the Y-offset, in pixels.

Click to summarize M_EXTRACTION_RANGE_Z +

Inquires the mode that helps determine the range of valid Z-coordinates for extracted points when using M3dmapAddScan(). 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_GREATER

Specifies that the Z-axis range is defined by a lower limit corresponding to M_EXTRACTION_RANGE_Z_LIMIT1. INFO

Click to summarize M_IN_RANGE

Specifies that the Z-axis range is defined by the inside range of a lower limit and a upper limit corresponding to M_EXTRACTION_RANGE_Z_LIMIT1 and M_EXTRACTION_RANGE_Z_LIMIT2. INFO

Click to summarize M_INFINITE

Specifies that the range covers the entire Z-axis, so all points are kept.

Click to summarize M_LESS

Specifies that the Z-axis range is defined by a upper limit corresponding to M_EXTRACTION_RANGE_Z_LIMIT1. INFO

Click to summarize M_OUT_RANGE

Specifies that the Z-axis range is defined by the outside range of a lower limit and a upper limit corresponding to M_EXTRACTION_RANGE_Z_LIMIT1 and M_EXTRACTION_RANGE_Z_LIMIT2. INFO

Click to summarize M_EXTRACTION_RANGE_Z_LIMIT1 +

Inquires the first limit value that determines the range of valid Z-coordinates for extracted points. 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 first limit value, which can be either the lower limit or upper limit.

Click to summarize M_EXTRACTION_RANGE_Z_LIMIT2 +

Inquires the first limit value that determines the range of valid Z-coordinates for extracted points. 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 second limit value, which can be either the lower limit or upper limit.

Click to summarize M_FIT_RMS_ERROR +

Inquires the root mean squared error.

This inquire type returns the root mean squared error of all inlier 3D points used to fit the laser plane to the calibration laser lines upon calling M3dmapCalibrate(). For more information, consult the Inspecting laser line calibration subsection of the Calibrating your 3D reconstruction setup to create a point cloud section of Chapter 40: 3D reconstruction using laser line profiling. In this case, this inquire type is only supported after a successful call to M3dmapCalibrate().

(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 >= 0.0

Specifies the root mean square error.

Click to summarize M_LASER_PLANE_A +

Inquires the coefficient a of the laser plane equation, ax + by + cz + d = 0.

This inquire type is only supported after a successful call to M3dmapCalibrate() or M3dmapCalibrateMultiple().

Note that the variables x, y, z, and d are expressed in world units in the absolute coordinate system, while the coefficients a, b, and c are dimensionless.

(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 coefficient a of the laser plane equation.

Click to summarize M_LASER_PLANE_B +

Inquires the coefficient b of the laser plane equation, ax + by + cz + d = 0.

This inquire type is only supported after a successful call to M3dmapCalibrate() or M3dmapCalibrateMultiple().

Note that the variables x, y, z, and d are expressed in world units in the absolute coordinate system, while the coefficients a, b, and c are dimensionless.

(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 coefficient b of the laser plane equation.

Click to summarize M_LASER_PLANE_C +

Inquires the coefficient c of the laser plane equation, ax + by + cz + d = 0.

This inquire type is only supported after a successful call to M3dmapCalibrate() or M3dmapCalibrateMultiple().

Note that the variables x, y, z, and d are expressed in world units in the absolute coordinate system, while the coefficients a, b, and c are dimensionless.

(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 coefficient c of the laser plane equation.

Click to summarize M_LASER_PLANE_D +

Inquires the coefficient d of the laser plane equation, ax + by + cz + d = 0.

This inquire type is only supported after a successful call to M3dmapCalibrate() or M3dmapCalibrateMultiple().

Note that the variables x, y, z, and d are expressed in world units in the absolute coordinate system, while the coefficients a, b, and c are dimensionless.

(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 coefficient d of the laser plane equation.

Click to summarize M_SCAN_SPEED +

Inquires the speed of the object being scanned. Note that this value is negative if the object is moving away from the camera. 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.0.

Click to summarize Value

Specifies the speed, in world units per frame. INFO

For profiling 3D reconstruction contexts set to M_DEPTH_CORRECTION, the InquireType parameter can be set to one of the following:

function map For profiling 3D reconstruction contexts set to M_DEPTH_CORRECTION
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_NUMBER_OF_COLUMNS +

Inquires the number of columns in the uncorrected depth map used for calibration. This corresponds to either the X-size or Y-size of the laser line images passed to the 3D reconstruction result buffer, depending on the M_SCAN_LANE_DIRECTION setting.

This inquire type is only supported after a successful call to M3dmapCalibrate() or M3dmapCalibrateMultiple().

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

Specifies the number of columns.

Click to summarize M_NUMBER_OF_COLUMNS_WITH_INVERSIONS +

Inquires the number of columns in the uncorrected depth map used for calibration, for which at least one inversion occurred.

To determine the fraction of columns or rows of the camera image that were not ideally calibrated because of inversions, divide the value returned using M_NUMBER_OF_COLUMNS_WITH_INVERSIONS by M_NUMBER_OF_COLUMNS.

This inquire type is only supported after a successful call to M3dmapCalibrate() or M3dmapCalibrateMultiple().

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

Specifies the number of columns.

Click to summarize M_NUMBER_OF_COLUMNS_WITH_MISSING_DATA +

Inquires the number of columns in the uncorrected depth map used for calibration, for which at least one calibration laser line was not detected.

To determine the fraction of columns or rows of the camera image that were not ideally calibrated because of missing data, divide the value returned using M_NUMBER_OF_COLUMNS_WITH_MISSING_DATA by M_NUMBER_OF_COLUMNS.

This inquire type is only supported after a successful call to M3dmapCalibrate() or M3dmapCalibrateMultiple().

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

Specifies the number of columns.

Click to summarize M_NUMBER_OF_INVERSIONS_PER_COLUMN +

Inquires the number of inversions, per column, in the uncorrected depth map used for calibration.

This inquire type is only supported after a successful call to M3dmapCalibrate() or M3dmapCalibrateMultiple().

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE
Click to summarize Value

Specifies the number of inversions per column.

Click to summarize M_NUMBER_OF_MISSING_DATA_PER_COLUMN +

Inquires the number of missing data points per column in the uncorrected depth map used for calibration.

This inquire type is only supported after a successful call to M3dmapCalibrate() or M3dmapCalibrateMultiple().

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE
Click to summarize Value

Specifies the number of missing data points per column.

For a point cloud container (3D reconstruction result buffer of type M_POINT_CLOUD_RESULT and LabelOrIndex set to M_GENERAL), the InquireType parameter can be set to one of the following:

function map For a 3D reconstruction result buffer set to M_POINT_CLOUD_RESULT
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_NUMBER_OF_POINT_CLOUDS +

Inquires the number of point clouds in the specified 3D reconstruction result buffer.

(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 >= 0

Specifies the number of point clouds.

Click to summarize M_RESULTS_DISPLACEMENT_MODE +

Inquires the displacement mode, which determines how the 3D coordinates of a scanned object are returned with respect to the ongoing movement (displacement) of the conveyor. 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_FIXED.

Click to summarize M_CURRENT

Specifies that the results include the ongoing Y-axis displacement. INFO

Click to summarize M_FIXED

Specifies that the results do not include the ongoing Y-axis displacement. INFO

Click to summarize M_RESULTS_DISPLACEMENT_Y +

Inquires the specified Y-axis displacement added to resulting 3D coordinates when M_RESULTS_DISPLACEMENT_MODE is set to M_FIXED. 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 Value

Specifies the Y-axis displacement. INFO

For a point cloud (3D reconstruction result buffer of type M_POINT_CLOUD_RESULT and LabelOrIndex set to M_POINT_CLOUD_INDEX(), M_POINT_CLOUD_LABEL(), or M_ALL), the InquireType parameter can be set to one of the following:

function map For a point cloud
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_CAMERA_LABEL_VALUE +

Inquires the camera label of the 3D reconstruction context associated with the specified point cloud. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize 1 <= Value <= 1023

Specifies the camera label value. The default value is 1.

(summarize)
Click to summarize M_LASER_LABEL_VALUE +

Inquires the laser label of the 3D reconstruction context associated with the specified point cloud. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize 1 <= Value <= 2047

Specifies the laser label value. The default value is 1.

(summarize)
Click to summarize M_POINT_CLOUD_INDEX_VALUE +

Inquires the index of the point cloud with the specified label.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_INVALID

Specifies that there is no point cloud in the 3D reconstruction result buffer with the specified label.

Click to summarize 0 <= Point cloud array index <= 134217726

Specifies the index of the point cloud.

Click to summarize M_POINT_CLOUD_LABEL_VALUE +

Inquires the label of the point cloud with the specified index. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_INVALID

Specifies that there is no point cloud in the 3D reconstruction result buffer with the specified index.

Click to summarize 1 <= Point cloud label <= 134217727

Specifies the label of the point cloud.

Combination value for the values listed in For a point cloud; and for the following values: M_CALIBRATION_DEPTHS; M_NUMBER_OF_INVERSIONS_PER_COLUMN; M_NUMBER_OF_MISSING_DATA_PER_COLUMN.

You can add the following value to the above-mentioned values to determine the required array size (number of elements) to store the returned values.

function map For determining the required array size (number of elements) to store the returned values
Click to summarizeInquireType combination value Description
UserVarPtr
- Possible values returned
Click to summarize M_NB_ELEMENTS

Retrieves the required array size (number of elements) to store the returned values.

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

For a draw 3D reconstruction context.

function map For a draw 3D reconstruction context
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_DRAW_ABSOLUTE_COORDINATE_SYSTEM +

Inquires whether to draw the absolute coordinate system's axes. 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_DISABLE

Specifies not to draw the absolute coordinate system's axes. INFO

Click to summarize M_ENABLE

Specifies to draw the absolute coordinate system's axes. INFO

Click to summarize M_DRAW_CAMERA_COORDINATE_SYSTEM +

Inquires whether to draw the camera coordinate system's axes. 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_DISABLE

Specifies not to draw the camera coordinate system's axes. INFO

Click to summarize M_ENABLE

Specifies to draw the camera coordinate system's axes. INFO

Click to summarize M_DRAW_CAMERA_COORDINATE_SYSTEM_NAME +

Inquires the name of the drawn camera coordinate system. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
Click to summarize
M_PTR_TO_MIL_INT(
MIL_CONST_TEXT_PTR String
)

Casts the address of the string identifying the camera coordinate system's name, from a MIL_CONST_TEXT_PTR to a MIL_INT.

(summarize)
Parameters

This parameter specifies the string whose address to cast.

M_DEFAULT

Specifies "Camera" as the name of the camera coordinate system.

MIL_TEXT("String") 1

Specifies the name of the camera coordinate system.

Click to summarize M_DRAW_COORDINATE_SYSTEM_LENGTH +

Inquires the drawn length of the specified coordinate system's axes. 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 > 0.0

Specifies the length (in world units) at which to draw the axes of the specified coordinate system. INFO

Click to summarize M_DRAW_FRUSTUM +

Inquires whether to draw the frustum. 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_DISABLE

Specifies not to draw the frustum. INFO

Click to summarize M_ENABLE

Specifies to draw the frustum. INFO

Click to summarize M_DRAW_FRUSTUM_COLOR +

Inquires the frustum's color. 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_COLOR_BLACK

Specifies the color black. INFO

Click to summarize M_COLOR_BLUE

Specifies the color blue. INFO

Click to summarize M_COLOR_BRIGHT_GRAY

Specifies the color bright gray. INFO

Click to summarize M_COLOR_CYAN

Specifies the color cyan. INFO

Click to summarize M_COLOR_DARK_BLUE

Specifies the color dark blue. INFO

Click to summarize M_COLOR_DARK_CYAN

Specifies the color dark cyan. INFO

Click to summarize M_COLOR_DARK_GREEN

Specifies the color dark green. INFO

Click to summarize M_COLOR_DARK_MAGENTA

Specifies the color dark magenta. INFO

Click to summarize M_COLOR_DARK_RED

Specifies the color dark red. INFO

Click to summarize M_COLOR_DARK_YELLOW

Specifies the color dark yellow. INFO

Click to summarize M_COLOR_GRAY

Specifies the color gray. INFO

Click to summarize M_COLOR_GREEN

Specifies the color green. INFO

Click to summarize M_COLOR_LIGHT_BLUE

Specifies the color light blue. INFO

Click to summarize M_COLOR_LIGHT_GRAY

Specifies the color light gray. INFO

Click to summarize M_COLOR_LIGHT_GREEN

Specifies the color light green. INFO

Click to summarize M_COLOR_LIGHT_WHITE

Specifies the color light white. INFO

Click to summarize M_COLOR_MAGENTA

Specifies the color magenta. INFO

Click to summarize M_COLOR_RED

Specifies the color red. INFO

Click to summarize M_COLOR_WHITE

Specifies the color white. INFO

Click to summarize M_COLOR_YELLOW

Specifies the color yellow. INFO

Click to summarize M_NO_COLOR

Specifies no color. INFO

Click to summarize M_DRAW_LASER_LINE_COORDINATE_SYSTEM +

Inquires whether to draw the laser line coordinate system's axes. 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 draw the laser line coordinate system's axes.

Click to summarize M_ENABLE

Specifies to draw the laser line coordinate system's axes.

Click to summarize M_DRAW_LASER_PLANE +

Inquires how to draw the laser plane. 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 draw the laser plane.

Click to summarize M_ENABLE

Specifies to draw the laser plane.

Click to summarize M_DRAW_LASER_PLANE_COLOR_FILL +

Inquires the laser plane's fill color. 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_AUTO_COLOR.

Click to summarize M_AUTO_COLOR

Specifies either the color red or the texture image. INFO

Click to summarize M_COLOR_BLACK

Specifies the color black. INFO

Click to summarize M_COLOR_BLUE

Specifies the color blue. INFO

Click to summarize M_COLOR_BRIGHT_GRAY

Specifies the color bright gray. INFO

Click to summarize M_COLOR_CYAN

Specifies the color cyan. INFO

Click to summarize M_COLOR_DARK_BLUE

Specifies the color dark blue. INFO

Click to summarize M_COLOR_DARK_CYAN

Specifies the color dark cyan. INFO

Click to summarize M_COLOR_DARK_GREEN

Specifies the color dark green. INFO

Click to summarize M_COLOR_DARK_MAGENTA

Specifies the color dark magenta. INFO

Click to summarize M_COLOR_DARK_RED

Specifies the color dark red. INFO

Click to summarize M_COLOR_DARK_YELLOW

Specifies the color dark yellow. INFO

Click to summarize M_COLOR_GRAY

Specifies the color gray. INFO

Click to summarize M_COLOR_GREEN

Specifies the color green. INFO

Click to summarize M_COLOR_LIGHT_BLUE

Specifies the color light blue. INFO

Click to summarize M_COLOR_LIGHT_GRAY

Specifies the color light gray. INFO

Click to summarize M_COLOR_LIGHT_GREEN

Specifies the color light green. INFO

Click to summarize M_COLOR_LIGHT_WHITE

Specifies the color light white. INFO

Click to summarize M_COLOR_MAGENTA

Specifies the color magenta. INFO

Click to summarize M_COLOR_RED

Specifies the color red. INFO

Click to summarize M_COLOR_WHITE

Specifies the color white. INFO

Click to summarize M_COLOR_YELLOW

Specifies the color yellow. INFO

Click to summarize M_NO_COLOR

Specifies no color.

Click to summarize M_TEXTURE_IMAGE

Specifies to use the image passed to M3dmapDraw3d() with LaserPlaneTextureImageBufId, when drawing the laser plane. INFO

Click to summarize M_DRAW_LASER_PLANE_COLOR_OUTLINE +

Inquires the laser plane's outline color. 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_COLOR_WHITE.

Click to summarize M_COLOR_BLACK

Specifies the color black. INFO

Click to summarize M_COLOR_BLUE

Specifies the color blue. INFO

Click to summarize M_COLOR_BRIGHT_GRAY

Specifies the color bright gray. INFO

Click to summarize M_COLOR_CYAN

Specifies the color cyan. INFO

Click to summarize M_COLOR_DARK_BLUE

Specifies the color dark blue. INFO

Click to summarize M_COLOR_DARK_CYAN

Specifies the color dark cyan. INFO

Click to summarize M_COLOR_DARK_GREEN

Specifies the color dark green. INFO

Click to summarize M_COLOR_DARK_MAGENTA

Specifies the color dark magenta. INFO

Click to summarize M_COLOR_DARK_RED

Specifies the color dark red. INFO

Click to summarize M_COLOR_DARK_YELLOW

Specifies the color dark yellow. INFO

Click to summarize M_COLOR_GRAY

Specifies the color gray. INFO

Click to summarize M_COLOR_GREEN

Specifies the color green. INFO

Click to summarize M_COLOR_LIGHT_BLUE

Specifies the color light blue. INFO

Click to summarize M_COLOR_LIGHT_GRAY

Specifies the color light gray. INFO

Click to summarize M_COLOR_LIGHT_GREEN

Specifies the color light green. INFO

Click to summarize M_COLOR_LIGHT_WHITE

Specifies the color light white. INFO

Click to summarize M_COLOR_MAGENTA

Specifies the color magenta. INFO

Click to summarize M_COLOR_RED

Specifies the color red. INFO

Click to summarize M_COLOR_WHITE

Specifies the color white.

Click to summarize M_COLOR_YELLOW

Specifies the color yellow. INFO

Click to summarize M_NO_COLOR

Specifies no color.

Click to summarize M_DRAW_LASER_PLANE_OPACITY +

Inquires the laser plane's opacity. 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 20.0.

Click to summarize 0.0 <= Value <= 100.0

Specifies the laser plane's opacity.

1 If you are passing the value in a variable, don't enclose it in MIL_TEXT().

You can add the following value to the above-mentioned value to get the string's length.

function map For getting the string size
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_STRING_SIZE +

Retrieves the length of the string, including the terminating null character ("\0").

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

For a 3D reconstruction result buffer of type M_LASER_CALIBRATION_DATA, M_DEPTH_CORRECTED_DATA, or M_POINT_CLOUD_RESULT, the InquireType parameter can be set to one of the following:

function map For inquiring the maximum number of frames
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_MAX_FRAMES +

Inquires the maximum number of scanned laser lines that the result buffer keeps internally.

When you specify a result buffer of type M_POINT_CLOUD_RESULT with LabelOrIndex set to M_GENERAL, this inquire type returns the maximum number of scanned laser lines that will be used for each subsequent point cloud created in this 3D reconstruction result buffer. 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 1024.

Click to summarize Value > 0

Specifies the maximum number of scanned laser lines to keep.

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

function map For inquiring the default value of an inquire type
Click to summarizeInquireType Description
UserVarPtr
- Possible values returned
Click to summarize M_DEFAULT

Inquires the default value of the specified inquire type.

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

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

function map For inquiring whether an inquire type is supported
Click to summarizeInquireType Description
UserVarPtr
- Possible values returned
Click to summarize M_SUPPORTED

Inquires whether the specified inquire type is supported.

(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_FALSE

Specifies that the inquire type is not supported.

Click to summarize M_TRUE

Specifies that the inquire type is supported.

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

Note: In C++, when using a standard vector (std::vector) instead of an array, the values listed in this combination table must not be used. If you need to use a specific data type, instantiate the vector with the necessary data type.

function map For specifying the data type
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_TYPE_MIL_DOUBLE

Casts the requested information to a MIL_DOUBLE.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_TYPE_MIL_FLOAT

Casts the requested information to a MIL_FLOAT.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_FLOAT  |  array of type MIL_FLOAT [optionally, in C++: a reference to a std::vector<MIL_FLOAT> ] MORE
Click to summarize M_TYPE_MIL_ID

Casts the requested information to a MIL_ID.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_ID  |  array of type MIL_ID [optionally, in C++: a reference to a std::vector<MIL_ID> ] MORE
Click to summarize M_TYPE_MIL_INT

Casts the requested information to a MIL_INT.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT  |  array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE
Click to summarize M_TYPE_MIL_INT16

Casts the requested results to a MIL_INT16.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT16  |  array of type MIL_INT16 [optionally, in C++: a reference to a std::vector<MIL_INT16> ] MORE
Click to summarize M_TYPE_MIL_INT32

Casts the requested information to a MIL_INT32.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT32  |  array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ] MORE
Click to summarize M_TYPE_MIL_INT64

Casts the requested information to a MIL_INT64.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT64  |  array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ] MORE
Return value
The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information.
Compilation information
Header Include mil.h.
Library Use mil.lib; mil3dmap.lib.
DLL Requires mil.dll; mil3dmap.dll.
ALL GENERAL OWNER SYSTEM DEFAULT HOST CALIBRATION DEPTHS CALIBRATION STATUS CALIBRATED GLOBAL OPTIMIZATION ERROR INTERNAL ERROR LASER LINE NOT DETECTED MATHEMATICAL EXCEPTION NOT ENOUGH MEMORY NOT INITIALIZED CAMERA IMAGE SIZE X CAMERA IMAGE SIZE Y CORRECTED DEPTH DEFAULT EXTRACTION FIXED POINT DEFAULT LASER CONTEXT TYPE CALIBRATED CAMERA LINEAR MOTION DEPTH CORRECTION LOCATE PEAK 1D CONTEXT ID NUMBER OF CALIBRATION DEPTHS ASSUMED PERPENDICULAR TO MOTION FALSE TRUE EXTRACTION CHILD OFFSET X DEFAULT EXTRACTION CHILD OFFSET Y DEFAULT EXTRACTION RANGE Z GREATER IN RANGE INFINITE LESS OUT RANGE EXTRACTION RANGE Z LIMIT1 EXTRACTION RANGE Z LIMIT2 FIT RMS ERROR LASER PLANE A LASER PLANE B LASER PLANE C LASER PLANE D SCAN SPEED DEFAULT NUMBER OF COLUMNS NUMBER OF COLUMNS WITH INVERSIONS NUMBER OF COLUMNS WITH MISSING DATA NUMBER OF INVERSIONS PER COLUMN NUMBER OF MISSING DATA PER COLUMN NUMBER OF POINT CLOUDS RESULTS DISPLACEMENT MODE DEFAULT CURRENT FIXED RESULTS DISPLACEMENT Y DEFAULT CAMERA LABEL VALUE LASER LABEL VALUE POINT CLOUD INDEX VALUE INVALID POINT CLOUD LABEL VALUE INVALID NB ELEMENTS DRAW ABSOLUTE COORDINATE SYSTEM DISABLE ENABLE DRAW CAMERA COORDINATE SYSTEM DISABLE ENABLE DRAW CAMERA COORDINATE SYSTEM NAME DEFAULT DRAW COORDINATE SYSTEM LENGTH DRAW FRUSTUM DISABLE ENABLE DRAW FRUSTUM COLOR COLOR BLACK COLOR BLUE COLOR BRIGHT GRAY COLOR CYAN COLOR DARK BLUE COLOR DARK CYAN COLOR DARK GREEN COLOR DARK MAGENTA COLOR DARK RED COLOR DARK YELLOW COLOR GRAY COLOR GREEN COLOR LIGHT BLUE COLOR LIGHT GRAY COLOR LIGHT GREEN COLOR LIGHT WHITE COLOR MAGENTA COLOR RED COLOR WHITE COLOR YELLOW NO COLOR DRAW LASER LINE COORDINATE SYSTEM DEFAULT DISABLE ENABLE DRAW LASER PLANE DEFAULT DISABLE ENABLE DRAW LASER PLANE COLOR FILL DEFAULT AUTO COLOR COLOR BLACK COLOR BLUE COLOR BRIGHT GRAY COLOR CYAN COLOR DARK BLUE COLOR DARK CYAN COLOR DARK GREEN COLOR DARK MAGENTA COLOR DARK RED COLOR DARK YELLOW COLOR GRAY COLOR GREEN COLOR LIGHT BLUE COLOR LIGHT GRAY COLOR LIGHT GREEN COLOR LIGHT WHITE COLOR MAGENTA COLOR RED COLOR WHITE COLOR YELLOW NO COLOR TEXTURE IMAGE DRAW LASER PLANE COLOR OUTLINE DEFAULT COLOR BLACK COLOR BLUE COLOR BRIGHT GRAY COLOR CYAN COLOR DARK BLUE COLOR DARK CYAN COLOR DARK GREEN COLOR DARK MAGENTA COLOR DARK RED COLOR DARK YELLOW COLOR GRAY COLOR GREEN COLOR LIGHT BLUE COLOR LIGHT GRAY COLOR LIGHT GREEN COLOR LIGHT WHITE COLOR MAGENTA COLOR RED COLOR WHITE COLOR YELLOW NO COLOR DRAW LASER PLANE OPACITY DEFAULT STRING SIZE MAX FRAMES DEFAULT DEFAULT SUPPORTED FALSE TRUE TYPE MIL DOUBLE TYPE MIL FLOAT TYPE MIL ID TYPE MIL INT TYPE MIL INT16 TYPE MIL INT32 TYPE MIL INT64 DEFAULT CALIBRATED CAMERA LINEAR MOTION DEFAULT DEPTH CORRECTION DEFAULT DEFAULT DEFAULT DEFAULT GENERAL ALL ALL