MregAlloc

Filters
See also

User Guide:

Extending your depth of field Generating an index map from a scene Steps to performing a correlation-stitching registration

Reference:

MregCalculate MregControl MregFree MsysAlloc

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

depthfromfocus.cpp
mreg.cpp
mreg.cs
mreg.vb
registeredgoldentemplate.cpp
superresolution.cpp
superresolutioncode.cpp
unwarpmultiviewcylinder.cpp

Function Map

- 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 or extended depth of field (EDoF) registration context on the specified system. A registration context contains all the information needed to perform the registration operation, using MregCalculate().

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

Parameters

This function is not supported on the selected boards.

Parameters

SystemId INQ

Specifies the system on which to allocate the 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().

RegistrationType

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

For specifying the type of registration context
Value	Description
M_DEPTH_FROM_FOCUS	Specifies a registration context for a depth-from-focus registration operation.
M_EXTENDED_DEPTH_OF_FIELD	Specifies a registration context for an extended depth of field registration operation.
M_STITCHING	Specifies a registration context for a correlation-stitching registration operation. A correlation-stitching registration context not only includes the global registration settings, it also contains the registration elements and their settings. When you allocate a correlation-stitching registration context, it is defined with a default number of registration elements (256). You can add or remove registration elements using MregControl() with M_NUMBER_OF_ELEMENTS. (summarize) Specifies a registration context for a correlation-stitching registration operation. (more details...)

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.