M3dregStream

See also

User Guide:

Steps to perform the pairwise 3D registration operation

Reference:

M3dregSave MsysAlloc

Availability

Not available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux with restrictions

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

None.

Function Map

- SysId

- StreamType

Table:

For specifying the type of stream

- Version

- ControlFlag

- ContextOrResult3dregIdPtr

- SizeByteVarPtr

Parameter Associations

Table:

For performing the stream operation.

Compilation information

Synopsis

Load, restore, or save a 3D registration context or result buffer from/to a file or memory stream.

Syntax

void M3dregStream(

MIL_TEXT_PTR MemPtrOrFileName,	//in-out
MIL_ID SysId,	//in
MIL_INT64 Operation,	//in
MIL_INT64 StreamType,	//in
MIL_DOUBLE Version,	//in
MIL_INT64 ControlFlag,	//in
MIL_ID *ContextOrResult3dregIdPtr,	//in-out
MIL_INT *SizeByteVarPtr	//out

)

Description

This function can load, restore, or save a 3D registration context and/or a 3D registration result buffer from/to a file or memory stream.

To inquire the number of bytes necessary to save a registration context or result buffer to a memory stream, you should first call this function (M3dregStream()) with M_INQUIRE_SIZE_BYTE.

The content saved to memory stream is equivalent to the content saved to file. This function is equivalent to a file saved using M3dregSave().

You can use this and other MIL stream functions, for example, to save all required MIL objects, as well as any other custom data, for your application to a memory stream. Once in a memory stream, you can write the stream to a single file or transfer it over a network. You are responsible for concatenating the streams and for saving the stream to file.

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

MemPtrOrFileName

Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):

MIL_TEXT_PTR [optionally, in C++: a reference to a MIL_STRING]
Optionally, in C++: a reference to a std::vector of type MIL_UINT8

Specifies the file or memory stream.

See the Parameter associations section for possible values that can be returned/specified.

SysId

Specifies the system on which to restore the 3D registration context or 3D registration result buffer.

See the Parameter associations section for possible values that can be specified.

Operation

Specifies the operation to perform.

See the Parameter associations section for possible values that can be specified.

StreamType

Specifies the type of stream in which to store/from which to restore the pairwise 3D registration context or pairwise 3D registration result buffer. This parameter must be set to one of the following values:

For specifying the type of stream
Value	Description
M_FILE	Specifies a file stream.
M_MEMORY	Specifies a memory stream. You are responsible for allocating a block of memory for the stream. (summarize) Specifies a memory stream. (more details...)

Version

Specifies the MIL version of the 3D registration context or result buffer.

See the Parameter associations section for possible values that can be specified.

ControlFlag

Reserved for future expansion. This parameter must be set to M_DEFAULT.

ContextOrResult3dregIdPtr

Specifies the address of the variable in which to write or from which to read the identifier of the 3D registration context or result buffer. If the M_RESTORE operation is not successful, M_NULL is returned.

See the Parameter associations section for possible values that can be returned/specified.

SizeByteVarPtr

Specifies the address of the variable in which to write the size of the 3D registration context or result buffer, in bytes.

If the size is not required, you can set this parameter to M_NULL.

Note that the size of the 3D registration context or result buffer will vary depending on the MIL version specified.

Parameter associations

The table below lists possible values for the MemPtrOrFileName, SysId, Operation, Version, and ContextOrResult3dregIdPtr parameters.

For performing the stream operation.

For performing the stream operation.
Operation			Description
	MemPtrOrFileName - Possible values passed or returned
	SysId
	Version
	ContextOrResult3dregIdPtr - Possible values passed or returned
M_INQUIRE_SIZE_BYTE			Inquires the number of bytes required to save a 3D registration context or result buffer to memory stream. This operation is not supported when the StreamType parameter is set to M_FILE. (summarize) Inquires the number of bytes required to save a 3D registration context or result buffer to memory stream. (more details...)
	MemPtrOrFileName		This parameter must be set to M_NULL. (summarize) This parameter must be set to M_NULL. (more details...)
	SysId		This parameter must be set to M_NULL. (summarize) This parameter must be set to M_NULL. (more details...)
	Version		Specifies the MIL version with which the 3D registration context or result buffer must be compatible when saved. The size of a 3D registration context or result buffer might differ from one MIL version to another. (summarize) Specifies the MIL version with which the 3D registration context or result buffer must be compatible when saved. (more details...)
		M_DEFAULT	Specifies the current version of MIL.
		M_PROC_VERSION_100_SP4	Specifies the version as being MIL 10 Service Pack 4.
	ContextOrResult3dregIdPtr		Specifies the address of the variable containing the identifier of the 3D registration context or result buffer. (summarize) Specifies the address of the variable containing the identifier of the 3D registration context or result buffer. (more details...)
M_LOAD			Loads the content of a specified file or memory stream into a previously allocated 3D registration context or result buffer. (summarize) Loads the content of a specified file or memory stream into a previously allocated 3D registration context or result buffer. (more details...)
	MemPtrOrFileName		Specifies the file or memory stream from which to load the context. (summarize) Specifies the file or memory stream from which to load the context. (more details...)
		M_INTERACTIVE	[This is only applicable to Windows] Opens a dialog box from which you can interactively specify the drive, directory, and name of the file, when the StreamType parameter is set to M_FILE.
		MIL_TEXT("FileName") ¹	Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"), when the StreamType parameter is set to M_FILE. 3D registration contexts or result buffers typically have an M3DREG file extension. The function handles (internally) the opening and closing of the file. To specify a file on a remote computer (under Distributed MIL), prefix the specified file name string with "remote:///" (for example, "remote:///C:\mydirectory\myfile"). (summarize) Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"), when the StreamType parameter is set to M_FILE. (more details...)
		MemPtr	Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. The block of memory should be of type MIL_UINT8. The specified address must correspond to the first memory address in which the object is located, and the block of memory must contain the entire object. Note that when using a C compiler (not a C++ or other compiler), you must cast the MIL_UINT8 pointer to a MIL_TEXT_PTR. (summarize) Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. (more details...)
	SysId		This parameter must be set to M_NULL. (summarize) This parameter must be set to M_NULL. (more details...)
	Version		This parameter must be set to M_DEFAULT. (summarize) This parameter must be set to M_DEFAULT. (more details...)
	ContextOrResult3dregIdPtr		Specifies the address of the variable containing the identifier of the 3D registration context or result buffer. All previous settings are overwritten with those of the loaded context or result buffer, or are set to the default value if the settings didn't exist in the version of MIL from which the context or result buffer is being loaded. (summarize) Specifies the address of the variable containing the identifier of the 3D registration context or result buffer. (more details...)
M_RESTORE			Restores a 3D registration context or result buffer from a file or memory stream and assigns it a MIL identifier. (summarize) Restores a 3D registration context or result buffer from a file or memory stream and assigns it a MIL identifier. (more details...)
	MemPtrOrFileName		Specifies the file or memory stream from which to restore the context. (summarize) Specifies the file or memory stream from which to restore the context. (more details...)
		M_INTERACTIVE	[This is only applicable to Windows] Opens a dialog box from which you can interactively specify the drive, directory, and name of the file, when the StreamType parameter is set to M_FILE.
		MIL_TEXT("FileName") ¹	Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"), when the StreamType parameter is set to M_FILE. 3D registration contexts or result buffers typically have an M3DREG file extension. The function handles (internally) the opening and closing of the file. To specify a file on a remote computer (under Distributed MIL), prefix the specified file name string with "remote:///" (for example, "remote:///C:\mydirectory\myfile"). (summarize) Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"), when the StreamType parameter is set to M_FILE. (more details...)
		MemPtr	Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. The block of memory should be of type MIL_UINT8. The specified address must correspond to the first memory address in which the object is located, and the block of memory must contain the entire object. Note that when using a C compiler (not a C++ or other compiler), you must cast the MIL_UINT8 pointer to a MIL_TEXT_PTR. (summarize) Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. (more details...)
	SysId		Specifies the system on which to allocate the 3D registration context or result buffer. (summarize) Specifies the system on which to allocate the 3D registration context or result buffer. (more details...)
		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().
	Version		This parameter must be set to M_DEFAULT. (summarize) This parameter must be set to M_DEFAULT. (more details...)
	ContextOrResult3dregIdPtr		Specifies the address of the variable in which to write the identifier of the 3D registration context or result buffer. If the operation is not successful, M_NULL is returned. (summarize) Specifies the address of the variable in which to write the identifier of the 3D registration context or result buffer. (more details...)
M_SAVE			Saves a 3D registration context or the contents of a registration result buffer to a specified file or memory stream. (summarize) Saves a 3D registration context or the contents of a registration result buffer to a specified file or memory stream. (more details...)
	MemPtrOrFileName		Specifies the file or memory stream. (summarize) Specifies the file or memory stream. (more details...)
		M_INTERACTIVE	[This is only applicable to Windows] Opens a dialog box from which you can interactively specify the drive, directory, and name of the file, when the StreamType parameter is set to M_FILE.
		MIL_TEXT("FileName") ¹	Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"), when the StreamType parameter is set to M_FILE. For easier use with other Matrox Imaging software products, when saving a 3D registration context or result to a file, use the M3DREG file extension. The function handles (internally) the opening and closing of the file. If the file already exists, it will be overwritten. To specify a file on a remote computer (under Distributed MIL), prefix the specified file name string with "remote:///" (for example, "remote:///C:\mydirectory\myfile"). (summarize) Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"), when the StreamType parameter is set to M_FILE. (more details...)
		MemPtr	Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. The block of memory should be of type MIL_UINT8. The specified address must correspond to the first memory address in which to write, and the block of memory must be large enough to stream the entire object. To determine the required size, call this function with M_INQUIRE_SIZE_BYTE. Note that when using a C compiler (not a C++ or other compiler), you must cast the MIL_UINT8 pointer to a MIL_TEXT_PTR. (summarize) Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. (more details...)
	SysId		This parameter must be set to M_NULL. (summarize) This parameter must be set to M_NULL. (more details...)
	Version		Specifies the MIL version with which the 3D registration context or result buffer must be compatible when saved. (summarize) Specifies the MIL version with which the 3D registration context or result buffer must be compatible when saved. (more details...)
		M_DEFAULT	Specifies the current version of MIL.
		M_PROC_VERSION_100_SP4	Specifies the version as being MIL 10 Service Pack 4.
	ContextOrResult3dregIdPtr		Specifies the address of the variable containing the identifier of the 3D registration context or result buffer to save. (summarize) Specifies the address of the variable containing the identifier of the 3D registration context or result buffer to save. (more details...)

¹ If you are passing the value in a variable, don't enclose it in MIL_TEXT().

Compilation information

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