M3dmetAlloc

See also

User Guide:

Calculating distance measurements and statistics Performing 3D fitting

Reference:

M3dmetControl M3dmetFit M3dmetFree M3dmetStat MsysAlloc

Availability

Not available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Not supported on:

Not supported on Matrox Indio (Update 53 or Update 68) (w)

Not supported on Matrox Concord PoE with ToE (Update 82) (z)

Fully supported on:

Fully supported on Host system (a)

Fully supported on Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)* (c)

Fully supported on Matrox Morphis (g)

Fully supported on Matrox Morphis QxT (h)

Fully supported on Matrox Orion HD (i)

Fully supported on Matrox Radient eCL (j)

Fully supported on Matrox Radient eV-CXP (MIL 10 or Update 29)* (k)

Fully supported on Matrox Solios eA/XA (l)

Fully supported on Matrox Solios ecl/xcl/ev-cl (m)

Fully supported on Matrox USB3 Vision driver (Update 19) (o)

Fully supported on Matrox RadientPro-CL (Update 7) (p)

Fully supported on Matrox Radient eV-CL (Update 27 or 74) (r)

Fully supported on Matrox Iris GTR (Update 28 or Update 68) (t)

Fully supported on Matrox Clarity UHD (Update 36 or 76) (u)

Fully supported on Matrox GenTL driver (Update 34) (v)

Fully supported on Matrox Rapixo CXP (Update 75 or Update 84) (y)

Fully supported on Matrox Rapixo CL Pro (Update 96) (aa)

* Refer to the MIL system-specific information
in the MIL Reference for the minimum update required.

For any information regarding a MIL system added during a MIL Update, see the MIL system’s release note

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

Function Map

- SysId

Table:

For specifying the system

- ContextType

Table:

For specifying the context object

- ControlFlag

- Context3dmetIdPtr

Return value

Compilation information

Synopsis

Allocate a 3D metrology context.

Syntax

MIL_ID M3dmetAlloc(

MIL_ID SysId,	//in
MIL_INT64 ContextType,	//in
MIL_INT64 ControlFlag,	//in
MIL_ID *Context3dmetIdPtr	//out

)

Description

This function allocates a fit 3D metrology context or statistics 3D metrology context on the specified system.

A 3D metrology context contains all the information to call M3dmetFit() (with fit 3D metrology contexts) or M3dmetStat() (with statistics 3D metrology context). You can modify the settings of a 3D metrology context using M3dmetControl().

When you no longer require a 3D metrology context, release its memory using M3dmetFree().

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

SysId

Specifies the system on which to allocate the 3D metrology context.

This parameter should be set to one of the following values:

For specifying the system
Value	Description
M_DEFAULT_HOST	Specifies the default Host system of the current MIL application.
MIL system identifier	Specifies a valid system identifier, previously allocated using MsysAlloc().

ContextType

Specifies the type of 3D metrology context to allocate. This parameter should be set to one of the following values:

For specifying the context object
Value	Description
M_FIT_CONTEXT	Specifies to allocate a fit 3D metrology context to use with M3dmetFit().
M_STATISTICS_CONTEXT	Allocates a statistics 3D metrology context to use with M3dmetStat().

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

Context3dmetIdPtr

Specifies the address of the variable in which to write the identifier of the 3D metrology context, if allocation is successful. Since M3dmetAlloc() also returns the 3D metrology context identifier, you can set this parameter to M_NULL. If allocation fails, M_NULL is written as the identifier.

Return value

The returned value is the 3D metrology context's identifier if the allocation is successful. If allocation fails, M_NULL is returned.

Compilation information

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