Table: | For specifying the statistics 3D metrology context, or specific statistic to calculate |
Table: | For specifying the point cloud container or depth map image buffer |
Table: | For specifying the condition |
MIL_ID StatContext3dmetId, | //in |
MIL_ID SrcContainerOrImageBufId, | //in |
MIL_ID RefMilObjectId, | //in |
MIL_ID StatResult3dmetId, | //in |
MIL_INT64 DistanceType, | //in |
MIL_INT64 Condition, | //in |
MIL_DOUBLE CondLow, | //in |
MIL_DOUBLE CondHigh, | //in |
MIL_INT64 ControlFlag | //in |
This function calculates a variety of statistics on the distance measurements collected between a source and reference MIL object.
The specified statistics 3D metrology context establishes which statistics to compute, and the DistanceType and Condition parameters establish the type of distance measurements to use in computing the statistics. Note that you can use a predefined context to calculate a single statistic. In this case, the statistic is calculated using its default settings.
You can use this function to, for example, calculate the mean distance between all points in a point cloud and the center of a 3D sphere geometry object.
Specifies a previously allocated statistics 3D metrology context (used to evaluate multiple statistical calculations), or a predefined statistics 3D metrology context (used to evaluate a single statistical calculation).
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_MAX which is set to M_ENABLE. Use this predefined context to calculate the maximum distance between the point cloud or depth map, and the specified reference object. (summarize)Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_MAX which is set to M_ENABLE. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_MAX_ABS which is set to M_ENABLE. Use this predefined context to calculate the maximum absolute distance between the point cloud or depth map, and the specified reference object. (summarize)Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_MAX_ABS which is set to M_ENABLE. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_MEAN which is set to M_ENABLE. Use this predefined context to calculate the average distance between the point cloud or depth map, and the specified reference object. (summarize)Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_MEAN which is set to M_ENABLE. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_MIN which is set to M_ENABLE. Use this predefined context to calculate the minimum distance between the point cloud or depth map, and the specified reference object. (summarize)Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_MIN which is set to M_ENABLE. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_MIN_ABS which is set to M_ENABLE. Use this predefined context to calculate the minimum absolute distance between the point cloud or depth map, and the specified reference object. (summarize)Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_MIN_ABS which is set to M_ENABLE. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_NUMBER which is set to M_ENABLE. Use this predefined context to calculate the number of points that meet the condition specified using the Condition, CondLow and CondHigh parameters. (summarize)Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_NUMBER which is set to M_ENABLE. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_RMS which is set to M_ENABLE. Use this predefined context to calculate the root-mean-square (RMS) error of the point cloud or depth map, and the specified reference object. (summarize)Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_RMS which is set to M_ENABLE. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_STANDARD_DEVIATION which is set to M_ENABLE. Use this predefined context to calculate the standard deviation of all the distances calculated between the point cloud or depth map, and the specified reference object. (summarize)Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_STANDARD_DEVIATION which is set to M_ENABLE. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_SUM which is set to M_ENABLE. Use this predefined context to calculate the sum of all the distances calculated between the point cloud or depth map, and the specified reference object. (summarize)Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_SUM which is set to M_ENABLE. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_SUM_ABS which is set to M_ENABLE. Use this predefined context to calculate the sum of all the absolute distances calculated between the point cloud or depth map, and the specified reference object. (summarize)Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_SUM_ABS which is set to M_ENABLE. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_SUM_OF_SQUARES which is set to M_ENABLE. Use this predefined context to calculate the sum of squared distances between the point cloud or depth map, and the specified reference object. (summarize)Specifies a predefined statistics 3D metrology context with all the control types (M3dmetControl()) in the context set to their default, except for M_STAT_SUM_OF_SQUARES which is set to M_ENABLE. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() identifier |
Specifies a statistics 3D metrology context identifier, previously allocated using M3dmetAlloc() with M_STATISTICS_CONTEXT. You can specify which statistics calculations are evaluated using M3dmetControl(). (summarize)Specifies a statistics 3D metrology context identifier, previously allocated using M3dmetAlloc() with M_STATISTICS_CONTEXT. (more details...) |
Specifies the source point cloud container or depth map image buffer.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies the identifier of a depth map image buffer. The image buffer must be a 1-band, 8-bit, 16-bit, or 32-bit unsigned buffer. It must contain a fully corrected depth map (that is, if you call McalInquire() with M_DEPTH_MAP, the function returns M_TRUE). The image buffer can have region of interest (ROI) in raster format; only the values inside the ROI will be used in the statistics calculations. (summarize)Specifies the identifier of a depth map image buffer. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies the identifier of a point cloud container. The container must be 3D-processable. You can use MbufInquireContainer() with M_3D_PROCESSABLE to ensure that the container contains a 3D-processable point cloud. (summarize)Specifies the identifier of a point cloud container. (more details...) |
Specifies the identifier of the reference MIL object, with respect to which distances will be measured.
You can set the RefMilObjectId parameter to one of the following values:
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies the XY (Z=0) plane. This is equivalent to passing a 3D plane geometry object, and can therefore be used with the same DistanceType parameter settings. (summarize)Specifies the XY (Z=0) plane. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies the identifier of a 3D geometry object to use as the reference MIL object. The geometry object must have been previously allocated on the required system using M3dgeoAlloc() and must have been successfully defined. Supported 3D geometries include box, cylinder, line, plane, and sphere. (summarize)Specifies the identifier of a 3D geometry object to use as the reference MIL object. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies the identifier of a depth map image buffer. The image buffer must be a 1-band, 8-bit, 16-bit, or 32-bit unsigned buffer. It must contain a fully corrected depth map (that is, if you call McalInquire() with M_DEPTH_MAP, the function returns M_TRUE). The image buffer is allocated using MbufAlloc2d(), and must not have a region of interest (ROI) associated with it. (summarize)Specifies the identifier of a depth map image buffer. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies the identifier of a point cloud container. The container must be 3D-processable. You can use MbufInquireContainer() with M_3D_PROCESSABLE to ensure that the container contains a 3D-processable point cloud. (summarize)Specifies the identifier of a point cloud container. (more details...) |
See the Parameter associations section for possible values that can be specified.
Specifies the identifier of the statistics 3D metrology result buffer in which to store the results. The result buffer must have been allocated using M3dmetAllocResult() with M_STATISTICS_RESULT.
Specifies the type of distance to calculate.
See the Parameter associations section for possible values that can be specified.
Specifies the condition for which distance measurements will be used in statistics calculations.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to use all distance measurements. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to use all distance measurements greater than CondLow. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to use all distance measurements greater than or equal to CondLow. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to use all distance measurements between CondLow and CondHigh (inclusive). |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to use all distance measurements less than CondLow. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to use all distance measurements less than or equal to CondLow. |
The table below lists possible values for the RefMilObjectId and DistanceType parameters.
To specify the type of distance measurement, the DistanceType parameter can be set to one of the following values, depending on the type of reference object (RefMilObjectId) being measured against.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
DistanceType | |||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies a 3D box geometry object, allocated using M3dgeoAlloc() and defined using M3dgeoBox(). (summarize)Specifies a 3D box geometry object, allocated using M3dgeoAlloc() and defined using M3dgeoBox(). (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to calculate the absolute distance to the surface of the box. The returned value is always positive. (summarize)Specifies to calculate the absolute distance to the surface of the box. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to calculate the Manhattan distance to the surface of the box. Distance measurements are positive for points outside the box, and negative for points inside the box. (summarize)Specifies to calculate the Manhattan distance to the surface of the box. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to calculate the signed distance to the surface of the box. Distance measurements are positive for points outside the box, and negative for points inside the box. (summarize)Specifies to calculate the signed distance to the surface of the box. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies a 3D cylinder geometry object, allocated using M3dgeoAlloc() and defined using M3dgeoCylinder(). (summarize)Specifies a 3D cylinder geometry object, allocated using M3dgeoAlloc() and defined using M3dgeoCylinder(). (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to calculate the absolute distance to the surface of the cylinder. The returned value is always positive. (summarize)Specifies to calculate the absolute distance to the surface of the cylinder. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to calculate the distance to the cylinder's central axis. The axis extends infinitely in both directions, even if the cylinder has a finite size. (summarize)Specifies to calculate the distance to the cylinder's central axis. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to calculate the square of the distance to the cylinder's central axis. The axis extends infinitely in both directions, even if the cylinder has a finite size. (summarize)Specifies to calculate the square of the distance to the cylinder's central axis. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to calculate the signed distance to the surface of the cylinder. Distance measurements are positive for points outside the cylinder, and negative for points inside the cylinder. (summarize)Specifies to calculate the signed distance to the surface of the cylinder. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies a 3D line geometry object, allocated using M3dgeoAlloc() and defined using M3dgeoLine(). (summarize)Specifies a 3D line geometry object, allocated using M3dgeoAlloc() and defined using M3dgeoLine(). (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to calculate the distance to the line. The length of the line is respected; if the line is finite, it is not extended infinitely when calculating distances. (summarize)Specifies to calculate the distance to the line. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to calculate the square of the distance to the line. The length of the line is respected; if the line is finite, it is not extended infinitely when calculating distances. (summarize)Specifies to calculate the square of the distance to the line. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies a 3D plane geometry object, allocated using M3dgeoAlloc() and defined using M3dgeoPlane(). When the reference object is a 3D plane geometry object, calculations are quicker if the source object is a depth map rather than a point cloud. (summarize)Specifies a 3D plane geometry object, allocated using M3dgeoAlloc() and defined using M3dgeoPlane(). (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to calculate the absolute distance, perpendicular to the plane. The returned value is always positive. (summarize)Specifies to calculate the absolute distance, perpendicular to the plane. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to calculate the absolute distance along the Z-axis to the plane. The returned value is always positive. (summarize)Specifies to calculate the absolute distance along the Z-axis to the plane. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to calculate the signed distance, perpendicular to the plane. Distance measurements are positive for points on the same side as the plane's normal, and negative on the other side. (summarize)Specifies to calculate the signed distance, perpendicular to the plane. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to calculate the signed distance along the Z-axis to the plane. Distance measurements are positive if the point is above the plane and negative below. (summarize)Specifies to calculate the signed distance along the Z-axis to the plane. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies a 3D sphere geometry object, allocated using M3dgeoAlloc() and defined using M3dgeoSphere(). (summarize)Specifies a 3D sphere geometry object, allocated using M3dgeoAlloc() and defined using M3dgeoSphere(). (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to calculate the absolute distance to the surface of the sphere. The returned value is always positive. (summarize)Specifies to calculate the absolute distance to the surface of the sphere. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to calculate the signed distance to the center of the sphere. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to calculate the square of the distance to the center of the sphere. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to calculate the signed distance to the surface of the sphere. Distance measurements are positive for points outside the sphere, and negative for points inside the sphere. (summarize)Specifies to calculate the signed distance to the surface of the sphere. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies the identifier of a depth map image buffer. The image buffer must be a 1-band, 8-bit, 16-bit, or 32-bit unsigned buffer. It must contain a fully corrected depth map (that is, if you call McalInquire() with M_DEPTH_MAP, the function returns M_TRUE). The image buffer must not have a region of interest (ROI) associated with it. When the source and reference MIL objects are depth maps, calculations are completed more quickly. The speed is further increased if both depth maps use the same calibration context. (summarize)Specifies the identifier of a depth map image buffer. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to calculate the absolute distance to the position in the depth map that is directly above or below the source along the Z-axis. The returned value is always positive. If a point would be projected outside of the depth map, the point is not used in statistics calculations. (summarize)Specifies to calculate the absolute distance to the position in the depth map that is directly above or below the source along the Z-axis. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to calculate the signed distance using the Z-coordinate of the corresponding pixel of the reference depth map. That is, the distance is calculated along the Z-axis. Distance measurements are positive for points above the depth map, and negative for points below the depth map. If a point would be projected outside of the depth map, the point is not used in statistics calculations. (summarize)Specifies to calculate the signed distance using the Z-coordinate of the corresponding pixel of the reference depth map. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies a point cloud container, allocated with MbufAllocContainer() with M_PROC. The function runs much slower when the reference MIL object is a point cloud container. If speed is an issue, you can specify a range for calculating distance measurements using the Condition, CondHigh and CondLow parameters. Any distance measurements outside the specified range are not used in statistics calculations. You can also project the reference point cloud into a fully corrected depth map first (using M3dimProject()), at the cost of precision. (summarize)Specifies a point cloud container, allocated with MbufAllocContainer() with M_PROC. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to calculate the shortest distance to the reference object's mesh. This calculation requires that the reference object have a mesh component. (summarize)Specifies to calculate the shortest distance to the reference object's mesh. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to calculate the distance to the nearest point in the reference point cloud. |
Header | Include mil.h. |
Library | Use mil.lib; mil3dmet.lib. |
DLL | Requires mil.dll; mil3dmet.dll. |