| Customize Help
| Save Settings

MregAlloc


Function Map
Syntax
Description
Parameters
- SystemId
Table: For specifying the system
- RegistrationType
Table: For specifying the type of registration context
- ControlFlag
- ContextIdPtr
Return value
Compilation information
Synopsis
Allocate a registration context.
Syntax
MIL_ID MregAlloc(
MIL_ID SystemId, //in
MIL_INT64 RegistrationType, //in
MIL_INT64 ControlFlag, //in
MIL_ID *ContextIdPtr //out
)
Description

This function allocates a correlation-stitching, depth from focus, extended depth of field (EDoF), high dynamic range, or photometric stereo registration context on the specified system. A registration context contains all the information needed to perform the registration operation, using MregCalculate().

Note that correlation-stitching and photometric stereo contexts contain registration elements and their settings, as well as the global registration settings. When you allocate a correlation-stitching or photometric stereo registration context, it is defined with a default number of registration elements (256 or 16, respectively). You can add or remove registration elements using MregControl() with M_NUMBER_OF_REGISTRATION_ELEMENTS.

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

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
SystemId INQ

Specifies the system on which to allocate the context. This parameter should be set to one of the following values:

function map For specifying the system
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().
RegistrationType

Specifies the type of registration context. This parameter defines the registration operation to perform. This parameter should be set to one of the following values:

function map For specifying the type of registration context
Click to summarizeValue Description
Click to summarize M_DEPTH_FROM_FOCUS

Specifies a registration context for a depth-from-focus registration operation.
Click to summarize M_EXTENDED_DEPTH_OF_FIELD

Specifies a registration context for an extended depth of field registration operation.
Click to summarize M_HIGH_DYNAMIC_RANGE

Specifies a registration context for a high dynamic range registration operation.
Click to summarize M_PHOTOMETRIC_STEREO

Specifies a registration context for a photometric stereo registration operation.
Click to summarize M_STITCHING

Specifies a registration context for a correlation-stitching registration operation.
ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

ContextIdPtr

Specifies the address of the variable in which to write the registration context identifier. Since the MregAlloc() function also returns the registration 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 registration context identifier if the allocation is successful. If allocation fails, M_NULL is returned.
Compilation information
Header Include mil.h.
Library Use mil.lib; milreg.lib.
DLL Requires mil.dll; milreg.dll.
DEFAULT HOST DEPTH FROM FOCUS EXTENDED DEPTH OF FIELD HIGH DYNAMIC RANGE PHOTOMETRIC STEREO STITCHING