M3dmetCopyResult

See also

User Guide:

How to fixture in 3D Performing 3D fitting Working with 3D

Reference:

M3dmetAllocResult M3dmetFit M3dmetGetResult MbufInquire

Availability

Not available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

3dcadregistration.cpp
3dplanarity.cpp
3dplanefit.cpp
bottlecapinspection.cpp
mechanicalpartscan.cpp
pointcloudprojection.cpp
sphereinspection.cpp
studinspection.cpp

Function Map

Parameter Associations

Table:

For specifying the destination object and copy type for a 3D metrology result buffer

Compilation information

Synopsis

Copy a group of results from a fit 3D metrology result buffer into an image buffer, 3D geometry object, or a transformation matrix.

Syntax

void M3dmetCopyResult(

MIL_ID SrcResult3dmetId,	//in
MIL_ID DstMilObjectId,	//in
MIL_INT64 CopyType,	//in
MIL_INT64 ControlFlag	//in

)

Description

This function copies a group of results from a 3D metrology result buffer into an image buffer, 3D geometry object, or a transformation matrix.

The copy operations that are available depends on the resulting status of the fit operation. To retrieve the status of the fit operation, use M3dmetGetResult() with M_STATUS.

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 if there is complementary information.

Parameters

This function is not supported on the selected boards.

Parameters

SrcResult3dmetId

Specifies the identifier of the fit 3D metrology result buffer from which to copy results. The fit 3D metrology context must have been allocated using M3dmetAllocResult() with M_FIT_RESULT, and must contain the results of a call to M3dmetFit().

DstMilObjectId

Specifies the identifier of the image buffer, 3D geometry object, or transformation matrix object into which the results will be copied.

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

CopyType

Specifies the type of copy operation to perform. Some copy types require the fit operation to have completed with a specific status.

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

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

Parameter associations

The table below lists possible values for the DstMilObjectId and CopyType parameters.

For specifying the destination object and copy type for a 3D metrology result buffer

For specifying the destination object and copy type for a 3D metrology result buffer
CopyType		Description
	DstMilObjectId	Description
M_FITTED_GEOMETRY		Specifies to copy the fitted 3D geometry object. 3D cylinder geometry objects and 3D line geometry objects copied using this copy operation will always be finite. Note that, you can only perform this copy operation if the fit operation completed successfully. (summarize) Specifies to copy the fitted 3D geometry object. (more details...)
	MIL 3D geometry object identifier	Specifies the identifier of a 3D geometry object in which to copy results.
M_FIXTURING_MATRIX		Specifies to initialize a transformation matrix object with the transformation matrix that can fixture the fitted 3D geometry to a position near the origin. If the fitted geometry is a plane, the matrix is initialized with the transformation that could move the plane to the XY-plane (Z=0), with its normal as the Z-axis. The centroid of all inlier points becomes the origin. If the fitted geometry is a cylinder or line, the matrix is initialized with the transformation that could move the starting point of the geometry to the origin, and the central axis to the Z-axis. If the fitted geometry is a sphere, the matrix is initialized with the transformation that could move the center of the sphere to the origin. Note that, you can only perform this copy operation if the fit operation completed successfully. (summarize) Specifies to initialize a transformation matrix object with the transformation matrix that can fixture the fitted 3D geometry to a position near the origin. (more details...)
	MIL 3D transformation matrix object identifier	Specifies the identifier of a 3D transformation matrix object in which to copy results.
M_INLIER_MASK		Specifies to copy the points that were considered inliers during the fit. That is, points that were considered inliers will have a confidence score of 255 in the destination image buffer, and all other points will have a confidence score of 0. Note that, you can perform this copy operation whether the fit operation completed successfully or not, as long as a call to M3dmetFit() was made. (summarize) Specifies to copy the points that were considered inliers during the fit. (more details...)
	Image buffer identifier	Specifies the identifier of an image buffer in which to copy results. The image buffer must be a 1-band, 8-bit unsigned image buffer. This image buffer must have a size equal to the number of points used during the fit. You can inquire this value using M3dmetGetResult() with M_NUMBER_OF_POINTS_TOTAL. This image buffer must not have a region of interest (ROI) associated with it. Using an image buffer with an ROI will cause an error. (summarize) Specifies the identifier of an image buffer in which to copy results. (more details...)
M_OUTLIER_MASK		Specifies to copy the points that were considered outliers during the fit. That is, points that were considered outliers will have a confidence score of 255 in the destination image buffer, and all other points will have a confidence score of 0. Note that, you can perform this copy operation whether the fit operation completed successfully or not, as long as a call to M3dmetFit() was made. (summarize) Specifies to copy the points that were considered outliers during the fit. (more details...)
	Image buffer identifier	Specifies the identifier of an image buffer in which to copy results. The image buffer must be a 1-band, 8-bit unsigned image buffer. This image buffer must have a size equal to the number of points used during the fit. You can inquire this value using M3dmetGetResult() with M_NUMBER_OF_POINTS_TOTAL. This image buffer must not have a region of interest (ROI) associated with it. Using an image buffer with an ROI will cause an error. (summarize) Specifies the identifier of an image buffer in which to copy results. (more details...)

Compilation information

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