Filters
Filter values by
Settings
  • Analog control
  • Input device information and control
  • Frame Burst
  • Bayer
  • Image format and adjustment control
  • Acquisition
    • Control
    • Triggered grab
    • Status and statistics
  • Data latches
  • Digital I/O control
  • Timer and counter control
  • Rotary decoder control
  • Transport layer control
| Customize Help
| Save Settings
Close

MdigControl



Function Map
Parameter Associations
Table: For the general digitizer settings
+ combination: For specifying the configuration file associated with the feature
+ combination: For specifying to wait for the camera to perform its focusing operation.
+ combination: For specifying the speed and precision of the interpolation.
+ combination: For specifying whether Matrox Feature Browser should be synchronous or asynchronous
+ combination: For specifying whether to enable anti-aliasing and/or dithering
Table: For the general reference settings
+ combination: For specifying the acquisition path
+ combination: For controlling the reference level of a specific acquisition path
+ combination: For specifying the reference level in Volts
Table: For controlling the input gain and shading correction
+ combination: For specifying the acquisition path for the input gain
+ combination: For specifying the specific video signal component to apply the input-gain setting
Table: For routing I/O signals and setting their mode
+ combination: For specifying the type and number of the I/O signal to affect
Table: For setting the state of specified user-bits in a static-user-output register
+ combination: For specifying the bit in a static-user-output register to affect
+ combination: For specifying the static-user-output register
Table: For controlling the settings to grab using a trigger
+ combination: For specifying which I/O command register bit to use
Table: For controlling frame bursts
Table: For controlling the settings of a timer
Table: For controlling the camera's exposure
Table: For controlling the settings of a quadrature decoder with inputs from a rotary or linear encoder
+ combination: For specifying which rotary decoder to set
Table: For controlling a data latch
+ combination: For specifying the data latch to affect
+ combination: For specifying which on-board timer to control
Synopsis
Control a digitizer setting.
Syntax
void MdigControl(
MIL_ID DigId, //in
MIL_INT64 ControlType, //in
MIL_DOUBLE ControlValue //in
)
Description

This function allows you to control various digitizer settings.

Note that, when a control type has only one supported control value on a given system, it is not documented in this function because it cannot be changed to another value. Instead it can only be inquired.

To inquire the current value of a particular digitizer setting, use MdigInquire().

If you change the setting of a control type of a digitizer currently being used in a grab, the change does not affect the current grab. It does, however, affect the very next grab.

[Matrox Radient eCL; Matrox Radient eV-CL (introduced U27); Matrox Radient eV-CXP (introduced M10); Matrox RadientPro-CL (Update 7); Matrox Rapixo CL Pro (Update 96); Matrox Rapixo CXP (introduced U75); Matrox Solios eA/XA; Matrox Solios ecl/xcl/ev-cl]

Note that, to change this default behavior and have the change affect the digitizer even if it is currently being used in a grab, use M_COMMAND_QUEUE_MODE.

You can also interactively control and test most of the digitizer settings and obtain results in real-time, using Matrox Feature Browser; to access this interface, use Matrox Intellicam or MdigControl() with M_GC_FEATURE_BROWSER. If your camera is connected to a CoaXPress (CXP) communication standard-compliant frame grabber (such as Matrox Radient eV-CXP), you can save digitizer (and camera) settings selected in Matrox Intellicam's Feature Browser to the DCF for your camera.

[Matrox GenTL driver (Update 34); Matrox GigE Vision driver (introduced M10); Matrox USB3 Vision driver (Update 19)]

Typically, the supported control types affect the GenICam-compliant camera (or device) associated with the digitizer. These control types assume your camera supports the associated GenICam standard feature naming convention (SFNC) feature. If the device does not support the associated GenICam SFNC feature, an error is generated. In case of error, use MdigControlFeature() with the device-specific feature names and values specified by the device manufacturer.

Note that there are several control types that are available on a Host system, even without any additional Matrox imaging boards; these are to control a simulated digitizer (allocated using MdigAlloc() with M_EMULATED). To see the control types available to control a simulated digitizer, select the Host system as your board type in this help file. For more information on simulated digitizers, refer to the Simulated digitizer section of Chapter 25: Grabbing with your digitizer.

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

Specifies the identifier of the digitizer.

ControlType

Specifies the digitizer setting to control.

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

ControlValue

Specifies the value to assign to the digitizer setting.

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

The following control types allow you to control various digitizer settings.

function map For the general digitizer settings
Click to summarize
ControlType
Description MIL system-specific
tooltip (‡)
ControlValue
Click to summarize M_BAYER_COEFFICIENTS_ID

Loads the internal white balance coefficients buffer with the values in the specified buffer. To have your digitizer automatically calculate these coefficients and load them into the internal buffer, use the M_WHITE_BALANCE control type with M_CALCULATE. Note that the internal buffer only has an effect if the M_BAYER_CONVERSION and M_WHITE_BALANCE control types are enabled.

If you change the coefficient values in the specified buffer, you must call MdigControl() again with the updated buffer to load the new values into the internal white balance coefficients buffer. INQ

(summarize)
c
M10
k
M10
m o p r
U27
t
U28
v y
U75
aa
MIL system specific

Refer to your Matrox Imaging board's hardware manual for more details.

k
M10
m p r
U27
y
U75
aa

Note that this control type is used to perform Bayer conversion if performed by the Host. To control the Bayer conversion on the camera, use MdigControlFeature(); refer to your camera's documentation for details regarding the features to set.

c
M10
o v

Note that this control type is only supported on Matrox Solios eV-CLB and eV-CLBL.

m

Note that this control type is only available when using color versions of Matrox Iris GTR (such as 1300C).

t
U28
Click to summarize M_DEFAULT

Specifies to use the default coefficients that were automatically set, following a call to MdigAlloc(). The default coefficients are initially set in the DCF.

(summarize)
c
M10
o t
U28
v
Click to summarize MIL array buffer identifier

Specifies the identifier of an M_ARRAY buffer containing the white balance coefficients. The buffer must be allocated as a single-band 32-bit floating-point buffer with a 3x1 dimension. For more information, see White balancing your Bayer images.

(summarize)
c
M10
k
M10
m o p r
U27
t
U28
v y
U75
aa
Click to summarize M_BAYER_CONVERSION

Sets whether to perform a Bayer color conversion, using your digitizer. This control type can only be used when grabbing from a camera that has a Bayer color filter, otherwise an error will be generated.

For a more conventional technique of controlling Bayer conversion, use MbufBayer() and see White balancing your Bayer images. INQ

(summarize)
c
M10
k
M10
m o p r
U27
t
U28
v y
U75
aa
MIL system specific

Refer to your Matrox Imaging board's hardware manual for more details.

k
M10
m p r
U27
y
U75
aa

Note that this control type is used to perform Bayer conversion if performed by the Host. To control the Bayer conversion on the camera, use MdigControlFeature(); refer to your camera's documentation for details regarding the features to set.

c
M10
o v

Note that this control value is only supported on Matrox Solios eV-CLB and eV-CLBL.

m

Note that this control type is only available when using color versions of Matrox Iris GTR (such as 1300C).

t
U28
Click to summarize M_DEFAULT

Same as M_ENABLE.

c
M10
k
M10
m o p r
U27
t
U28
v y
U75
aa
Click to summarize M_DISABLE

Specifies to not perform Bayer conversion on the grabbed image.

c
M10
k
M10
m o p r
U27
t
U28
v y
U75
aa
Click to summarize M_ENABLE

Specifies to perform Bayer conversion on the grabbed image. Note that to white balance an image, M_WHITE_BALANCE must also be set to M_ENABLE.

(summarize)
c
M10
k
M10
m o p r
U27
t
U28
v y
U75
aa
Click to summarize M_CAMERA_COLOR_LOCK

Sets whether a color-lock check is done before starting each grab. This control type has an effect only when M_CAMERA_LOCK is enabled and/or when a camera lock was successful (established using MdigInquire() with M_CAMERA_LOCKED). Note that this control type is only applicable when the digitizer uses a composite or Y/C color DCF. INQ

(summarize)
g
Click to summarize M_DEFAULT

Same as M_ENABLE.

g
Click to summarize M_DISABLE

Specifies that a color-lock check will not be done.

g
Click to summarize M_ENABLE

Specifies that a color-lock check will be done.

g
Click to summarize M_CAMERA_LOCK

Sets whether to check if the camera is locked with the digitizer after channel-switching. Ensuring that the camera is locked after channel-switching is useful when the digitizer might not be synchronized with the source. When performing a channel-switch, the hardware needs to be unlocked from the current camera and locked to the new camera. If the hardware is not locked properly, it can affect the speed and reliability of the next grab. INQ

(summarize)
g l
Click to summarize M_DEFAULT

Same as M_ENABLE.

g l
Click to summarize M_DISABLE

Specifies that the grab operation (such as, MdigGrab()) grabs without verifying whether the digitizer is locked with the camera. Corrupt images or a synchronization-lost error can occur if the digitizer is not locked.

(summarize)
g l
Click to summarize M_ENABLE

Specifies that the grab operation (such as, MdigGrab()) waits until the digitizer is locked with the camera before starting the grab.

g l
Click to summarize M_CAMERA_LOCK_SENSITIVITY

Sets how sensitive the digitizer is to locking with the next camera, during a channel switch. The lock sensitivity determines how quickly a lock can occur and how reliable the lock is. This control type only has an effect if M_CAMERA_LOCK is disabled. INQ

(summarize)
g
Click to summarize M_DEFAULT

Specifies the optimal compromise between speed and reliability, and varies depending on the Matrox Imaging board.

g
Click to summarize 0 <= Value <= 511

Specifies the camera line-lock sensitivity level. 0 is the least reliable but has the fastest lock speed.

(summarize)
g
Click to summarize M_CAMERA_UNLOCK_SENSITIVITY

Sets how sensitive the digitizer is to unlocking from the camera, during a channel switch. The unlock sensitivity determines how quickly an unlock can occur and how reliable the unlock is. This control type only has an effect if M_CAMERA_LOCK is enabled. INQ

(summarize)
g
Click to summarize M_DEFAULT

Specifies the optimal compromise between speed and reliability, and varies depending on the Matrox Imaging board.

g
Click to summarize 0 <= Value <= 255

Specifies the camera line-unlock sensitivity level. 0 is the least reliable but has the fastest unlock speed.

(summarize)
g
Click to summarize M_CHANNEL

Sets the channel on which the digitizer is to acquire data, as well as sets the synchronization channel to the default for the selected data channel. Note that, typically, this control type is only available when the specified digitizer uses acquisition paths with several multiplexed data inputs. This means that they have several data input channels but can only grab from one channel at a time. INQ

(summarize)
g i l u
U36
Click to summarize M_DEFAULT

Same as M_CH0.

g i l u
U36
Click to summarize M_CH0

Specifies channel 0 as the channel on which the digitizer is to receive input data.

(summarize)
g i l u
U36
MIL system specific

For Y/C input, this corresponds to VID_IN2 (Green of camera 0) and VID_IN3 (Blue of camera 0).

For CVBS input, this corresponds to VID_IN2 (Green of camera 0).

u
U36

For monochrome or composite input, this corresponds to VID_IN0 .

g

For Y/C input, this corresponds to VID_IN0 (Y of camera 0) and VID_IN1 (C of camera 0).

g

For DVI-D signals or when using RGB input, only this channel is available. It corresponds to analog green (CVBS0), analog blue (CVBS1), and analog red (CVBS2).

When using standard definition (SD) analog, it corresponds to HD/SD_SDI_IN0 on the external digital video input connectors.

i

This corresponds to a signal whose name ends with A.

l
Click to summarize M_CH1

Specifies channel 1 as the channel on which the digitizer is to receive input data.

(summarize)
g i l u
U36
MIL system specific

For Y/C input, this corresponds to VID_IN6 (Luminance of camera 1) and VID_IN5 (Chrominance of camera 1).

For CVBS input, this corresponds to VID_IN5 (Chrominance of camera 1).

u
U36

For monochrome or composite input, this corresponds to VID_IN1 .

g

This channel corresponds to a signal whose name ends with B.

l

For Y/C input, this corresponds to VID_IN2 (Y of camera 1) and VID_IN3 (C of camera 1).

g

When using standard definition (SD) analog, it corresponds to HD/SD_SDI_IN1 on the external digital video input connectors.

i
Click to summarize M_CH2

Specifies channel 2 as the channel on which the digitizer is to receive input data.

(summarize)
g i u
U36
MIL system specific

For CVBS input, this corresponds to VID_IN6 (Luminance of camera 2).

u
U36

For composite color/monochrome input, this corresponds to VID_IN2 .

g
Click to summarize M_CH3

Specifies channel 3 as the channel on which the digitizer is to receive input data.

For composite color/monochrome input, this corresponds to VID_IN3 .

(summarize)
g
MIL system specific

For Y/C input, this corresponds to VID_IN6 (Y of camera 3) and VID_IN7 (C of camera 3).

g
Click to summarize M_CH4

Specifies channel 4 as the channel on which the digitizer is to receive input data.

For Y/C input, this corresponds to VID_IN8 (Y of camera 4) and VID_IN9 (C of camera 4).

For composite color/monochrome input, this corresponds to VID_IN4 .

(summarize)
g
Click to summarize M_CH5

Specifies channel 5 as the channel on which the digitizer is to receive input data.

For composite color/monochrome input, this corresponds to VID_IN3 .

For Y/C input, this corresponds to VID_IN10 (Y of camera 5) and VID_IN11 (C of camera 5).

(summarize)
g
Click to summarize M_CH6

Specifies channel 6 as the channel on which the digitizer is to receive input data.

For composite color/monochrome input, this corresponds to VID_IN6 .

For Y/C input, this corresponds to VID_IN12 (Y of camera 6) and VID_IN13 (C of camera 6).

(summarize)
g
Click to summarize M_CH7

Specifies channel 7 as the channel on which the digitizer is to receive input data.

For composite color/monochrome input, this corresponds to VID_IN7 .

For Y/C input, this corresponds to VID_IN14 (Y of camera 7) and VID_IN15 (C of camera 7).

(summarize)
g
Click to summarize M_CH8

Specifies channel 8 as the channel on which the digitizer is to receive input data.

For composite color/monochrome input, this corresponds to VID_IN8 .

(summarize)
g
Click to summarize M_CH9

Specifies channel 9 as the channel on which the digitizer is to receive input data.

For composite color/monochrome input, this corresponds to VID_IN9 .

(summarize)
g
Click to summarize M_CH10

Specifies channel 10 as the channel on which the digitizer is to receive input data.

For composite color/monochrome input, this corresponds to VID_IN10 .

(summarize)
g
Click to summarize M_CH11

Specifies channel 11 as the channel on which the digitizer is to receive input data.

For composite color/monochrome input, this corresponds to VID_IN11 .

(summarize)
g
Click to summarize M_CH12

Specifies channel 12 as the channel on which the digitizer is to receive input data.

For composite color/monochrome input, this corresponds to VID_IN12 .

(summarize)
g
Click to summarize M_CH13

Specifies channel 13 as the channel on which the digitizer is to receive input data.

For composite color/monochrome input, this corresponds to VID_IN13 .

(summarize)
g
Click to summarize M_CH14

Specifies channel 14 as the channel on which the digitizer is to receive input data.

For composite color/monochrome input, this corresponds to VID_IN14 .

(summarize)
g
Click to summarize M_CH15

Specifies channel 15 as the channel on which the digitizer is to receive input data.

For composite color/monochrome input, this corresponds to VID_IN15 .

(summarize)
g
Click to summarize M_COMMAND_QUEUE_MODE

Sets whether changes to digitizer settings affect the digitizer immediately, even if it is currently being used in a grab, or the change will wait until the current grab is complete. INQ

(summarize)
j k
M10
l m p r
U27
y
U75
aa
Click to summarize M_DEFAULT

Same as M_QUEUED.

j k
M10
l m p r
U27
y
U75
aa
Click to summarize M_IMMEDIATE

Specifies that, if you change the setting of a control type of a digitizer currently being used in a grab, the change affects the current grab. Note that, this can cause the grabbed image to become corrupt.

(summarize)
j k
M10
l m p r
U27
y
U75
aa
Click to summarize M_QUEUED

Specifies that, if you change the setting of a control type of a digitizer currently being used in a grab, the change does not affect the current grab. Instead, the changes are queued and applied before the very next grab.

(summarize)
j k
M10
l m p r
U27
y
U75
aa
Click to summarize M_CORRUPTED_FRAME_ERROR

Sets whether an error is generated when a corrupted or incomplete frame is grabbed. INQ

(summarize)
c
M10
i o t
U28
u
U36
v
MIL system specific

Note that whether the grabbed image is corrupt can always be inquired using MdigGetHookInfo() with M_CORRUPTED_FRAME from the user-defined function hooked to the end of a grab using MdigProcess().

c
M10
o v
Click to summarize M_DEFAULT

Same as M_ENABLE.

c
M10
i o t
U28
u
U36
v
Click to summarize M_DISABLE

Specifies not to generate an error when grabbing a corrupted frame.

c
M10
i o t
U28
u
U36
v
Click to summarize M_ENABLE

Specifies to generate an error when grabbing a corrupted frame.

c
M10
i o t
U28
u
U36
v
Click to summarize M_DIGITIZER_INTERNAL_BUFFERS_NUM

Sets the number of internal grab buffers allocated and used when MIL cannot grab directly into the specified buffers (for example, when the grab buffer's format is not compatible with the camera's current pixel format or when the image sent from a GenICam-compliant camera has additional information that needs to be stripped out to make the grabbed image compatible with MIL buffers, such as when GenICam "chunk mode" is enabled). INQ

(summarize)
c
M10
o v
Click to summarize M_DEFAULT

Specifies the default value; the default value is 5.

c
M10
o v
Click to summarize Value >= 0

Specifies the number of internal grab buffers.

c
M10
o v
Click to summarize M_FIX_PATTERN_NOISE_CORRECTION

Sets the type of fixed pattern noise correction to apply when acquiring images. Note that, acquisition must be stopped prior to changing this control type. INQ

(summarize)
t
U28
Click to summarize M_DEFAULT

Same as M_PREPROCESSING.

t
U28
Click to summarize M_PREPROCESSING

Specifies a correction for dark signal non-uniformity and for photo response non-uniformity, applied to the grabbed images. MIL calculates the correction factor(s) when the control type is called.

(summarize)
t
U28
Click to summarize M_SENSOR

Specifies a correction for dark signal non-uniformity, applied to the grabbed images. MIL adjusts the correction factor for each image.

(summarize)
t
U28
Click to summarize M_FOCUS +

Sets the lens focus capabilities.

Note that this control type requires that your Matrox Iris GTR use an I 2 C (inter-integrated circuit) controlled lens. INQ

(summarize)
t
U28
Click to summarize Min. focus <= Value <= Max. focus

Specifies a value between the minimum and maximum values supported by the camera. Use MdigInquire() to determine these values.

(summarize)
t
U28
Click to summarize M_FOCUS_PERSISTENCE

Sets whether to store a focus position for the I 2 C (inter-integrated circuit) controlled lens. This stored focus position is written to the I 2 C (inter-integrated circuit) controlled lens when the smart camera is allocated, using MdigAlloc(). If there is no I 2 C (inter-integrated circuit) controlled lens attached, the value is ignored. INQ

(summarize)
t
U28
Click to summarize M_DEFAULT

Same as M_DISABLE.

t
U28
Click to summarize M_DISABLE

Specifies to not store the focus position.

t
U28
Click to summarize M_ENABLE

Specifies to store the focus position.

t
U28
Click to summarize M_FOCUS_PERSISTENT_VALUE

Sets the focus position to store for the I 2 C (inter-integrated circuit) controlled lens. If there is no I 2 C (inter-integrated circuit) controlled lens attached, the value is ignored. INQ

(summarize)
t
U28
Click to summarize 0 <= Value <= 1023

Specifies to store the focus position.

t
U28
Click to summarize M_GC_CLPROTOCOL

Sets whether the GenICam CLProtocol module is enabled. The GenICam CLProtocol module allows Camera Link cameras to be accessed using GenICam-specific constants (including M_GC_FEATURE_BROWSER), as well as using MdigControlFeature() and MdigInquireFeature().

Even when the GenICam CLProtocol module is enabled, you should follow the MIL documentation specific to your board; if a control type requires the CLProtocol module to be enabled, it will be noted.

Note that this control type should be enabled only if using a GenCP-compliant camera or after the required third-party, vendor-supplied, standard-compliant CLProtocol library for the Camera Link camera is installed on your computer and M_GC_CLPROTOCOL_DEVICE_ID is set. INQ

(summarize)
j m p r
U27
aa
Click to summarize M_DEFAULT

Same as M_DISABLE.

j m p r
U27
aa
Click to summarize M_DISABLE

Specifies that the GenICam CLProtocol module is disabled.

j m p r
U27
aa
Click to summarize M_ENABLE

Specifies that the GenICam CLProtocol module is enabled.

j m p r
U27
aa
Click to summarize M_GC_CLPROTOCOL_DEVICE_ID

Identifies the Camera Link camera connected to your digitizer, as well as the GenICam CLProtocol library for the camera. When allocating a digitizer for a camera, the digitizer identifies that the connected device is a camera; M_GC_CLPROTOCOL_DEVICE_ID provides the digitizer with the details required to identify a specific Camera Link camera and its corresponding GenICam CLProtocol library.

Note that this control type should be used only if using a GenCP-compliant camera or after the required third-party vendor-supplied, standard compliant, CLProtocol library for the Camera Link camera is installed on your computer.

To enumerate the complete list of camera identifiers installed on your computer, use MdigInquire() with M_GC_CLPROTOCOL_DEVICE_ID + n. For an example, see CLProtocol.cpp.

Even after you have specified the library to use, you must enable the CLProtocol module (with M_GC_CLPROTOCOL set to M_ENABLE) before you can use a Matrox GenICam constant (including M_GC_FEATURE_BROWSER), or use MdigControlFeature(), or MdigInquireFeature(). INQ

(summarize)
j m p r
U27
aa
Click to summarize
M_PTR_TO_DOUBLE(
MIL_CONST_TEXT_PTR String
)

Casts the address of the string identifying the specified Camera Link camera and its corresponding GenICam CLProtocol library, from a MIL_CONST_TEXT_PTR to a MIL_DOUBLE. The specified identifier string must contain sufficient data to uniquely identify the Camera Link camera and its GenICam CLProtocol library.

(summarize)
j m p r
U27
aa
Parameters

This parameter specifies the string whose address to cast.

j m p r
U27
aa
MIL_TEXT("M_DEFAULT") 1

Specifies to use the default identifier string of your Camera Link camera and its corresponding GenICam CLProtocol library, specified using the MILConfig utility.

j m p r
U27
aa
MIL_TEXT("CameraLinkCameraIdentifier") 1

Specifies the identifier string of your Camera Link camera and its corresponding GenICam CLProtocol library.

The specified string should contain the tokens separated by the hash ("#") sign instead of back slashes (for example, "LibraryDirectory#LibraryFileName#Manufacturer#Family#Model#Version). Each of these tokens must follow the naming convention for C variables.

j m p r
U27
aa
Click to summarize M_GC_FEATURE_BROWSER +

Sets whether to open or close a window that allows you to view and edit the GenICam-compliant camera configuration information interactively; this widow is referred to as Matrox Feature Browser.

(summarize)
c
M10
j k
M10
m o p r
U27
u
U36
v y
U75
aa
MIL system specific

Note that, this control type is only available if using a GenCP-compatible camera, or if you first install the third-party, vendor-supplied, standard compliant CLProtocol library for the Camera Link camera connected to your digitizer.

j m p r
U27
aa

The Matrox GenTL Consumer driver allows you to edit the GenICam-compliant stream, device, or remote device configuration information.

v
Click to summarize M_DEFAULT

Same as M_OPEN.

c
M10
j k
M10
m o p r
U27
u
U36
v y
U75
aa
Click to summarize M_CLOSE

Closes Matrox Feature Browser.

c
M10
j k
M10
m o p r
U27
u
U36
v y
U75
aa
Click to summarize M_OPEN +

Opens Matrox Feature Browser.

(summarize)
c
M10
j k
M10
m o p r
U27
u
U36
v y
U75
aa
MIL system specific

You must specify a combination value from the following table:
c
M10
k
M10
m o u
U36
v y
U75
Click to summarize M_GC_FEATURE_POLLING

Sets whether Matrox Feature Browser will periodically poll camera features that can automatically change on the camera, for updates (for example, the camera's temperature). The camera's device description file (XML) defines these feature as pollable. To learn whether a camera feature is pollable, refer to your camera's documentation.

If this control type is enabled, these features will be polled periodically and Matrox Feature Browser (if open either through Matrox Intellicam or launched using M_GC_FEATURE_BROWSER) will be updated automatically with this information. The polling period is determined by MIL and throttled with respect to available bandwidth.

If this control type is disabled, Matrox Feature Browser will display the initial value of the pollable features and not update them until the user clicks upon their corresponding display field in Matrox Feature Browser. Note that MdigInquire() and MdigInquireFeature() always return information that comes from the camera at the time of the inquire, regardless of whether feature polling is enabled or not.

Note that this control type does not enable execution-polling completion of executable commands. To enable execution-polling completion, use MsysControl() with M_GC_FEATURE_EXECUTE_POLLING_MODE. INQ

(summarize)
c
M10
j k
M10
m o p r
U27
v y
U75
aa
MIL system specific

Note that, this control type is only available if using a GenCP-compatible camera, or if you first install the third-party, vendor-supplied, standard compliant CLProtocol library for the Camera Link camera connected to your digitizer.

j m p r
U27
aa
Click to summarize M_DEFAULT

Same as M_DISABLE.

c
M10
j k
M10
m o p r
U27
v y
U75
aa
Click to summarize M_DISABLE

Specifies that automatically changing camera features will not be polled.

c
M10
j k
M10
m o p r
U27
v y
U75
aa
Click to summarize M_ENABLE

Specifies that automatically changing camera features will be polled.

c
M10
j k
M10
m o p r
U27
v y
U75
aa
Click to summarize M_GC_FRAME_MAX_RETRIES

Sets the maximum number of times packets should be re-sent before flagging their associated frame as corrupt. Each packet can be re-sent the number of times specified using M_GC_PACKET_MAX_RETRIES. When the total number of packet re-sends is equal to M_GC_FRAME_MAX_RETRIES, the frame is flagged as corrupt (for example, if each packet can be re-sent 3 times and the frame's maximum retries is set to 30, a total of 30 packets associated with the frame can be re-sent before the frame is flagged as corrupt).

To establish the number of frames corrupted, use MdigInquire() with M_GC_TOTAL_FRAMES_MISSED, Matrox Capture Assistant, or Matrox Intellicam's Feature Browser. INQ

(summarize)
c
M10
Click to summarize M_DEFAULT

Specifies the default value; the default value is 30.

c
M10
Click to summarize Value >= M_GC_PACKET_MAX_RETRIES

Specifies the maximum number of times to retry sending the packets of a frame.

Note that this value should always be greater than or equal to M_GC_PACKET_MAX_RETRIES.

(summarize)
c
M10
Click to summarize M_GC_FRAME_TIMEOUT

Sets the maximum amount of time to wait for the remaining packets of a frame, after receiving the trailer packet. If the missing packets are not returned within this time period, the corresponding frame is flagged as corrupt. To establish the number of corrupt frames, use MdigInquire() with M_GC_TOTAL_FRAMES_MISSED, Matrox Capture Assistant, or Matrox Intellicam's Feature Browser. INQ

(summarize)
c
M10
Click to summarize M_DEFAULT

Specifies the default value; the default value is 100 msec.

c
M10
Click to summarize Value >= 0

Specifies the maximum time to wait, in msec.

c
M10
Click to summarize M_GC_HEARTBEAT_STATE

Sets whether the heartbeat mechanism is used to keep the GigE Vision-compliant camera active. The heartbeat mechanism is used to inform your camera that communication between your MIL application and the camera is still open.

If your application experiences a fatal error while the heartbeat mechanism is disabled, you will be unable to reconnect to your camera until you manually restart it. You should therefore typically disable the heartbeat mechanism only when required for debugging your application. If you experience timeouts when your application is running under normal circumstances, you should extend the heartbeat timeout period using M_GC_HEARTBEAT_TIMEOUT instead. INQ

(summarize)
c
M10
Click to summarize M_DEFAULT

Same as M_ENABLE.

c
M10
Click to summarize M_DISABLE

Specifies that the heartbeat mechanism is disabled. The camera always assumes communication will continue and remains active indefinitely.

(summarize)
c
M10
Click to summarize M_ENABLE

Specifies that the heartbeat mechanism is enabled. If, after the heartbeat timeout value expires, the camera assumes there will be no further communication and shuts down.

(summarize)
c
M10
Click to summarize M_GC_HEARTBEAT_TIMEOUT

Sets the amount of time that your GigE Vision-compliant camera will wait after the last communication before shutting down. INQ

(summarize)
c
M10
Click to summarize M_DEFAULT

Specifies the default value; the default value is 5000 msec.

c
M10
Click to summarize Value >= 0

Specifies the amount of time, in msec.

c
M10
Click to summarize M_GC_INTER_PACKET_DELAY

Sets the delay between packets sent by your camera when transmitting a stream of image packets.

The unit used is a timestamp tick. If you know the inter-packet delay in sec, use the following calculation to convert from timestamp ticks to sec: (1/m)*n , where m is the frequency of the timestamp ticks (to inquire this value, use MdigInquire() with M_GC_COUNTER_TICK_FREQUENCY), and n is your inter-packet delay value. INQ

(summarize)
c
M10
Click to summarize Value >= 0

Specifies the delay, in timestamp ticks.

c
M10
Click to summarize M_GC_LOCAL_MESSAGE_PORT

Sets the UDP port number used for the message channel on the computer connected to your GigE Vision-compliant camera. By default, this port number is set by MIL. This control type should be changed only if there is a multicast conflict. Note that, with a multicast conflict, the multicast IP address and/or the UDP port assignment can be in conflict. If the problem persists after changing the message port, you can try changing the default multicast IP address, using M_GC_MESSAGE_CHANNEL_MULTICAST_ADDRESS_STRING.

This control type is only available when dealing with a multicast master or monitor (allocated using MdigAlloc() with M_GC_MULTICAST_MASTER or M_GC_MULTICAST_MONITOR). For more information on using a multicast IP address, refer to the Using IP multicast section of the Matrox GigE Vision driver chapter in the MIL Hardware-specific Notes. INQ

(summarize)
c
M10
Click to summarize 0 <= Value <=66535

Specifies the port number.

c
M10
Click to summarize M_GC_LOCAL_STREAM_PORT

Sets the UDP port number used for the GVSP (GigE Vision Stream Protocol) channel on the computer connected to your GigE Vision-compliant camera. By default, this port number is set by MIL within the reserved range of multicast port numbers. This control type should be changed only if there is a multicast conflict. Note that, with a multicast conflict, the multicast IP address and/or the UDP port assignment can be in conflict. If the problem persists after changing the stream port, you can try changing the default multicast IP address, using M_GC_STREAM_CHANNEL_MULTICAST_ADDRESS_STRING.

This control type is only available when dealing with a multicast master or monitor (allocated using MdigAlloc() with M_GC_MULTICAST_MASTER or M_GC_MULTICAST_MONITOR). For more information on using a multicast IP address, refer to the Using IP multicast section of the Matrox GigE Vision driver chapter in the MIL Hardware-specific Notes. INQ

(summarize)
c
M10
Click to summarize 0 <= Value <=66535

Specifies the port number.

c
M10
Click to summarize M_GC_MAX_NBR_PACKETS_OUT_OF_ORDER

Sets the maximum number of packets that can be received out-of-order, before the associated frame is marked as corrupt. This is useful when using link-aggregated cameras, where packets are typically received out-of-order. To establish the number of packets currently received out-of-order, use MdigInquire() with M_GC_MAX_NBR_PACKETS_OUT_OF_ORDER, Matrox Capture Assistant, or Matrox Intellicam's Feature Browser. INQ

(summarize)
c
M10
Click to summarize M_DEFAULT

Specifies the default value; the default value is 0.

c
M10
Click to summarize Value >= 0

Specifies the maximum number of out-of-order packets to receive.

c
M10
Click to summarize M_GC_MESSAGE_CHANNEL_MULTICAST_ADDRESS_STRING

Sets the IP address used for the multicast message channel of your GigE Vision-compliant camera. This IP address is set by MIL within the reserved range of multicast IP addresses (239.0.0.0 to 239.255.255.255). This control type should be changed only if there is a multicast conflict. Note that, with a multicast conflict, the multicast IP address and/or the UDP port assignment can be in conflict. If the problem persists after changing the multicast IP address, you can try changing the default UDP port assignment, using M_GC_LOCAL_MESSAGE_PORT.

This control type is only available when dealing with a multicast master or monitor (allocated using MdigAlloc() with M_GC_MULTICAST_MASTER or M_GC_MULTICAST_MONITOR). For more information on using a multicast IP address, refer to the Using IP multicast section of the Matrox GigE Vision driver chapter in the MIL Hardware-specific Notes. INQ

(summarize)
c
M10
Click to summarize
M_PTR_TO_DOUBLE(
MIL_CONST_TEXT_PTR String
)

Casts the string with the specified multicast IP address of the camera from a MIL_CONST_TEXT_PTR to a MIL_DOUBLE. The size of this string is determined by calling MdigInquire() with M_GC_MESSAGE_CHANNEL_MULTICAST_ADDRESS_STRING.

(summarize)
c
M10
Parameters

This parameter specifies the string whose address to cast.

c
M10
MIL_TEXT("239.n.n.n") 1

Specifies the multicast IP address of the camera, in dotted decimal notation where each dotted decimal value (n) is a number between 0 and 255.

c
M10
Click to summarize M_GC_PACKET_MAX_RETRIES

Sets the maximum number of times each packet can be re-sent. If the maximum number of times a packet can be re-sent is reached, the packet is flagged as corrupted. INQ

(summarize)
c
M10
Click to summarize M_DEFAULT

Specifies the default value; the default value is 3.

c
M10
Click to summarize Value >= M_GC_FRAME_MAX_RETRIES

Specifies the maximum number of times to resend a given packet of a frame.

Note that this value should always be less than M_GC_FRAME_MAX_RETRIES.

(summarize)
c
M10
Click to summarize M_GC_PACKET_RESEND

Sets whether to request packets be re-sent from your GigE Vision-compliant camera, if the packets are not received properly (for example, when the packets are received out-of-order, or a packet timeout occurs). The request is issued up to a maximum number of times for each packet, set using M_GC_PACKET_MAX_RETRIES. INQ

(summarize)
c
M10
Click to summarize M_DISABLE

Specifies that packets should never be re-sent.

c
M10
Click to summarize M_ENABLE

Specifies that packets should be re-sent as required.

This is the default value.

(summarize)
c
M10
Click to summarize M_GC_PACKET_SIZE

Sets the packet size used by the GigE Vision-compliant camera when streaming data to the Host. By default, Matrox's GigE Vision driver negotiates the largest possible packet size with the GigE Vision-compliant camera. This control type should only be changed if the negotiated size is causing errors in acquisition (such as image corruption). INQ

(summarize)
c
M10
Click to summarize Value >= 0

Specifies the packet size, in bytes. Typical packet sizes range from 512 bytes to 1.5 Kbytes. Jumbo packets, if enabled on your network and compatible with both your GigE Vision device and your firewall, are up to 9 Kbytes in size.

(summarize)
c
M10
Click to summarize M_GC_PACKET_TIMEOUT

Sets the maximum amount of time to wait before flagging a packet as dropped. INQ

(summarize)
c
M10
Click to summarize M_DEFAULT

Specifies the default value; the default value is 10 msec.

c
M10
Click to summarize Value >= 0

Specifies the maximum time to wait, in msec.

c
M10
Click to summarize M_GC_PIXEL_FORMAT

Sets the pixel format that the digitizer should use to create internal buffers to receive images from the camera, if the digitizer is a multicast monitor digitizer. The pixel format cannot be inquired from the GigE Vision-compliant camera. It must therefore be set using this control type or a DCF. To set this value to the same pixel format as received image data, use MdigInquire() with M_SOURCE_DATA_FORMAT; in this case, you must first grab into an arbitrary image buffer and then issue the inquire. INQ

(summarize)
c
M10
v
Click to summarize M_DEFAULT

Same as specified in the DCF.

c
M10
v
Click to summarize Value

Specifies the data depth and raw color format to use to create the internal buffers. The GenICam predefined list of pixel formats are in the PFNC.h header file in MIL installation folder, under the include\MilDyn subfolder.

(summarize)
c
M10
v
Click to summarize M_GC_PIXEL_FORMAT_SWITCHING

Sets whether to allow the camera's pixel format to change automatically to match the current grab buffer, when supported by the GenICam-compliant camera. INQ

(summarize)
c
M10
o v
Click to summarize M_DEFAULT

Same as M_ENABLE.

c
M10
o v
Click to summarize M_DISABLE

Specifies to disable automatic pixel format switching.

c
M10
o v
Click to summarize M_ENABLE

Specifies to enable automatic pixel format switching.

c
M10
o v
Click to summarize M_GC_STATISTICS_RESET

Resets the acquisition statistics. For a list of GenICam-compliant statistics available in MIL, refer to MdigInquire() with M_GC_TOTAL_..., Matrox Capture Assistant, or Matrox Intellicam's Feature Browser.

(summarize)
c
M10
o
Click to summarize M_DEFAULT

Implements the default behavior.

c
M10
o
Click to summarize M_GC_STREAM_CHANNEL_MULTICAST_ADDRESS_STRING

Sets the IP address used for the multicast stream channel of your GigE Vision-compliant camera. By default, this address is set by MIL within a limited range of multicast addresses (239.0.0.0 to 239.255.255.255). This control type should be changed only if there is a multicast conflict. Note that, with a multicast conflict, the multicast IP address and/or the UDP port assignment can be in conflict. If the problem persists after changing the multicast IP address, you can try changing the default UDP port assignment, using M_GC_LOCAL_STREAM_PORT.

This control type is only available when dealing with a multicast master or monitor (allocated using MdigAlloc() with M_GC_MULTICAST_MASTER or M_GC_MULTICAST_MONITOR). For more information on using a multicast IP address, refer to the Using IP multicast section of the Matrox GigE Vision driver chapter in the MIL Hardware-specific Notes. INQ

(summarize)
c
M10
Click to summarize
M_PTR_TO_DOUBLE(
MIL_CONST_TEXT_PTR String
)

Casts the string with the specified multicast IP address of the camera from a MIL_CONST_TEXT_PTR to a MIL_DOUBLE. While MIL assigns an address within a limited range of multicast IP addresses (239.0.0.0 to 239.255.255.255), the full range is available (224.0.0.0 to 239.255.255.255). You can determine the size of this string by calling MdigInquire() with M_GC_STREAM_CHANNEL_MULTICAST_ADDRESS_STRING + M_STRING_SIZE.

(summarize)
c
M10
Parameters

This parameter specifies the string whose address to cast.

c
M10
MIL_TEXT("2nn.n.n.n") 1

Specifies the multicast IP address of the camera, in dotted decimal notation where each dotted decimal value (n) is a number between 0 and 255.

c
M10
Click to summarize M_GC_STREAMING_MODE

Sets the camera's image stream activation mechanism. Typically, this control type is used when performing a monoshot grab in a loop. Since the camera cannot tell when the next grab might arrive, you can either manually control the image stream (starting it before the first grab and stopping it after the last one), or allow MIL to handle it automatically (using M_GC_STREAMING_STOP_CHECK_PERIOD and M_GC_STREAMING_STOP_DELAY to control the delay between the grab and when the image stream is stopped). Reducing the time during which images are streamed to the Host can reduce bandwidth requirements. INQ

(summarize)
c
M10
k
M10
o v y
U75
Click to summarize M_DEFAULT

Same as M_AUTOMATIC.

c
M10
k
M10
o v y
U75
Click to summarize M_AUTOMATIC

Specifies that the image stream is started and stopped automatically.

Use M_GC_STREAMING_STOP_CHECK_PERIOD and M_GC_STREAMING_STOP_DELAY to control the delay between the grab and when the image stream is stopped.

(summarize)
c
M10
k
M10
o v y
U75
Click to summarize M_MANUAL

Specifies that the image stream is started and stopped manually. Use M_GC_STREAMING_START and M_GC_STREAMING_STOP.

(summarize)
c
M10
k
M10
o v y
U75
Click to summarize M_GC_STREAMING_START

Starts the camera's image stream. Note that this control type is only available when M_GC_STREAMING_MODE is set to M_MANUAL.

(summarize)
c
M10
k
M10
o v y
U75
Click to summarize M_DEFAULT

Implements the default behavior.

c
M10
k
M10
o v y
U75
Click to summarize M_GC_STREAMING_STOP

Stops the camera's image stream. Note that this control type is only available when M_GC_STREAMING_MODE is set to M_MANUAL.

(summarize)
c
M10
k
M10
o v y
U75
Click to summarize M_DEFAULT

Implements the default behavior.

c
M10
k
M10
o v y
U75
Click to summarize M_GC_STREAMING_STOP_CHECK_PERIOD

Sets the maximum amount of time to wait before MIL checks to see whether a grab is pending. If there is no grab pending after this delay, a second check is made after a second delay (set using M_GC_STREAMING_STOP_DELAY). If there is still no grab pending, then MIL stops the digitizer from streaming images.

Note that this control type is only available when M_GC_STREAMING_MODE is set to M_AUTOMATIC. INQ

(summarize)
c
M10
k
M10
o v y
U75
Click to summarize M_DEFAULT

Specifies the default value; the default value is 1000 msec.

c
M10
k
M10
o v y
U75
Click to summarize Value >= 0

Specifies the amount of time, in msec.

c
M10
k
M10
o v y
U75
Click to summarize M_GC_STREAMING_STOP_DELAY

Sets the amount of time to wait before stopping the image stream, if no grab is pending. Note that this delay occurs after the first check for pending grabs (set using M_GC_STREAMING_STOP_CHECK_PERIOD).

Note that this control type is only available when M_GC_STREAMING_MODE is set to M_AUTOMATIC. INQ

(summarize)
c
M10
k
M10
o v y
U75
Click to summarize M_DEFAULT

Specifies the default value; the default value is 0 msec.

c
M10
k
M10
o v y
U75
Click to summarize Value >= 0

Specifies the amount of time, in msec.

c
M10
k
M10
o v y
U75
Click to summarize M_GC_UPDATE_MULTICAST_INFO

Updates the multicast information on the master, slave, or monitor digitizer. The multicast information includes the IP address and port number used for the multicast stream and message channels of your GigE Vision-compliant camera.

When used with the multicast master digitizer (allocated using MdigAlloc() with M_GC_MULTICAST_MASTER), this control type updates the master digitizer's multicast information after you manually change it on the camera (using M_GC_STREAM_CHANNEL_MULTICAST_ADDRESS_STRING, M_GC_LOCAL_STREAM_PORT, M_GC_MESSAGE_CHANNEL_MULTICAST_ADDRESS_STRING, and/or M_GC_LOCAL_MESSAGE_PORT).

When used with a multicast slave digitizer (allocated using MdigAlloc() with M_GC_MULTICAST_SLAVE), this control type is used to update the local copy of the slave digitizer's multicast information after the multicast master digitizer disconnects with the camera and reconnects using a different multicast IP address and/or port number.

When used with a multicast monitor digitizer (allocated using MdigAlloc() with M_GC_MULTICAST_MONITOR), this control type is used to update the monitor digitizer's multicast information after you change the multicast stream channel address and port address manually for the digitizer.

To verify that the multicast master is connected, use MdigInquire() with M_GC_MULTICAST_MASTER_CONNECTED.

To detect when the image stream stops, check the number of images grabbed with MdigProcess(), using MdigInquire() with M_PROCESS_FRAME_COUNT before and after a wait period.

For more information on multicast IP addresses, refer to the Using IP multicast section of the Matrox GigE Vision driver chapter in the MIL Hardware-specific Notes.

(summarize)
c
M10
Click to summarize M_DEFAULT

Implements the default behavior.

c
M10
Click to summarize M_GC_USER_NAME

Sets the camera's name. INQ

(summarize)
c
M10
o v
Click to summarize
M_PTR_TO_DOUBLE(
MIL_CONST_TEXT_PTR String
)

Casts the address of the string identifying the camera's name, from a MIL_CONST_TEXT_PTR to a MIL_DOUBLE.

(summarize)
c
M10
o v
Parameters

This parameter specifies the string whose address to cast.

c
M10
o v
MIL_TEXT("CameraName") 1

Specifies the name of the camera. Note that this string can be 16 characters long (including the null-terminating character) and must use the UTF-8 character set.

c
M10
o v
Click to summarize M_GENTL_ANNOUNCE_BUFFER

Sets to announce the specified buffer to the GenTL producer, before starting the acquisition with MdigGrab(). Note that it is not necessary to announce buffers when using MdigGrabContinuous(), or MdigProcess().

(summarize)
v
Click to summarize MIL grab image buffer identifier

Specifies the identifier of a destination image buffer with an M_IMAGE + M_GRAB attribute.

v
Click to summarize M_GENTL_REVOKE_BUFFER

Sets to revoke a previously announced grab image buffer to the GenTL producer. Note that acquisition must be stopped before a buffer can be revoked.

(summarize)
v
Click to summarize MIL grab image buffer identifier

Specifies the identifier of a destination image buffer with an M_IMAGE + M_GRAB attribute.

v
Click to summarize M_GRAB_ABORT

Immediately stops a grab in progress and aborts queued grabs. This is useful for canceling a triggered grab that is waiting for a trigger.

(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

Note that, for this control type to function on the Host, you must pass a simulated digitizer (allocated using MdigAlloc() with M_EMULATED).

a
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_GRAB_DIRECTION_X

Sets the horizontal grab direction. INQ

(summarize)
c
M10
g h 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_FORWARD.

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

Specifies to grab from left to right, in the horizontal direction.

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

Specifies to grab from right to left, in the horizontal direction. Effectively, this flips the grabbed image horizontally.

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

Sets the vertical grab direction. INQ

(summarize)
c
M10
g h 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_FORWARD.

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

Specifies to grab from top to bottom, in the vertical direction.

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

Specifies to grab from bottom to top, in the vertical direction. Effectively, this flips the grabbed image vertically.

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

Sets the number of fields to grab when grabbing data with MdigGrab().

This control type should only be used with interlaced cameras. When using progressive cameras, set this control type to 1. INQ

(summarize)
g h i l m u
U36
Click to summarize M_DEFAULT

Specifies the default value.

For interlaced cameras, the default is 2. For progressive cameras, the default is 1.

(summarize)
g h i l m u
U36
Click to summarize 1

Specifies to grab one field. The grabbed field is written to sequential rows of the grab buffer. When set to 1, each field is treated like a frame and the following digitizer events occur relative to the grabbed field: M_GRAB_FRAME_START, M_GRAB_END, and M_GRAB_FRAME_END.

To achieve 60 fps in NTSC or 50 fps in PAL, M_GRAB_START_MODE must be set to M_FIELD_START.

(summarize)
g h i l m u
U36
Click to summarize 2

Specifies to grab two fields.

g h i l m u
U36
Click to summarize M_GRAB_FRAME_MISSED_COUNTER

Sets whether to count the number of frames sent by the camera, but not received by the digitizer when performing a grab operation (that is, MdigGrab(), MdigGrabContinuous(), or MdigProcess()).

To inquire the current value of this counter, use MdigInquire() with M_GRAB_FRAME_MISSED. INQ

(summarize)
j k
M10
p r
U27
y
U75
aa
Click to summarize M_DEFAULT

Same as M_DISABLE.

j k
M10
p r
U27
y
U75
aa
Click to summarize M_DISABLE

Specifies to disable frames missed detection.

j k
M10
p r
U27
y
U75
aa
Click to summarize M_ENABLE

Specifies to enable frames missed detection.

j k
M10
p r
U27
y
U75
aa
Click to summarize M_GRAB_FRAME_MISSED_RESET

Resets the counter for the number of frames sent by the camera but not received by the digitizer.

(summarize)
j k
M10
p r
U27
y
U75
aa
Click to summarize M_DEFAULT

Implements the default behavior.

j k
M10
p r
U27
y
U75
aa
Click to summarize M_GRAB_LINE_COUNTER

Sets whether a function hooked to an M_GRAB_END, M_ROTARY_ENCODER, or M_GRAB_FRAME_END event can inquire the number of lines grabbed, performed using MdigGrab(), MdigGrabContinuous(), or MdigProcess(); the function could have been hooked using either MdigProcess() or MdigHookFunction(). To inquire the number of lines grabbed at any other time, use MdigGetHookInfo() with M_GRAB_LINE_COUNT. INQ

(summarize)
j k
M10
l m p r
U27
y
U75
aa
Click to summarize M_DEFAULT

Same as M_DISABLE.

j k
M10
l m p r
U27
y
U75
aa
Click to summarize M_DISABLE

Specifies that the hooked function cannot inquire the number of lines grabbed.

j k
M10
l m p r
U27
y
U75
aa
Click to summarize M_ENABLE

Specifies that the hooked function can inquire the number of lines grabbed.

j k
M10
l m p r
U27
y
U75
aa
Click to summarize M_GRAB_LUT_PALETTE

Sets which LUT to use.

Note that this control value is only supported on color cameras. INQ

(summarize)
t
U28
Click to summarize M_DEFAULT

Specifies to use a 3-band RGB LUT.

t
U28
Click to summarize M_GAMMA

Specifies to use the native Bayer LUT that is applied to the Bayer image before it is converted to an RGB image.

t
U28
Click to summarize M_GRAB_MODE

Sets how the grab should be synchronized with the Host when grabbing data with MdigGrab(). Note that this does not affect MdigGrabContinuous(), which always runs asynchronously; otherwise, MdigHalt() could not stop the grab. In addition, this control type does not affect MdigProcess(). 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

Note that, for this control type to function on the Host, you must pass a simulated digitizer (allocated using MdigAlloc() with M_EMULATED).

a
Click to summarize M_DEFAULT

Same as M_SYNCHRONOUS.

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_ASYNCHRONOUS

Specifies that your application continues after one grab is queued, rather than waiting for the grab to finish. Note that only one MdigGrab() function can be queued at a time. If one MdigGrab() is already queued, subsequent grabs will cause your application to wait until the current grab is finished. This allows the currently queued grab to start.

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

Specifies that your application continues after each grab is queued, rather than waiting for the grab to finish. Note that more than one MdigGrab() function can be queued. This causes the grabs to be truly asynchronous.

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

Specifies that your application is synchronized with the end of a grab operation (that is, your application waits for the grab to finish before returning from the grab function).

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_GRAB_SCALE

Sets the vertical and horizontal scaling factor when grabbing data with MdigGrab(), MdigGrabContinuous(), or MdigProcess().

If the scale entered is not supported, the closest scaling factor will be used instead. If, however, the scale entered is larger than the maximum value supported, an error is generated. 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

By default, this control type is IIDC camera specific. The camera must support the ability to scale grabbed data for this control type to be available on the camera. This control type is also available on the board.

c
M10
o

Note that, for this control type to function on the Host, you must pass a simulated digitizer (allocated using MdigAlloc() with M_EMULATED).

a

Note that this control type will subsample 2 adjacent pixels and 2 adjacent lines.

t
U28
Click to summarize M_FILL_DESTINATION

Specifies that the scaling factor is calculated and set to fill the destination buffer.

(summarize)
g h i j k
M10
l m p r
U27
u
U36
y
U75
aa
MIL system specific

Note that this control value uses software scaling rather than hardware scaling.

i u
U36
Click to summarize 1

Specifies that no scaling is applied.

a c
M10
g h j k
M10
l m o p r
U27
t
U28
v y
U75
aa
Click to summarize Value = 1/n

Specifies to reduce the image size. To reduce the image size, the specified value must always be less than 1.0.

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

The value of n can be any integer between 1 and 16.

g h i j k
M10
l m p r
U27
u
U36
y
U75
aa

The value of n can be 1 or 2.

t
U28

Note that data grabbed into a YUV buffer can only have a ½ scaling factor.

g h i l m t
U28
u
U36
v
Click to summarize M_GRAB_SCALE_INTERPOLATION_MODE

Sets the interpolation mode used when performing a vertical and/or horizontal scaling. INQ

(summarize)
a i
MIL system specific

Note that, for this control type to function on the Host, you must pass a simulated digitizer (allocated using MdigAlloc() with M_EMULATED).

a
Click to summarize M_DEFAULT

Specifies the default value.

(summarize)
a i
MIL system specific

Same as M_AUTOMATIC.

i

Same as M_NEAREST_NEIGHBOR.

a
Click to summarize M_AUTOMATIC

Specifies that the best interpolation mode is automatically selected, based on the input filter (set using M_INPUT_FILTER).

a i
Click to summarize M_AVERAGE

Specifies averaging interpolation. The scaling factors for the width and height of the image must be less than or equal to 1. This interpolation mode is software-based.

(summarize)
i
Click to summarize M_BICUBIC

Specifies bicubic interpolation. Note that the sum of the weights used for bicubic interpolation might be greater than one. If this occurs and the result reflects an overflow or underflow, the result is saturated according to the depth and data type of the destination buffer. This interpolation mode is software-based.

(summarize)
a i
Click to summarize M_BILINEAR

Specifies bilinear interpolation. This interpolation mode is software-based.

(summarize)
a i
Click to summarize M_NEAREST_NEIGHBOR +

Specifies nearest neighbor interpolation. By default, nearest neighbor interpolation is software-based. To use hardware-based nearest neighbor interpolation, use M_NEAREST_NEIGHBOR + M_FAST.

(summarize)
a i
Click to summarize M_GRAB_SCALE_X

Sets the horizontal scaling factor when grabbing data.

If the scale entered is not supported, the closest scaling factor will be used instead. If, however, the scale entered is larger than the maximum value supported, an error is generated. 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

By default, this control type is IIDC camera specific. The camera must support the ability to scale grabbed data for this control type to be available on the camera. This control type is also available on the board.

c
M10
o

Note that, for this control type to function on the Host, you must pass a simulated digitizer (allocated using MdigAlloc() with M_EMULATED).

a
Click to summarize M_FILL_DESTINATION

Specifies that the scaling factor is calculated and set to fill the destination buffer. INFO

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

Specifies that no scaling is applied.

a c
M10
g h j k
M10
l m o p r
U27
t
U28
v y
U75
aa
Click to summarize Value = 1/n

Specifies to reduce the image size. INFO

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

Sets the vertical scaling factor when grabbing data.

If the scale entered is not supported, the closest scaling factor will be used instead. If, however, the scale entered is larger than the maximum value supported, an error is generated. 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

By default, this control type is IIDC camera specific. The camera must support the ability to scale grabbed data for this control type to be available on the camera. This control type is also available on the board.

c
M10
o

When down-scaling the image width, a smaller image will result but its scan rate will be proportionally higher than if the image is not scaled.

t
U28

Note that, for this control type to function on the Host, you must pass a simulated digitizer (allocated using MdigAlloc() with M_EMULATED).

a
Click to summarize M_FILL_DESTINATION

Specifies that the scaling factor is calculated and set to fill the destination buffer. INFO

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

Specifies that no scaling is applied.

a c
M10
g h j k
M10
l m o p r
U27
t
U28
v y
U75
aa
Click to summarize Value = 1/n

See the description of this setting in M_GRAB_SCALE.

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

Note that the restriction of using a ½ scaling factor when grabbing into a YUV buffer does not apply.

g h j k
M10
l m p r
U27
t
U28
v y
U75
aa
Click to summarize M_GRAB_START_MODE

Sets the type of field on which to grab. Note that this value applies only when dealing with interlaced cameras. INQ

(summarize)
g h i j l m p r
U27
u
U36
aa
Click to summarize M_DEFAULT

Same as M_FIELD_START_ODD.

g h i j l m p r
U27
u
U36
aa
Click to summarize M_FIELD_START

Specifies that the grab starts on any field.

g h j l m p r
U27
aa
Click to summarize M_FIELD_START_EVEN

Specifies that the grab starts on an even field.

g h i j l m p r
U27
u
U36
aa
Click to summarize M_FIELD_START_ODD

Specifies that the grab starts on an odd field.

g h i j l m p r
U27
u
U36
aa
Click to summarize M_GRAB_TIMEOUT

Sets the maximum time to wait for a frame before generating an error.

Note that when used with MdigProcess(), M_GRAB_TIMEOUT sets the time to wait before checking whether a grab occurred. If no grab occurred within this time period, a second time period of the same duration might elapse before an error is generated. INQ

(summarize)
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 amount of time to wait. Note that this is the same as M_INFINITE when performing a triggered grab.

(summarize)
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

The amount of time is either 5 sec or 5 times the frame period, which ever is higher.

c
M10
j k
M10
l m o p r
U27
v y
U75
aa

The amount of time is 60 times the frame period.

g h

The amount of time is 200 times the frame period.

t
U28

The amount of time is 5000 msec.

i u
U36
Click to summarize M_INFINITE

Specifies to wait indefinitely. This is recommended only for triggered grabs.

(summarize)
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 time to wait, in msec.

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_HARDWARE_DEINTERLACING

Sets whether hardware deinterlacing is used when the video source is interlaced.

Note that this control type is only available when your DCF uses an interlaced video signal. INQ

(summarize)
i u
U36
Click to summarize M_DEFAULT

Same as M_DISABLE.

i u
U36
Click to summarize M_BOB_METHOD +

Specifies to use the BOB algorithm for hardware deinterlacing.

i u
U36
Click to summarize M_DISABLE

Specifies that hardware deinterlacing is disabled.

i u
U36
Click to summarize M_MADI_METHOD +

Specifies to use the MADI (motion adaptive deinterlacing) algorithm for hardware deinterlacing.

i u
U36
Click to summarize M_INPUT_FILTER +

Sets the low-pass filter applied to incoming data. INQ

(summarize)
i l u
U36
MIL system specific

Note that, if no combination constant is used with this control type, it will be applied to all acquisition paths (as if using the combination constant M_ALL_CHANNELS). For more information regarding the low-pass filters, refer to the Installation and hardware reference manual for your Matrox Imaging board.

l
Click to summarize M_DEFAULT

Specifies the default value.

(summarize)
i l u
U36
MIL system specific

Same as M_BYPASS.

i u
U36

Same as M_LOW_PASS_1.

l
Click to summarize M_AUTOMATIC

Specifies that the best hardware filter is automatically selected or the filter is bypassed when the video input is interlaced and hardware deinterlacing is disabled.

(summarize)
i u
U36
MIL system specific

To disable hardware deinterlacing, set M_HARDWARE_DEINTERLACING to M_DISABLE).

i
Click to summarize M_BYPASS

Specifies to not use a filter.

i l u
U36
Click to summarize M_LOW_PASS_0

Specifies to use the first low-pass filter.

(summarize)
i l u
U36
MIL system specific

Uses a filter of 7.5 MHz.

l

Uses a Kaiser filter.

i u
U36

Note that this value is not available when the video input is interlaced and hardware deinterlacing is disabled (that is, M_HARDWARE_DEINTERLACING is set to M_DISABLE).

i
Click to summarize M_LOW_PASS_1

Specifies to use the second low-pass filter.

(summarize)
i l u
U36
MIL system specific

Uses a filter of 33 MHz.

l

Uses a Gaussian filter.

i u
U36

Note that this value is not available when the video input is interlaced and hardware deinterlacing is disabled (that is, M_HARDWARE_DEINTERLACING is set to M_DISABLE).

i
Click to summarize M_LAST_GRAB_IN_TRUE_BUFFER

Sets whether a monoshot grab is performed when MdigHalt() is called after performing a continuous grab operation. This control type only has an effect if the target image buffer of the continuous grab is selected on a display. When the target buffer is selected on the display, the continuous grab will typically grab into a temporary internal buffer and only update the target image buffer when MdigHalt() is called. This control type establishes how to update to the target image 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
MIL system specific

Note that, for this control type to function on the Host, you must pass a simulated digitizer (allocated using MdigAlloc() with M_EMULATED).

a
Click to summarize M_DEFAULT

Same as M_ENABLE.

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 last frame grabbed during the continuous grab operation is copied to the target image buffer, instead of performing one last grab. This setting might reduce the time it takes for the continuous grab to terminate once MdigHalt() is called (since copying a frame tends to take less time than grabbing a frame).

(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 a monoshot grab is performed. Note that after performing a monoshot grab in the target image buffer selected to the display, the display is updated.

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

Sets the intensity of light to emit parallel to the optical axis, making the flat parts of an object stand out in stark contrast in the image.

Increasing the value of this control type increases the intensity of the light transmitted by your lighting controller. Note that this control type is only for controlling the intensity of an LED (as a signal passed to a lighting controller). To control the timing of when the strobe light goes on or off, use M_GRAB_TRIGGER... + M_TIMER_STROBE or M_TIMER_TRIGGER_SOURCE with M_TIMER_STROBE. For more information, refer to your board's MIL Hardware-specific Notes.

Note that some consecutive bright field intensity level settings might produce the same result due to the fact that there are only 250 distinct adjustments (adjustments of 0.4% each). INQ

(summarize)
t
U28
Click to summarize M_DEFAULT

Specifies the default value; the default value is 255.

t
U28
Click to summarize 0 <= Value <= 255

Specifies the intensity of light to be emitted on the flat parts of the object.

t
U28
Click to summarize M_LUT_ID

Sets whether to map the input data through the physical LUT of the specified digitizer and the values with which to initialize the LUT. MIL uses the data format (DCF) of the digitizer to determine whether a physical LUT is supported. If it is not, and you try to initialize it, an error is generated.

To learn how the digitizer's physical LUT is configured, refer to Mapping grabbed data through a LUT.

If the destination grab buffer's depth is larger than that of the digitizer's physical LUT, the destination grab buffer's least significant bits are set to zero when the data is grabbed. If the digitizer's physical LUT depth is greater than that of the destination grab buffer, the most-significant bits of the data (the non-zero values) are used when the data is grabbed. INQ

(summarize)
a k
M10
l m p r
U27
t
U28
y
U75
aa
MIL system specific

Note that if 14-, or 16-bit data is grabbed, the digitizer's physical LUT is not used.

k
M10
l m p y
U75

Note that if using a 10-tap video source, this value is not available.

m

Note that, for this control type to function on the Host, you must pass a simulated digitizer (allocated using MdigAlloc() with M_EMULATED).

a
Click to summarize M_DEFAULT

Specifies that the digitizer's physical LUT is not used.

a k
M10
l m p r
U27
t
U28
y
U75
aa
Click to summarize MIL LUT buffer identifier

Specifies the identifier of the LUT buffer (allocated with MbufAlloc...() with M_LUT) with which to initialize the digitizer's physical LUT.

To copy the data from a LUT buffer to the digitizer's physical LUT, the number of entries in the LUT buffer must match those of the digitizer's physical LUT. Note that if the digitizer's physical LUT cannot support the depth of the specified LUT buffer, an error will occur.

LUT buffer data is loaded into the digitizer's physical LUT as follows. In the case where a 1-band LUT buffer is loaded into a 3-band digitizer's physical LUT, the LUT buffer is copied into each component of the digitizer's physical LUT. When a 3-band LUT buffer is loaded into a 1-band digitizer's physical LUT, only the first band of the LUT buffer is copied into the digitizer's physical LUT. In all other cases, each band of the LUT buffer is copied into the associated band of the digitizer's physical LUT.

(summarize)
a k
M10
l m p r
U27
t
U28
y
U75
aa
MIL system specific

When grabbing 8-bit data, the digitizer's physical LUT has 256 entries.

a k
M10
m y
U75

Matrox Iris GTR only supports an 8- or 10-bit LUT buffer.

k
M10
t
U28
y
U75

When grabbing 10-bit data, the digitizer's physical LUT has 1024 entries.

When grabbing 12-bit data, the digitizer's physical LUT has 4096 entries.

a k
M10
l m y
U75

Matrox Radient eV-CXP only supports a 1-band LUT buffer with 1K entries. When grabbing into a 3-band buffer, the LUT is duplicated 3 times. When grabbing 10- or 12-bit data, use a LUT buffer with a data depth of 16-bits; the least-significant bits will be used as the LUT values. The grabbed data depth is specified in the DCF.

k
M10

Matrox Rapixo CXP on-board programmable LUTs can map 8-bit, 10-bit, and 12-bit (monochrome or color). When a link is receiving color data, all bands of the data use the same specified LUT mapping. As soon as one link is receiving 12-bit data, all links (CoaXPress connections) share the same specified LUT mapping. Data of other depths are mapped through transparent LUTs.

y
U75
Click to summarize M_POWER_OVER_CABLE

Sets whether to enable PoCL (power over Camera Link) and PoCXP (power over CoaXPress). INQ

(summarize)
j k
M10
m p r
U27
y
U75
aa
MIL system specific

Note that the camera must be PoCL-capable. Once enabled, your PoCL-capable camera receives power over its Camera Link connection.

j m p r
U27
aa

Note that the camera must be PoCXP-capable. Once enabled, your PoCXP-capable camera receives power over its CoaXPress connection.

k
M10
y
U75
Click to summarize M_DEFAULT

Same as M_ON.

j k
M10
m p r
U27
y
U75
aa
Click to summarize M_OFF

Specifies to disable PoCL/PoCXP.

j k
M10
m p r
U27
y
U75
aa
Click to summarize M_ON

Specifies to enable PoCL/PoCXP.

j k
M10
m p r
U27
y
U75
aa
Click to summarize M_PROCESS_GRAB_MONITOR

Sets whether to create an internal grab monitoring thread when using MdigProcess() with either M_START or M_SEQUENCE. The internal grab monitoring thread will produce an error if there is no longer any grab activity (for example, when a camera is unplugged) after M_PROCESS_TIMEOUT expires.

A typical use of this control type would be to disable the grab monitoring thread before a camera is unplugged, so that an error is not generated. INQ

(summarize)
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_ENABLE.

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 create a grab monitoring thread.

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 create a grab monitoring thread.

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_PROCESS_TIMEOUT

Sets the maximum amount of time to wait for MdigProcess() to complete the current grab (M_STOP) or all the queued grabs (M_STOP + M_WAIT), before generating an error. In an ideal situation, MdigProcess() would complete all the queued grabs before this timeout expires. If the timeout does expire either the specified time was too short, or a grab error occurred. INQ

(summarize)
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_INFINITE.

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_INFINITE

Specifies to wait indefinitely.

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 time to wait, in msec.

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_SOURCE_OFFSET_X

Sets the X-offset of the input signal capture window. 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

Note that, for this control type to function on the Host, you must pass a simulated digitizer (allocated using MdigAlloc() with M_EMULATED).

a

Note that this value must be multiple of 32.

t
U28
Click to summarize Value

Specifies the X-offset, 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_SOURCE_OFFSET_Y

Sets the Y-offset of the input signal capture window. 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

Note that, for this control type to function on the Host, you must pass a simulated digitizer (allocated using MdigAlloc() with M_EMULATED).

a

Note that this value must be multiple of 2.

t
U28
Click to summarize Value

Specifies the Y-offset, 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_SOURCE_SIZE_X

Sets the width of the input signal capture window.

Note that certain source sizes, offsets, and destination buffer sizes can affect a grab. Refer to MdigGrab() and MdigGrabContinuous() for more information. 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

On some cameras, you might not be able to set the width (that is, this information might be read-only).

c
M10
o v

Note that, for this control type to function on the Host, you must pass a simulated digitizer (allocated using MdigAlloc() with M_EMULATED).

a

Note that this value must be multiple of 32.

t
U28
Click to summarize Value

Specifies the width, 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_SOURCE_SIZE_Y

Sets the height of the input signal capture window.

Note that certain source sizes, offsets, and destination buffer sizes can affect a grab. Refer to MdigGrab() and MdigGrabContinuous() for more information. 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

On some cameras, you might not be able to set the height (that is, this information might be read-only).

c
M10
o v

Note that, for this control type to function on the Host, you must pass a simulated digitizer (allocated using MdigAlloc() with M_EMULATED).

a

Note that this value must be multiple of 2.

t
U28
Click to summarize Value

Specifies the height, 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_TL_TRIGGER_ACTIVATION

Sets the signal variation upon which to generate a trigger signal to the camera through the transport layer interface. INQ

(summarize)
k
U29
y
U75
Click to summarize M_DEFAULT

Specifies to use the camera's default value or, if supported, to enable the camera's auto control state for this feature(that is, the camera adjusts this value automatically).

k
U29
y
U75
Click to summarize M_ANY_EDGE

Specifies that a trigger will be generated both upon a high-to-low and a low-to-high signal transition.

k
U29
y
U75
Click to summarize M_EDGE_RISING

Specifies that a trigger will be generated upon a low-to-high signal transition.

k
U29
y
U75
Click to summarize M_VIDEO_OUTPUT

Sets whether to route the current digitizer's video input signal to a specific analog video output. INQ

(summarize)
h
Click to summarize M_NULL

Specifies that the current digitizer's video input signal is not routed to an analog video output.

h
Click to summarize M_CHn

Specifies that the current digitizer's video input signal is routed to analog video output n (VID_OUT n), where n is a value from 0 to 3.

h
Click to summarize M_WHITE_BALANCE

Sets whether to perform white balancing.

The white balance coefficients used for white balancing are taken from an internal buffer, which is created and updated when you specify coefficients (using MdigControl() with M_BAYER_COEFFICIENTS_ID) or when you let the driver calculate them (using this control type with M_CALCULATE).

Note that to use this control type, M_BAYER_CONVERSION must be enabled. INQ

(summarize)
c
M10
k
M10
m o p r
U27
t
U28
v y
U75
aa
MIL system specific

Note that this control type is used to perform Bayer conversion if performed by the Host. To control the Bayer conversion on the camera, use MdigControlFeature(); refer to your camera's documentation for details regarding the features to set.

c
M10
o v

Note that this control type is only available when using color versions of Matrox Iris GTR (such as 1300C).

t
U28
Click to summarize M_DEFAULT

Same as M_DISABLE.

y
U75
Click to summarize M_CALCULATE

Calculates new white balance coefficients, overwriting old coefficients.

Calling MdigControl() with M_WHITE_BALANCE set to M_CALCULATE grabs an image. The image is assumed to be a uniform shade of gray that is not saturated. It is used to calculate the new white balance coefficients.

Use MdigInquire() with M_BAYER_COEFFICIENTS_ID to determine the calculated values.

(summarize)
c
M10
k
M10
m o p r
U27
t
U28
v y
U75
aa
MIL system specific

If the digitizer is configured to perform a software triggered grab, calling MdigControl() with this value will automatically trigger a grab. For more information, see White balancing your Bayer images.

c
M10
o t
U28
v
Click to summarize M_DISABLE

Specifies that white balancing is disabled.

c
M10
k
M10
m o p r
U27
t
U28
v y
U75
aa
Click to summarize M_ENABLE

Specifies that white balancing is enabled.

If you have not called MdigControl() with M_BAYER_COEFFICIENTS_ID or with M_WHITE_BALANCE set to M_CALCULATE before enabling white balancing, it will automatically calculate the white balance coefficients and then use those coefficients for subsequent images. Note that if M_WHITE_BALANCE is disabled and then re-enabled, the previously calculated coefficients are used.

(summarize)
c
M10
k
M10
m o p r
U27
t
U28
v y
U75
aa

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

Combination values for M_GC_FEATURE_BROWSER.

You can add one of the following values to the above-mentioned value to specify which GenTL configuration file (XML file) is associated with the feature.

function map For specifying the configuration file associated with the feature
Click to summarizeCombination value Description MIL system-specific
tooltip (‡)
Click to summarize

Specifies the feature is associated with an instance of the GenTL stream configuration information.

(summarize)
v
Parameters

Specifies the instance (index number) of the GenTL stream library associated with the feature.

v
0 <= Value <= M_GENTL_STREAM_COUNT

Specifies the index.

v
Click to summarize M_GENTL_DEVICE

Specifies that the feature is associated with the GenTL device configuration information.

v
Click to summarize M_GENTL_REMOTE_DEVICE

Specifies that the feature is associated with the GenTL remote device configuration information.

This is the default value.

(summarize)
v
Combination value for M_FOCUS.

You can add the following value to the above-mentioned value to specify to wait for the camera to focus.

function map For specifying to wait for the camera to perform its focusing operation.
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize M_WAIT

Waits for the amount of time it takes the camera's lens motor moves the camera to a position that produces optimum focus. When used, this combination constant delays the callback function (hook-handler function) of MdigFocus() a predetermined amount of time.

(summarize)
t
U28
Combination value for M_NEAREST_NEIGHBOR (when ControlType=M_GRAB_SCALE_INTERPOLATION_MODE and ControlValue=M_NEAREST_NEIGHBOR).

You can add the following value to the above-mentioned value to set the speed and precision of the interpolation.

function map For specifying the speed and precision of the interpolation.
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize M_FAST

Uses a fast interpolation.

When dealing with M_GRAB_SCALE_INTERPOLATION_MODE set to M_NEAREST_NEIGHBOR + M_FAST, this value specifies that a fast interpolation is used. Fast interpolation is performed by hardware. Note that this combination is only available when M_INPUT_FILTER is set to M_BYPASS and hardware interpolation is available.

(summarize)
i
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.

[Matrox Solios ecl/xcl/ev-cl]

Note that these values are only supported on Matrox Solios eV-CL.

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

Specifies that this function returns immediately once Matrox feature browser window opens.

c
M10
k
M10
m o u
U36
v y
U75
Click to summarize M_SYNCHRONOUS

Specifies that this function is blocked until Matrox feature browser window closes.

This is the default value.

(summarize)
c
M10
k
M10
m o u
U36
v y
U75
Combination values for M_BOB_METHOD (when ControlType=M_HARDWARE_DEINTERLACING and ControlValue=M_BOB_METHOD); M_MADI_METHOD (when ControlType=M_HARDWARE_DEINTERLACING and ControlValue=M_MADI_METHOD).

You can add one or more of the following values to the above-mentioned values to specify whether anti-aliasing and/or dithering is enabled.

function map For specifying whether to enable anti-aliasing and/or dithering
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize M_ANTIALIASING

Specifies that anti-aliasing is enabled.

i
Click to summarize M_DITHERING

Specifies that dithering is enabled.

i

The following control types and control values set (if available) the reference levels used to digitize the analog signal received from a camera. These control types are specific to analog input devices. Depending on the type of digitizer and input signal, some reference types are not applicable. The smallest voltage increment supported by your board can differ such that consecutive reference-level settings might produce the same result. Note, some digitizers might take a few milliseconds before the reference level stabilizes.

[Matrox Solios eA/XA]

For more information about reference levels, refer to Adjusting the reference levels, in the Frame Grabbers chapter of your board's Installation and Hardware Guide. There are three ways to change the input signal's gain:

The first method is to set M_BLACK_REF and M_WHITE_REF to specific values (between M_MIN_LEVEL and M_MAX_LEVEL). This method is commonly used interactively (for example, in an application that allows you to change the settings until you are satisfied with the image quality). Note that the black reference level must always be less than the white level. Do not use M_GRAB_INPUT_GAIN if you are using this method since the gain will be adjusted automatically.

The second method is to set the black and the white reference levels in Volts. By adding M_VOLTAGE to the reference level, the optimum levels for the offset and gain controllers will be calculated automatically. This is more useful if you know the actual input signal voltages.

The third method is to set M_BLACK_REF, and then set M_GRAB_INPUT_GAIN to a value from M_MIN_LEVEL to M_MAX_LEVEL. This method corresponds more closely to the actual hardware that controls the reference levels. The hardware has an offset controller followed by a gain controller; the analog-to-digital converter cannot be programmed directly with the reference levels. Note that when using this method, you should not specify a white reference level because it would cause the gain to be altered.

To inquire the maximum and minimum levels for your camera, set the reference level to M_MIN_LEVEL or M_MAX_LEVEL, and then inquire the reference level (for example, set M_BLACK_REF to M_MIN_LEVEL, and then use MdigInquire() with M_BLACK_REF to return the minimum level for the black reference level).

[Matrox GenTL driver (Update 34); Matrox GigE Vision driver (introduced M10); Matrox USB3 Vision driver (Update 19)]

Note that the following reference types are only available if they are supported by the camera. Refer to your camera's documentation for more details.

[Matrox Clarity UHD (introduced U36); Matrox Orion HD]

Note that the following control types are only supported when the device number of the specifies digitizer is M_DEV2 or M_DEV3. These control types are supported when the DCF specifies to grab either an analog or digital input signal.

[Matrox Clarity UHD (introduced U36); Matrox GenTL driver (Update 34); Matrox GigE Vision driver (introduced M10); Matrox Morphis; Matrox Morphis QxT; Matrox Orion HD; Matrox Solios eA/XA; Matrox USB3 Vision driver (Update 19)]

Note that the following control types are only available when the DCF specifies to grab an analog input signal.

function map For the general reference settings
Click to summarize
ControlType
Description MIL system-specific
tooltip (‡)
ControlValue
Click to summarize M_BLACK_OFFSET

Sets the offset to the black level of the image in hardware before the image reaches the digitization module of the sensor. INQ

(summarize)
t
U28
Click to summarize 0<= Value <= 255

Specifies the value of the black offset.

t
U28
Click to summarize M_BLACK_REF +

Sets the input signal's digitization black reference level. Note that when setting black and white reference levels, always set black reference levels first. INQ

(summarize)
c
M10
l o v
Click to summarize M_DEFAULT

Specifies the default reference level for the specified digitizer data format.

l
Click to summarize M_AUTOMATIC

Sets the reference level automatically.

c
M10
o v
Click to summarize M_MAX_LEVEL

Specifies the maximum value.

l
Click to summarize M_MIN_LEVEL

Specifies the minimum value.

l
Click to summarize M_MIN_LEVEL <= Value <= M_MAX_LEVEL

Specifies the black reference level. Note that the black reference level must be lower than the white reference level.

Note that some consecutive black reference level settings might produce the same result due to the fact that there are only 98 distinct adjustments (adjustments of 10.23 mV each).

To calculate the value to pass to M_BLACK_REF, use the following equation with the appropriate voltages for your particular board.

(summarize)
l
Click to summarize Min. black level <= Value <= Max. black level

Specifies the black reference level.

Note that to determine the camera-specific minimum and maximum black reference level, use MdigInquire() with M_BLACK_REF + M_MAX_VALUE or + M_MIN_VALUE, respectively.

(summarize)
c
M10
o v
Click to summarize Min. voltage <= Value <= Max. voltage

Specifies the black reference level in Volts. Note that the black reference level must be lower than the white reference level.

Note that you can only specify the reference level in Volts if using M_BLACK_REF + M_VOLTAGE.

(summarize)
l
MIL system specific

The reference levels are from -1.0 V to +1.0 V.

l
Click to summarize M_BRIGHTNESS_REF

Sets the brightness level for composite input signals. INQ

(summarize)
g h i u
U36
Click to summarize M_DEFAULT

Specifies the default reference level for the specified digitizer data format.

g h i u
U36
Click to summarize M_MAX_LEVEL

Specifies the maximum value.

g h i u
U36
Click to summarize M_MIN_LEVEL

Specifies the minimum value.

g h i u
U36
Click to summarize M_MIN_LEVEL <= Value <= M_MAX_LEVEL

Specifies the brightness reference level.

g h i u
U36
Click to summarize M_CONTRAST_REF

Sets the contrast level for composite input signals. INQ

(summarize)
g h i u
U36
MIL system specific

Note that this reference type is only available when using a DCF that uses a composite video signal.

i u
U36
Click to summarize M_DEFAULT

Specifies the default reference level for the specified digitizer data format.

g h i u
U36
Click to summarize M_MAX_LEVEL

Specifies the maximum value.

g h i u
U36
Click to summarize M_MIN_LEVEL

Specifies the minimum value.

g h i u
U36
Click to summarize M_MIN_LEVEL <= Value <= M_MAX_LEVEL

Specifies the contrast reference level.

g h i u
U36
Click to summarize M_HUE_REF

Sets the hue level for composite input signals.

M_HUE_REF is available when grabbing color data (not monochrome data). INQ

(summarize)
g h i u
U36
MIL system specific

Note that this reference type is only available when using a DCF that uses a composite video signal.

i u
U36
Click to summarize M_DEFAULT

Specifies the default reference level for the specified digitizer data format.

g h i u
U36
Click to summarize M_MAX_LEVEL

Specifies the maximum value.

g h i u
U36
Click to summarize M_MIN_LEVEL

Specifies the minimum value.

g h i u
U36
Click to summarize M_MIN_LEVEL <= Value <= M_MAX_LEVEL

Specifies the hue level.

g h i u
U36
Click to summarize M_SATURATION_REF

Sets the saturation level for composite input signals.

M_SATURATION_REF is available when grabbing color data (not monochrome data). INQ

(summarize)
g h i u
U36
MIL system specific

Note that this reference type is only available when using a DCF that uses a composite video signal.

i u
U36
Click to summarize M_DEFAULT

Specifies the default reference level for the specified digitizer data format.

g h i u
U36
Click to summarize M_MAX_LEVEL

Specifies the maximum value.

g h i u
U36
Click to summarize M_MIN_LEVEL

Specifies the minimum value.

g h i u
U36
Click to summarize M_MIN_LEVEL <= Value <= M_MAX_LEVEL

Specifies the saturation level.

g h i u
U36
Click to summarize M_WHITE_REF +

Sets the input signal's digitization white reference level. Note that when setting black and white reference levels, always set black reference levels first. INQ

(summarize)
c
M10
l o v
Click to summarize M_DEFAULT

Specifies the default reference level for the specified digitizer data format.

c
M10
l o v
Click to summarize M_AUTOMATIC

Sets the reference level automatically.

c
M10
o v
Click to summarize M_MAX_LEVEL

Specifies the maximum value.

l
Click to summarize M_MIN_LEVEL

Specifies the minimum value.

l
Click to summarize M_MIN_LEVEL <= Value <= M_MAX_LEVEL

Specifies the white reference level. Note that the white reference level must be higher than the black reference level.

(summarize)
l
MIL system specific

To calculate the value to pass to M_WHITE_REF, use the following equation with the appropriate voltages for your particular board.

l
Click to summarize Min. voltage <= Value <= Max. voltage

Specifies the white reference level in Volts. Note that the white reference level must be higher than the black reference level.

Note that you can only specify the reference level in Volts if using M_WHITE_REF + M_VOLTAGE.

(summarize)
l
MIL system specific

The reference levels are from -1.0V to +1.0V.

l
Click to summarize Min. white level <= Value <= Max. white level

Specifies the white reference level.

Note that to determine the camera-specific minimum and maximum white reference level, use MdigInquire() with M_WHITE_REF + M_MAX_VALUE or + M_MIN_VALUE, respectively.

(summarize)
c
M10
o v
Combination value for M_BLACK_REF; M_INPUT_FILTER; M_WHITE_REF.

You can add the following value to the above-mentioned values to specify which component(s) to affect.

function map For specifying the acquisition path
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize M_CHn

Applies the setting to acquisition path n.

When adding this combination constant to M_INPUT_FILTER, n can be a value from 0 to 3.

More than one acquisition path can be specified by adding them together (for example, M_CH0 + M_CH1).

(summarize)
l
Combination values for M_BLACK_REF; M_WHITE_REF.

You can add one of the following values to the above-mentioned values to set the reference level of a specific acquisition path when using RGB or multi-tap input.

function map For controlling the reference level of a specific acquisition path
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize M_ALL_REF

Sets the reference level on all available acquisition paths.

c
M10
l o v
Click to summarize M_CH0_REF

Sets the reference level on acquisition path 0.

c
M10
l o v
Click to summarize M_CH1_REF

Sets the reference level on acquisition path 1.

c
M10
l o v
Click to summarize M_CH2_REF

Sets the reference level on acquisition path 2.

c
M10
l o v
Click to summarize M_CH3_REF

Sets the reference level on acquisition path 3.

l
Combination value for M_BLACK_REF; M_WHITE_REF.

You can add the following value to the above-mentioned values to specify the reference level in Volts.

function map For specifying the reference level in Volts
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize M_VOLTAGE

Sets the reference level in Volts.

l

The following control types allow you to control the input gain and shading correction.

function map For controlling the input gain and shading correction
Click to summarize
ControlType
Description MIL system-specific
tooltip (‡)
ControlValue
Click to summarize M_GAIN

Sets the input gain with which to amplify the input signal. Note that gain affects the acquisition path before the data is digitized, and is applied to all the color bands of the image. INQ

(summarize)
c
M10
o t
U28
v
Click to summarize M_DEFAULT

Specifies to use the camera's default value or, if supported, to enable the camera's auto control state for this feature (that is, the camera adjusts this value automatically).

c
M10
o t
U28
v
Click to summarize Min. gain <= Value <= Max. gain

Specifies a value between the minimum and maximum values supported by the camera. Use MdigInquire() to determine these values.

(summarize)
c
M10
o t
U28
v
Click to summarize M_GRAB_AUTOMATIC_INPUT_GAIN +

Sets whether the input gain should be automatically set. INQ

(summarize)
c
M10
g h i o u
U36
v
MIL system specific

If enabled, the on-board decoder automatically sets the input gain.

g h

By default, this setting is applied to both Y (luminance) and C (chrominance) components (for composite, after separation). To apply this setting to a specific component, see combination values below.

g h

To manually set your input gain, use M_GRAB_INPUT_GAIN.

g h

This control type is supported only when the DCF specifies to grab an analog input signal.

i

This control type is only supported when the device number of the specified digitizer is M_DEV2 or M_DEV3. Note that this control type is available when the DCF specifies to grab either an analog or digital input signal.

u
U36
Click to summarize M_DEFAULT

Same as M_ENABLE.

c
M10
g h i o u
U36
v
Click to summarize M_DISABLE

Specifies that the input gain is not automatically set.

c
M10
g h i o u
U36
v
Click to summarize M_ENABLE

Specifies that the input gain is automatically set.

c
M10
g h i o u
U36
v
Click to summarize M_GRAB_INPUT_GAIN +

Sets the input gain with which to amplify the input signal. This allows you to optimize the amplitude of the analog video input signal so that the full dynamic range of the component digitizing the video is used. INQ

(summarize)
g h i l u
U36
MIL system specific

By default, this setting is applied to all acquisition paths used by the digitizer or to both Y (luminance) and C (chrominance) components (for composite, after separation). To apply this setting to a specific acquisition path or component, see combination values below.

g l

This control type affects the black reference, set using M_BLACK_REF. Note that you can also change this value by modifying the DCF.

l

To automatically set your input gain, use M_GRAB_AUTOMATIC_INPUT_GAIN.

To manually set your input gain, M_GRAB_AUTOMATIC_INPUT_GAIN must first be disabled.

g h u
U36

This control type is only available when the DCF specifies to grab an analog input signal.

i

This control type is only supported when the device number of the specified digitizer is M_DEV2 or M_DEV3. Note that this control type is available when the DCF specifies to grab either an analog or digital input signal.

u
U36
Click to summarize M_DEFAULT

Specifies the default input gain factor.

(summarize)
g h i l u
U36
MIL system specific

The exact gain level varies depending on the board.

g

Same as the input gain factor specified by the DCF.

g h l

When dealing with a composite or RGB analog input signal, the input gain factor is 128.

i u
U36
Click to summarize M_GAIN0

Specifies the first input gain supported.

(summarize)
i l
MIL system specific

Sets a gain of 1. This should be used when the input voltage is 0.0 - 1.0 Vpp.

l

Sets a gain of 0.5. Note that this control value is only available when your DCF uses an analog input signal.

i
Click to summarize M_GAIN1

Specifies the second input gain supported.

(summarize)
i l
MIL system specific

Sets a gain of 2. Note that this control value is only available when your DCF uses an analog input signal.

i

Sets a gain of 2. This should be used when the input voltage is 0.0 - 0.5 Vpp.

l
Click to summarize M_GAIN2

Specifies the third input gain supported.

(summarize)
i l
MIL system specific

Sets a gain of 2.8. Note that this control value is only available when your DCF uses an analog input signal.

i

Sets a gain of 3. This should be used when the input voltage is 0.0 - 0.333 Vpp.

l
Click to summarize M_GAIN3

Specifies the fourth input gain supported.

(summarize)
i l
MIL system specific

Sets a gain of 4.0. Note that this control value is only available when your DCF uses an analog input signal.

i

Sets a gain of 3.99. This should be used when the input voltage is 0.0 - 0.25 Vpp.

i
Click to summarize M_MAX_LEVEL

Specifies the maximum input gain factor.

g h i l u
U36
Click to summarize M_MIN_LEVEL

Specifies the minimum input gain factor.

g h i l u
U36
Click to summarize 0 <= Value <= 255

Specifies an integer value which is used to determine the input gain factor. With this range, 0 is mapped to the minimum gain factor supported by the camera, while 255 is mapped to the maximum gain factor supported by the camera.

(summarize)
g h i l u
U36
MIL system specific

This value is supported only when using a DCF that uses either a composite or RGB analog video signal.

i u
U36
Click to summarize M_SHADING_CORRECTION

Sets whether to perform a gain and offset correction per pixel. This shading correction operation is performed by the digitizer when transferring grabbed data to the Host, using the following equation:

(Grab Image x M_SHADING_CORRECTION_GAIN_ID) + M_SHADING_CORRECTION_OFFSET_ID

To set the gain and offset values for shading correction, use M_SHADING_CORRECTION_GAIN_ID and M_SHADING_CORRECTION_OFFSET_ID, respectively. INQ

(summarize)
k
U29
p y
U75
MIL system specific

Note that this control type is only available on Matrox Rapixo CXP Pro, and only if the loaded FPGA configuration contains the Matrox PU that supports this functionality.

y
U75

Note that this control type is only available on Matrox Radient eV-CXP for 3D profiling.

k
U29

Note that this control type is only available if the loaded FPGA configuration contains the Matrox PU that supports this functionality.

p
Click to summarize M_DEFAULT

Same as M_DISABLE.

k
U29
p y
U75
Click to summarize M_DISABLE

Disables shading correction.

k
U29
p y
U75
Click to summarize M_ENABLE

Enables shading correction.

k
U29
p y
U75
Click to summarize M_SHADING_CORRECTION_GAIN_FIXED_POINT

Sets the number of bits in the fractional part of the gain values specified for performing shading correction, where values are in fixed point format. The image resulting from the shading correction will be rounded to the nearest whole number.

To enable on-board shading correction and provide gain values, use M_SHADING_CORRECTION and M_SHADING_CORRECTION_GAIN_ID, respectively. INQ

(summarize)
k
U29
p y
U75
MIL system specific

Note that this control type is only available on Matrox Rapixo CXP Pro, and only if the loaded FPGA configuration contains the Matrox PU that supports this functionality.

y
U75

Note that this control type is only available on Matrox Radient eV-CXP for 3D profiling.

k
U29

Note that this control type is only available if the loaded FPGA configuration contains the Matrox PU that supports this functionality.

p
Click to summarize M_DEFAULT

Specifies the default value. For an 8-bit buffer, the default value is 8. For a 16-bit buffer, the default value is 14.

(summarize)
k
U29
p y
U75
Click to summarize 0 < Value <= 16

Specifies the number of bits in the fractional part of the fixed-point gain values.

k
U29
p y
U75
Click to summarize M_SHADING_CORRECTION_GAIN_ID

Sets the buffer containing the gain values that the digitizer should use when it performs shading correction. This is interpreted as a fixed point buffer.

To enable on-board shading correction, use M_SHADING_CORRECTION. INQ

(summarize)
k
U29
p y
U75
MIL system specific

Note that this control type is only available on Matrox Rapixo CXP Pro, and only if the loaded FPGA configuration contains the Matrox PU that supports this functionality.

y
U75

Note that this control type is only available on Matrox Radient eV-CXP for 3D profiling.

k
U29

Note that this control type is only available if the loaded FPGA configuration contains the Matrox PU that supports this functionality.

p
Click to summarize M_DEFAULT

Same as M_NULL.

k
U29
p y
U75
Click to summarize M_NULL

Specifies not to apply a gain correction when performing shading correction.

k
U29
p y
U75
Click to summarize ShadingCorrectionGainID

Specifies the identifier of an M_IMAGE buffer containing the gain values. The buffer must be a single-band, unsigned 8-bit or 16-bit buffer. It can have a maximum X-size of 16384 pixels. Use M_SHADING_CORRECTION_GAIN_FIXED_POINT to set the number of bits for the fractional part.

(summarize)
k
U29
p y
U75
Click to summarize M_SHADING_CORRECTION_OFFSET_ID

Sets the buffer containing the offset values that the digitizer should use when it performs shading correction.

To enable on-board shading correction, use M_SHADING_CORRECTION. INQ

(summarize)
k
U29
p y
U75
MIL system specific

Note that this control type is only available on Matrox Rapixo CXP Pro, and only if the loaded FPGA configuration contains the Matrox PU that supports this functionality.

y
U75

Note that this control type is only available on Matrox Radient eV-CXP for 3D profiling.

k
U29

Note that this control type is only available if the loaded FPGA configuration contains the Matrox PU that supports this functionality.

p
Click to summarize M_DEFAULT

Same as M_NULL.

k
U29
p y
U75
Click to summarize M_NULL

Specifies not to apply an offset correction when performing shading correction.

k
U29
p y
U75
Click to summarize ShadingCorrectionOffsetID

Specifies the identifier of an M_IMAGE buffer containing the offset values. The buffer must be a single-band, unsigned 8-bit or 16-bit buffer. It can have a maximum X-size of 16384 pixels.

(summarize)
k
U29
p y
U75
Combination values for M_GRAB_INPUT_GAIN.

You can add one of the following values to the above-mentioned value to specify which component(s) to affect.

function map For specifying the acquisition path for the input gain
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize M_ALL_CHANNELS

Applies the setting to all available acquisition paths used by the specified digitizer.

l
Click to summarize M_CHn

Applies the setting to acquisition path n, where n is a value from 0 to 2.

More than one acquisition path can be specified by adding them together (for example, M_CH0 + M_CH1).

(summarize)
l

You can add one of the following values to the above-mentioned values to specify the specific video signal component to apply the input-gain setting.

Note that these combination constants are only available if your DCF uses a composite color input signal.

function map For specifying the specific video signal component to apply the input-gain setting
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize M_CHROMINANCE

Applies the input-gain setting to the chrominance component of the video signal. The gain setting is applied only after the composite signal is separated into its components.

(summarize)
g h i
Click to summarize M_LUMINANCE

Applies the input-gain setting to the luminance component of the video signal. The gain setting is applied only after the composite signal is separated into its components.

(summarize)
g h i

The following control types allow you to set the mode and the purpose of your Matrox imaging board's I/O signals (such as, auxiliary, Camera Link control, and transport layer trigger signal). Once the format, routing, and mode are determined for an I/O signal, you can further control the I/O signal using the control types described in the following tables: For setting the state of specified user-bits in a static-user-output register, For controlling the settings of a timer, For controlling the camera's exposure, and For controlling the settings to grab using a trigger.

Note that for all MIL supported hardware that have I/O signals, but are not supported with the constants below, see MsysControl().

Each Matrox imaging board and MIL driver has its own list of limitations regarding the signals you can control with this function. While general limitations are listed in the table below, for a complete list of the available signals and their limitations, see the Connectors and signal names section of the MIL Hardware-specific Notes chapter for your Matrox imaging board or MIL driver.

function map For routing I/O signals and setting their mode
Click to summarize
ControlType
Description MIL system-specific
tooltip (‡)
ControlValue
Click to summarize M_IO_FORMAT +

Sets whether to enable a specific transmitter/receiver for an I/O signal, on systems whose transmitters/receivers are enabled through software and where the option of two or more signal formats are possible. Note that some signals cannot be affected individually. In this case, if you affect any one of the signals in the group, they will all be affected. For more information, refer to the Technical information appendix in the Installation and Hardware Reference manual for your Matrox imaging board. INQ


You must specify a combination value from the following table:
(summarize)
c
M10
l o v
Click to summarize M_DEFAULT

Same as the transmitter/receiver for the I/O signal specified by the DCF.

l
Click to summarize M_DISABLE

Specifies that the specified I/O signal is not available for use.

c
M10
o v
Click to summarize M_LVDS

Specifies to use the LVDS transmitter/receiver for the I/O signal.

(summarize)
c
M10
l o v
MIL system specific

Uses the LVDS signal on external auxiliary I/O connector 0 (HB-44), instead of the TTL signal.

l
Click to summarize M_OPEN_DRAIN

Specifies to use the open collector (open drain) transmitter/receiver for the specified I/O signal.

c
M10
o v
Click to summarize M_OPTO

Specifies to use the opto-coupled transmitter/receiver for the specified I/O signal.

c
M10
o v
Click to summarize M_RS422

Specifies to use the RS-422 transmitter/receiver for the specified I/O signal.

c
M10
o v
Click to summarize M_TRI_STATE

Specifies to use the tri-state transmitter/receiver for the specified I/O signal.

c
M10
o v
Click to summarize M_TTL

Specifies to use the TTL transmitter/receiver for the specified I/O signal.

(summarize)
c
M10
l o v
MIL system specific

Uses the TTL signal on external auxiliary I/O connector 0 (HB-44), instead of the LVDS signal.

l
Click to summarize M_IO_INTERRUPT_ACTIVATION +

Sets the signal transition upon which to generate an interrupt, if interrupt generation has been enabled for the specified I/O signal. Use M_IO_INTERRUPT_STATE to enable interrupt generation.

Note that this only applies to input signals.

Note that this control type only has an effect when M_IO_INTERRUPT_STATE is enabled. INQ


You must specify a combination value from the following table:
(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_DEFAULT

Same as the signal transition specified by the DCF. If this value is not specified in the DCF, the default is the same as M_EDGE_RISING.

(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_ANY_EDGE

Specifies to generate an interrupt upon both a low-to-high and a high-to-low signal transition.

c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_EDGE_FALLING

Specifies that an interrupt will be generated upon a high-to-low signal transition.

c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_EDGE_RISING

Specifies that an interrupt will be generated upon a low-to-high signal transition.

c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_IO_INTERRUPT_STATE +

Sets whether to generate an interrupt upon the specified transition of the I/O signal. Use M_IO_INTERRUPT_ACTIVATION to specify the transition. Note that this only applies to input signals, or I/O signals set to input (using M_IO_MODE). INQ


You must specify a combination value from the following table:
(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_DEFAULT

Same as the transition specified by the DCF. If this value is not specified in the DCF, the default is the same as M_DISABLE.

(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_DISABLE

Specifies not to generate an interrupt.

c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_ENABLE

Specifies to generate an interrupt.

c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_IO_MODE +

Sets the mode of the specified I/O signal. Note that you can only change the mode of a bidirectional (I/O) signal. INQ


You must specify a combination value from the following table:
(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_DEFAULT

Same as the mode specified by the DCF, or disabled when dealing with a tri-state I/O signal.

c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_INPUT

Specifies that the signal is for input.

c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_OUTPUT

Specifies that the signal is for output.

c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_IO_SOURCE +

Sets the type of signal to route to an output signal, or a bidirectional signal set to output mode. INQ


You must specify a combination value from the following table:
(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_DEFAULT

Same as the type of signal specified by the DCF.

If this value is not specified in the DCF and dealing with an auxiliary signal, the default is M_USER_BITn, where n is the number of the user-bit that can drive the output signal.

For the number of the user-bit that can drive the specified output signal, see the Connectors and signal names section of the MIL Hardware-specific Notes chapter for your Matrox imaging board or MIL driver.

(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
MIL system specific

If this value is not specified in the DCF and dealing with a Camera Link camera control output signal, the default is M_USER_BIT_CC_IOn, where n is either 0 or 1.

j m p r
U27
aa
Click to summarize M_AUX_IOn

Specifies to reroute auxiliary input signal n to the output signal, where n is the number of the auxiliary input signal. Note that the specified auxiliary signal can also be a bidirectional signal set to input (using M_IO_MODE set to M_INPUT).

You can typically reroute an auxiliary input signal to an output signal that is hard-wired to the camera (for example, a Camera Control (CC) output signal or a transport layer (TL) trigger signal). Note that you cannot reroute auxiliary input signals to auxiliary output signals.

(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
MIL system specific

For a list of the available auxiliary I/O signals, see the Connectors and signal names section of the MIL Hardware-specific Notes chapter for your Matrox imaging board or MIL driver.

j k
M10
m p r
U27
y
U75
aa

n is a number from 0 to 31.

c
M10
o v

The only output signal on which an auxiliary input signal can be routed to is a TL signal (using M_IO_SOURCE + M_TL_TRIGGER).

k
M10
y
U75

The only output signal on which an auxiliary input signal can be routed to is a CC signal (using M_IO_SOURCE + M_CC_IOn). For more information, refer to the Connectors and signal names section of the MIL Hardware-specific Notes chapter for your Matrox hardware.

j m p r
U27
aa
Click to summarize M_DISABLE

Specifies to not route any signal to the specified signal.

c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_HSYNC

Specifies to route the horizontal synchronization signal of the camera.

Note that instead of using an auxiliary signal to output the HSYNC signal, you can use the dedicated HSYNC output signal; refer to the Installation and hardware reference manual for the list of available dedicated signals.

(summarize)
l m
Click to summarize M_PIXCLK

Specifies to route the pixel clock signal of the camera.

Note that instead of using an auxiliary signal to output the pixel clock signal, you can use the dedicated pixel clock output signal; refer to the Installation and hardware reference manual for the list of available dedicated signals.

(summarize)
l m
Click to summarize M_TIMERn

Specifies to route the output of timer n, where n is the number of timers available.

(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
MIL system specific

In this case, n can be a value from 1 to 4.

j k
M10
m p r
U27
y
U75
aa

With GigE Vision, USB3 Vision, and GenTL, n can be a value from 0 to 8.

c
M10
o v
Click to summarize M_TL_TRIGGER

Specifies to use the transport layer trigger signal (input mode only). The transport layer trigger signal is an embedded bidirectional signal from the physical transport layer connection of your camera. Typically, the TL Trigger is reserved for trigger information and is sent with other control and data signals along the same cable.

(summarize)
k
M10
y
U75
Click to summarize M_USER_BIT_CC_IOn

Specifies to route the state of bit n of the camera control static-user-output register, where n is a value from 0 to 1. Note that you can route a bit from the camera control static-user-output register to any of the 4 Camera Link camera control output signals (such as routing bit 0 to the M_CC_IO1 signal).

Note that there is one camera control static-user-output register per acquisition path.

(summarize)
j m p r
U27
aa
Click to summarize M_USER_BIT_TL_TRIGGER

Specifies to route the state of the bit of the TL trigger static-user-output register.

k
M10
y
U75
Click to summarize M_USER_BITn

Specifies to route the state of bit n of the main static-user-output register, where n is the bit number.

Note that there is one main static-user-output register per acquisition path. However, if one of its bits can be routed to a signal that is shared across acquisition paths, changing that bit in one register affects the register of all the other acquisition paths.

For the number of the user-bit that can drive the specified output signal, see the Connectors and signal names section of the MIL Hardware-specific Notes chapter for your Matrox imaging board or MIL driver.

(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
MIL system specific

With GigE Vision, USB3 Vision, and GenTL, n is a number from 0 to 31.

c
M10
o v
Click to summarize M_VSYNC

Specifies to route the vertical synchronization signal of the camera.

Note that instead of using an auxiliary signal to output the VSYNC signal, you can use the dedicated VSYNC output signal; refer to the Installation and hardware reference manual for the list of available dedicated signals.

(summarize)
l m
Combination values for the values listed in For routing I/O signals and setting their mode.

You must add one of the following values to the above-mentioned values to set the type and number of the I/O signal to affect.

function map For specifying the type and number of the I/O signal to affect
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize M_AUX_IOn

Specifies to affect auxiliary signal n, where n is the signal number.

Note that, when using this value with M_IO_SOURCE, the auxiliary signal n must be an output signal, or an I/O signal set to output (using M_IO_MODE).

(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
MIL system specific

For a list of the available auxiliary I/O signals, see the Connectors and signal names section of the MIL Hardware-specific Notes chapter for your Matrox imaging board or MIL driver.

j k
M10
l m p r
U27
y
U75
aa

With GigE Vision, USB3 Vision, and GenTL, n is a number from 0 to 31.

c
M10
o v
Click to summarize M_CC_IOn

Specifies to affect Camera Link camera control signal n, where n is a value from 1 to 4.

Note that this value is only available when using M_IO_SOURCE.

For a list of the available camera control signals, see the Connectors and signal names section of the MIL Hardware-specific Notes chapter for your Matrox imaging board or MIL driver.

(summarize)
j m p r
U27
aa
Click to summarize M_TL_TRIGGER

Specifies to affect the transport layer trigger signal. The transport layer trigger signal is an embedded bidirectional signal from the physical transport layer connection of your camera. Typically, the TL trigger signal is reserved for trigger information and is sent with other control and data signals along the same cable.

Note that this value is not available when using M_IO_FORMAT.

(summarize)
k
M10
y
U75

The following control types and control values allow you to set the bits in a static-user-output register. You can route the bits to output signals or I/O signals set to output; to do so, use M_IO_SOURCE with M_USER_BIT...). To establish which user-bits can be routed to a specific signal, see the connectors and signal names section of the MIL Hardware-specific Notes chapter for your Matrox imaging board.

Note that for all MIL supported hardware that have I/O signals, but are not supported with the constants below, see MsysControl().

function map For setting the state of specified user-bits in a static-user-output register
Click to summarize
ControlType
Description MIL system-specific
tooltip (‡)
ControlValue
Click to summarize M_USER_BIT_STATE +

Sets the state of the specified bit of a static-user-output register. INQ


You must specify a combination value from the following table:
(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_OFF

Specifies that the specified bit is set to off.

c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_ON

Specifies that the specified bit is set to on.

c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_USER_BIT_STATE_ALL +

Sets the state of all the bits of the main static-user-output register or another specified static-user-output register. INQ

(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
MIL system specific

To affect a static-user-output register other than the main one, use one of the combination values documented below.

k
M10
y
U75
Click to summarize Value

Specifies a bit-encoded value that establishes the value of all the bits of the specified static-user-output register. It is recommended to specify the value in hexadecimal notation (0x), so that it is more legible to what you are setting each bit of the register.

(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Combination values for M_USER_BIT_STATE.

You must add one of the following values to the above-mentioned value to specify the static-user-output register and bit to affect.

function map For specifying the bit in a static-user-output register to affect
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize M_USER_BIT_CC_IOn

Specifies which bit of the camera control static-user-output register to affect, where n is a value from 0 to 1. In this case, n represents the bit in the camera control static-user-output register.

Note that there is one camera control static-user-output register per acquisition path.

(summarize)
j m p r
U27
aa
Click to summarize M_USER_BIT_TL_TRIGGER0

Specifies to affect the bit of the TL trigger static-user-output register.

k
M10
y
U75
Click to summarize M_USER_BITn

Specifies to affect bit n of the main static-user-output register.

Note that there is one main static-user-output register per acquisition path. However, if one of its bits can be routed to a signal that is shared across acquisition paths, changing that bit in one register affects the register of all the other acquisition paths.

(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
MIL system specific

With GigE Vision, USB3 Vision, and GenTL, n is a number from 0 to 31.

c
M10
o v
Combination values for M_USER_BIT_STATE_ALL.

You can add one of the following values to the above-mentioned value to specify the static-user-output register to affect, if you don't want to affect the main static-user-output register.

function map For specifying the static-user-output register
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize M_USER_BIT

Specifies to control the main static-user-output register.

This is the default value.

(summarize)
j k
M10
l m p r
U27
y
U75
aa
Click to summarize M_USER_BIT_CC_IO

Specifies to control the static-user-output register associated with Camera Link camera control signals (the camera control static-user-output register).

j m p r
U27
aa
Click to summarize M_USER_BIT_TL_TRIGGER

Specifies to control the static-user-output register associated with TL trigger signals (the TL trigger static-user-output register).

k
M10
y
U75

The following control types and control values allow you to set the controls associated with triggered grabbing. For more information, see the Grabbing with triggers section of Chapter 25: Grabbing with your digitizer.

[Matrox Morphis]

Triggered grabs are not supported on Matrox Morphis Quad.

function map For controlling the settings to grab using a trigger
Click to summarize
ControlType
Description MIL system-specific
tooltip (‡)
ControlValue
Click to summarize M_GRAB_CONTINUOUS_END_TRIGGER

Sets whether to automatically generate a trigger after MdigHalt() is issued when performing a triggered continuous grab. INQ

(summarize)
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.

M_ENABLE is the default for a software triggered grab.

M_DISABLE is the default for a hardware triggered grab.

(summarize)
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 generate the trigger automatically.

With a software triggered continuous grab operation, MdigHalt() will wait indefinitely until a software trigger is issued on a separate thread.

With a hardware triggered continuous grab operation, MdigHalt() will wait indefinitely until a hardware trigger is generated before invoking the last grab.

(summarize)
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 generate the trigger automatically.

With a software or hardware triggered continuous grab operation, MdigHalt() will generate a software trigger that invokes the last grab.

(summarize)
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_GRAB_TRIGGER_ACTIVATION

Sets the signal transition upon which to generate a grab trigger. Use M_GRAB_TRIGGER_STATE to enable triggered grabbing. INQ

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

Same as the signal transition specified by the DCF. If the transition upon which to generate a grab trigger is not in the DCF, M_EDGE_RISING is the default.

(summarize)
g j k
M10
l m p r
U27
t
U28
y
U75
aa
Click to summarize M_ANY_EDGE

Specifies that a trigger will be generated upon both a low-to-high and a high-to-low signal transition.

c
M10
o v
Click to summarize M_EDGE_FALLING

Specifies that a trigger will be generated upon a high-to-low signal transition.

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

Specifies that a trigger will be generated upon a low-to-high signal transition.

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

Specifies that a trigger is continuously issued during a high signal polarity.

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

Specifies that a trigger is continuously issued during a low signal polarity.

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

Sets the delay between the trigger and the grab.

Note, an error is generated if the specified delay cannot be respected. INQ

(summarize)
c
M10
o v
Click to summarize Value >= 0

Specifies the delay, in nsec.

c
M10
o v
Click to summarize M_GRAB_TRIGGER_MISSED

Sets whether the number of grab triggers missed should be counted. INQ

(summarize)
t
U28
Click to summarize M_DISABLE

Specifies to not count the number of grab triggers missed.

This is the default value.

(summarize)
t
U28
Click to summarize M_ENABLE

Specifies to count the number of grab triggers missed.

t
U28
Click to summarize M_GRAB_TRIGGER_OVERLAP

Sets how to deal with a new grab trigger that occurs when the current grab is in progress. INQ

(summarize)
c
M10
k
U29
o r
U74
t
U28
v y
U75
aa
MIL system specific

On the camera, this control type allows the exposure phase of a triggered grab to occur while the previous image is still being transferred to the Host. If disabled, the exposure phase and the data transfer phase will occur sequentially.

If the exposure phase ends before the previously grabbed image is transferred to the Host, disabling this control type can lead to dropped frames. If, however, the exposure phase ends after the previously grabbed image is transferred to the Host, disabling this control type can increase the speed of your application.

c
M10
o t
U28
v
Click to summarize M_DEFAULT

Specifies the default value.

(summarize)
c
M10
k
U29
o r
U74
t
U28
v y
U75
aa
MIL system specific

Same as M_ENABLE.

c
M10
o t
U28
v

Same as M_RESET.

k
U29
r
U74
y
U75
aa
Click to summarize M_DISABLE

Specifies that a triggered grab will not overlap the transfer of the previous image. Note that, when grab trigger overlap is disabled, the exposure phase and the data transfer phase will occur sequentially.

(summarize)
c
M10
o t
U28
v
Click to summarize M_ENABLE

Specifies that a triggered grab can overlap the transfer of the previous image.

c
M10
o t
U28
v
Click to summarize M_OFF

Specifies that a new trigger is ignored.

k
U29
r
U74
y
U75
aa
Click to summarize M_PREVIOUS_FRAME

Specifies that a trigger received, while a grab is in progress, will be latched (stored). As soon as the current grab finishes, a new grab will be started.

(summarize)
k
U29
r
U74
y
U75
aa
Click to summarize M_RESET

Specifies that the current grab will be immediately stopped and a new grab will be started.

k
U29
r
U74
y
U75
aa
Click to summarize M_GRAB_TRIGGER_SOFTWARE

Issues a software trigger.

To use this control type, the trigger source must be set to software (M_GRAB_TRIGGER_SOURCE set to M_SOFTWARE).

The call to issue a software trigger should be made in a thread separate from the thread performing the continuous grab operation (or the series of asynchronous grabs) to be triggered. If using MdigProcess(), the grab operation is automatically performed in a separate thread from the software trigger (along with any other issued M_GRAB_TRIGGER... controls); whereas, MdigGrabContinuous() and MdigGrab() are performed in the same thread as the software trigger, unless otherwise programmed.

(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

Note that, for this control type to function on the Host, you must pass a simulated digitizer (allocated using MdigAlloc() with M_EMULATED).

a
Click to summarize M_ACTIVATE

Specifies 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_GRAB_TRIGGER_SOURCE

Sets the signal source of the grab trigger when there are multiple sources available. 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

Note that, when using an external trigger source to control both your external lighting source and your Matrox Iris's grab, if one out of x grabbed images is significantly darker (insufficiently lit), your external trigger source might be triggering faster than your Matrox Iris can grab, transfer the image, and prepare to grab again.

t
U28
Click to summarize M_DEFAULT

Same as the one specified by the DCF.

g h j k
M10
l m p r
U27
t
U28
y
U75
aa
Click to summarize M_AUX_IOn

Specifies to use auxiliary input signal n as the trigger source, where n is the number of the auxiliary signal.

(summarize)
c
M10
g j k
M10
l m o p r
U27
t
U28
v y
U75
aa
MIL system specific

Note that the specified auxiliary signal can also be a bidirectional signal set to input (using M_IO_MODE set to M_INPUT).

c
M10
l o p r
U27
v aa

With a Matrox Radient eV-CxP, n is a number from 0 to 31.

k
M10
y
U75

With a Matrox Solios eCL/XCL-B, n is a number from 0 to 2.

m

With GigE Vision, USB3 Vision, and GenTL, n is a number from 0 to 31.

c
M10
o v

With Matrox Iris GTR, n is a number from 3 to 6.

t
U28
Click to summarize M_HSYNC

Specifies to use the horizontal synchronization signal of the camera as the trigger source.

j l m p r
U27
aa
Click to summarize M_IO_COMMAND_LIST1 +

Specifies to use a bit of the I/O command register of I/O command list 1 as a trigger source.


You must specify a combination value from the following table:
(summarize)
t
U28
Click to summarize M_ROTARY_ENCODER

Specifies to use the output of the default rotary decoder (set with M_ROTARY_ENCODER_OUTPUT_MODE) as the trigger source.

(summarize)
j k
M10
m p r
U27
t
U28
y
U75
aa
MIL system specific

This control type specifies to use the rotary decoder corresponding to 1+ the device number of the specified digitizer (DigId) will be used. For example, when the device number of the specified digitizer is M_DEV2, rotary decoder M_ROTARY_ENCODER3 is used.

k
M10
y
U75
Click to summarize M_ROTARY_ENCODERn

Specifies to use rotary decoder n as the trigger source, where n is a number between 1 and 4.

To use the output of the default rotary decoder, use M_ROTARY_ENCODER.

(summarize)
k
M10
t
U28
y
U75
MIL system specific

With Matrox Iris GTR, n must be 1.

t
U28
Click to summarize M_SOFTWARE

Specifies to use a software trigger as the trigger source. Use M_GRAB_TRIGGER_SOFTWARE to issue the trigger.

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

Specifies to use the software trigger being used for the grab of another digitizer (on the same board) as the trigger source. With this control value, n corresponds to 1+ the device number of the digitizer that is (by default) associated with the specified software trigger, and can be from 1 to 4.

(summarize)
k
M10
y
U75
Click to summarize M_TIMERn

Specifies to use the output signal of the specified timer as the trigger source. Use the M_TIMER_... to set up the timer.

(summarize)
c
M10
j k
M10
l m o p r
U27
t
U28
v y
U75
aa
MIL system specific

In this case, n can be a value from 1 to 2.

l

In this case, n can be a value from 1 to 4.

j k
M10
m p r
U27
y
U75
aa

With Matrox Iris GTR, n is a number from 1 to 8.

t
U28

With GigE Vision, USB3 Vision, and GenTL, n can be a value from 0 to 8.

c
M10
o v
Click to summarize M_TL_TRIGGER

Specifies to use the transport layer trigger signal. The transport layer trigger signal is an embedded bidirectional signal from the physical transport layer connection of your camera. Typically, the TL Trigger is reserved for trigger information and is sent with other control and data signals along the same cable.

(summarize)
k
M10
Click to summarize M_VSYNC

Specifies to use the vertical synchronization signal of the camera as the trigger source.

j l m p r
U27
aa
Click to summarize M_GRAB_TRIGGER_STATE

Sets whether, when a grab command is issued (for example, MdigGrab()) to wait for a trigger before grabbing. If your Matrox frame grabber supports trigger input, you can set up your digitizer to perform a triggered grab, that is, to grab a frame upon the occurrence of an event. In this case, nothing is grabbed when you call MdigGrab() or MdigGrabContinuous() or MdigProcess(), until a specified event occurs. When grabbing continuously, the digitizer waits for a trigger before grabbing each frame; you must still call MdigHalt() after grabbing all required frames.

Note that, you can specify the number of frames to grab per trigger received (using MdigProcess() with M_FRAMES_PER_TRIGGER()) or only use a single trigger to start the grab (using MdigProcess() with M_TRIGGER_FOR_FIRST_GRAB). 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

Use M_GRAB_TRIGGER_SOURCE to specify the trigger source.

c
M10
g o t
U28
v

The trigger source is automatically set to use a software trigger.

a i u
U36

Note that, for this control type to function on the Host, you must pass a simulated digitizer (allocated using MdigAlloc() with M_EMULATED).

a
Click to summarize M_DEFAULT

Same as the state specified by the DCF or, if none specified, M_DISABLE.

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

Specifies that, when a grab command is issued, the grab occurs without waiting for a trigger.

Note that, this is the default behavior when using a software trigger.

(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, when a grab command is issued, the grab waits for a trigger before occurring.

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

You must add the following value to the above-mentioned value to specify which I/O command register bit to use.

function map For specifying which I/O command register bit to use
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize M_IO_COMMAND_BITn

Specifies I/O command register bit n, where n represents the bit number.

With Matrox Iris GTR, n can be a value from 0 to 4.

(summarize)
t
U28

The following control types allow you to control the settings for a grab of sequential frames into a multi-frame image buffer (frame burst).

function map For controlling frame bursts
Click to summarize
ControlType
Description MIL system-specific
tooltip (‡)
ControlValue
Click to summarize M_GRAB_FRAME_BURST_END_TRIGGER_SOURCE

Sets the signal from which a rising edge signals the end of a grab of sequential frames into a multi-frame image buffer (end-of-frame-burst trigger). This control type only has an effect if the M_GRAB_FRAME_BURST_END_TRIGGER_STATE is set to M_ENABLE. INQ

(summarize)
k
U29
r
U27
y
U75
aa
Click to summarize M_DEFAULT

Same as M_AUX_IO0.

k
U29
r
U27
y
U75
aa
Click to summarize M_AUX_IOn

Specifies to use auxiliary input signal n as the trigger source, where n is the number of the auxiliary signal. Note that the specified auxiliary signal can also be a bidirectional signal set to input, using M_IO_MODE set to M_INPUT.

(summarize)
k
U29
r
U27
y
U75
aa
Click to summarize M_GRAB_FRAME_BURST_END_TRIGGER_STATE

Sets whether a grab into a multi-frame image buffer is ended upon an end-of-frame-burst trigger. Specify the trigger source using M_GRAB_FRAME_BURST_END_TRIGGER_SOURCE. Note that regardless of this setting, the grab also ends if the multi-frame image buffer is filled or the timeout is reached (M_GRAB_FRAME_BURST_MAX_TIME). INQ

(summarize)
k
U29
r
U27
y
U75
aa
Click to summarize M_DEFAULT

Same as M_DISABLE.

k
U29
r
U27
y
U75
aa
Click to summarize M_DISABLE

Specifies that an end-of frame-burst trigger is not used to end the grab.

k
U29
r
U27
y
U75
aa
Click to summarize M_ENABLE

Specifies that an end-of frame-burst trigger is used to end the grab.

k
U29
r
U27
y
U75
aa
Click to summarize M_GRAB_FRAME_BURST_MAX_TIME

Sets the maximum amount of time to wait for all the frames to be grabbed into the multi-frame image buffer. The timer starts when the first frame is grabbed. The number of frames in the buffer can be inquired using MdigGetHookInfo() with M_GRAB_FRAME_BURST_COUNT. This is useful when the camera stops sending frames and the multi-frame buffer is only partially full. INQ

(summarize)
k
U29
r
U27
y
U75
aa
Click to summarize M_DEFAULT

Same as M_INFINITE.

k
U29
r
U27
y
U75
aa
Click to summarize M_INFINITE

Specifies to wait indefinitely.

k
U29
r
U27
y
U75
aa
Click to summarize 0.000008 <= Value <= 1.000000

Specifies the maximum amount of time to wait, in secs.

k
U29
r
U27
y
U75
aa
Click to summarize M_GRAB_FRAME_BURST_SIZE

Sets the number of sequential frames to grab into a multi-frame image buffer with one grab command (MdigGrab(), or one grab of MdigProcess()); the defined number of frames are stored contiguously in the same buffer. The end-of-grab event only occurs once the entire group of frames has been grabbed, reducing the number of events that need to be handled. The Y-size of the grab buffer must be equal to (height of the frame * M_GRAB_FRAME_BURST_SIZE). For more information about the grab buffer size, see the Specifying the dimensions of a multi-frame image buffer subsection of the Specifying the dimensions of a data buffer section of Chapter 21: Data buffers. INQ

(summarize)
k
U29
r
U27
y
U75
aa
Click to summarize M_DEFAULT

Specifies the default value; the default value is 1.

k
U29
r
U27
y
U75
aa
Click to summarize 1 <= Value <= 1023

Specifies the number of frames to grab.

k
U29
r
U27
y
U75
aa

The following control types and control values specify the settings for controlling a timer and the signal generated from the timer (timer output signals). For more information, see the Grabbing with triggers section of Chapter 25: Grabbing with your digitizer.

function map For controlling the settings of a timer
Click to summarize
ControlType
Description MIL system-specific
tooltip (‡)
ControlValue
Click to summarize M_TIMER_CLOCK_SOURCE +

Specifies the source of the clock that drives the specified timer.

The clock source must have a frequency greater than or equal to 1 Hz. INQ


You must specify a combination value from the following table:
(summarize)
j k
M10
l m p r
U27
y
U75
aa
Click to summarize M_DEFAULT

Specifies to use the most appropriate clock source (as determined by the driver).

j k
M10
l m p r
U27
y
U75
aa
Click to summarize M_HSYNC

Specifies to use the horizontal synchronization frequency of your camera.

j k
U29
l m p r
U27
y
U75
aa
Click to summarize M_PIXCLK

Specifies to use the pixel clock frequency of your camera.

j l m p r
U27
aa
Click to summarize M_SYSCLK

Specifies to use the frequency of the allocated system's clock source.

(summarize)
j k
M10
l m p r
U27
y
U75
aa
MIL system specific

The frequency is programmable in the DCF.

j l m p r
U27
aa

For Matrox Radient eV-CXP, the frequency is set to 125MHz, and it cannot be changed.

k
M10
y
U75
Click to summarize M_TIMERn

Specifies to use the frequency of the output of the specified timer, where n is the timer number. Note that, in this case, the timer output pulse is used as a clock tick. The specified timer should be in continuous mode (that is, M_TIMER_TRIGGER_SOURCE is set to M_CONTINUOUS).

Only a continuous timer can clock another timer. References where timer 1 points to timer 2, and timer 2 points back to timer 1, are not supported and will generate an error.

(summarize)
j k
M10
l m p r
U27
y
U75
aa
MIL system specific

With Matrox Solios eA/XA, n can be a value from 1 to 2.

l

In this case, n can be a value from 1 to 4.

j k
M10
m p r
U27
y
U75
aa
Click to summarize M_VSYNC

Specifies to use the vertical synchronization frequency of your camera.

j k
U29
l m p r
U27
y
U75
aa
Click to summarize M_TIMER_DELAY +

Sets the delay between the timer trigger and the active portion of the timer output signal.

Note, an error is generated if the specified delay cannot be respected. INQ


You must specify a combination value from the following table:
(summarize)
c
M10
j k
M10
l m o p r
U27
t
U28
v y
U75
aa
Click to summarize M_DEFAULT

Specifies the default value.

(summarize)
j k
M10
l m p r
U27
t
U28
y
U75
aa
MIL system specific

Same as the delay specified by the DCF.

j k
M10
l m p r
U27
y
U75
aa
Click to summarize 0

Specifies that there is no delay.

c
M10
o t
U28
v
Click to summarize Value > 0

Specifies the delay, in nsec.

c
M10
j k
M10
l m o p r
U27
t
U28
v y
U75
aa
Click to summarize M_TIMER_DELAY2 +

Sets the delay between the end of the first active portion of the timer output signal and the start of the second pulse. INQ


You must specify a combination value from the following table:
(summarize)
j k
U29
p r
U27
y
U75
aa
Click to summarize M_DEFAULT

Specifies the default value. This is the same as specified in the DCF or, if not specified in the DCF, 0.

(summarize)
j k
U29
p r
U27
y
U75
aa
Click to summarize Value > 0

Specifies the delay, in nsec.

j k
U29
p r
U27
y
U75
aa
Click to summarize M_TIMER_DURATION +

Sets the duration for the active portion of the timer output signal.

Note, an error is generated if the specified duration cannot be respected. INQ


You must specify a combination value from the following table:
(summarize)
c
M10
j k
M10
l m o p r
U27
t
U28
v y
U75
aa
MIL system specific

Unlike with other products, when using the grab trigger signal to trigger the strobe, the specified duration of the strobe's timer output signal specifies how long the timer should remain active during the exposure period. The active period of the strobe's timer output will actually start after the specified delay, but the count for how long it should remain active only starts when the camera starts exposing its image sensor. Once counting begins, the signal will typically be active for the specified duration. If the duration of the strobe's timer is greater than the exposure time, the strobe's timer's output signal will end when the exposure time ends (set using M_EXPOSURE_TIME).

t
U28
Click to summarize M_DEFAULT

Specifies to use the duration specified by the DCF.

j k
M10
l m p r
U27
t
U28
y
U75
aa
Click to summarize Value > 0

Specifies the duration of the active portion of the timer output signal, in nsec.

c
M10
j k
M10
l m o p r
U27
t
U28
v y
U75
aa
Click to summarize M_TIMER_DURATION2 +

Sets the duration for the active portion of the second pulse of the timer output signal. INQ


You must specify a combination value from the following table:
(summarize)
j k
U29
p r
U27
y
U75
aa
Click to summarize M_DEFAULT

Specifies the default value. This is the same as specified in the DFC or, if not specified in the DCF, 0.

(summarize)
j k
U29
p r
U27
y
U75
aa
Click to summarize Value > 0

Specifies the duration of the active portion of the second pulse of the timer output signal, in nsecs.

j k
U29
p r
U27
y
U75
aa
Click to summarize M_TIMER_OUTPUT_INVERTER +

Sets whether the output of the timer should be inverted. This causes the low portion of the signal (the delay period) to be high and the high portion of the signal (the active portion) to be low. INQ


You must specify a combination value from the following table:
(summarize)
j k
M10
l m p r
U27
t
U28
y
U75
aa
Click to summarize M_DEFAULT

Specifies the default value.

(summarize)
j k
M10
l m p r
U27
y
U75
aa
MIL system specific

Same as the value specified by the DCF.

j k
M10
l m p r
U27
y
U75
aa
Click to summarize M_DISABLE

Specifies not to invert the output of the timer.

j k
M10
l m p r
U27
t
U28
y
U75
aa
Click to summarize M_ENABLE

Specifies to invert the output of the timer.

j k
M10
l m p r
U27
t
U28
y
U75
aa
Click to summarize M_TIMER_STATE +

Sets the state of the specified timer.

When a timer is enabled, the timer waits for a trigger to be received. To set the source of the trigger, use M_TIMER_TRIGGER_SOURCE. Once the trigger is received, the timer starts by outputting a low signal. This lasts for the duration of the delay period (set using M_TIMER_DELAY). The timer then changes to output a high signal for the duration of the active period (set using M_TIMER_DURATION). To invert this signal, use M_TIMER_OUTPUT_INVERTER. INQ


You must specify a combination value from the following table:
(summarize)
c
M10
j k
M10
l m o p r
U27
t
U28
v y
U75
aa
Click to summarize M_DEFAULT

Specifies the default value.

(summarize)
j k
M10
l m p r
U27
t
U28
y
U75
aa
MIL system specific

Same as the state specified by the DCF.

j k
M10
l m p r
U27
y
U75
aa

Same as M_TIMER_STATE set to M_DISABLE.

t
U28
Click to summarize M_DISABLE

Specifies that the timer is disabled.

c
M10
j k
M10
l m o p r
U27
t
U28
v y
U75
aa
Click to summarize M_ENABLE

Specifies that the timer is enabled.

c
M10
j k
M10
l m o p r
U27
t
U28
v y
U75
aa
Click to summarize M_TIMER_TRIGGER_ACTIVATION +

Sets the signal variation upon which to generate a timer trigger, if the specified timer is enabled. Use M_TIMER_STATE to enable the timer. INQ


You must specify a combination value from the following table:
(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_DEFAULT

Specifies the default value.

(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
MIL system specific

Same as the signal variation specified by the DCF.

j k
M10
l m p r
U27
y
U75
aa

Same as M_EDGE_RISING.

c
M10
o v
Click to summarize M_ANY_EDGE

Specifies that a timer trigger will be generated both upon a high-to-low and a low-to-high signal transition.

c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_EDGE_FALLING

Specifies that a timer trigger will be generated upon a high-to-low signal transition.

c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_EDGE_RISING

Specifies that a timer trigger will be generated upon a low-to-high signal transition.

c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_LEVEL_HIGH

Specifies that a timer trigger is continuously issued during a high signal polarity.

c
M10
o v
Click to summarize M_LEVEL_LOW

Specifies that a timer trigger is continuously issued during a low signal polarity.

c
M10
o v
Click to summarize M_TIMER_TRIGGER_MISSED +

Sets whether to count the number of trigger pulses missed. INQ


You must specify a combination value from the following table:
(summarize)
j k
M10
l m p r
U27
y
U75
aa
Click to summarize M_DEFAULT

Same as M_DISABLE.

j k
M10
l m p r
U27
y
U75
aa
Click to summarize M_DISABLE

Specifies not to count the number of trigger pulses missed.

j k
M10
l m p r
U27
y
U75
aa
Click to summarize M_ENABLE

Specifies to count the number of trigger pulses missed.

j k
M10
l m p r
U27
y
U75
aa
Click to summarize M_TIMER_TRIGGER_OVERLAP +

Sets how to deal with a new trigger that occurs while the associated timer has not yet expired. This is applied to both the delay and duration. INQ


You must specify a combination value from the following table:
(summarize)
k
U29
p r
U74
y
U75
aa
Click to summarize M_DEFAULT

Same as M_RESET.

k
U29
p r
U74
y
U75
aa
Click to summarize M_LATCH

Specifies that a trigger received, while the associated timer has not expired, will be latched (stored). As soon as the current timer expired, a new trigger is issued.

(summarize)
k
U29
p r
U74
y
U75
aa
Click to summarize M_OFF

Specifies that a new trigger is ignored.

k
U29
r
U74
y
U75
aa
Click to summarize M_RESET

Specifies that a new trigger automatically resets the timer (regardless of whether it is in its delay or active period) and then restarts the timer. This process will repeat for each new trigger received.

(summarize)
k
U29
p r
U74
y
U75
aa
Click to summarize M_TIMER_TRIGGER_RATE_DIVIDER +

Sets the frequency with which to accept trigger pulses (for example, if set to 2, the first trigger pulse is ignored and the second is accepted). INQ


You must specify a combination value from the following table:
(summarize)
j k
M10
l m p r
U74
y
U75
aa
Click to summarize M_DEFAULT

Specifies the default value; the default value is 1.

j k
M10
l m p r
U74
y
U75
aa
Click to summarize 1; 2; 4; 8; 16

Specifies the frequency with which to accept a trigger out of a series of trigger pulses. Note that, if set to 1, all trigger pulses are accepted.

(summarize)
j l m p
Click to summarize 1 <= Value <= 255

Specifies the frequency with which to accept a trigger out of a series of trigger pulses. Note that, if set to 1, all trigger pulses are accepted.

(summarize)
k
U29
r
U74
y
U75
aa
Click to summarize M_TIMER_TRIGGER_SOFTWARE +

Issues a software trigger for the specified timer.

To use this setting, the timer's trigger source must be set to software (M_TIMER_TRIGGER_SOURCE set to M_SOFTWARE).


You must specify a combination value from the following table:
(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_ACTIVATE

Specifies the default behavior.

c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_TIMER_TRIGGER_SOURCE +

Selects the trigger source for the specified timer when there are multiple sources available. INQ


You must specify a combination value from the following table:
(summarize)
c
M10
j k
M10
l m o p r
U27
t
U28
v y
U75
aa
Click to summarize M_DEFAULT

Same as the one specified by the DCF.

c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_NULL

Specifies that no trigger source is specified.

j k
M10
l m p r
U27
y
U75
aa
Click to summarize M_AUX_IOn

Specifies to use auxiliary input signal n as the trigger source for the specified timer, where n is the number of the auxiliary signal. Note that the specified auxiliary signal can also be a bidirectional signal set to input (using M_IO_MODE set to M_INPUT).

For a list of the available auxiliary I/O signals, see the Connectors and signal names section of the MIL Hardware-specific Notes chapter for your Matrox imaging board or MIL driver.

(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_CONTINUOUS

Specifies to run the specified timer in periodic mode; no actual trigger signal is used. The timer is automatically reset after the timer's duration expires. The timer loops between a delay and an active period.

(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_EXPOSURE_END

Specifies to use the exposure end signal as the trigger source. The exposure end signal is a quick pulse that occurs when the exposure ends.

(summarize)
c
M10
o v
Click to summarize M_EXPOSURE_START

Specifies to use the exposure start signal as the trigger source. The exposure start signal is a quick pulse that occurs when the exposure starts.

(summarize)
c
M10
o t
U28
v
Click to summarize M_GRAB_TRIGGER

Specifies to use the grab trigger source signal as the trigger source. To set the grab trigger source signal, use M_GRAB_TRIGGER_SOURCE.

(summarize)
c
M10
o t
U28
v
Click to summarize M_HSYNC

Specifies to use the horizontal synchronization signal as the trigger source.

j k
U29
l m p r
U27
y
U75
aa
Click to summarize M_ROTARY_ENCODER

Specifies to use the output of the default rotary decoder (set with M_ROTARY_ENCODER_OUTPUT_MODE) as the trigger source.

(summarize)
j k
M10
m p r
U27
y
U75
aa
MIL system specific

This control type specifies to use the rotary decoder corresponding to 1+ the device number of the specified digitizer (DigId) will be used. For example, when the device number of the specified digitizer is M_DEV2, rotary decoder M_ROTARY_ENCODER3 is used.

k
M10
y
U75
Click to summarize M_ROTARY_ENCODERn

Specifies to use rotary decoder n, where n is a number between 1 and 4.

To use the output of the default rotary decoder, use M_ROTARY_ENCODER.

(summarize)
k
M10
y
U75
Click to summarize M_SOFTWARE

Specifies to use a software trigger as the trigger source. Use M_TIMER_TRIGGER_SOFTWARE to issue the trigger.

(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
Click to summarize M_TIMERn

Specifies to use the output signal of the specified timer as the trigger source, where n is the timer number.

(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
MIL system specific

With Matrox Solios eA/XA, n can from 1 to 2.

l

In this case, n can be a value from 1 to 4.

j k
M10
m p r
U27
y
U75
aa

With GigE Vision, USB3 Vision, and GenTL, n can be a value from 0 to 8.

c
M10
o v
Click to summarize M_TL_TRIGGER

Specifies to use the transport layer trigger signal. The transport layer trigger signal is an embedded bidirectional signal from the physical transport layer connection of your camera. Typically, the TL Trigger is reserved for trigger information and is sent with other control and data signals along the same cable.

(summarize)
k
M10
y
U75
Click to summarize M_VSYNC

Specifies to use the vertical synchronization signal as the trigger source.

j k
U29
l m p r
U27
y
U75
aa

The following control types and control values specify the settings for controlling the camera's exposure. For more information, see the MIL Hardware-specific Notes for your Matrox Imaging board.

function map For controlling the camera's exposure
Click to summarize
ControlType
Description MIL system-specific
tooltip (‡)
ControlValue
Click to summarize M_AUTO_EXPOSURE

Sets the automatic exposure mode of the camera. INQ

(summarize)
c
M10
o v
Click to summarize M_DEFAULT

Specifies to use the camera's default values or, if supported, to enable the camera's auto control state for the gain, iris, and shutter features (that is, the camera adjusts these values automatically).

c
M10
o v
Click to summarize M_AUTOMATIC

Specifies that the camera's exposure duration is constantly adapted by the device to maximize its effect.

c
M10
o v
Click to summarize M_DISABLE

Specifies that the camera will not control the gain, iris, and shutter settings automatically.

c
M10
o v
Click to summarize M_ENABLE

Specifies that the camera controls the gain, iris, and shutter settings automatically.

c
M10
o v
Click to summarize M_EXPOSURE_DELAY

Sets the required delay between the exposure trigger and the start of your camera's image sensor being exposed.

Note, an error is generated if the specified delay cannot be respected. INQ

(summarize)
t
U28
Click to summarize M_DEFAULT

Specifies the default value; the default value is 0 nsec.

t
U28
Click to summarize Value >= 0

Specifies the delay, in nsec.

t
U28
Click to summarize M_EXPOSURE_MODE

Sets whether the exposure duration is set using an exposure timer or using the width of the trigger signal. INQ

(summarize)
t
U28
Click to summarize M_TIMED

Specifies to use M_EXPOSURE_TIME to control the length of the exposure.

t
U28
Click to summarize M_TRIGGER_WIDTH

Specifies to use duration of the active portion of the grab trigger's output signal to control the length of the exposure.

Use M_GRAB_TRIGGER_ACTIVATION to specify the signal transition upon which to generate a grab trigger. Note that, M_TRIGGER_WIDTH can only be used when M_GRAB_TRIGGER_ACTIVATION is set to M_LEVEL_HIGH or M_LEVEL_LOW.

(summarize)
t
U28
Click to summarize M_EXPOSURE_TIME

Sets the amount of time to expose the camera's image sensor.

Note, an error is generated if the specified duration cannot be respected. INQ

(summarize)
c
M10
o t
U28
v
Click to summarize M_DEFAULT

Specifies to use the camera's default exposure time, as specified by the DCF.

t
U28
Click to summarize Value >= 0

Specifies the amount of time to expose the camera's image sensor, in nsec.

c
M10
o t
U28
v

The following control types allow you to control the settings of a quadrature decoder with inputs from a rotary or linear encoder.

function map For controlling the settings of a quadrature decoder with inputs from a rotary or linear encoder
Click to summarize
ControlType
Description MIL system-specific
tooltip (‡)
ControlValue
Click to summarize M_ROTARY_ENCODER_BIT0_SOURCE

Sets the auxiliary input signal on which to receive bit 0 of the 2-bit Gray code.

Note that if the auxiliary input signal for bit 0 is set using this constant, the corresponding auxiliary input signal for bit 1 will automatically be assigned; you do not need to specify it using M_ROTARY_ENCODER_BIT1_SOURCE. INQ

(summarize)
j k
U29
p r
U27
y
U75
aa
Click to summarize M_DEFAULT

Same as DCF.

j k
U29
p r
U27
y
U75
aa
Click to summarize M_AUX_IOn

Specifies the auxiliary input signal to use. The auxiliary input signal must support bit 0 of quadrature input.

(summarize)
j k
U29
p r
U27
y
U75
aa
Click to summarize M_ROTARY_ENCODER_BIT1_SOURCE

Sets the auxiliary input signal on which to receive bit 1 of the 2-bit Gray code.

Note that if the auxiliary input signal for bit 1 is set using this constant, the corresponding auxiliary input signal for bit 0 will automatically be assigned; you do not need to specify it using M_ROTARY_ENCODER_BIT0_SOURCE. INQ

(summarize)
j k
U29
p r
U27
y
U75
aa
Click to summarize M_DEFAULT

Same as DCF.

j k
U29
p r
U27
y
U75
aa
Click to summarize M_AUX_IOn

Specifies the auxiliary input signal to use. The auxiliary input signal must support bit 1 of quadrature input.

(summarize)
j k
U29
p r
U27
y
U75
aa
Click to summarize M_ROTARY_ENCODER_DIRECTION +

Sets the direction of movement occurring when the Gray code sequence received by the rotary decoder is 00 - 01 - 11 - 10; this essentially establishes whether to increment or decrement the counter when receiving this sequence. A forward direction increments; while a backward direction decrements. For more information on how to set the direction, refer to the Interpreting the direction of movement from the Gray code subsection of the Using quadrature input from a rotary encoder section of Chapter 41: I/O signals and communicating with external devices. INQ

(summarize)
j k
M10
m p r
U27
y
U75
aa
Click to summarize M_DEFAULT

Same as DCF.

j k
M10
m p r
U27
y
U75
aa
Click to summarize M_BACKWARD

Specifies a backward direction of movement and to decrement the counter when the Gray code sequence is 00 - 01 - 11 - 10.

j k
M10
m p r
U27
y
U75
aa
Click to summarize M_FORWARD

Specifies a forward direction of movement and to increment the counter when the Gray code sequence is 00 - 01 - 11 - 10.

j k
M10
m p r
U27
y
U75
aa
Click to summarize M_ROTARY_ENCODER_FORCE_VALUE_SOURCE +

Sets the signal source to use to set the rotary decoder's counter to 0xFFFFFFFF. The rotary decoder will set the counter to this value on the rising edge of a signal transition of the selected source. INQ

(summarize)
j k
M10
m p r
U27
y
U75
aa
Click to summarize M_DEFAULT

Specifies to use the source set in the DCF.

j k
M10
m p r
U27
y
U75
aa
Click to summarize M_NULL

Specifies not to set the counter to 0xFFFFFFFF upon a signal.

j k
M10
m p r
U27
y
U75
aa
Click to summarize M_AUX_IOn

Specifies to use an auxiliary input signal or an auxiliary bidirectional signal set to input (using M_IO_MODE set to M_INPUT).

(summarize)
j k
M10
m p r
U27
y
U75
aa
MIL system specific

Only auxiliary input signals M_AUX_IO2 and M_AUX_IO7 can be specified.

j m p r
U27
aa
Click to summarize M_COUNTER_OVERFLOW

Specifies to set the counter to 0xFFFFFFFF and keep it at this value after the counter increments past 0x7FFFFFFF. To reset the counter to 0, use M_ROTARY_ENCODER_POSITION.

(summarize)
j k
M10
m p r
U27
y
U75
aa
Click to summarize M_POSITION_TRIGGER

Specifies to use the trigger signal generated by the rotary decoder when the counter reaches the value specified with M_ROTARY_ENCODER_POSITION_TRIGGER.

j k
M10
m p r
U27
y
U75
aa
Click to summarize M_STEP_BACKWARD_WHILE_POSITIVE

Specifies to set the counter to 0xFFFFFFFF upon a decrement, only if the counter value is in the range of 0x0 to 0x7FFFFFFF before the decrement occurs; when interpreting the counter value as signed, this would be the positive counter value range.

A typical use of this control value is to identify the number of steps taken backwards by the rotary encoder, so that the corresponding lines of data are not regrabbed. For a complete example, refer to the Using the rotary decoder's output to trigger a timer or a grab subsection of the Using quadrature input from a rotary encoder section of Chapter 41: I/O signals and communicating with external devices.

(summarize)
j k
M10
m p r
U27
y
U75
aa
Click to summarize M_TL_TRIGGER

Specifies to use a transport layer trigger input signal.

k
M10
y
U75
Click to summarize M_ROTARY_ENCODER_FRAME_END_READ +

Sets whether to enable the rotary decoder to store the counter value at the end of the last grab or frame interrupt. If enabled, the value of the counter can be inquired at anytime using MdigInquire() with M_ROTARY_ENCODER_FRAME_END_POSITION, or retrieved at the end of the last grab from a hooked function, using MdigGetHookInfo() with M_ROTARY_ENCODER_FRAME_END_POSITION. INQ

(summarize)
j k
M10
m p r
U27
y
U75
aa
Click to summarize M_DEFAULT

Same as M_DISABLE.

j k
M10
m p r
U27
y
U75
aa
Click to summarize M_DISABLE

Specifies that the counter value will not be available to be inquired at the end of the last frame grabbed.

j k
M10
m p r
U27
y
U75
aa
Click to summarize M_ENABLE

Specifies to enable the rotary decoder to store the counter value at the end of the last grabbed frame, so that it can be inquired.

j k
M10
m p r
U27
y
U75
aa
Click to summarize M_ROTARY_ENCODER_MULTIPLIER

Sets the multiplying factor to apply to each increment/decrement of the rotary decoder's counter for every rotary encoder step (change in position); this in turn applies a multiplying factor to the number of pulses that the rotary decoder outputs per step. For example, if this control value is set to 4, and M_ROTARY_ENCODER_OUTPUT_MODE is set to M_STEP_ANY, the rotary decoder will increment its counter by 4 and output 4 pulses for every rotary encoder step. INQ

(summarize)
j p r
U27
aa
Click to summarize M_DEFAULT

Specifies the default value; the default value is 1.

j p r
U27
aa
Click to summarize 0 < Value <= 4096

Specifies the multiplying factor to use.

j p r
U27
aa
Click to summarize M_ROTARY_ENCODER_OUTPUT_MODE +

Sets the rotary decoder's counter value and/or the direction of movement upon which the rotary decoder should output a pulse. The pulse can be used to trigger a timer or a grab. To trigger a timer or a grab, set M_TIMER_TRIGGER_SOURCE or M_GRAB_TRIGGER_SOURCE (respectively) to M_ROTARY_ENCODER.

To decimate (subsample) the rotary decoder output signal before sending it to a timer or a grab controller, set this control type to M_POSITION_TRIGGER and set M_ROTARY_ENCODER_POSITION_TRIGGER to the required decimation value. For more information, refer to the Pixel aspect ratio subsection of the Using quadrature input from a rotary encoder section of Chapter 41: I/O signals and communicating with external devices. INQ

(summarize)
j k
M10
p r
U27
y
U75
aa
Click to summarize M_DEFAULT

Same as DCF.

j k
M10
p r
U27
y
U75
aa
Click to summarize M_POSITION_TRIGGER

Specifies to output a pulse upon the trigger generated by M_ROTARY_ENCODER_POSITION_TRIGGER.

j k
M10
p r
U27
y
U75
aa
Click to summarize M_POSITION_TRIGGER_MULTIPLE

Specifies to start triggering only when the counter value set with M_ROTARY_ENCODER_POSITION_START_TRIGGER is reached and then to generate a trigger at a set interval (change) in counter value. Set the interval with M_ROTARY_ENCODER_POSITION_START_TRIGGER.

(summarize)
k
U29
p r
U74
y
U75
aa
Click to summarize M_STEP_ANY

Specifies to output a pulse upon any change in the rotary decoder's counter value (position change in any direction).

j k
M10
p r
U27
y
U75
aa
Click to summarize M_STEP_ANY_WHILE_POSITIVE

Specifies to output a pulse upon any change in the rotary decoder's counter value (position change in any direction), only if the counter value is in the range of 0x0 to 0x7FFFFFFF before the increment or decrement occurs; when interpreting the counter value as signed, this would be the positive counter value range.

Note that, if the counter value is treated as a signed integer and the counter is 0x7FFFFFFF, the next incremented value is 0x80000000 (falling into the negative counter value range). If you want to remain in the positive range, reset the counter to 0 using either M_ROTARY_ENCODER_POSITION or M_ROTARY_ENCODER_RESET_SOURCE.

(summarize)
j k
M10
p r
U27
y
U75
aa
Click to summarize M_STEP_FORWARD

Specifies to output a pulse upon a rotary decoder counter increment only.

j k
M10
p r
U27
y
U75
aa
Click to summarize M_STEP_FORWARD_WHILE_POSITIVE

Specifies to output a pulse upon a rotary decoder counter increment, only if the counter value is in the range of 0x0 to 0x7FFFFFFF before the increment occurs; when interpreting the counter value as signed, this would be the positive counter value range.

Note that, if the counter value is treated as a signed integer and the counter is 0x7FFFFFFF, the next incremented value is 0x80000000 (falling into the negative counter value range). If you want to remain in the positive range, reset the counter to 0 using either M_ROTARY_ENCODER_POSITION or M_ROTARY_ENCODER_RESET_SOURCE.

(summarize)
j k
M10
p r
U27
y
U75
aa
Click to summarize M_ROTARY_ENCODER_POSITION +

Resets the rotary decoder's counter to 0 immediately.

To reset the counter to 0 upon a signal, use M_ROTARY_ENCODER_RESET_SOURCE.

Note that a call to MdigInquire() with M_ROTARY_ENCODER_POSITION inquires the current value of the rotary decoder counter.

(summarize)
j k
M10
m p r
U27
y
U75
aa
Click to summarize Value = 0

Implements the default behavior. Note that, if a non-zero value is specified, an error is generated.

(summarize)
j k
M10
m p r
U27
y
U75
aa
Click to summarize M_ROTARY_ENCODER_POSITION_START_TRIGGER +

Sets the rotary decoder's counter value upon which to start generating triggers, when M_ROTARY_ENCODER_OUTPUT_MODE is set to M_POSITION_TRIGGER_MULTIPLE. If it is not set to this value, then M_ROTARY_ENCODER_POSITION_START_TRIGGER is ignored. INQ

(summarize)
j k
M10
m p r
U27
y
U75
aa
Click to summarize 0 <= Value <= 0xFFFFFFFF

Specified the value of the counter upon which to start generating triggers.

j k
M10
m p r
U27
y
U75
aa
Click to summarize M_ROTARY_ENCODER_POSITION_TRIGGER +

Sets the rotary decoder's counter value upon which a trigger is generated.

You can hook a function to the trigger generated, using MdigHookFunction() with M_ROTARY_ENCODER. You can also output this trigger to a timer or a grab controller using M_ROTARY_ENCODER_OUTPUT_MODE set to M_POSITION_TRIGGER. INQ

(summarize)
j k
M10
m p r
U27
y
U75
aa
Click to summarize 0 <= Value <= 0xFFFFFFFF

Specifies the value of the counter upon which a trigger is generated. If a value beyond the supported range is specified, an error is generated.

If you are treating the counter values as a signed range of values (for example, forcing the counter to reset to 0 at 0x80000000) and you want to generate a trigger upon a negative value, specify the equivalent value in the range of 0x80000000 to 0xFFFFFFFF.

If M_ROTARY_ENCODER_OUTPUT_MODE is set to M_POSITION_TRIGGER_MULTIPLE, this will specify the change in counter value at which to generate a trigger, beginning at the counter value specified by M_ROTARY_ENCODER_POSITION_START_TRIGGER.

If M_ROTARY_ENCODER_OUTPUT_MODE is set to M_POSITION_TRIGGER, this will specify the counter value at which to generate a trigger each time this value is reached.

If M_POSITION_TRIGGER is set to any other control value, this value will be ignored.

(summarize)
j k
M10
m p r
U27
y
U75
aa
Click to summarize M_ROTARY_ENCODER_RESET_SOURCE +

Sets the signal source to use to reset the rotary decoder's counter to 0. The rotary decoder will reset the counter on the rising edge of a signal transition of the selected source.

Alternatively, you can immediately reset the counter to 0 (without using a signal to trigger the reset), using M_ROTARY_ENCODER_POSITION. INQ

(summarize)
j k
M10
m p r
U27
y
U75
aa
Click to summarize M_DEFAULT

Specifies to use the source set in the DCF.

j k
M10
m p r
U27
y
U75
aa
Click to summarize M_NULL

Specifies not to reset using a hardware signal source.

j k
M10
m p r
U27
y
U75
aa
Click to summarize M_AUX_IOn

Specifies to use an auxiliary input signal or an auxiliary bidirectional signal set to input (using M_IO_MODE set to M_INPUT).

(summarize)
j k
M10
m p r
U27
y
U75
aa
MIL system specific

Only auxiliary input signals M_AUX_IO2 and M_AUX_IO7 can be specified.

j m p r
U27
aa
Click to summarize M_POSITION_TRIGGER

Specifies to use the trigger signal generated by the rotary decoder when the counter reaches the value specified with M_ROTARY_ENCODER_POSITION_TRIGGER.

j k
M10
m p r
U27
y
U75
aa
Click to summarize M_TL_TRIGGER

Specifies to use a transport layer trigger input signal.

k
M10
y
U75

You can add the following value to the above-mentioned values to specify which rotary decoder to set.

function map For specifying which rotary decoder to set
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize M_ROTARY_ENCODERn

Specifies to set rotary decoder n, where n is a number between 1 and 4.

Note that if you do not use this combination constant to specify a rotary decoder, the rotary decoder corresponding to 1+ the device number of the specified digitizer (DigId) will be used. For example, when the device number of the specified digitizer is M_DEV2, rotary decoder M_ROTARY_ENCODER3 is used.

(summarize)
k
M10
y
U75

The following control types allow you to control the settings for one of the data latches of your installed MIL board. Data latches store information specific to a grabbed frame when the latch is triggered; the data latch is reset at the end of every grabbed frame. To retrieve information from a data latch, use MdigGetHookInfo() with M_DATA_LATCH.... Note that data latch information is only available when MdigGetHookInfo() is called from a function hooked to an end of grabbed frame event using MdigHookFunction() with M_GRAB_FRAME_END or from the hook-handler function (callback function) of MdigProcess().

Note that you can only use data latches in association with the MIL digitizer allocated using MdigAlloc() with M_DEV0.

function map For controlling a data latch
Click to summarize
ControlType
Description MIL system-specific
tooltip (‡)
ControlValue
Click to summarize M_DATA_LATCH_MODE +

Configures whether to latch data from the point when the grab is queued until the start of the first frame of a series of queued grabs or grab sequence.

If calls to MdigGrab() occur while no other grab is currently being performed and M_DATA_LATCH_MODE is set to M_PREFETCH, events that occur, from the moment the grab command is issued until the start of the grabbed frame, can also trigger a data latch and be retrieved at the end of the grabbed frame, for each MdigGrab() call. INQ


You must specify a combination value from the following table:
(summarize)
k
M10
p r
U27
y
U75
aa
Click to summarize M_DEFAULT

Same as M_NORMAL.

k
M10
p r
U27
y
U75
aa
Click to summarize M_NORMAL

Specifies not to latch before the start of the first grabbed frame.

k
M10
p r
U27
y
U75
aa
Click to summarize M_PREFETCH

Specifies to latch data before the start of the first grabbed frame.

k
M10
p r
U27
y
U75
aa
Click to summarize M_DATA_LATCH_STATE +

Sets the state of the specified data latch. INQ


You must specify a combination value from the following table:
(summarize)
k
M10
p r
U27
y
U75
aa
Click to summarize M_DEFAULT

Same as M_DISABLE.

k
M10
p r
U27
y
U75
aa
Click to summarize M_DISABLE

Disables the data latch.

k
M10
p r
U27
y
U75
aa
Click to summarize M_ENABLE

Enables the data latch.

k
M10
p r
U27
y
U75
aa
Click to summarize M_DATA_LATCH_TRIGGER_ACTIVATION +

Sets the trigger signal transition upon which to store the specified information to the specified data latch. Note that this is only useful when M_DATA_LATCH_TRIGGER_SOURCE is set to M_AUX_IOn or M_TIMER_ACTIVE.

To set the signal with which to trigger the data latch, use M_DATA_LATCH_TRIGGER_SOURCE. INQ


You must specify a combination value from the following table:
(summarize)
k
M10
p r
U27
y
U75
aa
Click to summarize M_DEFAULT

Same as M_EDGE_RISING.

k
M10
p r
U27
y
U75
aa
Click to summarize M_EDGE_FALLING

Specifies to store the specified information to the data latch upon a high-to-low signal transition.

k
M10
p r
U27
y
U75
aa
Click to summarize M_EDGE_RISING

Specifies to store the specified information to the data latch upon a low-to-high signal transition.

k
M10
p r
U27
y
U75
aa
Click to summarize M_DATA_LATCH_TRIGGER_SOURCE +

Sets what triggers storing the specified information to the specified data latch. Use M_DATA_LATCH_TYPE to specify the type of information to store. INQ


You must specify a combination value from the following table:
(summarize)
k
M10
p r
U27
y
U75
aa
Click to summarize M_DEFAULT

Same as M_GRAB_FRAME_END.

k
M10
p r
U27
y
U75
aa
Click to summarize M_AUX_IOn

Specifies to use auxiliary signal n as the trigger source, where n is the auxiliary signal number. Note that the specified auxiliary signal can also be a bidirectional signal set to input (using M_IO_MODE set to M_INPUT).

For a list of the available auxiliary I/O signals, see the Connectors and signal names section of the MIL Hardware-specific Notes chapter for your Matrox imaging board or MIL driver.

To specify the signal transition, use M_DATA_LATCH_TRIGGER_ACTIVATION.

(summarize)
k
M10
p r
U27
y
U75
aa
Click to summarize M_GRAB_FRAME_END

Specifies to trigger the data latch on the event that occurs at the end of each grabbed frame; this event occurs when the frame grabber receives the last pixels (or packet) of a frame from the camera. Note that, in this case, the grabbed data might not be completely transferred to the Host.

(summarize)
k
M10
p r
U27
y
U75
aa
Click to summarize M_GRAB_FRAME_START

Specifies to trigger the data latch on the event that occurs at the start of each grabbed frame.

k
M10
p r
U27
y
U75
aa
Click to summarize M_GRAB_LINE

Specifies to trigger the data latch on the event that occurs at the end of each grabbed line; this event occurs when the frame grabber receives the last pixels (or packet) of a line from the camera. Note that, in this case, the grabbed data might not be completely transferred to the Host.

(summarize)
k
M10
p r
U27
y
U75
aa
Click to summarize M_ROTARY_ENCODERn

Specifies to use rotary decoder n as the trigger source, where n is the rotary decoder number.

To configure the rotary decoder, use the M_ROTARY_ENCODER... control types. To establish when the rotary decoder issues a trigger, use M_ROTARY_ENCODER_POSITION_TRIGGER.

(summarize)
k
M10
p r
U27
y
U75
aa
Click to summarize M_TIMER_ACTIVE +

Specifies to trigger the data latch on the event that occurs when the specified timer is active. This can be at the start of the active period or the end of the active period, depending on how you set M_DATA_LATCH_TRIGGER_ACTIVATION.


You must specify a combination value from the following table:
(summarize)
k
M10
p r
U27
y
U75
aa
Click to summarize M_DATA_LATCH_TYPE +

Sets the type of information to store in the specified data latch. Note that each type of information can only be associated with one data latch, except for timestamp, which can be associated with up to four data latches. MIL returns an error when this limitation is not respected. INQ


You must specify a combination value from the following table:
(summarize)
k
M10
p r
U27
y
U75
aa
Click to summarize M_IO_STATUS_ALL

Stores the status of all the auxiliary I/O signals.

k
M10
p r
U27
y
U75
aa
Click to summarize M_ROTARY_ENCODERn

Stores the value of the counter of rotary decoder n, where n is a number between 1 and 4. To configure the rotary decoder, use the M_ROTARY_ENCODER... control types.

(summarize)
k
M10
p r
U27
y
U75
aa
Click to summarize M_TIME_STAMP

Stores the timestamp upon which the data latch is triggered, in ticks. Up to four separate data latches can store a timestamp.

To convert a timestamp from clock ticks to seconds, use the following equation: Timestamp * ( TimestampFrequencyInHz). To inquire the clock frequency, use MdigInquire() with M_DATA_LATCH_CLOCK_FREQUENCY.

(summarize)
k
M10
p r
U27
y
U75
aa
Combination value for the values listed in For controlling a data latch.

You must add the following value to the above-mentioned values to specify which data latch to affect.

function map For specifying the data latch to affect
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize M_LATCHn

Specifies which data latch to affect, where n is a value from 0 to 15.

k
M10
p r
U27
y
U75
aa
Combination values for the values listed in For controlling the settings of a timer; and for the following value: M_TIMER_ACTIVE (when ControlType=M_DATA_LATCH_TRIGGER_SOURCE and ControlValue=M_TIMER_ACTIVE).

You must add one of the following values to the above-mentioned values to specify which on-board timer to control.

function map For specifying which on-board timer to control
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize M_TIMER_STROBE

Specifies the strobe timer.

t
U28
Click to summarize M_TIMERn

Specifies on-board timer n, where n is one of the timers available on your Matrox imaging board or the hardware associated with your MIL driver.

Note that, when dealing with timers (excluding M_DATA_LATCH_TRIGGER_SOURCE with M_TIMER_ACTIVE) only a continuous timer can clock another timer. In addition, references where timer 1 points to timer 2, and timer 2 points back to timer 1, are not supported and will generate an error.

(summarize)
c
M10
j k
M10
l m o p r
U27
v y
U75
aa
MIL system specific

With Matrox Solios eA/XA, n can be a value from 1 to 2.

l

n can be a value from 1 to 4.

j k
M10
m p r
U27
y
U75
aa

With GigE Vision, USB3 Vision, and GenTL, n can be a value from 0 to 8.

c
M10
o v
Type-specific versions of the function when using a C compiler under 64-bit
void MdigControlDouble (MIL_ID DigId, MIL_INT64 ControlType, MIL_DOUBLE ControlValue)
Parameters

DigId

See DigId 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 MdigControlInt64 (MIL_ID DigId, MIL_INT64 ControlType, MIL_INT64 ControlValue)
Parameters

DigId

See DigId 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.
BAYER COEFFICIENTS ID DEFAULT FLOAT BAYER CONVERSION DEFAULT DISABLE ENABLE CAMERA COLOR LOCK DEFAULT DISABLE ENABLE CAMERA LOCK DEFAULT DISABLE ENABLE CAMERA LOCK SENSITIVITY DEFAULT CAMERA UNLOCK SENSITIVITY DEFAULT CHANNEL DEFAULT CH0 CH1 CH2 CH3 CH4 CH5 CH6 CH7 CH8 CH9 CH10 CH11 CH12 CH13 CH14 CH15 COMMAND QUEUE MODE DEFAULT IMMEDIATE QUEUED CORRUPTED FRAME ERROR DEFAULT DISABLE ENABLE DIGITIZER INTERNAL BUFFERS NUM DEFAULT FIX PATTERN NOISE CORRECTION DEFAULT PREPROCESSING SENSOR FOCUS FOCUS PERSISTENCE DEFAULT DISABLE ENABLE FOCUS PERSISTENT VALUE GC CLPROTOCOL DEFAULT DISABLE ENABLE GC CLPROTOCOL DEVICE ID DEFAULT" GC FEATURE BROWSER DEFAULT CLOSE OPEN GC FEATURE POLLING DEFAULT DISABLE ENABLE GC FRAME MAX RETRIES DEFAULT GC PACKET MAX RETRIES GC FRAME TIMEOUT DEFAULT GC HEARTBEAT STATE DEFAULT DISABLE ENABLE GC HEARTBEAT TIMEOUT DEFAULT GC INTER PACKET DELAY GC LOCAL MESSAGE PORT GC LOCAL STREAM PORT GC MAX NBR PACKETS OUT OF ORDER DEFAULT GC MESSAGE CHANNEL MULTICAST ADDRESS STRING GC PACKET MAX RETRIES DEFAULT GC FRAME MAX RETRIES GC PACKET RESEND DISABLE ENABLE GC PACKET SIZE GC PACKET TIMEOUT DEFAULT GC PIXEL FORMAT DEFAULT GC PIXEL FORMAT SWITCHING DEFAULT DISABLE ENABLE GC STATISTICS RESET DEFAULT GC STREAM CHANNEL MULTICAST ADDRESS STRING GC STREAMING MODE DEFAULT AUTOMATIC MANUAL GC STREAMING START DEFAULT GC STREAMING STOP DEFAULT GC STREAMING STOP CHECK PERIOD DEFAULT GC STREAMING STOP DELAY DEFAULT GC UPDATE MULTICAST INFO DEFAULT GC USER NAME GENTL ANNOUNCE BUFFER GRAB PROC GENTL REVOKE BUFFER GRAB PROC GRAB ABORT DEFAULT GRAB DIRECTION X DEFAULT FORWARD REVERSE GRAB DIRECTION Y DEFAULT FORWARD REVERSE GRAB FIELD NUM DEFAULT GRAB FRAME MISSED COUNTER DEFAULT DISABLE ENABLE GRAB FRAME MISSED RESET DEFAULT GRAB LINE COUNTER DEFAULT DISABLE ENABLE GRAB LUT PALETTE DEFAULT GAMMA GRAB MODE DEFAULT ASYNCHRONOUS ASYNCHRONOUS QUEUED SYNCHRONOUS GRAB SCALE FILL DESTINATION GRAB SCALE INTERPOLATION MODE DEFAULT AUTOMATIC AVERAGE BICUBIC BILINEAR NEAREST NEIGHBOR GRAB SCALE X FILL DESTINATION GRAB SCALE Y FILL DESTINATION GRAB START MODE DEFAULT FIELD START FIELD START EVEN FIELD START ODD GRAB TIMEOUT DEFAULT INFINITE HARDWARE DEINTERLACING DEFAULT BOB METHOD DISABLE MADI METHOD INPUT FILTER DEFAULT AUTOMATIC BYPASS LOW PASS 0 LOW PASS 1 LAST GRAB IN TRUE BUFFER DEFAULT DISABLE ENABLE LIGHTING BRIGHT FIELD DEFAULT LUT ID DEFAULT POWER OVER CABLE DEFAULT OFF ON PROCESS GRAB MONITOR DEFAULT DISABLE ENABLE PROCESS TIMEOUT DEFAULT INFINITE SOURCE OFFSET X SOURCE OFFSET Y SOURCE SIZE X SOURCE SIZE Y TL TRIGGER ACTIVATION DEFAULT ANY EDGE EDGE RISING VIDEO OUTPUT NULL CHn WHITE BALANCE DEFAULT CALCULATE DISABLE ENABLE GENTL STREAM COUNT GENTL DEVICE GENTL REMOTE DEVICE WAIT FAST ASYNCHRONOUS SYNCHRONOUS ANTIALIASING DITHERING BLACK OFFSET BLACK REF DEFAULT AUTOMATIC MAX LEVEL MIN LEVEL MIN LEVEL <= Value <= M MAX LEVEL BRIGHTNESS REF DEFAULT MAX LEVEL MIN LEVEL MIN LEVEL <= Value <= M MAX LEVEL CONTRAST REF DEFAULT MAX LEVEL MIN LEVEL MIN LEVEL <= Value <= M MAX LEVEL HUE REF DEFAULT MAX LEVEL MIN LEVEL MIN LEVEL <= Value <= M MAX LEVEL SATURATION REF DEFAULT MAX LEVEL MIN LEVEL MIN LEVEL <= Value <= M MAX LEVEL WHITE REF DEFAULT AUTOMATIC MAX LEVEL MIN LEVEL MIN LEVEL <= Value <= M MAX LEVEL CHn ALL REF CH0 REF CH1 REF CH2 REF CH3 REF VOLTAGE GAIN DEFAULT GRAB AUTOMATIC INPUT GAIN DEFAULT DISABLE ENABLE GRAB INPUT GAIN DEFAULT GAIN0 GAIN1 GAIN2 GAIN3 MAX LEVEL MIN LEVEL SHADING CORRECTION DEFAULT DISABLE ENABLE SHADING CORRECTION GAIN FIXED POINT DEFAULT SHADING CORRECTION GAIN ID DEFAULT NULL UNSIGNED SHADING CORRECTION OFFSET ID DEFAULT NULL UNSIGNED ALL CHANNELS CHn CHROMINANCE LUMINANCE IO FORMAT DEFAULT DISABLE LVDS OPEN DRAIN OPTO RS422 TRI STATE TTL IO INTERRUPT ACTIVATION DEFAULT ANY EDGE EDGE FALLING EDGE RISING IO INTERRUPT STATE DEFAULT DISABLE ENABLE IO MODE DEFAULT INPUT OUTPUT IO SOURCE DEFAULT AUX IOn DISABLE HSYNC PIXCLK TIMERn TL TRIGGER USER BIT CC IOn USER BIT TL TRIGGER USER BITn VSYNC AUX IOn CC IOn TL TRIGGER USER BIT STATE OFF ON USER BIT STATE ALL USER BIT CC IOn USER BIT TL TRIGGER0 USER BITn USER BIT USER BIT CC IO USER BIT TL TRIGGER GRAB CONTINUOUS END TRIGGER DEFAULT DISABLE ENABLE GRAB TRIGGER ACTIVATION DEFAULT ANY EDGE EDGE FALLING EDGE RISING LEVEL HIGH LEVEL LOW GRAB TRIGGER DELAY GRAB TRIGGER MISSED DISABLE ENABLE GRAB TRIGGER OVERLAP DEFAULT DISABLE ENABLE OFF PREVIOUS FRAME RESET GRAB TRIGGER SOFTWARE ACTIVATE GRAB TRIGGER SOURCE DEFAULT AUX IOn HSYNC IO COMMAND LIST1 ROTARY ENCODER ROTARY ENCODERn SOFTWARE SOFTWAREn TIMERn TL TRIGGER VSYNC GRAB TRIGGER STATE DEFAULT DISABLE ENABLE IO COMMAND BITn GRAB FRAME BURST END TRIGGER SOURCE DEFAULT AUX IOn GRAB FRAME BURST END TRIGGER STATE DEFAULT DISABLE ENABLE GRAB FRAME BURST MAX TIME DEFAULT INFINITE GRAB FRAME BURST SIZE DEFAULT TIMER CLOCK SOURCE DEFAULT HSYNC PIXCLK SYSCLK TIMERn VSYNC TIMER DELAY DEFAULT TIMER DELAY2 DEFAULT TIMER DURATION DEFAULT TIMER DURATION2 DEFAULT TIMER OUTPUT INVERTER DEFAULT DISABLE ENABLE TIMER STATE DEFAULT DISABLE ENABLE TIMER TRIGGER ACTIVATION DEFAULT ANY EDGE EDGE FALLING EDGE RISING LEVEL HIGH LEVEL LOW TIMER TRIGGER MISSED DEFAULT DISABLE ENABLE TIMER TRIGGER OVERLAP DEFAULT LATCH OFF RESET TIMER TRIGGER RATE DIVIDER DEFAULT TIMER TRIGGER SOFTWARE ACTIVATE TIMER TRIGGER SOURCE DEFAULT NULL AUX IOn CONTINUOUS EXPOSURE END EXPOSURE START GRAB TRIGGER HSYNC ROTARY ENCODER ROTARY ENCODERn SOFTWARE TIMERn TL TRIGGER VSYNC AUTO EXPOSURE DEFAULT AUTOMATIC DISABLE ENABLE EXPOSURE DELAY DEFAULT EXPOSURE MODE TIMED TRIGGER WIDTH EXPOSURE TIME DEFAULT ROTARY ENCODER BIT0 SOURCE DEFAULT AUX IOn ROTARY ENCODER BIT1 SOURCE DEFAULT AUX IOn ROTARY ENCODER DIRECTION DEFAULT BACKWARD FORWARD ROTARY ENCODER FORCE VALUE SOURCE DEFAULT NULL AUX IOn COUNTER OVERFLOW POSITION TRIGGER STEP BACKWARD WHILE POSITIVE TL TRIGGER ROTARY ENCODER FRAME END READ DEFAULT DISABLE ENABLE ROTARY ENCODER MULTIPLIER DEFAULT ROTARY ENCODER OUTPUT MODE DEFAULT POSITION TRIGGER POSITION TRIGGER MULTIPLE STEP ANY STEP ANY WHILE POSITIVE STEP FORWARD STEP FORWARD WHILE POSITIVE ROTARY ENCODER POSITION ROTARY ENCODER POSITION START TRIGGER ROTARY ENCODER POSITION TRIGGER ROTARY ENCODER RESET SOURCE DEFAULT NULL AUX IOn POSITION TRIGGER TL TRIGGER ROTARY ENCODERn DATA LATCH MODE DEFAULT NORMAL PREFETCH DATA LATCH STATE DEFAULT DISABLE ENABLE DATA LATCH TRIGGER ACTIVATION DEFAULT EDGE FALLING EDGE RISING DATA LATCH TRIGGER SOURCE DEFAULT AUX IOn GRAB FRAME END GRAB FRAME START GRAB LINE ROTARY ENCODERn TIMER ACTIVE DATA LATCH TYPE IO STATUS ALL ROTARY ENCODERn TIME STAMP LATCHn TIMER STROBE TIMERn M_CHn M_CHn M_CHn M_AUX_IOn M_TIMERn M_USER_BIT_CC_IOn M_USER_BITn M_AUX_IOn M_CC_IOn M_USER_BIT_CC_IOn M_USER_BITn M_AUX_IOn M_ROTARY_ENCODERn M_SOFTWAREn M_TIMERn M_IO_COMMAND_BITn M_AUX_IOn M_TIMERn M_AUX_IOn M_ROTARY_ENCODERn M_TIMERn M_AUX_IOn M_AUX_IOn M_AUX_IOn M_AUX_IOn M_ROTARY_ENCODERn M_AUX_IOn M_ROTARY_ENCODERn M_ROTARY_ENCODERn M_LATCHn M_TIMERn