Filters
Filter values by
Buffer type
  • Array buffer
  • Image buffer
    • Common to all
    • Compressed attribute specific
  • Kernel buffer
  • LUT buffer
  • Structuring element buffer
Component type
  • Range component
  • Disparity component
| Customize Help
| Save Settings

MbufControl


Function Map
Syntax
Description
Parameters
- BufId
- ControlType
- ControlValue
Parameter Associations
Table: For specifying general buffer settings
+ combination: For specifying whether Matrox Feature Browser should be synchronous or asynchronous
+ combination: For M_LOCK (Read and write permission)
Table: For specifying image buffer settings
Table: For M_IMAGE + M_COMPRESS image buffers
+ combination: For specifying the color bands to affect
Table: For controlling general neighborhood operation settings of an M_KERNEL or an M_STRUCT_ELEMENT data buffer
Table: For the neighborhood operation settings of M_KERNEL data buffers
Table: For specifying settings useful with buffers that are components
Table: For specifying settings useful with image buffers that store 3D data and are components
Remarks
Type-specific versions of the function when using a C compiler under 64-bit
Compilation information
Synopsis
Control a specified data buffer setting.
Syntax
void MbufControl(
MIL_ID BufId, //in
MIL_INT64 ControlType, //in
MIL_DOUBLE ControlValue //in
)
Description

This function allows you to control a specified data buffer setting.

Note that when using a C compiler (not a C++ or other compiler) in 64-bit mode, MbufControl() internally calls the MIL_INT64 version of this function (MbufControlInt64()). If you need to pass floating-point values, call the MIL_INT64 version of this function (MbufControlDouble()).
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
BufId

Specifies the identifier of the buffer to control.

ControlType

Specifies the buffer setting to control.

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

ControlValue

Specifies the value needed for the setting.

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

Parameter associations

The tables below list possible values for the ControlType and ControlValue parameters.

The following ControlType and corresponding ControlValue parameter settings are used to control general buffer settings.

function map For specifying general buffer settings
Click to summarize
ControlType		 Description MIL system-specific
tooltip (‡)
ControlValue
Click to summarize M_ASSOCIATED_LUT

Sets whether to associate or disassociate a LUT buffer with the specified image buffer. The image buffer must be a 1-band 8-bit or 16-bit buffer. INQ

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_DEFAULT

Specifies to remove the association between the LUT buffer and the image buffer.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize MIL LUT buffer identifier

Specifies the MIL identifier of the LUT buffer to associate with the image buffer. If and when the image buffer is selected to a display, the required changes occur to produce the display effect of the LUT, unless the display is also associated with a LUT (MdispLut()). If associated with a LUT buffer, the image buffer cannot be selected to a display whose view mode is set to M_AUTO_SCALE or M_MULTI_BYTES.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_DC_ALLOC
[This is only applicable to Windows]

Allocates a device context (DC) for drawing. Determine the DC handle (HDC) using MbufInquire() with the M_DC_HANDLE inquire type. When using this control type, the buffer should be internally stored in M_GDI format, and cannot be a child buffer. No MIL operation can be done between a device context allocation and free, therefore you should use the device context for a short period of time.

(summarize)
‡ a c
M10		 g h l m o v
Click to summarize M_DEFAULT

Implements the default behavior.

 ‡ a c
M10		 g h l m o v
Click to summarize M_DC_FREE
[This is only applicable to Windows]

Frees a device context (DC).

(summarize)
‡ a c
M10		 g h l m o v
Click to summarize M_DEFAULT

Implements the default behavior.

 ‡ a c
M10		 g h l m o v
Click to summarize M_GC_FEATURE_BROWSER

Sets whether to open or close a dialog box that allows you to view and edit the GenTL buffer configuration information interactively, using Matrox Feature Browser.

(summarize)
‡ v
Click to summarize M_DEFAULT

Same as M_OPEN.

 ‡ v
Click to summarize M_CLOSE

Closes Matrox Feature Browser.

 ‡ v
Click to summarize M_OPEN +

Opens Matrox Feature Browser.


You must specify a combination value from the following table:
(summarize)
‡ v
Click to summarize M_LOCK +

Locks the specified buffer to allow a memory pointer to obtain a valid buffer address. The address is valid while the buffer is locked, but becomes invalid after it is unlocked. The calling thread will be blocked if the buffer is already locked by a different thread.

To unlock the specified buffer, use M_UNLOCK.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_DEFAULT

Implements the default behavior.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_MAP

Maps or unmaps the buffer to the memory address space of the process. Note that, to use this control, the buffer must be allocated with the M_MAPPABLE attribute.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_DISABLE

Unmaps the buffer from the address space of the process. This sets the buffer's Host address to M_NULL.

This is the default value.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_ENABLE

Maps the buffer to the address space of the process. This associates the buffer with a logical Host address.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_MAX

Sets the expected maximum pixel value of the buffer. This information is used to optimize certain processing operations on the buffer and the display of the buffer. Note that this information is not validated against the content of the buffer and is not updated automatically.

M_MIN and M_MAX should specify the expected range of pixel values in the buffer. Pixel values between M_MIN and M_MAX are remapped linearly to values between the minimum and maximum possible display values.

Note that M_MIN and M_MAX cannot be used with child buffers; this information is obtained directly from the parent buffer. INQ

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize Value

Specifies the expected maximum pixel value within the range of the buffer type. For example, for an 8-bit unsigned buffer, set this value to a value between 0 and 255, inclusive.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_MIN

Sets the expected minimum pixel value of the buffer. This information is used to optimize certain processing operations on the buffer and the display of the buffer. Note that this information is not validated against the content of the buffer and is not updated automatically.

M_MIN and M_MAX should specify the expected range of pixel values in the buffer. Pixel values between M_MIN and M_MAX are remapped linearly to values between the minimum and maximum possible display values.

Note that M_MIN and M_MAX cannot be used with child buffers; this information is obtained directly from the parent buffer. INQ

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize Value

Specifies the expected minimum pixel value within the range of the buffer type. For example, for an 8-bit unsigned buffer, set this value to a value between 0 and 255, inclusive.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_MODIFICATION_HOOK

Sets whether to run the user-defined functions hooked to the buffer's modification event upon the event. These user-defined functions are initially hooked to the buffer modification event using MbufHookFunction(). INQ

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_DISABLE

Specifies that the user-defined functions should not be called.

Note that the modification counter of the image buffer will still be incremented. To inquire the count, use MbufInquire() with M_MODIFICATION_COUNT.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_ENABLE

Specifies that the user-defined functions should be called.

This is the default value.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_MODIFIED

Signals MIL that the buffer content was modified without using MIL. This control must be used to ensure that MIL updates its internal information on the buffer. For example, if a display buffer was modified outside MIL, the display will not be updated until you use this control. Note, if only a certain region of the buffer was modified, it is more efficient to specify an appropriate child buffer as BufId.

If a specific area of the buffer was modified without using MIL, it is faster to use MbufControlArea() with the control type to signal MIL to update the content of the specified area of the buffer.

M_MODIFIED increments the buffer's modification counter. You can inquire about the counter's current value using MbufInquire() with M_MODIFICATION_COUNT.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_DEFAULT

Implements the default behavior.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_UNLOCK

Unlocks the specified buffer.

The buffer must have been previously locked with M_LOCK.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_DEFAULT

Implements the default behavior.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_XPIXMAP_ALLOC
[This is only applicable to Linux]

Allocates a device context for drawing. Determine the device context handle using MbufInquire() with the M_XPIXMAP_HANDLE inquire type. When using this control type, the buffer should be internally stored in M_LINUX_MXIMAGE format. No MIL operation can be done between a device context allocation and free, therefore you should use the device context for a short period of time.

(summarize)
‡ a c
M10		 g h j k
M10		 l m o p r
U27		 v y
U75		 aa
Click to summarize M_DEFAULT

Implements the default behavior.

 ‡ a c
M10		 g h j k
M10		 l m o p r
U27		 v y
U75		 aa
Click to summarize M_XPIXMAP_FREE
[This is only applicable to Linux]

Frees a pixmap.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_DEFAULT

Implements the default behavior.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Combination values for M_OPEN (when ControlType=M_GC_FEATURE_BROWSER and ControlValue=M_OPEN).

You must add one of the following values to the above-mentioned value to set whether the Feature Browser should be synchronous or asynchronous.

function map For specifying whether Matrox Feature Browser should be synchronous or asynchronous
Click to summarizeCombination value Description MIL system-specific
tooltip (‡)
Click to summarize M_ASYNCHRONOUS

Specifies that this function returns immediately once Matrox Feature Browser window opens.

 ‡ v
Click to summarize M_SYNCHRONOUS

Specifies that this function is blocked until Matrox Feature Browser window closes.

This is the default value.

(summarize)
‡ v
Combination values for M_LOCK.

You can add one or more of the following values to the above-mentioned value to set the buffer's read and write permission.

function map For M_LOCK (Read and write permission)
Click to summarize
Combination value		 Description
Click to summarize M_READ

Locks the buffer to be read only.
Click to summarize M_READ+M_WRITE

Locks the buffer to be read and write.

This is the default value.

(summarize)
Click to summarize M_WRITE

Locks the buffer to be write only.

For buffers with an M_IMAGE attribute, ControlType and ControlValue can also be set to one of the values below.

function map For specifying image buffer settings
Click to summarize
ControlType		 Description MIL system-specific
tooltip (‡)
ControlValue
Click to summarize M_REGION_USE

Sets whether the ROI associated with the image buffer is used with supported image processing operations. This setting is ignored if the buffer is not associated with an ROI.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_IGNORE

Specifies that image processing functions will ignore the ROI associated with the buffer.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_USE

Specifies that image processing functions will use the ROI associated with the buffer.

This is the default value.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_RESOLUTION_X

Sets the X-resolution of the image buffer in pixels per inch (PPI). Typically, you would specify the X-resolution if you are exporting the image, using MbufExport(), for third-party software that makes use of the specified pixels per inch. INQ

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_DEFAULT

Specifies an X resolution of 72 PPI.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize Value > 0.0

Specifies the X resolution in PPI.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_RESOLUTION_Y

Sets the Y-resolution of the image buffer in pixels per inch (PPI). Typically, you would specify the Y-resolution if you are exporting the image, using MbufExport(), for third-party software that makes use of the specified pixels per inch. INQ

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_DEFAULT

Specifies a Y resolution of 72 PPI.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize Value > 0.0

Specifies the Y resolution in PPI.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_YCBCR_RANGE

Sets whether the YUV buffer's pixel values are YCbCr encoded; this limits the range of the buffer's pixel values. The Y-band's pixel values are limited between 16 and 235. The Cb- and Cr-bands are limited to pixel values between 16 and 240.

This control type is not supported for an RGB buffer. The buffer must be of an uncompressed packed YUV16 type; otherwise, it will generate an error. INQ

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
MIL system specific

When grabbing into the specified buffer from a source that transmits in a YCbCr format (for example, an SDI source), the data is not converted to match the encoding that you specify. Instead, this control type is automatically changed to match the encoding of the grabbed data.

 ‡ i u
U36
Click to summarize M_DISABLE

Specifies not to encode the YUV buffer's pixel values in YCbCr.

This is the default value.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_YCBCR_HD

Specifies to encode the YUV buffer's pixel values using the high-definition YCbCr standard.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_YCBCR_SD

Specifies to encode the YUV buffer's pixel values using the standard-definition YCbCr standard.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_YCBCR_UHD

Specifies to encode the YUV buffer's pixel values using the ultra-high-definition YCbCr standard.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa

For buffers with an M_IMAGE + M_COMPRESS attribute, ControlType and ControlValue can also be set to one of the values below.

Note that, if the buffer contains any data, setting one of these control types automatically deletes the data. This is because, for MIL to decompress the buffer's data, it must know the control values that were used in the compression. If you change one of these controls, MIL will be unable to decompress the data and the data is therefore irrelevant. Note that the control type M_TARGET_SIZE is the only control type that can be changed without affecting the data. For more information, see Chapter 28: JPEG and JPEG2000 compression.

function map For M_IMAGE + M_COMPRESS image buffers
Click to summarize
ControlType		 Description
ControlValue
Click to summarize M_DECOMPOSITION_LEVEL +

Sets the number of iterations (decomposition levels) the discrete wavelet transform is applied to the image. This control type is only supported with JPEG2000 buffers (both lossy and losseless).

The number of decomposition levels is applied to all bands by default. INQ

(summarize)
Click to summarize Value >= 0

Specifies the number of iterations (decomposition levels). Only integer values are accepted.

(summarize)
Click to summarize M_HUFFMAN_AC

Associates an AC Huffman table to the buffer. This control type is only supported with JPEG lossy buffers. INQ

(summarize)
Click to summarize MIL M_ARRAY buffer identifier

Specifies the identifier of the array buffer containing the table. If the buffer is 3-band, the same table is applied to all bands.

(summarize)
Click to summarize M_HUFFMAN_AC_CHROMINANCE

Associates an AC Huffman table to the U and V bands (chrominance) of the buffer. This control type is only supported with JPEG lossy buffers in YUV format. INQ

(summarize)
Click to summarize MIL M_ARRAY buffer identifier

Specifies the identifier of the array buffer containing the table.
Click to summarize M_HUFFMAN_AC_LUMINANCE

Associates an AC Huffman table to the Y band (luminance) of the buffer. This control type is only supported with JPEG lossy buffers in YUV format. INQ

(summarize)
Click to summarize MIL M_ARRAY buffer identifier

Specifies the identifier of the array buffer containing the table.
Click to summarize M_HUFFMAN_DC

Associates a DC Huffman table to the buffer. This control type is only supported with JPEG buffers (both lossy and lossless). INQ

(summarize)
Click to summarize MIL M_ARRAY buffer identifier

Specifies the identifier of the array buffer containing the table. If the buffer is 3-band, the same table is applied to all bands.

(summarize)
Click to summarize M_HUFFMAN_DC_CHROMINANCE

Associates a DC Huffman table to the U and V bands (chrominance) of the buffer. This control type is only supported with JPEG lossy buffers in YUV format. INQ

(summarize)
Click to summarize MIL M_ARRAY buffer identifier

Specifies the identifier of the array buffer containing the table.
Click to summarize M_HUFFMAN_DC_LUMINANCE

Associates a DC Huffman table to the Y band (luminance) of the buffer. This control type is only supported with JPEG lossy buffers in YUV format. INQ

(summarize)
Click to summarize MIL M_ARRAY buffer identifier

Specifies the identifier of the array buffer containing the table.
Click to summarize M_PREDICTOR

Sets the type of predictor. This control type is only supported with JPEG lossless buffers. If the buffer is 3-band, the same predictor is applied to all bands. INQ

(summarize)
Click to summarize 0

Specifies predictor #0 (no prediction).
Click to summarize 1

Specifies predictor #1 (the "pixel-to-the-left" predictor).

This is the default value.

(summarize)
Click to summarize 2

Specifies predictor #2 (the "pixel-above" predictor).
Click to summarize M_Q_FACTOR +

Sets the quantization factor. This control type is only supported with lossy buffers.

For JPEG lossy buffers, the Q factor is always applied to all bands.

For JPEG2000 lossy buffers, the Q factor is applied to all bands by default. To change this default behavior, see the combination values below. INQ

(summarize)
Click to summarize 1 <= Value <= 99

Specifies the quantization factor. Only integer values are accepted. The higher the factor, the more the compression, but the lower the image quality.

The default value is 50.

(summarize)
Click to summarize M_Q_FACTOR_CHROMINANCE

Sets the chrominance quantization factor. This control type is only supported with JPEG or JPEG2000 lossy buffers in YUV format. INQ

(summarize)
Click to summarize 1 <= Value <= 99

Specifies the factor. Only integer values are accepted. The higher the factor, the more the compression, but the lower the image quality.

The factor is applied to the U and V bands (chrominance).

The default value is 50.

(summarize)
Click to summarize M_Q_FACTOR_LUMINANCE

Sets the luminance quantization factor. This control type is only supported with JPEG or JPEG2000 lossy buffers in YUV format. INQ

(summarize)
Click to summarize 1 <= Value <= 99

Specifies the factor. Only integer values are accepted. The higher the factor, the more the compression, but the lower the image quality.

The factor is applied only to the Y band (luminance).

The default value is 50.

(summarize)
Click to summarize M_QUANTIZATION +

Associates a quantization table to the buffer. This control type is only supported with lossy buffers.

For JPEG lossy buffers, this table is associated with all bands.

For JPEG2000 lossy buffers, this table is associated with all bands by default.

Note that setting this control type will reset the M_Q_... control types to their default value (50). If you set the M_Q_FACTOR control type after specifying a custom table with the M_QUANTIZATION control type, the custom table will be scaled accordingly. INQ

(summarize)
Click to summarize MIL M_ARRAY buffer identifier

Specifies the identifier of the array buffer containing the table.
Click to summarize M_QUANTIZATION_CHROMINANCE

Associates a quantization table to the U and V bands (chrominance) of the buffer. This control type is only supported with JPEG or JPEG2000 lossy buffers in YUV format.

Note that setting this control type will reset the M_Q_FACTOR_CHROMINANCE control type to its default value (50). If you set a M_Q_... control type after specifying a custom table with the M_QUANTIZATION_CHROMINANCE control type, the custom table will be scaled accordingly. INQ

(summarize)
Click to summarize MIL M_ARRAY buffer identifier

Specifies the identifier of the array buffer containing the table.
Click to summarize M_QUANTIZATION_LUMINANCE

Associates a quantization table to the Y band (luminance) of the buffer. This control type is only supported with JPEG or JPEG2000 lossy buffers in YUV format.

Note that setting this control type will reset the M_Q_FACTOR_LUMINANCE control type to its default value (50). If you set a M_Q_... control type after specifying a custom table with the M_QUANTIZATION_LUMINANCE control type, the custom table will be scaled accordingly. INQ

(summarize)
Click to summarize MIL M_ARRAY buffer identifier

Specifies the identifier of the array buffer containing the table.
Click to summarize M_RESTART_INTERVAL

Sets the number of rows or 8x8 blocks between restart markers in a compressed image. INQ

(summarize)
Click to summarize Value >= 0

Specifies after how many rows (for JPEG lossless buffers) or 8x8 blocks (for JPEG lossy buffers) of data to place restart markers. Only integer values are accepted. The default value is 8 for JPEG lossy buffers and 2 for JPEG lossless buffers.

(summarize)
Click to summarize M_TARGET_SIZE

Sets the size of the buffer into which the source image is compressed. This control type is only supported with JPEG2000 lossy buffers.

To ensure that the compressed data fits into the specified buffer size, less-significant data is discarded. INQ

(summarize)
Click to summarize Value > 0

Specifies the size, in bytes. Only integer values are accepted.

(summarize)
Combination values for M_DECOMPOSITION_LEVEL; M_Q_FACTOR; M_QUANTIZATION.

You can add one of the following values to the above-mentioned values to specify the color bands to affect.

When dealing with M_Q_FACTOR and M_QUANTIZATION, the following values are only supported with JPEG2000 lossy buffers.

function map For specifying the color bands to affect
Click to summarize
Combination value		 Description
Click to summarize M_ALL_BANDS
[For essential MIL-Lite information, see remarks ]

Applies the specified control value to all bands of the buffer.

This is the default value.

(summarize)
Click to summarize M_BLUE
[For essential MIL-Lite information, see remarks ]

Applies the specified control value to the blue band only (for RGB buffers).
Click to summarize M_GREEN
[For essential MIL-Lite information, see remarks ]

Applies the specified control value to the green band only (for RGB buffers).
Click to summarize M_RED
[For essential MIL-Lite information, see remarks ]

Applies the specified control value to the red band only (for RGB buffers).
Click to summarize M_U
[For essential MIL-Lite information, see remarks ]

Applies the specified control value to the U band only (for YUV buffers).
Click to summarize M_V
[For essential MIL-Lite information, see remarks ]

Applies the specified control value to the V band only (for YUV buffers).
Click to summarize M_Y
[For essential MIL-Lite information, see remarks ]

Applies the specified control value to the Y band only (for YUV buffers).

The following ControlType and corresponding ControlValue parameter settings can be specified for an M_KERNEL or an M_STRUCT_ELEMENT data buffer.

The following ControlType values change the setting of a neighborhood operation for the specified kernel buffer or structuring element buffer. The ControlType values establish how to perform a neighborhood operation when using the specified kernel buffer or structuring element buffer. Neighborhood operations that do not use a kernel buffer or structuring element buffer typically use the default values.

function map For controlling general neighborhood operation settings of an M_KERNEL or an M_STRUCT_ELEMENT data buffer
Click to summarize
ControlType		 Description MIL system-specific
tooltip (‡)
ControlValue
Click to summarize M_DEFAULT

Sets all neighborhood operation control types to their default value.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_NULL

Implements the default behavior.

This is the default value.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_OFFSET_CENTER_X

Sets the X-coordinate of the center pixel of the kernel or structuring element. INQ

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_DEFAULT

Specifies the X-coordinate of the top-left pixel of the central elements.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize 0 <= Value < SizeX

Specifies the value of the X-coordinate.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_OFFSET_CENTER_Y

Sets the Y-coordinate of the center of the kernel or structuring element. INQ

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_DEFAULT

Specifies the Y-coordinate of the top-left pixel of the central elements.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize 0 <= Value < SizeY

Specifies the value of the Y-coordinate.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_OVERSCAN

Sets the type of overscan used to handle the border pixels of a source image. INQ

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_DEFAULT

Specifies that MIL automatically selects the type of overscan to optimize speed and logic according to the specified operation and the target system.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_DISABLE

Specifies that no overscan will be used, unless processing the border pixels is faster than ignoring them; in the latter case, MIL automatically selects the overscan to optimize speed according to the specified operation and the target system.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_FAST

Specifies that MIL automatically selects the overscan to optimize speed according to the specified neighborhood operation and the target system. The overscan could be hardware-specific thereby having a different behavior than the other supported overscan modes.

Note that when using M_FAST, the destination pixels in the overscan area are undefined. The pixels can therefore contain different values from one function call to the next, even if the function's parameter values are the same.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_MIRROR

Specifies a type of overscan that processes the border pixels of a source image using overscan pixel values that mirror the source buffer pixel values. That is, the overscan pixel values will be a mirror copy of the source buffer's borders. For example:

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_REPLACE

Specifies a type of overscan that processes the border pixels of a source image using overscan pixel values set to the overscan replacement value (M_OVERSCAN_REPLACE_VALUE).

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_REPLICATE

Specifies a type of overscan that processes the border pixels of a source image using overscan pixel values that replicate the border pixels. For example:

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_TRANSPARENT

Specifies a type of overscan that processes the border pixels of a source image using transparent overscan pixel values. The overscan pixel values will be those of the ancestor buffer, and a mirror is done on the ancestor for any missing pixels.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
MIL system specific

Points falling outside the source image are undefined.

 ‡ l m
Click to summarize M_OVERSCAN_REPLACE_VALUE

Sets a replacement value for the overscan pixel values.

Note that to use this control type, M_OVERSCAN must be set to M_REPLACE. INQ

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_DEFAULT

Specifies the default value; the default value is 0.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_REPLACE_MAX

Specifies that the overscan neighborhood pixel values will be set to the maximum value of the source buffer.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_REPLACE_MIN

Specifies that the overscan neighborhood pixel values will be set to the minimum value of the source buffer.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize Value

Specifies the value of the overscan neighborhood pixels.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_SATURATION

Sets whether to saturate the results. INQ

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_DEFAULT

Same as M_DISABLE.

 ‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_DISABLE

Specifies not to saturate results, except when MIL can take advantage of optimization routines to accelerate the processing. In the latter case, results will be saturated and processing will be done in hardware.

When it is not possible to run hardware processing optimization routines, results that overflow the buffer are undefined.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa
Click to summarize M_ENABLE

Specifies to saturate results. A result that overflows or underflows will be set to the maximum or minimum value (respectively) that can be represented in the destination buffer.

If the saturation, normalization, and absolute value settings are specified for a kernel buffer, the saturation is performed after the normalization factor and the absolute value operations have been applied.

(summarize)
‡ a c
M10		 g h i j k
M10		 l m o p r
U27		 t
U28		 u
U36		 v y
U75		 aa

The following ControlType and corresponding ControlValue parameter settings can be specified for an M_KERNEL data buffer. These settings establish how to perform a neighborhood operation when using the specified kernel buffer.

function map For the neighborhood operation settings of M_KERNEL data buffers
Click to summarize
ControlType		 Description
ControlValue
Click to summarize M_ABSOLUTE_VALUE

Sets whether to take the absolute value of the results. INQ

(summarize)
Click to summarize M_DEFAULT

Same as M_DISABLE.
Click to summarize M_DISABLE

Specifies not to take the absolute value of the result.
Click to summarize M_ENABLE

Specifies to take the absolute value of the result.

Note that for a structuring element buffer, you cannot take the absolute value of a result.

(summarize)
Click to summarize M_NORMALIZATION_FACTOR

Sets the normalization factor to apply to the result.

Note that for a structuring element buffer, you cannot specify a normalization factor. INQ

(summarize)
Click to summarize M_DEFAULT

Specifies the default value; the default value is 1.
Click to summarize Value > 0

Specifies the normalization factor.

If the factor produces an overflow in the destination, saturation might occur, depending on the M_SATURATION control type.

(summarize)

The following ControlType and corresponding ControlValue parameter settings are used to control buffer settings that are primarily useful when working with a buffer that is a component of a container, or a buffer that will be copied to a component of a container using MbufCopyComponent().

function map For specifying settings useful with buffers that are components
Click to summarizeControlType Description
ControlValue
Click to summarize M_COMPONENT_TYPE

Sets the component type of the buffer, used when the buffer is a component of a container. The component type specifies the type of information stored in the component. INQ

(summarize)
Click to summarize M_COMPONENT_CONFIDENCE

Specifies that the component stores confidence information for the M_COMPONENT_RANGE or M_COMPONENT_DISPARITY component of the container. Coordinates associated with the confidence value 0 are considered invalid data and will not be used by 3D image processing functions.

A confidence component is associated with a range or disparity component in the same container when there are no other range, disparity, or confidence components in the container. If there is more than one range, disparity, and/or confidence component in a container (for example, because a single grab into the container transmitted multiple range and confidence components), you will need to either create a child container which contains only the required components using MbufChildContainer(), or free the extra components using MbufFreeComponent().

(summarize)
Click to summarize M_COMPONENT_CUSTOM + n

Specifies that the component has a custom component type, identified by n, where n can be a value between 0 and 255.

You can use custom component types to identify components which store information that does not fit one of the standard component types. In addition, some cameras transmit components with custom component types. Refer to your camera manual to determine what type of information is stored in these components.

(summarize)
Click to summarize M_COMPONENT_DISPARITY

Specifies that the component stores a disparity map. Each pixel of a disparity map indicates the apparent distance (typically measured in pixel units) between where an object appears in the left and right images captured by a stereoscopic camera.

(summarize)
Click to summarize M_COMPONENT_INFRARED

Specifies that the component stores an intensity image of infrared light.
Click to summarize M_COMPONENT_INTENSITY

Specifies that the component stores an intensity image of visible light.
Click to summarize M_COMPONENT_MESH_MIL

Specifies that the component stores mesh information for the M_COMPONENT_RANGE component of the container.

A mesh component is associated with a range component in the same container when there are no other range or mesh components in that container. A point cloud container which has a mesh component is referred to as a meshed point cloud container.

(summarize)
Click to summarize M_COMPONENT_METADATA

Specifies that the component stores metadata information. Metadata components are used by MIL internally. Typically, you should ignore metadata components in your application.

(summarize)
Click to summarize M_COMPONENT_MULTISPECTRAL

Specifies that the component stores an intensity image where each band represents the intensity of a specific wavelength of light. Unlike an intensity component, a multispectral component might include information about non-visible light.

(summarize)
Click to summarize M_COMPONENT_NORMALS_MIL

Specifies that the buffer stores normals information for each point in the M_COMPONENT_RANGE component of the container.

A normals component is associated with a range component in the same container when there are no other range or normals components in that container.

(summarize)
Click to summarize M_COMPONENT_RANGE

Specifies that the component stores 3D distance/position information. The component can be either a 1-band buffer that stores a depth map, or a 3-band buffer that stores coordinates of 3D points.

(summarize)
Click to summarize M_COMPONENT_REFLECTANCE

Specifies that the component stores a reflectance map. Each pixel of a reflectance map indicates how much of the light hitting an object at that location is reflected back. Typically, this is an intensity image of the light wavelength used by a 3D sensor to detect 3D distance/position information. Typically, if the map was generated by a laser profiler, each line indicates the detected intensity of the laser for a single scan.

(summarize)
Click to summarize M_COMPONENT_SCATTER

Specifies that the component stores a scatter map. Each pixel of a scatter map indicates how much of the light hitting an object at that location is detected scattering beneath the object's surface.

(summarize)
Click to summarize M_COMPONENT_ULTRAVIOLET

Specifies that the component stores an intensity image of ultraviolet light.
Click to summarize M_COMPONENT_UNDEFINED

Specifies that the component contains information of an unknown type.

For buffers with an M_IMAGE attribute and with M_COMPONENT_TYPE set to M_COMPONENT_RANGE or M_COMPONENT_DISPARITY, ControlType and ControlValue can also be set to one of the values below. These settings are used only when the buffer is the range or disparity component of a container passed as a source to MbufConvert3d().

A container cannot be 3D-processable or 3D-displayable unless it has a single range component with all of these settings at their default values (except for M_3D_DISTANCE_UNIT which can be any value and M_3D_REPRESENTATION, which must be set to M_CALIBRATED_XYZ or M_CALIBRATED_XYZ_UNORGANIZED).

function map For specifying settings useful with image buffers that store 3D data and are components
Click to summarize
ControlType		 Description
ControlValue
Click to summarize M_3D_COORDINATE_SYSTEM_TYPE

Sets which type of coordinate system to use to interpret the coordinates stored in the bands of the buffer if it is a range component.

Note that MIL does not support any functionality with coordinates stored using a coordinate system type other than M_CARTESIAN. If a buffer stores information defined using another type of coordinate system, you will need to manually convert that information to cartesian coordinates before the buffer can be used with any MIL processing function. This conversion cannot be done using MbufConvert3d(). INQ

(summarize)
Click to summarize M_CARTESIAN

Specifies that the buffer stores right-handed cartesian coordinates.

If the buffer is a 1-band buffer, its values will be interpreted as Z-coordinates (equivalent to the pixels of a depth map).

If the buffer is a 3-band buffer, the bands store the following:

Band

Information

Band 0

Stores the X-coordinates.

Band 1

Stores the Y-coordinates.

Band 2

Stores the Z-coordinates.

This is the default value.

(summarize)
Click to summarize M_CYLINDRICAL

Specifies that the buffer stores cylindrical coordinates (theta-Y-rho).

In a cylindrical coordinate system, points are defined relative to a reference axis and reference angle perpendicular to that axis. The Y-coordinate is the distance from the origin along the reference axis, theta (θ) is the polar angle of the point relative to a reference angle, and rho is the distance from that axis along the line described by theta and perpendicular to the reference axis (the radius).

If the buffer is a 1-band buffer, its values store rho, the distance from a chosen reference axis.

If the buffer is a 3-band buffer, the bands store the following:

Band

Information

Band 0

Stores theta, the polar angle coordinates relative to the chosen reference angle.

Band 1

Stores Y-coordinates, the distances along the chosen reference axis.

Band 2

Stores rho, the distances from the chosen reference axis.
(summarize)
Click to summarize M_SPHERICAL

Specifies that the buffer stores spherical coordinates (theta-phi-rho).

In a spherical coordinate system, points are defined relative to a reference axis and a reference angle perpendicular to that axis. Rho is the distance from the origin (the radius), theta (θ) is the elevation angle of the point relative to reference axis, and phi is the azimuthal angle relative to the reference angle.

If the buffer is a 1-band buffer, its values store rho, the distance from a chosen reference axis.

If the buffer is a 3-band buffer, the bands store the following:

Band

Information

Band 0

Stores theta, the elevation angle coordinates relative to the chosen reference axis.

Band 1

Stores phi, the azimuth angle coordinates relative to a chosen reference angle.

Band 2

Stores rho, the distances from the chosen reference axis.
(summarize)
Click to summarize M_UNKNOWN

Specifies that the coordinate system type is unknown.
Click to summarize M_3D_DISPARITY_BASELINE

Sets the stereo baseline value of the stereoscopic camera used to generate the data in the buffer. This is the physical distance between the lenses of the camera.

Refer to your camera manual to determine the correct value for this setting, which might differ from the true physical distance between the lenses of your camera. INQ

(summarize)
Click to summarize Value > 0.0

Specifies the stereo baseline value, expressed in meters.

The default value is 1.0.

(summarize)
Click to summarize M_3D_DISPARITY_FOCAL_LENGTH

Sets the focal length of the lenses of the stereoscopic camera used to generate the data in the buffer.

Refer to your camera manual to determine the correct value for this setting, which might differ from the true focal length of your camera. INQ

(summarize)
Click to summarize Value > 0.0

Specifies the focal length of the lenses of the stereoscopic camera used to generate the data in the buffer if it stores a disparity map, expressed in pixels. For example, if the disparity map has 1000 pixels per millimeter of a single image sensor (after calibration), and the focal length of the lenses in millimeters is 35, the focal length in pixels is 35000.

The default value is 1.0.

(summarize)
Click to summarize M_3D_DISPARITY_PRINCIPAL_POINT_X

Sets the X-position of the principal point of the disparity map. This is the point in the disparity map which the optical axis of the camera intersects. INQ

(summarize)
Click to summarize Value

Specifies X-position of the principal point, expressed in pixels.

The default value is 0.0.

(summarize)
Click to summarize M_3D_DISPARITY_PRINCIPAL_POINT_Y

Sets the Y-position of the principal point of the disparity map. This is the point in the disparity map which the optical axis of the camera intersects. INQ

(summarize)
Click to summarize Value

Specifies Y-position of the principal point, expressed in pixels.

The default value is 0.0.

(summarize)
Click to summarize M_3D_DISTANCE_UNIT

Sets the unit to use when the buffer is part of a container and stores natively calibrated distance data. INQ

(summarize)
Click to summarize M_INCH

Specifies that the distance data is provided in inches.
Click to summarize M_MILLIMETER

Specifies that the distance data is provided in millimeters.
Click to summarize M_PIXEL

Specifies that the distance data is provided in pixels. This setting is only useful for buffers that have the component type M_COMPONENT_DISPARITY and store a disparity map.

(summarize)
Click to summarize M_UNKNOWN

Specifies that the distance unit is unknown.

This is the default value.

(summarize)
Click to summarize M_3D_INVALID_DATA_FLAG

Sets whether the buffer uses a specific value to indicate invalid data. For 3-band buffers that store coordinates, the invalid data flag should be stored in the Z-axis band. Specify the value that indicates invalid data using M_3D_INVALID_DATA_VALUE. INQ

(summarize)
Click to summarize M_FALSE

Specifies that the buffer does not use a special value to indicate invalid data.

This is the default value.

(summarize)
Click to summarize M_TRUE

Specifies that the buffer uses a special value to indicate invalid data.
Click to summarize M_3D_INVALID_DATA_VALUE

Sets the value used to indicate missing data when M_3D_INVALID_DATA_FLAG is set to M_TRUE.

Note that this value is not used or respected by any MIL function except for MbufConvert3d() when the buffer is a component of the source container. INQ

(summarize)
Click to summarize Value

Specifies the value used to indicate missing data.

The default value is 0.0.

(summarize)
Click to summarize M_3D_OFFSET_X

Sets by how much the X-coordinates stored in the buffer will be offset in the destination point cloud when the buffer is a component of a container passed as a source to MbufConvert3d(). INQ

(summarize)
Click to summarize Value

Specifies by how much the X-coordinates stored in the buffer will be offset.

The default value is 0.0.

(summarize)
Click to summarize M_3D_OFFSET_Y

Sets by how much the Y-coordinates stored in the buffer will be offset in the destination point cloud when the buffer is a component of a container passed as a source to MbufConvert3d(). INQ

(summarize)
Click to summarize Value

Specifies by how much the Y-coordinates stored in the buffer will be offset.

The default value is 0.0.

(summarize)
Click to summarize M_3D_OFFSET_Z

Sets by how much the Z-coordinates stored in the buffer will be offset in the destination point cloud when the buffer is a component of a container passed as a source to MbufConvert3d(). INQ

(summarize)
Click to summarize Value

Specifies by how much the Z-coordinates stored in the buffer will be offset.

The default value is 0.0.

(summarize)
Click to summarize M_3D_REPRESENTATION

Sets how 3D data is stored in the buffer; this information is used when the buffer is a range or disparity component of a container. For more information, see MbufConvert3d(). INQ

(summarize)
Click to summarize M_CALIBRATED_XYZ

Specifies that the component stores organized and natively calibrated X, Y, and Z-coordinates.

This is the default value for 3-band buffers with M_SIZE_Y greater than 1.

This corresponds to the GenICam Scan3dOutputMode feature set to CalibratedABC_Grid.

(summarize)
Click to summarize M_CALIBRATED_XYZ_UNORGANIZED

Specifies that the component stores unorganized and natively calibrated X, Y, and Z-coordinates.

This is the default value for 3-band buffers with M_SIZE_Y of 1.

This corresponds to the GenICam Scan3dOutputMode feature set to CalibratedABC_PointCloud.

(summarize)
Click to summarize M_CALIBRATED_XZ_EXTERNAL_Y

Specifies that the component stores organized and natively calibrated X and Z-coordinates, with Y-coordinates stored in a separate array buffer.

This corresponds to the GenICam Scan3dOutputMode feature set to CalibratedAC_Linescan.

(summarize)
Click to summarize M_CALIBRATED_XZ_UNIFORM_Y

Specifies that the component stores organized and natively calibrated X and Z-coordinates, with Y-coordinates identified by the row index.

This corresponds to the GenICam Scan3dOutputMode feature set to CalibratedAC.

(summarize)
Click to summarize M_CALIBRATED_Z

Specifies that the component stores organized and natively calibrated Z-coordinates, without X and Y-coordinates.

This corresponds to the GenICam Scan3dOutputMode feature set to CalibratedC.

(summarize)
Click to summarize M_CALIBRATED_Z_EXTERNAL_Y

Specifies that the component stores organized and natively calibrated Z-coordinates without X-coordinates; Y-coordinates are stored in a separate buffer that has an M_ARRAY attribute and is not part of the container.

This corresponds to the GenICam Scan3dOutputMode feature set to CalibratedC_Linescan.

(summarize)
Click to summarize M_CALIBRATED_Z_UNIFORM_X_EXTERNAL_Y

Specifies that the component stores organized and natively calibrated Z-coordinates, with the X-coordinates identified by column index; Y-coordinates are stored in a separate buffer that has an M_ARRAY attribute and is not part of the container.

This corresponds to the GenICam Scan3dOutputMode feature set to RectifiedC_Linescan.

(summarize)
Click to summarize M_CALIBRATED_Z_UNIFORM_XY

Specifies that the component stores organized and natively calibrated Z-coordinates, with X and Y-coordinates identified by column and row index respectively. The manufacturer of your camera might refer to a range component with this setting as a depth map.

This is the default value for 1-band buffers.

This corresponds to the GenICam Scan3dOutputMode feature set to RectifiedC.

(summarize)
Click to summarize M_DISPARITY

Specifies that the component stores a disparity map with perspective distortion along the Y-axis. When used with MbufConvert3d(), the Y-coordinate of each point in the resulting point cloud will be generated using the row index of the corresponding pixel and compensating for perspective.

This corresponds to the GenICam Scan3dOutputMode feature set to DisparityC.

Typically, this setting should only be used with disparity components that have been generated using areascan cameras.

(summarize)
Click to summarize M_DISPARITY_EXTERNAL_Y

Specifies that the component stores a disparity map; Y-coordinates are stored in a separate buffer that has an M_ARRAY attribute and is not part of the container. When used with MbufConvert3d(), the Y-coordinate of each point in the resulting point cloud will be taken from the specified buffer.

This corresponds to the GenICam Scan3dOutputMode feature set to DisparityC_Linescan.

Typically, this setting should only be used with disparity components that have been generated using linescan cameras.

(summarize)
Click to summarize M_DISPARITY_UNIFORM_Y

Specifies that the component stores a disparity map, with Y-values identified by row index. When used with MbufConvert3d(), the Y-coordinates of each point in the resulting point cloud will be generated using the row index of the corresponding pixel. Since the Y-values are uniform, no perspective correction is applied.

This partially corresponds to the GenICam Scan3dOutputMode feature set to DisparityC_Linescan, except that the Y-values are not stored in a separate buffer.

Typically, this setting should only be used with disparity components that have been generated using linescan cameras.

(summarize)
Click to summarize M_UNCALIBRATED_Z

Specifies that the component stores organized and uncalibrated Z-coordinates, without X and Y-coordinates.

This corresponds to the GenICam Scan3dOutputMode feature set to UncalibratedC.

(summarize)
Click to summarize M_3D_SCALE_X

Sets by how much the X-coordinates stored in the buffer will be scaled in the destination point cloud when the buffer is a component of a container passed as a source to MbufConvert3d(). INQ

(summarize)
Click to summarize Value != 0.0

Specifies by how much the X-coordinates stored in the buffer will be scaled.

The default value is 1.0.

(summarize)
Click to summarize M_3D_SCALE_Y

Sets by how much the Y-coordinates stored in the buffer will be scaled in the destination point cloud when the buffer is a component of a container passed as a source to MbufConvert3d(). INQ

(summarize)
Click to summarize Value != 0.0

Specifies how much the Y-coordinates stored in the buffer will be scaled.

The default value is 1.0.

(summarize)
Click to summarize M_3D_SCALE_Z

Sets by how much the Z-coordinates stored in the buffer will be scaled in the destination point cloud when the buffer is a component of a container passed as a source to MbufConvert3d(). INQ

(summarize)
Click to summarize Value != 0.0

Specifies how much the Z-coordinates stored in the buffer will be scaled.

The default value is 1.0.

(summarize)
Click to summarize M_3D_SHEAR_X

Sets by how much the X-coordinates stored in the buffer will be offset in the destination point cloud from the X-coordinates in the previous row when the buffer is a component of a container passed as a source to MbufConvert3d(). INQ

(summarize)
Click to summarize Value

Specifies by how much the X-coordinates stored in the buffer will be offset in the destination point cloud from the X-coordinates in the previous row.

The default value is 0.0.

(summarize)
Click to summarize M_3D_SHEAR_Z

Sets by how much the Z-coordinates stored in the buffer will be offset in the destination point cloud from the Z-coordinates in the previous row when the buffer is a component of a container passed as a source to MbufConvert3d(). INQ

(summarize)
Click to summarize Value

Specifies by how much the Z-coordinates stored in the buffer will be offset in the destination point cloud from the Z-coordinates in the previous row.

The default value is 0.0.

(summarize)
Remark
  • [MIL-Lite]
    Note that during development and at runtime, compression support, particularly for an M_IMAGE + M_COMPRESS buffer type, requires the presence of a MIL license that grants access to the compression/decompression package. This access is only granted by default with the development license dongle for the full version of MIL. In other cases, you must purchase access to this package separately.
Type-specific versions of the function when using a C compiler under 64-bit
void MbufControlDouble (MIL_ID BufId, MIL_INT64 ControlType, MIL_DOUBLE ControlValue)
Details
Parameters

BufId

See BufId of the main function for a description.

ControlType

See ControlType of the main function for a description.

ControlValue

See ControlValue of the main function for a description.
void MbufControlInt64 (MIL_ID BufId, MIL_INT64 ControlType, MIL_INT64 ControlValue)
Details
Parameters

BufId

See BufId of the main function for a description.

ControlType

See ControlType of the main function for a description.

ControlValue

See ControlValue of the main function for a description.
Compilation information
Header Include mil.h.
Library Use mil.lib.
DLL Requires mil.dll.
ASSOCIATED LUT DEFAULT DC ALLOC DEFAULT DC FREE DEFAULT GC FEATURE BROWSER DEFAULT CLOSE OPEN LOCK DEFAULT MAP DISABLE ENABLE MAX MIN MODIFICATION HOOK DISABLE ENABLE MODIFIED DEFAULT UNLOCK DEFAULT XPIXMAP ALLOC DEFAULT XPIXMAP FREE DEFAULT ASYNCHRONOUS SYNCHRONOUS READ READM WRITE WRITE REGION USE IGNORE USE RESOLUTION X DEFAULT RESOLUTION Y DEFAULT YCBCR RANGE DISABLE YCBCR HD YCBCR SD YCBCR UHD DECOMPOSITION LEVEL HUFFMAN AC ARRAY buffer identifier HUFFMAN AC CHROMINANCE ARRAY buffer identifier HUFFMAN AC LUMINANCE ARRAY buffer identifier HUFFMAN DC ARRAY buffer identifier HUFFMAN DC CHROMINANCE ARRAY buffer identifier HUFFMAN DC LUMINANCE ARRAY buffer identifier PREDICTOR Q FACTOR Q FACTOR CHROMINANCE Q FACTOR LUMINANCE QUANTIZATION ARRAY buffer identifier QUANTIZATION CHROMINANCE ARRAY buffer identifier QUANTIZATION LUMINANCE ARRAY buffer identifier RESTART INTERVAL TARGET SIZE ALL BANDS BLUE GREEN RED U V Y DEFAULT NULL OFFSET CENTER X DEFAULT OFFSET CENTER Y DEFAULT OVERSCAN DEFAULT DISABLE FAST MIRROR REPLACE REPLICATE TRANSPARENT OVERSCAN REPLACE VALUE DEFAULT REPLACE MAX REPLACE MIN SATURATION DEFAULT DISABLE ENABLE ABSOLUTE VALUE DEFAULT DISABLE ENABLE NORMALIZATION FACTOR DEFAULT COMPONENT TYPE COMPONENT CONFIDENCE COMPONENT CUSTOM n COMPONENT DISPARITY COMPONENT INFRARED COMPONENT INTENSITY COMPONENT MESH MIL COMPONENT METADATA COMPONENT MULTISPECTRAL COMPONENT NORMALS MIL COMPONENT RANGE COMPONENT REFLECTANCE COMPONENT SCATTER COMPONENT ULTRAVIOLET COMPONENT UNDEFINED 3D COORDINATE SYSTEM TYPE CARTESIAN CYLINDRICAL SPHERICAL UNKNOWN 3D DISPARITY BASELINE 3D DISPARITY FOCAL LENGTH 3D DISPARITY PRINCIPAL POINT X 3D DISPARITY PRINCIPAL POINT Y 3D DISTANCE UNIT INCH MILLIMETER PIXEL UNKNOWN 3D INVALID DATA FLAG FALSE TRUE 3D INVALID DATA VALUE 3D OFFSET X 3D OFFSET Y 3D OFFSET Z 3D REPRESENTATION CALIBRATED XYZ CALIBRATED XYZ UNORGANIZED CALIBRATED XZ EXTERNAL Y CALIBRATED XZ UNIFORM Y CALIBRATED Z CALIBRATED Z EXTERNAL Y CALIBRATED Z UNIFORM X EXTERNAL Y CALIBRATED Z UNIFORM XY DISPARITY DISPARITY EXTERNAL Y DISPARITY UNIFORM Y UNCALIBRATED Z 3D SCALE X 3D SCALE Y 3D SCALE Z 3D SHEAR X 3D SHEAR Z COMPRESS YUV16 COMPONENT RANGE COMPONENT DISPARITY M_COMPONENT_CUSTOM + n