Filters
Filter values by
Buffer type
  • Image buffer component
    • Common to all
Object type
  • Component
  • Container
Component type
  • Range component
  • Disparity component
| Customize Help
| Save Settings

MbufInquireContainer



Function Map
Synopsis
Inquire about a MIL container or component setting.
Syntax
MIL_INT MbufInquireContainer(
MIL_ID ContainerBufId, //in
MIL_INT64 Component, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function inquires about a specified setting of a MIL container or component.

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
ContainerBufId

Specifies the identifier of the source container. The container must have been previously allocated on the required system using MbufAllocContainer().

Component

Specifies the component to inquire.

This setting can be used to specify to inquire the container itself.

function map For specifying to inquire the container itself
Click to summarizeValue Description
Click to summarize M_CONTAINER

Specifies to inquire a setting of the container.

These settings can be used to inquire the component which meets the specified criterion, or the container itself. In most cases, an error will be generated if there is no component matching this criterion in the container.

function map For specifying the component to inquire by a unique identifier
Click to summarizeValue Description
Click to summarize

Specifies to control the component, in the container, which has the specified buffer identifier. An error will be generated if the container does not have a component with this buffer identifier.

(summarize)
Parameters

Specifies the MIL identifier of the component to control.

Click to summarize

Specifies to control the component, in the container, at the specified index. An error will be generated if the container does not have a component at this index.

(summarize)
Parameters

Specifies the index of the component to control.

These settings can be used to inquire the component with the specified component type. In most cases, an error will be generated if there is no component, or more than one component, matching this criterion in the container.

function map For specifying the component to inquire by component type
Click to summarizeValue Description
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 254.

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 transmitted 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 component 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. This can be either a 1-band component 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 spectrum used by a 3D sensor to detect 3D distance/position information. Typically, if the map was generated by a laser profiler, each row 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 stores information of an unknown type.

InquireType

Specifies the setting to inquire.

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

UserVarPtr
Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):
  • array of type MIL_ID [optionally, in C++: a reference to a std::vector<MIL_ID> ]
  • array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ]
  • array of type MIL_TEXT_CHAR [optionally, in C++: a reference to a MIL_STRING]
  • MIL_DOUBLE
  • MIL_ID
  • MIL_INT
  • MIL_INT64

Specifies the address in which to return the value of the inquired setting. Since the MbufInquireContainer() function also returns the requested information, you can set this parameter to M_NULL.

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

To inquire the container itself, specify M_CONTAINER and one of the following constants.

function map For inquiring about a container
Click to summarize
InquireType
Description MIL system-specific
tooltip (‡)
UserVarPtr
- Possible values returned
Click to summarize M_3D_CONVERTIBLE

Inquires whether the container can be converted to a 3D-processable and/or natively 3D displayable container using MbufConvert3d(), and whether compensation is required to convert the data.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
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_CONVERTIBLE

Specifies that the container stores 3D data that can be converted using MbufConvert3d().

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_CONVERTIBLE_WITH_COMPENSATION

Specifies that the container stores 3D data that can be converted using MbufConvert3d() with M_COMPENSATE.

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_NOT_CONVERTIBLE

Specifies that the container can be converted us.

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_3D_DISPLAYABLE

Inquires whether the container can be used with 3D displays.

Any container that is 3D-convertible is also 3D-displayable. A conversion will occur each time the container is modified, unless you convert the container to a format that is natively 3D-displayable.

In order to be natively 3D-displayable, a container must have the attribute M_DISP and must have the following components:

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
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_DISPLAYABLE

Specifies that the container can be used with 3D displays.

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_DISPLAYABLE_WITH_CONVERSION

Specifies that the container can be used with 3D displays, with automatic conversion.

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_NOT_DISPLAYABLE

Specifies that the container cannot be used with 3D displays.

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_3D_PROCESSABLE

Inquires whether the container can be used for 3D processing.

In order to be 3D-processable, a container must have the attribute M_PROC and must have the following components:

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
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_NOT_PROCESSABLE

Specifies that the container cannot be used for 3D processing.

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_PROCESSABLE

Specifies that the container can be used for 3D processing.

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_3D_PROCESSABLE_MESHED

Inquires whether or not the container can be used for 3D processing that requires the presence of a mesh component. The mesh component must be a 3-band, packed, 32-bit unsigned data image buffer with M_COMPONENT_TYPE set to M_COMPONENT_MESH_MIL.

In order to be 3D-processable, a container must have the attribute M_PROC and must have the following components:

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
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_FALSE

Specifies that the container cannot be used for 3D processing that requires the presence of a correctly formatted mesh component.

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_TRUE

Specifies that the container can be used for 3D processing that requires the presence of a correctly formatted mesh component.

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_ANCESTOR_ID

Inquires the MIL identifier of the ancestor container. Only child containers have an ancestor container. The ancestor container is the container from which the specified container ultimately originated. It is the root container; it does not have a parent container (it is not a child container of another container).

If the specified container is not a child container, the identifier of the container itself is returned as the ancestor container.

To establish the parent container of the specified container, use M_PARENT_ID instead.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_ID
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_COMPONENT_GROUP_ID_LIST +

Inquires the list of unique group IDs of components in the container.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ] MORE
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_COMPONENT_REGION_ID_LIST +

Inquires the list of unique region IDs of components in the container.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ] MORE
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_COMPONENT_SOURCE_ID_LIST +

Inquires the list of unique source IDs of components in the container.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ] MORE
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_COMPONENT_TYPE_LIST +

Inquires the list of unique component types of components in the container.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ] MORE
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_OWNER_SYSTEM

Inquires the identifier of the system on which the container has been allocated. SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_ID
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_HOST

Specifies the default Host system of the current MIL application.

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 system identifier

Specifies a valid system identifier, previously allocated using MsysAlloc().

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_OWNER_SYSTEM_TYPE

Inquires the type of system on which the container was allocated.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
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_SYSTEM_CLARITY_UHD_TYPE

Specifies a MIL Clarity UHD system. INFO

u
U36
Click to summarize M_SYSTEM_GENTL_TYPE

Specifies a MIL GenTL system. INFO

v
Click to summarize M_SYSTEM_GIGE_VISION_TYPE

Specifies a MIL GigE Vision system. INFO

c
M10
Click to summarize M_SYSTEM_HOST_TYPE

Specifies the Host. INFO

a
Click to summarize M_SYSTEM_IRIS_GTR_TYPE

Specifies a MIL Iris GTR system. INFO

t
U28
Click to summarize M_SYSTEM_MORPHIS_TYPE

Specifies a MIL Morphis system. INFO

g
Click to summarize M_SYSTEM_MORPHISQXT_TYPE

Specifies a MIL Morphis QxT system. INFO

h
Click to summarize M_SYSTEM_ORION_HD_TYPE

Specifies a MIL Orion HD system. INFO

i
Click to summarize M_SYSTEM_RADIENT_TYPE

Specifies a MIL Radient system. INFO

j
Click to summarize M_SYSTEM_RADIENTCXP_TYPE

Specifies a MIL Radient eV-CXP system. INFO

k
M10
Click to summarize M_SYSTEM_RADIENTEVCL_TYPE

Specifies a MIL Radient eV-CL system. INFO

r
U27
aa
Click to summarize M_SYSTEM_RADIENTPRO_TYPE

Specifies a MIL Radient Pro system. INFO

p
Click to summarize M_SYSTEM_RAPIXOCL_TYPE

Specifies a MIL Rapixo Pro CL system. INFO

aa
Click to summarize M_SYSTEM_RAPIXOCXP_TYPE

Specifies a MIL Rapixo CXP system. INFO

y
U75
Click to summarize M_SYSTEM_SOLIOS_TYPE

Specifies a MIL Solios system. INFO

l m
Click to summarize M_SYSTEM_USB3_VISION_TYPE

Specifies a MIL USB3 Vision system. INFO

o
Click to summarize M_PARENT_ID

Inquires the MIL identifier of the parent container. Only child container have a parent container. The parent container is the container from which the specified container (ContainerBufId) was defined. The container can itself have a parent container. If the specified container has no parent container, the identifier of the specified container is returned.

To establish the ultimate ancestor container of the specified container, use M_ANCESTOR_ID instead. SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_ID
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_SYSTEM_LOCATION

Inquires whether the specified container is allocated on a system on the master computer or the remote computer.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
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_LOCAL

Specifies that the container is allocated on a system on the master computer.

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_REMOTE

Specifies that the container is allocated on a system on the remote computer.

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

To inquire which components are in the container, specify one of the following constants:

These settings will not return an error if there is more or less than one component that matches the criterion specified by Component.

function map For inquiring about which components are in a container
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_COMPONENT_COUNT

Inquires how many components are in the container. If Component is set to M_CONTAINER, the returned value will be the number of all components in the container. Otherwise, the returned value will be the number of components in the container which meet the specified criteria.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_COMPONENT_LIST +

Inquires the MIL identifiers of components in the container. If Component is set to M_CONTAINER, the returned array will contain the MIL identifiers of all components in the container. Otherwise, the returned array will contain the MIL identifiers of all components in the container which meet the specified criteria.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_ID [optionally, in C++: a reference to a std::vector<MIL_ID> ] MORE

You can add the following value to the above-mentioned values to determine the required array size (number of elements) to store the returned values.

function map For determining the required array size (number of elements) to store the returned values
Click to summarizeInquireType combination value Description
UserVarPtr
- Possible values returned
Click to summarize M_NB_ELEMENTS

Retrieves the required array size (number of elements) to store the returned values.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT

To inquire a container or component, specify one of the following constants.

function map For inquiring about settings that apply to both containers and components
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_EXTENDED_ATTRIBUTE

Inquires the attributes of the container or component.

To retrieve only the color or monochrome storage format of the buffer, use MbufInquireContainer() with M_DATA_FORMAT. To retrieve the actual format of the specified buffer, use MbufInquireContainer() with M_EXTENDED_FORMAT.

Note that you cannot set the UserVarPtr parameter to M_NULL when InquireType is set to M_EXTENDED_ATTRIBUTE. In addition, a valid MIL_INT64 pointer must be passed to the function; otherwise, an error will occur.

To convert the returned attributes, select the Benchmarks and Utilities item in the tree structure of the MILConfig utility. Then, select the Buffer format item. On the Value type pane, paste the returned attributes in the text box provided. Then, click on the Value lookup button. The results of the translation are presented below the Value lookup button. SET SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT64
Click to summarize M_ARRAY +

Specifies a buffer to store array type data. INFO

Click to summarize M_CONTAINER

Specifies a container.

Click to summarize M_IMAGE +

Specifies a buffer to store image data.

Click to summarize M_KERNEL +
//For 1D or 2D data

Specifies a kernel buffer to store a custom filter for convolution functions. INFO

Click to summarize M_LUT +

Specifies a buffer to store lookup table data. INFO

Click to summarize M_STRUCT_ELEMENT +
//For 1D or 2D data

Specifies a buffer to store structuring element data for morphology functions. INFO

Click to summarize M_EXTENDED_ATTRIBUTE_NAME +

Inquires the human-readable extended attributes of the container or component.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
Click to summarize M_MODIFICATION_COUNT

Inquires the current value of the modification counter of the image buffer. INFO

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize Value

Specifies the current value of the modification counter.

Click to summarize M_MODIFICATION_HOOK

Inquires the status of the modification hook, which runs a user-defined function upon an event. These user-defined functions are initially hooked to the buffer modification event using MbufHookFunction(). SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_DISABLE

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

Click to summarize M_ENABLE

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

To inquire a component, specify one of the following constants.

function map For inquiring about settings that apply only to components
Click to summarize
InquireType
Description MIL system-specific
tooltip (‡)
UserVarPtr
- Possible values returned
Click to summarize M_COMPONENT_GROUP_ID

Inquires the component group ID assigned to the buffer during acquisition. INFO

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT64
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 component group ID of 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_COMPONENT_ID

Inquires the MIL identifier of the component.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_ID
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

Specifies that no component in the container matches the specified criterion.

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_MULTIPLE_IDS

Specifies that more than one component in the container matches the specified criterion.

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 Component ID

Specifies the MIL identifier of the component.

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_COMPONENT_INVALID

Inquires whether the information in the buffer was marked as invalid by the camera.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
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_FALSE

Specifies that the information in the buffer has not been marked invalid by the camera.

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_TRUE

Specifies that the information in the buffer has been marked invalid by the camera.

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_COMPONENT_REGION_ID

Inquires the component region ID assigned to the buffer during acquisition. This identifies which region of the image sensor was used to generate the data in the buffer.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT64
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 component region ID of 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_COMPONENT_REGION_OFFSET_X

Inquires the X-offset of the top left corner of the region of the image sensor used to generate the data in the buffer.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
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

Specifies the X-offset of the component region of the buffer, expressed in 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_COMPONENT_REGION_OFFSET_Y

Inquires the Y-offset of the top left corner of the region of the image sensor used to generate the data in the buffer.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
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

Specifies the Y-axis offset of the component region ID of the buffer, expressed in 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_COMPONENT_SOURCE_ID

Inquires the component source ID assigned to the buffer during acquisition. This indicates which of the camera's data sources was used to generate the data in the buffer.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT64
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 component source ID of 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_COMPONENT_TYPE

Inquires the component type of the buffer, used when the buffer is a component of a container. The component type specifies what kind of information is stored in the component. SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT64
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_COMPONENT_CONFIDENCE

Specifies that the component stores confidence information for the M_COMPONENT_RANGE or M_COMPONENT_DISPARITY component of the container. INFO

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_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. INFO

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_COMPONENT_DISPARITY

Specifies that the component stores a disparity map. INFO

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_COMPONENT_INFRARED

Specifies that the component stores an intensity image of infrared light. INFO

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_COMPONENT_INTENSITY

Specifies that the component stores an intensity image of visible light. INFO

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_COMPONENT_MESH_MIL

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

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_COMPONENT_METADATA

Specifies that the component stores metadata information. INFO

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_COMPONENT_MULTISPECTRAL

Specifies that the component stores an intensity image where each band represents the intensity of a specific wavelength of light. INFO

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_COMPONENT_NORMALS_MIL

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

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_COMPONENT_RANGE

Specifies that the component stores 3D distance/position information. INFO

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_COMPONENT_REFLECTANCE

Specifies that the component stores a reflectance map. INFO

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_COMPONENT_SCATTER

Specifies that the component stores a scatter map. INFO

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_COMPONENT_ULTRAVIOLET

Specifies that the component stores an intensity image of ultraviolet light. INFO

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_COMPONENT_UNDEFINED

Specifies that the component contains information of an unknown type. INFO

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_COMPONENT_TYPE_NAME +

Inquires the component type of the buffer in a human-readable format.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
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_DATA_FORMAT

Inquires the color or monochrome storage format of the buffer. This includes whether it is packed or planar format. Note that to retrieve the entire list of attributes, use MbufInquire() with M_EXTENDED_ATTRIBUTE or M_EXTENDED_FORMAT. SET SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v w
U53
y
U75
z aa
Click to summarize M_PACKED +

Specifies that the buffer's bands are stored in packed format (color buffer only); that is, the pixel components are stored together (RGB RGB RGB...). INFO

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_PLANAR +

This value can have multiple meanings, as indicated below.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
//Initially, if a color buffer was allocated at the same time as its memory

Specifies that the buffer's bands are stored in planar format (color buffer only); that is, each pixel is stored as three component planes (RRR... GGG... BBB...). INFO

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
//Initially, if a color buffer was created from preallocated memory

Specifies that the buffer's bands are stored in planar format (color buffer only); that is, each pixel is stored as three component planes (RRR... GGG... BBB...). INFO

a g h i j k
M10
l m p r
U27
t
U28
u
U36
y
U75
aa
Click to summarize M_DATA_TYPE

Inquires the buffer data type. SET SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
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_FLOAT

Specifies that the buffer uses the float data type.

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_SIGNED

Specifies that the buffer uses the signed data type.

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_UNSIGNED

Specifies that the buffer uses the unsigned data type.

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_EXTENDED_FORMAT

Inquires the color or monochrome storage format of the specified buffer. INFO

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT64
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_ARRAY +

Specifies a buffer to store array type data. INFO INFO

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_IMAGE +

Specifies a buffer to store image data. INFO INFO

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_KERNEL +

Specifies a kernel buffer to store a custom filter for convolution functions. INFO

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_LUT +

Specifies a buffer to store lookup table data. INFO INFO

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_STRUCT_ELEMENT +

Specifies a buffer to store structuring element data for morphology functions. INFO

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_EXTENDED_FORMAT_NAME +

Inquires the M_EXTENDED_FORMAT of the buffer, expressed in a human readable format.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
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_PFNC_NAME +

Inquires the name of the buffer's pixel format, as defined by the GenICam Pixel Format Naming Convention.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
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_PFNC_SIZE_BIT

Inquires the number of bits per pixel, as per the GenICam Pixel Format Naming Convention. INFO

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
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 number of bit per pixel as per the PFNC.

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_PFNC_SUPPORT

Inquires whether MIL supports processing the buffer's given it's pixel format. INFO

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
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_NO

Specifies that image processing is not supported for the buffer's pixel format. INFO

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_WITH_COMPENSATION

Specifies that MIL will process the buffer by copying its data to a temporary buffer with a supported pixel format.

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_YES

Specifies that the buffer will be processed as normal.

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_PFNC_VALUE

Inquires the pixel format of the buffer, as defined by the GenICam Pixel Format Naming Convention. INFO

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
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 PFNCvalue

Specifies the pixel format of the buffer using a value from PFNC (as defined in pfnc.h). INFO

(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_PITCH

Inquires the number of pixels between the beginnings of any two adjacent lines of the buffer data. SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
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 pitch, in 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_PITCH_BYTE

Inquires the number of bytes between the beginnings of any two adjacent lines of the buffer data. SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
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 pitch, in bytes.

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_SIZE_BAND

Inquires the number of buffer color bands. SET SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
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 1

Specifies the buffer has one band.

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 2

Specifies the buffer has two bands.

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 3

Specifies the buffer has three bands.

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_SIZE_BIT

Inquires the depth per band. SET SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
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 depth per band, in bits.

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_SIZE_X

Inquires the width of the buffer. SET SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
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 width of the buffer, in 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_SIZE_Y

Inquires the height of the buffer. SET SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
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 height of the buffer, in 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_TYPE

Inquires the buffer data type and depth. Depth is returned in bits. SET SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
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_FLOAT + Depth value

Specifies the data depth and that the data type is floating-point.

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_SIGNED + Depth value

Specifies the data depth and that the data type is signed.

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_UNSIGNED + Depth value

Specifies the data depth and that the data type is unsigned.

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

You can add the following value to the above-mentioned values to get the string's length.

function map For getting the string size
Click to summarizeInquireType Description
UserVarPtr
- Possible values returned
Click to summarize M_STRING_SIZE

Retrieves the length of the string, including the terminating null character ("\0").

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Combination values for M_ARRAY (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_ARRAY); M_ARRAY (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_ARRAY); M_IMAGE (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_IMAGE); M_IMAGE (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_IMAGE); M_KERNEL (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_KERNEL); M_KERNEL (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_KERNEL); M_LUT (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_LUT); M_LUT (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_LUT); M_STRUCT_ELEMENT (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_STRUCT_ELEMENT); M_STRUCT_ELEMENT (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_STRUCT_ELEMENT).

One of the following values might be combined with the above-mentioned values to determine the location of the buffer.

function map Returns the location of the buffer
Click to summarizeCombination value Description MIL system-specific
tooltip (‡)
Click to summarize M_HOST_MEMORY +

Specifies that the buffer is in Host memory. INFO

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_MAPPABLE

Specifies that the buffer is in non-paged memory. INFO

a c
M10
g h j k
M10
l m o p r
U27
t
U28
v y
U75
aa
Click to summarize M_OFF_BOARD

Specifies that the buffer is not in on-board memory. INFO

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_ON_BOARD +

Specifies that the buffer is in on-board memory. INFO

g h i j k
M10
l m p r
U27
t
U28
u
U36
y
U75
aa
Click to summarize M_VIDEO_MEMORY

Specifies that the buffer is in (off-screen) display memory of your graphics controller. INFO

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_ARRAY (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_ARRAY); M_ARRAY (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_ARRAY); M_IMAGE (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_IMAGE); M_IMAGE (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_IMAGE); M_KERNEL (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_KERNEL); M_KERNEL (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_KERNEL); M_LUT (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_LUT); M_LUT (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_LUT); M_STRUCT_ELEMENT (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_STRUCT_ELEMENT); M_STRUCT_ELEMENT (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_STRUCT_ELEMENT).

One of the following values might be combined with the above-mentioned values to determine whether the buffer was allocated in paged or non-paged memory.

function map Returns whether the buffer was allocated in paged or non-paged memory
Click to summarizeCombination value Description
Click to summarize M_NON_PAGED

Specifies that the buffer is in MIL reserved, non-pageable memory. INFO

Click to summarize M_PAGED

Specifies that the buffer is in pageable memory. INFO

Combination values for M_IMAGE (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_IMAGE); M_IMAGE (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_IMAGE).

One or more of the following values are combined with the above-mentioned values to determine the intended purpose of the buffer.

function map Returns the intended purpose of the image buffer
Click to summarize
Combination value
Description
Click to summarize M_COMPRESS +

Specifies an image buffer that can hold compressed data. INFO

Click to summarize M_DISP

Specifies an image buffer that can be displayed. INFO

Click to summarize M_GRAB

Specifies an image buffer in which to grab data. INFO

Click to summarize M_PROC +

Specifies an image buffer that can be processed. INFO

Combination values for M_IMAGE (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_IMAGE); M_IMAGE (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_IMAGE).

One of the following values might be combined with the above-mentioned values to determine the storage format and location specifier.

You might have set this value, or it could have been automatically selected by MIL.

function map Returns the storage format and location specifier
Click to summarizeCombination value Description MIL system-specific
tooltip (‡)
Click to summarize M_DIB

Specifies that the buffer is a DIB buffer. INFO

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_DIRECTX
[This is only applicable to Windows]

Specifies that the buffer is a DirectX surface. INFO

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

Specifies that the buffer is compatible with GDI. INFO

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_LINUX_MXIMAGE
[This is only applicable to Linux]

Specifies that the buffer is an X11 Ximage. INFO

a c
M10
g h i j k
M10
l m o p r
U27
u
U36
v y
U75
aa
Combination values for M_COMPRESS.

One of the following values might be combined with the above-mentioned value to determine the compression type.

function map Returns the compression type
Click to summarize
Combination value
Description
Click to summarize M_JPEG2000_LOSSLESS

Specifies that the buffer will be used to hold JPEG2000 lossless data. INFO

Click to summarize M_JPEG2000_LOSSY

Specifies that the buffer will be used to hold JPEG2000 lossy data. INFO

Click to summarize M_JPEG_LOSSLESS

Specifies that the buffer will be used to hold JPEG lossless data. INFO

Click to summarize M_JPEG_LOSSLESS_INTERLACED

Specifies that the buffer will be used to hold JPEG lossless data in separate fields. INFO

Click to summarize M_JPEG_LOSSY

Specifies that the buffer will be used to hold JPEG lossy data. INFO

Click to summarize M_JPEG_LOSSY_INTERLACED

Specifies that the buffer will be used to hold JPEG lossy data in separate fields. INFO

Combination value for M_PROC.

The following value might be combined with the above-mentioned value to determine whether the buffer was allocated with an overscan region.

function map Returns whether the buffer was allocated with an overscan region
Click to summarizeCombination value Description
Click to summarize M_ALLOCATION_OVERSCAN

Specifies that the buffer is allocated with an overscan region. INFO

Combination value for M_ARRAY (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_ARRAY); M_ARRAY (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_ARRAY); M_IMAGE (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_IMAGE); M_IMAGE (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_IMAGE); M_KERNEL (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_KERNEL); M_KERNEL (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_KERNEL); M_LUT (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_LUT); M_LUT (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_LUT); M_STRUCT_ELEMENT (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_STRUCT_ELEMENT); M_STRUCT_ELEMENT (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_STRUCT_ELEMENT).

The following value might be combined with the above-mentioned values to determine whether the buffer is FPGA accessible.

function map Returns whether the buffer is FPGA accessible
Click to summarizeCombination value Description MIL system-specific
tooltip (‡)
Click to summarize M_FPGA_ACCESSIBLE +

Specifies that the buffer is allocated in a bank of memory that is accessible from the Processing FPGA. INFO

j l m p r
U27
aa
Combination values for M_IMAGE (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_IMAGE); M_IMAGE (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_IMAGE).

One of the following values might be combined with the above-mentioned values to determine the format in which color buffers were stored.

function map Returns the format in which color buffers were stored
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize M_PACKED +

Specifies that the buffer's bands are stored in packed format (color buffer only); that is, the pixel components are stored together (RGB RGB RGB...). INFO

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_PLANAR +

Specifies that the buffer's bands are stored in planar format (color buffer only); that is, each pixel is stored as three component planes (RRR... GGG... BBB...). INFO

a g h i j k
M10
l m p r
U27
t
U28
u
U36
y
U75
aa
Combination values for M_PACKED (when InquireType=M_DATA_FORMAT and UserVarPtr=M_PACKED); M_PACKED; M_PLANAR (when InquireType=M_DATA_FORMAT and UserVarPtr=M_PLANAR); M_PLANAR.

One of the following values might be combined with the above-mentioned values to determine the packed or planar color buffer format.

function map Returns the packed or planar color buffer format
Click to summarize
Combination value
Description
Click to summarize M_RGB24

Specifies 24-bit color depth (RGB 8:8:8) packed or planar pixels. INFO

Click to summarize M_RGB48

Specifies 48-bit color depth (RGB 16:16:16). INFO

Click to summarize M_RGB96

Specifies 96-bit color depth (RGB 32:32:32) packed or planar pixels. INFO

Click to summarize M_YUV16

Specifies YUV16 (4:2:2) pixels. INFO

Combination values for M_PACKED (when InquireType=M_DATA_FORMAT and UserVarPtr=M_PACKED); M_PACKED.

One of the following values might be combined with the above-mentioned values to determine the packed color buffer format.

function map Returns the packed color buffer format
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize M_BGR24

Specifies 24-bit color depth packed pixels (BGRBGR). INFO

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_BGR32

Specifies 32-bit color depth packed pixels (BGRXBGRX). INFO

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_RGB15

Specifies 16-bit color depth packed pixels (XRGB 1:5:5:5). INFO

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_RGB16

Specifies 16-bit color depth packed pixels (RGB 5:6:5). INFO

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_YUV16_UYVY

Specifies YUV16 packed (4:2:2) pixels, whereby the components of each pixel are stored in the UYVY order. INFO

c
M10
o v
Click to summarize M_YUV16_YUYV

Specifies YUV16 packed (4:2:2) pixels, whereby the components of each pixel are stored in the YUYV order. INFO

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_PLANAR (when InquireType=M_DATA_FORMAT and UserVarPtr=M_PLANAR); M_PLANAR.

One of the following values might be combined with the above-mentioned values to determine the planar color buffer format.

function map Returns the planar color buffer format
Click to summarizeCombination value Description MIL system-specific
tooltip (‡)
Click to summarize M_RGB3

Specifies 3-bit color depth (RGB 1:1:1) planar pixels. INFO

a g h i j k
M10
l m p r
U27
t
U28
u
U36
y
U75
aa
Click to summarize M_YUV9

Specifies YUV9 planar pixels. INFO

a g h i j k
M10
l m p r
U27
t
U28
u
U36
y
U75
aa
Click to summarize M_YUV12

Specifies YUV12 planar pixels. INFO

a g h i j k
M10
l m p r
U27
t
U28
u
U36
y
U75
aa
Click to summarize M_YUV24

Specifies YUV24 planar pixels. INFO

a g h i j k
M10
l m p r
U27
t
U28
u
U36
y
U75
aa
Combination value for M_FPGA_ACCESSIBLE; M_HOST_MEMORY; M_ON_BOARD.

The following value might be combined with the above-mentioned values to determine the memory bank in which the buffer was allocated.

function map Returns the memory bank used
Click to summarizeCombination value Description
Click to summarize M_MEMORY_BANK_n

Inquires the buffer allocated in the specified memory bank. INFO

Combination values for M_FPGA_ACCESSIBLE; M_ON_BOARD.

One of the following values might be combined with the above-mentioned values to set a location in a specific type of memory.

function map For specifying a location in a specific type of memory
Click to summarizeCombination value Description MIL system-specific
tooltip (‡)
Click to summarize M_FAST_MEMORY

Specifies that the buffer is in the fastest memory available. INFO

j l m p r
U27
aa
Click to summarize M_SHARED

Specifies that the buffer is in shared processing memory. INFO

j k
M10
l m p r
U27
y
U75
aa

For components with an M_IMAGE attribute and with M_COMPONENT_TYPE set to M_COMPONENT_RANGE or M_COMPONENT_DISPARITY, InquireType can also be set to one of the values below.

These settings are used only when the component is the range or disparity component of a container that is used as a source with MbufConvert3d(). Additionally, 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 inquiring about 3D settings that apply only to range and disparity components that are image buffers
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_3D_COORDINATE_SYSTEM_TYPE

Inquires 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(). SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_CARTESIAN

Specifies that the buffer stores right-handed cartesian coordinates. INFO

This is the default value.

(summarize)
Click to summarize M_CYLINDRICAL

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

Click to summarize M_SPHERICAL

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

Click to summarize M_UNKNOWN

Specifies that the coordinate system type is unknown. INFO

Click to summarize M_3D_DISPARITY_BASELINE

Inquires 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. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value > 0.0

Specifies the stereo baseline value, expressed in meters. INFO

The default value is 1.0.

(summarize)