MbufDiskInquire

See also

Reference:

MbufAlloc1d MbufAlloc2d MbufControl MbufCreate2d MbufExport MbufExportSequence

Availability

Available in MIL-Lite with restrictions (see remarks)

Available in MIL

Available on Windows

Available on Linux

Not supported on:

Not supported on Matrox Indio (Update 53 or Update 68) (w)

Not supported on Matrox Concord PoE with ToE (Update 82) (z)

Fully supported on:

Fully supported on Host system (a)

Fully supported on Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)* (c)

Fully supported on Matrox Morphis (g)

Fully supported on Matrox Morphis QxT (h)

Fully supported on Matrox Orion HD (i)

Fully supported on Matrox Radient eCL (j)

Fully supported on Matrox Radient eV-CXP (MIL 10 or Update 29)* (k)

Fully supported on Matrox Solios eA/XA (l)

Fully supported on Matrox Solios ecl/xcl/ev-cl (m)

Fully supported on Matrox USB3 Vision driver (Update 19) (o)

Fully supported on Matrox RadientPro-CL (Update 7) (p)

Fully supported on Matrox Radient eV-CL (Update 27 or 74) (r)

Fully supported on Matrox Iris GTR (Update 28 or Update 68) (t)

Fully supported on Matrox Clarity UHD (Update 36 or 76) (u)

Fully supported on Matrox GenTL driver (Update 34) (v)

Fully supported on Matrox Rapixo CXP (Update 75 or Update 84) (y)

Fully supported on Matrox Rapixo CL Pro (Update 96) (aa)

* Refer to the MIL system-specific information
in the MIL Reference for the minimum update required.

For any information regarding a MIL system added during a MIL Update, see the MIL system’s release note

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

adaptivefiltering.cpp
alphablending.cpp
cameraonrobotarmcalibration.cpp
cielabconversion.cpp
colorrelativecalibration.cpp
depthmapgoldentemplate.cpp
exampleinterface.cpp
examplemanager.cpp
examplemanagerfor3d.cpp
findimageorientation.cpp
foodinspectioncereal.cpp
foodinspectionmango.cpp
gumpackinspection.cpp
imagedownscalingmodes.cpp
imageflattening.cpp
imageupscalingmodes.cpp
m3dmap.cpp
m3dmap.cs
m3dmap.vb
mappbenchmark.cpp
mappbenchmark.cs
mappbenchmark.vb
mbufcolor.cpp
mbufcolor.cs
mbufcolor.vb
mcol.cpp
mcol.cs
mcol.vb
mdiggrabsequence.cpp
mdiggrabsequence.cs
mdiggrabsequence.vb
mechanicalpartscan.cpp
mfunc.cpp
mfunc.cs
mfunc.vb
mgenlutfunction.cpp
mimbinarizeadaptive.cpp
mimlocatepeak1d.cpp
mimlocatepeak1d.cs
mimlocatepeak1d.vb
mocr.cpp
mocr.cs
mocr.vb
mpmenubutton.cpp
mprotateprocessing.cpp
mpwarpprocessing.cpp
objectlocalization3d.cpp
pcbmodelmatching.cpp
productidentificationoasis.cpp
projection.cpp
semiocr.cpp
standaloneexample.cpp
stereocalibration.cpp
superresolution.cpp
superresolutioncode.cpp
texturestatistics.cpp
variousdenoising.cpp

Function Map

- FileName

Table:

For specifying the file name or memory stream

- InquireType

- UserVarPtr

Parameter Associations

Table:	For inquiring about general types of file settings
Table:	For M_ARRAY, M_IMAGE, M_KERNEL, M_LUT and M_STRUCT_ELEMENT
+ combination:	For obtaining information about the LUT associated with the image
Table:	For M_IMAGE
Table:	For M_KERNEL and M_STRUCT_ELEMENT
Table:	For M_KERNEL

Return value

Remarks

Compilation information

Synopsis

Inquire about the data in a file.

Syntax

MIL_INT MbufDiskInquire(

MIL_CONST_TEXT_PTR FileName,	//in
MIL_INT64 InquireType,	//in
void *UserVarPtr	//out

)

Description

This function inquires about the data in the specified file on disk.

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

FileName

Specifies the file that contains the data.

For specifying the file name or memory stream
Value	Description
MIL_TEXT("FileName") ¹	Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"). Note, an error occurs if the file does not have a known file format or the file format is not supported. The supported file types include all the formats supported by the MbufExport() and MbufExportSequence() functions. Since a raw data file does not have any information regarding size or type, you can only use MbufDiskInquire() to determine the file format of this type of file. This function cannot access a file on the remote computer; the file must be located on the master computer. (summarize) Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"). (more details...)

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

InquireType

Specifies the type of file setting about which 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):

MIL_DOUBLE
MIL_INT
MIL_INT64

Specifies the address in which to write the requested information. Since the MbufDiskInquire() 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.

Parameter associations

The tables below list possible values for the InquireType parameter and possible values returned to the UserVarPtr parameter.

For inquiring about general types of file settings
For M_ARRAY, M_IMAGE, M_KERNEL, M_LUT and M_STRUCT_ELEMENT
For M_IMAGE
For M_KERNEL and M_STRUCT_ELEMENT
For M_KERNEL

The following inquire types allow you to inquire about general types of file settings.

For inquiring about general types of file settings
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_BYTE_ORDER		Inquires the file's byte order. (summarize) Inquires the file's byte order. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_BIG_ENDIAN	Specifies that the file is in big endian format.
	M_LITTLE_ENDIAN	Specifies that the file is in little endian format.
M_FILE_FORMAT		Inquires the file format. SET SET (summarize) Inquires the file format. SET SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_AVI_CODEC	Specifies an AVI format used with a codec found on your computer, where the AVI is not an M_AVI_DIB, M_AVI_MIL or M_AVI_MJPG.
	M_AVI_DIB	Specifies an AVI format used to hold non-compressed DIB images . INFO
	M_AVI_MIL	Specifies an AVI format used to hold images in their MIL format. INFO
	M_AVI_MJPG	Specifies an AVI format used to hold JPEG compressed sequences. INFO
	M_BMP	Specifies that the data is saved in a BMP file format. INFO
	M_GENDC	Specifies that the data is saved in the GenDC file format. INFO
	M_JPEG2000_LOSSLESS	Specifies that the data is saved in a JPEG2000 lossless file format. INFO
	M_JPEG2000_LOSSLESS_JP2	Specifies that the data is saved in a JPEG2000 lossless file format using the standard JP2 format. INFO
	M_JPEG2000_LOSSY	Specifies that the data is saved in a JPEG2000 lossy file format. INFO
	M_JPEG2000_LOSSY_JP2	Specifies that the data is saved in a JP2000 lossy file format using the standard JP2 file format. INFO
	M_JPEG_LOSSLESS	Specifies that the data is saved in a JPEG lossless file format. INFO
	M_JPEG_LOSSLESS_INTERLACED	Specifies that the data is saved in an interlaced JPEG lossless file format. INFO
	M_JPEG_LOSSY	Specifies that the data is saved in a JPEG lossy file format. INFO
	M_JPEG_LOSSY_INTERLACED	Specifies that the data is saved in an interlaced JPEG lossy file format. INFO
	M_JPEG_LOSSY_RGB	Specifies that the data is saved in a JPEG lossy file format. INFO
	M_MIL_NATIVE	Specifies that the data is saved in the MIL native file format. INFO
	M_MIL_TIFF	Specifies that the data is saved in a MIL file format that uses the baseline TIFF 6.0 file format with extra MIL information included in the comment field. INFO
	M_PLY_ASCII	Specifies that the data is saved in the PLY file format using ASCII encoding.
	M_PLY_BINARY_LITTLE_ENDIAN	Specifies that the data is saved in the PLY file format using binary encoding.
	M_PNG	Specifies that the data is saved in a PNG file format.
	M_RAW	Specifies that the data is saved as raw data. INFO
	M_STL_ASCII	Specifies that the data is saved in the STL file format using ASCII encoding. INFO
	M_STL_BINARY	Specifies that the data is saved in the STL file format using binary encoding. INFO
	M_TIFF	Specifies that the data is saved in a TIFF file format. INFO
	M_USE_EXTENSION	Specifies that the data is saved in a format automatically determined from the file extension specified in the FileName parameter. INFO
M_OBJECT_TYPE		Inquires the type of MIL object stored in the file. Note that AVI files return M_IMAGE as an object type. (summarize) Inquires the type of MIL object stored in the file. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT64 Data type: address of a MIL_INT64 Data type info: Data type: address of a MIL_INT64 Data type: address of a MIL_INT64
	M_ARRAY	Specifies that the file stores an array buffer.
	M_CONTAINER	Specifies that the file stores a container.
	M_IMAGE	Specifies that the file stores an image buffer.
	M_KERNEL	Specifies that the file stores a kernel buffer.
	M_LUT	Specifies that the file stores a LUT buffer.
	M_STRUCT_ELEMENT	Specifies that the file stores a struct element buffer.
M_TYPE		Inquires the file data type and depth. The depth is returned in bits. (summarize) Inquires the file data type and depth. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	depth value + M_FLOAT	Specifies the data depth and that the data type is floating-point.
	depth value + M_SIGNED	Specifies the data depth and that the data type is signed.
	depth value + M_UNSIGNED	Specifies the data depth and that the data type is unsigned.

You can inquire the following values for M_KERNEL and M_STRUCT_ELEMENT files.

For M_ARRAY, M_IMAGE, M_KERNEL, M_LUT and M_STRUCT_ELEMENT
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_RESOLUTION_X		Inquires the X-resolution of the file in pixels per inch (PPI). (summarize) Inquires the X-resolution of the file in pixels per inch (PPI). (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_DOUBLE Data type: address of a MIL_DOUBLE Data type info: Data type: address of a MIL_DOUBLE Data type: address of a MIL_DOUBLE
	0.0	Specifies that the file has no resolution information.
	Value > 0.0	Specifies the X resolution in PPI.
M_RESOLUTION_Y		Inquires the Y-resolution of the file in pixels per inch (PPI). If the file has no resolution information, 0 is returned. (summarize) Inquires the Y-resolution of the file in pixels per inch (PPI). (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_DOUBLE Data type: address of a MIL_DOUBLE Data type info: Data type: address of a MIL_DOUBLE Data type: address of a MIL_DOUBLE
	0.0	Specifies that the file has no resolution information.
	Value > 0.0	Specifies the Y resolution in PPI.
M_SIGN		Inquires whether the file's data is signed or unsigned. (summarize) Inquires whether the file's data is signed or unsigned. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_SIGNED	Specifies that the data is signed.
	M_UNSIGNED	Specifies that the data is unsigned.
M_SIZE_BAND +		Inquires the number of color bands in the file. (summarize) Inquires the number of color bands in the file. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	1 <= Value <= 3	Specifies the number of color bands.
M_SIZE_BIT		Inquires the file data depth. (summarize) Inquires the file data depth. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	1 <= Value <= 64	Specifies the data depth, in bits.
M_SIZE_X +		Inquires the width of the data in the file. (summarize) Inquires the width of the data in the file. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	Value	Specifies the width of the data, in pixels.
M_SIZE_Y		Inquires the height of the data in the file. (summarize) Inquires the height of the data in the file. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	Value	Specifies the height of the data, in pixels.

Combination value for M_SIZE_BAND; M_SIZE_X.

You can add the following value to the above-mentioned values to get the width or the number of bands of the LUT associated with the image.

This option is available only if image data was saved to the file. This option is not available for AVI files.

For obtaining information about the LUT associated with the image
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_LUT		Inquires either the width or the number of bands of the LUT associated with the image in the file. (summarize) Inquires either the width or the number of bands of the LUT associated with the image in the file. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_INVALID	Specifies that there is no LUT associated with the image.
	Value	Specifies either the width of the LUT associated with the image in the file (for M_SIZE_X) or the number of bands of the LUT associated with the image in the file (for M_SIZE_BAND).

You can inquire the following values for M_IMAGE files (images or AVI sequences).

For M_IMAGE
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_ASPECT_RATIO		Inquires the aspect ratio of the images in the file. (summarize) Inquires the aspect ratio of the images in the file. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_DOUBLE Data type: address of a MIL_DOUBLE Data type info: Data type: address of a MIL_DOUBLE Data type: address of a MIL_DOUBLE
	Value > 0.0	Specifies the aspect ratio.
M_CALIBRATION_PRESENT		Inquires whether the calibration information associated with the buffer was saved, using MbufExport() with M_WITH_CALIBRATION. (summarize) Inquires whether the calibration information associated with the buffer was saved, using MbufExport() with M_WITH_CALIBRATION. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_FALSE	Specifies that the calibration was not saved.
	M_TRUE	Specifies that the calibration was saved.
M_COMPRESSION_TYPE		[For essential MIL-Lite information, see remarks ] Inquires the compression type of the images in the file. (summarize) [For essential MIL-Lite information, see remarks ] Inquires the compression type of the images in the file. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_NULL	Specifies that the images are not compressed.
	M_COMPRESSION_CCITTFAX3	Specifies that the file holds TIFF CCITT FAX3 data . INFO
	M_COMPRESSION_CCITTFAX4	Specifies that the file holds TIFF CCITT FAX4 data . INFO
	M_COMPRESSION_CCITTRLE	Specifies that the file holds TIFF CCITT RLE data . INFO
	M_COMPRESSION_CCITTRLEW	Specifies that the file holds TIFF CCITT RLEW data . INFO
	M_COMPRESSION_LZW	Specifies that the file holds TIFF LZW data .
	M_COMPRESSION_PACKBITS	Specifies that the file holds TIFF PackBits data .
	M_JPEG2000_LOSSLESS	Specifies that the file holds JPEG2000 lossless data. INFO
	M_JPEG2000_LOSSY	Specifies that the file holds JPEG2000 lossy data. INFO
	M_JPEG_LOSSLESS	Specifies that the file holds JPEG lossless data. INFO
	M_JPEG_LOSSLESS_INTERLACED	Specifies that the file holds JPEG lossless data in separate fields. INFO
	M_JPEG_LOSSY	Specifies that the file holds JPEG lossy data. INFO
	M_JPEG_LOSSY_INTERLACED	Specifies that the file holds JPEG lossy data in separate fields. INFO
M_FRAME_RATE		Inquires the frame rate of an AVI file. This value is only valid for sequences. (summarize) Inquires the frame rate of an AVI file. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_DOUBLE Data type: address of a MIL_DOUBLE Data type info: Data type: address of a MIL_DOUBLE Data type: address of a MIL_DOUBLE
	Value > 0.0	Specifies the frame rate, in number of images/second.
M_LUT_PRESENT		Inquires the presence of LUT data in the file. (summarize) Inquires the presence of LUT data in the file. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_NO	Specifies that LUT data is not available.
	M_YES	Specifies that LUT data is available.
M_NUMBER_OF_IMAGES		Inquires the number of images in an AVI file. This value is only valid for sequences. SET (summarize) Inquires the number of images in an AVI file. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	Value > 0	Specifies the number of images.

You can inquire the following values for M_KERNEL and M_STRUCT_ELEMENT files.

For M_KERNEL and M_STRUCT_ELEMENT
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_OFFSET_CENTER_X		Inquires the X-coordinate of the center of the kernel or structuring element. (summarize) Inquires the X-coordinate of the center of the kernel or structuring element. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	Value	Specifies the X-coordinate.
M_OFFSET_CENTER_Y		Inquires the Y-coordinate of the center of the kernel or structuring element. (summarize) Inquires the Y-coordinate of the center of the kernel or structuring element. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	Value	Specifies the Y-coordinate.
M_OVERSCAN		Inquires the overscan type. (summarize) Inquires the overscan type. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	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.
	M_DISABLE	Specifies that no overscan is 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.
	M_FAST	Specifies that MIL automatically selects the overscan to optimize speed according to the specified neighborhood operation and the target system. INFO
	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. INFO
	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).
	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. INFO
	M_TRANSPARENT	Specifies a type of overscan that processes the border pixels of a source image using transparent overscan pixel values. INFO
M_OVERSCAN_REPLACE_VALUE		Inquires the replacement value for the overscan pixel values. (summarize) Inquires the replacement value for the overscan pixel values. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_REPLACE_MAX	Specifies that the overscan neighborhood pixel values will be set to the maximum value of the source buffer.
	M_REPLACE_MIN	Specifies that the overscan neighborhood pixel values will be set to the minimum value of the source buffer.
	Value	Specifies the value of the overscan neighborhood pixels.

You can inquire the following values for M_KERNEL files.

For M_KERNEL
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_ABSOLUTE_VALUE		Inquires the absolute value setting. (summarize) Inquires the absolute value setting. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_DISABLE	Specifies not to take the absolute value of the result.
	M_ENABLE	Specifies to take the absolute value of the result. INFO
M_NORMALIZATION_FACTOR		Inquires the normalization factor. (summarize) Inquires the normalization factor. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	Value > 0	Specifies the normalization factor. INFO
M_SATURATION		Inquires the saturation flag. (summarize) Inquires the saturation flag. (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_DISABLE	Specifies not to saturate results, except when MIL can take advantage of optimization routines to accelerate the processing. INFO
	M_ENABLE	Specifies to saturate results. INFO

Return value

The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information is not available, M_INVALID is returned. If an AVI file is specified but its codec is not known, M_AVI_CODEC_UNSUPPORTED is returned.

Remarks

[MIL-Lite]

Note that MIL-Lite does not support the inquiries available for M_KERNEL and M_STRUCT_ELEMENT data buffers.

[MIL-Lite]

Note that during development and at runtime, compression support 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.

Compilation information

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