| Customize Help
| Save Settings

M3dregAlloc



Function Map
Synopsis
Allocate a 3D registration context.
Syntax
MIL_ID M3dregAlloc(
MIL_ID SysId, //in
MIL_INT64 ContextType, //in
MIL_INT64 ControlFlag, //in
MIL_ID *Context3dregIdPtr //out
)
Description

This function allocates a 3D registration context on the specified system. A 3D registration context contains information needed to perform a registration operation, using M3dregCalculate(). A 3D registration context contains global registration settings and registration elements; each registration element stores the registration information for a single point cloud. Specify how many registration elements are in the 3D registration context using M3dregControl() with M_NUMBER_OF_REGISTRATION_ELEMENTS. This registration information is set using M3dregControl() and M3dregSetLocation().

When the 3D registration context is no longer required, you should release its memory, using M3dregFree().

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
SysId

Specifies the identifier of the system on which to allocate the 3D registration context. Set this parameter to one of the values below:

function map For specifying the system identifier
Click to summarizeValue Description
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().

ContextType

Specifies the type of 3D registration context to allocate. Set this parameter to the value below:

function map For specifying the type of 3D registration context
Click to summarizeValue Description
Click to summarize M_PAIRWISE_REGISTRATION_CONTEXT

Specifies a pairwise 3D registration context.

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

Context3dregIdPtr

Specifies the address of the variable in which to write the pairwise 3D registration context identifier. Since the M3dregAlloc() function also returns the 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 context's identifier. If allocation fails, M_NULL is returned.
Compilation information
Header Include mil.h.
Library Use mil.lib; mil3dreg.lib.
DLL Requires mil.dll; mil3dreg.dll.
DEFAULT HOST PAIRWISE REGISTRATION CONTEXT