Feature Name |
Min |
Max |
Inc |
Valid Values |
Documentation |
ProductFeatures |
This list has been created with Impact Acquire version '2.38.0' and firmware version '52'. This does NOT imply that all these features will only be available since these versions. They might be available in previous ones as well. |
Feature Name |
Min |
Max |
Inc |
Valid Values |
Documentation |
Camera |
This list contains features to control the device |
PixelFormat |
- |
- |
- |
Auto, Mono8, Mono10
|
Defines the transfer pixel format from the capture device into the host systems memory. This can differ from the pixel format delivered to the user application if needed. |
AutoControlMode |
- |
- |
- |
Standard, DeviceSpecific
|
An enumerated integer property defining the auto control mode the device is operated in. This property can be used to control the overall behaviour of the algorithms used for performing AEC (A utomatic E xpose C ontrol) or AGC (A utomatic G ain C ontrol). This could be done by the device itself thus e.g. even in the analog domain or e.g. by a software process in the driver. Each method will offer certain advantages and disadvantages and depending on the application the correct method can be selected. Every device or even different models belonging to the same device family may support different auto control modes, thus it's crucial to query the valid modes for each device by reading the properties translation dictionary BEFORE trying to assign a certain value to this property. |
AutoExposeControl |
- |
- |
- |
Off, On
|
An enumerated integer property, which represents the current mode the AEC (A utomatic E xpose C ontrol) is operated in. The values used to capture the image, which are directly influenced by an activated AGC or AEC (e.g. the gain or the exposure time) will be returned as part of the result of the image request. |
AutoGainControl |
- |
- |
- |
Off, On
|
An enumerated integer property, which represents the current mode the AGC (A utomatic G ain C ontrol) is operated in. The values used to capture the image, which are directly influenced by an activated AGC or AEC (e.g. the gain or the exposure time) will be returned as part of the result of the image request. |
Gain_dB |
-1.000 dB |
12.000 dB |
1.000 dB |
- |
A float property defining the gain in dB |
OffsetAutoCalibration |
- |
- |
- |
Off, On
|
An enumerated integer property defining the offset calibration mode. |
OffsetAutoBlackLevel |
2 |
2 |
1 |
- |
An integer property defining the digital value assumed as black. Modifying this property in rare cases might be useful to achieve a higher dynamic range for noise close to the black level. |
OffsetAutoBlackSpeed |
- |
- |
- |
Medium
|
An enumerated integer property defining the speed of the auto offset calibration circuit. Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBlueFOXOffsetAutoBlackSpeed. |
Offset_pc |
-100.0 % |
100.0 % |
1.0 % |
- |
A float property defining the analogue sensor offset in percent of the allowed range (sensor specific). This property influences the average grey level when no light reaches the sensor |
OffsetCorrection_pc |
0.00 % |
0.00 % |
0.01 % |
- |
A float property defining an ADDITIONAL analogue sensor offset in percent of the allowed range (sensor specific) PER COLOR CHANNEL. Together with value of the property 'Offset_pc' this property influences the average grey level when no light reaches the sensor. The value at index 0 applies to the green component of the red-green rows of the bayer pattern The value at index 1 applies to the red component of the bayer pattern The value at index 2 applies to the green component of the blue-green rows of the bayer pattern The value at index 3 applies to the blue component of the bayer pattern |
TriggerMode |
- |
- |
- |
Continuous, OnDemand, OnLowLevel, OnHighLevel
|
An enumerated integer property which defines what kind of trigger mode shall be used for an image acquisition. |
TriggerSource |
- |
- |
- |
DigIn0, DigIn1, RTCtrl, Digout0, Digout1, Digout2, Digout3
|
An enumerated integer property defining where the trigger signal is expected to occur. When working with hardware generated signals via mvIMPACT::acquire::RTCtrProgram objects this property should be set to mvIMPACT::acquire::ctsRTCtrl as otherwise the program will not affect the behaviour of the camera. Valid values for this property are defined by the enumeration mvIMPACT::acquire::TCameraTriggerSource. |
ExposeMode |
- |
- |
- |
Standard, Overlapped
|
An enumerated integer property defining the exposure mode the camera sensor is operated in. |
PixelClock_KHz |
- |
- |
- |
6000, 8000, 10000, 12000, 20000, 24000, 27000, 32000, 40000
|
An enumerated integer property defining the pixel clock of the camera sensor in KHz. Valid values for this property are defined by the enumeration mvIMPACT::acquire::TCameraPixelClock. |
Expose_us |
12 |
4000000 |
1 |
- |
An integer property which defines the exposure time for an image in us. |
BinningMode |
- |
- |
- |
Off, BinningV, BinningH, BinningHV
|
An enumerated integer property defining the binning mode the camera is operated in. By default the no binning will be performed. |
FrameDelay_us |
0 |
100000 |
100 |
- |
An integer property defining the delay in us between an external trigger event an the begin of the sensor exposure. |
LineDelay_clk |
0 |
0 |
10 |
- |
An integer property defining the delay in clocks between two lines. Can be used to slow down the image readout the reduce the peak bandwidth required for the transfer. |
Framerate_Hz |
1.000000 |
100000.000000 |
0.010000 |
- |
- |
FlashMode |
- |
3 |
- |
Off, Digout0, Digout1
|
An enumerated integer property defining the behaviour of the flash output of the camera (if available). If this property is set the cameras flash output (if available) will be pulsed during the exposure period of the sensor. In that case the pulse width will be equal to the exposure time. Valid values for this property are defined by the enumeration mvIMPACT::acquire::TCameraFlashMode. |
FlashType |
- |
- |
- |
Standard
|
An enumerated integer property defining the behaviour of the flash output of the camera (if available). If this property is set the cameras flash output (if available) will be pulsed during the exposure period of the sensor. In that case the pulse width will be equal to the exposure time. |
TestMode |
- |
- |
- |
Off, GreyRamp, MovingColor
|
An enumerated integer property defining the image transmission mode of the camera. If this property is set to mvIMPACT::acquire::ctmOff the 'normal' image captured by the cameras sensor will be transmitted. This is the default. To ensure correct operation the camera might define several test modes where some kind of well defined pattern will be transmitted. Valid values for this property are defined by the enumeration mvIMPACT::acquire::TCameraTestMode. No every test mode will be supported by every device. |
ShutterMode |
- |
- |
- |
FrameShutter
|
An enumerated integer property defining the shutter mode to use. |
ImageRequestTimeout_ms |
0 ms |
INT_MAX |
1 ms |
- |
Defines the timeout for the request in ms. Once the timeout has elapsed the request object is returned to the user even if no data has been captured into it. The timespan taken into account for the measurement starts when the driver begins to capture data into this particular buffer! So when queuing 4 buffers with a timeout of 3000 ms each and no data being transmitted by the device will cause the last buffer to time out 3000*4 = 12000 ms AFTER the buffer has been queued and the acquisition has been started. A timeout of 0 never elapses. |
FlashToExposeDelay_us |
0 |
10000 |
50 |
- |
An integer property defining the delay in us between the start of the flash signal output and the beginning of the expose period of the image sensor. |
AdvancedOptions |
- |
28 |
- |
Off, ImageAverage, PipelinedGainExposeControl, OnDemandTriggerPreShot
|
LowLight: Put camera in low light mode. EmbeddedImageInfo: Embed sensor specific info into the image readout buffer. ImageAverage: Calculate the average intensity value of the image and return as part of the request. PipelinedGainExposeControl: Enable pipelined Gain/Exposure control. OnDemandTriggerPreShot: Enable on demand trigger pre-shot option. LowFrameRateOptimization: Enable low frame rate optimization. EnablePerChannelOffsetCorrection: Enable per channel offset correction. UseRawSensorGain: Enable raw sensor gain. |
SensorTimingMode |
- |
- |
- |
Standard
|
An enumerated integer property defining the current image sensor timing mode. |
Feature Name |
Min |
Max |
Inc |
Valid Values |
Documentation |
Aoi |
A list of values which define the number of lines, pixels per line and the offsets of both. |
X |
0 |
736 |
2 |
- |
An integer property defining the X-offset for each capture line. |
Y |
0 |
476 |
2 |
- |
An integer property defining the Y-offset. |
W |
16 |
752 |
2 |
- |
An integer property defining the number of pixels to capture per line. |
H |
4 |
480 |
2 |
- |
An integer property defining the number of lines to capture. |
|
Feature Name |
Min |
Max |
Inc |
Valid Values |
Documentation |
AutoControlParameters |
Provides access to the control parameters for AGC and AEC. |
AoiMode |
- |
- |
- |
Centered, Full, User
|
An enumerated integer property defining the which area of the image is used for the calculation of the parameters. |
DesiredAverageGreyValue |
0 |
255 |
1 |
- |
For multi-byte pixel formats, this will refer to the 8 MSBs |
ControllerSpeed |
- |
- |
- |
Slow, Medium, Fast, User
|
An enumerated integer property defining the speed the control circuit will be operated in. |
ControllerDelay_Images |
0 |
10000000 |
1 |
- |
An integer property to influence the speed the AGC and/or AEC control circuit will react and adapt to changes. |
GainLowerLimit_dB |
-1.000000 |
12.000000 |
1.000000 |
- |
A float property defining the lower limit for the cameras gain(in dB). |
GainUpperLimit_dB |
-1.000000 |
12.000000 |
1.000000 |
- |
A float property defining the upper limit for the cameras gain(in dB). |
ExposeLowerLimit_us |
12 |
4000000 |
1 |
- |
An integer property defining the lower limit for the sensors expose time in us. |
ExposeUpperLimit_us |
12 |
4000000 |
1 |
- |
An integer property defining the upper limit for the sensors expose time in us. |
Feature Name |
Min |
Max |
Inc |
Valid Values |
Documentation |
Aoi |
A list of values which define the number of lines, pixels per line and the offsets of both. |
X |
0 |
736 |
2 |
- |
An integer property defining the X-offset for each capture line. |
Y |
0 |
476 |
2 |
- |
An integer property defining the Y-offset. |
W |
16 |
752 |
2 |
- |
An integer property defining the number of pixels to capture per line. |
H |
4 |
480 |
2 |
- |
An integer property defining the number of lines to capture. |
|
Feature Name |
Min |
Max |
Inc |
Valid Values |
Documentation |
ControllerParameter |
- |
ControllerGain |
0.000000 |
100.000000 |
0.001000 |
- |
The P fraction of the controller. |
IntegralTime_ms |
0.000100 |
1000000.000000 |
0.000100 |
- |
- |
DerivativeTime_ms |
0.000000 |
10000.000000 |
0.000100 |
- |
- |
|
|
Feature Name |
Min |
Max |
Inc |
Valid Values |
Documentation |
HDRControl |
- |
HDREnable |
- |
- |
- |
Off, On
|
- |
HDRMode |
- |
- |
- |
Fixed0, Fixed1, Fixed2, Fixed3, Fixed4, Fixed5, User
|
- |
HDRKneePointCount |
1 |
2 |
- |
- |
- |
Feature Name |
Min |
Max |
Inc |
Valid Values |
Documentation |
HDRKneePoints |
- |
Feature Name |
Min |
Max |
Inc |
Valid Values |
Documentation |
HDRKneePoint-0 |
- |
HDRExposure_ppm |
- |
- |
- |
1000000, 500000, 250000, 125000, 62500, 31250, 15625, 7812, 3906, 1953, 976, 488, 244, 122, 61, 30
|
- |
HDRControlVoltage_mV |
- |
- |
- |
200, 400, 600, 800, 1000, 1200, 1761, 1784, 1808, 1831, 1855, 1878, 1902, 1925, 1949, 1972, 1996, 2019, 2043, 2066, 2090, 2113, 2137, 2160, 2184, 2207, 2231, 2254, 2278, 2301, 2325, 2348, 2372, 2395, 2419, 2442, 2466, 2489, 2513, 2536, 2560, 2583, 2607, 2630, 2654, 2677, 2701, 2724, 2748, 2771, 2795, 2818, 2842, 2865, 2889, 2912, 2936, 2959, 2983, 3006, 3030, 3053, 3077, 3100
|
- |
|
Feature Name |
Min |
Max |
Inc |
Valid Values |
Documentation |
HDRKneePoint-1 |
- |
HDRExposure_ppm |
- |
- |
- |
1000000, 500000, 250000, 125000, 62500, 31250, 15625, 7812, 3906, 1953, 976, 488, 244, 122, 61, 30
|
- |
HDRControlVoltage_mV |
- |
- |
- |
200, 400, 600, 800, 1000, 1200, 1761, 1784, 1808, 1831, 1855, 1878, 1902, 1925, 1949, 1972, 1996, 2019, 2043, 2066, 2090, 2113, 2137, 2160, 2184, 2207, 2231, 2254, 2278, 2301, 2325, 2348, 2372, 2395, 2419, 2442, 2466, 2489, 2513, 2536, 2560, 2583, 2607, 2630, 2654, 2677, 2701, 2724, 2748, 2771, 2795, 2818, 2842, 2865, 2889, 2912, 2936, 2959, 2983, 3006, 3030, 3053, 3077, 3100
|
- |
|
|
|
|
Feature Name |
Min |
Max |
Inc |
Valid Values |
Documentation |
IOSubSystem |
Digital I/O related features |
DigitalInputs |
- |
- |
- |
Off, On
|
An integer vector property to access the digital inputs |
DigitalOutputs |
- |
- |
- |
Off, On
|
An integer vector property to access the digital outputs |
DigitalInputThreshold |
- |
- |
- |
2V, 10V
|
The input threshold of the digital inputs |
Feature Name |
Min |
Max |
Inc |
Valid Values |
Documentation |
HardwareRealTimeController |
A list containing features to access the 'H'ardware 'R'eal'T'ime 'C'ontroller(s)(HRTC) |
Feature Name |
Min |
Max |
Inc |
Valid Values |
Documentation |
HRTCtrl_0 |
- |
ProgramSize |
0 |
256 |
1 |
- |
The size(in program steps) of the HRTC program |
Mode |
- |
- |
- |
Stop, Run, RunRestart
|
The current mode the HRTC program is in |
ProgramState |
- |
- |
- |
- |
The current state of the HRTC program |
Filename |
- |
- |
- |
- |
The name of the file used to load/store HRTC programs from/to |
Load@i |
- |
- |
- |
- |
Calling this method will load the current HRTC program from a file specified by 'Filename' |
Save@i |
- |
- |
- |
- |
Calling this method will store the current HRTC program in a file specified by 'Filename' |
Feature Name |
Min |
Max |
Inc |
Valid Values |
Documentation |
RTCtrProgram |
A list containing features to access and modify the program executed by a 'H'ardware 'R'eal'T'ime 'C'ontroller(HRTC) engine |
Feature Name |
Min |
Max |
Inc |
Valid Values |
Documentation |
Step0 |
Features in this list represent a single instruction belonging to a HRTC program |
OpCode |
- |
- |
- |
Nop, SetDigout, WaitDigin, WaitClocks, Jump, TriggerSet, TriggerReset, ExposeSet, ExposeReset, FrameNrReset
|
Defines the HRTC instruction to be executed |
Clocks_us |
0 |
INT_MAX |
1 |
- |
Defines a time span(in us)(usually associated with a 'Wait' instruction) |
DigitalInputs |
- |
- |
- |
Off, On, Ignore
|
An integer vector property to configure the digital inputs(usually associated with a 'WaitDigIn' instruction) |
DigitalOutputs |
- |
- |
- |
Off, On, Keep
|
An integer vector property to configure the digital outputs(usually associated with a 'SetDigOut' instruction) |
Address |
0 |
255 |
1 |
- |
Defines an address(usually associated with a 'Jump' instruction) |
FrameID |
0 |
255 |
1 |
- |
An integer property to define a frame ID to be associated with a frame(usually associated with a 'TriggerSet' instruction) |
SensorHeads |
- |
- |
- |
Off, On, Keep
|
An integer vector property to configure the sensor heads(usually associated with a 'Trigger' or 'Exposure' related instruction)(only available for devices with multiple sensor heads) |
|
Feature Name |
Min |
Max |
Inc |
Valid Values |
Documentation |
Step1 |
Features in this list represent a single instruction belonging to a HRTC program |
OpCode |
- |
- |
- |
Nop, SetDigout, WaitDigin, WaitClocks, Jump, TriggerSet, TriggerReset, ExposeSet, ExposeReset, FrameNrReset
|
Defines the HRTC instruction to be executed |
Clocks_us |
0 |
INT_MAX |
1 |
- |
Defines a time span(in us)(usually associated with a 'Wait' instruction) |
DigitalInputs |
- |
- |
- |
Off, On, Ignore
|
An integer vector property to configure the digital inputs(usually associated with a 'WaitDigIn' instruction) |
DigitalOutputs |
- |
- |
- |
Off, On, Keep
|
An integer vector property to configure the digital outputs(usually associated with a 'SetDigOut' instruction) |
Address |
0 |
255 |
1 |
- |
Defines an address(usually associated with a 'Jump' instruction) |
FrameID |
0 |
255 |
1 |
- |
An integer property to define a frame ID to be associated with a frame(usually associated with a 'TriggerSet' instruction) |
SensorHeads |
- |
- |
- |
Off, On, Keep
|
An integer vector property to configure the sensor heads(usually associated with a 'Trigger' or 'Exposure' related instruction)(only available for devices with multiple sensor heads) |
|
Feature Name |
Min |
Max |
Inc |
Valid Values |
Documentation |
Step2 |
Features in this list represent a single instruction belonging to a HRTC program |
OpCode |
- |
- |
- |
Nop, SetDigout, WaitDigin, WaitClocks, Jump, TriggerSet, TriggerReset, ExposeSet, ExposeReset, FrameNrReset
|
Defines the HRTC instruction to be executed |
Clocks_us |
0 |
INT_MAX |
1 |
- |
Defines a time span(in us)(usually associated with a 'Wait' instruction) |
DigitalInputs |
- |
- |
- |
Off, On, Ignore
|
An integer vector property to configure the digital inputs(usually associated with a 'WaitDigIn' instruction) |
DigitalOutputs |
- |
- |
- |
Off, On, Keep
|
An integer vector property to configure the digital outputs(usually associated with a 'SetDigOut' instruction) |
Address |
0 |
255 |
1 |
- |
Defines an address(usually associated with a 'Jump' instruction) |
FrameID |
0 |
255 |
1 |
- |
An integer property to define a frame ID to be associated with a frame(usually associated with a 'TriggerSet' instruction) |
SensorHeads |
- |
- |
- |
Off, On, Keep
|
An integer vector property to configure the sensor heads(usually associated with a 'Trigger' or 'Exposure' related instruction)(only available for devices with multiple sensor heads) |
|
Feature Name |
Min |
Max |
Inc |
Valid Values |
Documentation |
Step3 |
Features in this list represent a single instruction belonging to a HRTC program |
OpCode |
- |
- |
- |
Nop, SetDigout, WaitDigin, WaitClocks, Jump, TriggerSet, TriggerReset, ExposeSet, ExposeReset, FrameNrReset
|
Defines the HRTC instruction to be executed |
Clocks_us |
0 |
INT_MAX |
1 |
- |
Defines a time span(in us)(usually associated with a 'Wait' instruction) |
DigitalInputs |
- |
- |
- |
Off, On, Ignore
|
An integer vector property to configure the digital inputs(usually associated with a 'WaitDigIn' instruction) |
DigitalOutputs |
- |
- |
- |
Off, On, Keep
|
An integer vector property to configure the digital outputs(usually associated with a 'SetDigOut' instruction) |
Address |
0 |
255 |
1 |
- |
Defines an address(usually associated with a 'Jump' instruction) |
FrameID |
0 |
255 |
1 |
- |
An integer property to define a frame ID to be associated with a frame(usually associated with a 'TriggerSet' instruction) |
SensorHeads |
- |
- |
- |
Off, On, Keep
|
An integer vector property to configure the sensor heads(usually associated with a 'Trigger' or 'Exposure' related instruction)(only available for devices with multiple sensor heads) |
|
Feature Name |
Min |
Max |
Inc |
Valid Values |
Documentation |
Step4 |
Features in this list represent a single instruction belonging to a HRTC program |
OpCode |
- |
- |
- |
Nop, SetDigout, WaitDigin, WaitClocks, Jump, TriggerSet, TriggerReset, ExposeSet, ExposeReset, FrameNrReset
|
Defines the HRTC instruction to be executed |
Clocks_us |
0 |
INT_MAX |
1 |
- |
Defines a time span(in us)(usually associated with a 'Wait' instruction) |
DigitalInputs |
- |
- |
- |
Off, On, Ignore
|
An integer vector property to configure the digital inputs(usually associated with a 'WaitDigIn' instruction) |
DigitalOutputs |
- |
- |
- |
Off, On, Keep
|
An integer vector property to configure the digital outputs(usually associated with a 'SetDigOut' instruction) |
Address |
0 |
255 |
1 |
- |
Defines an address(usually associated with a 'Jump' instruction) |
FrameID |
0 |
255 |
1 |
- |
An integer property to define a frame ID to be associated with a frame(usually associated with a 'TriggerSet' instruction) |
SensorHeads |
- |
- |
- |
Off, On, Keep
|
An integer vector property to configure the sensor heads(usually associated with a 'Trigger' or 'Exposure' related instruction)(only available for devices with multiple sensor heads) |
|
|
|
|
Feature Name |
Min |
Max |
Inc |
Valid Values |
Documentation |
DigitalIOMeasurementControl |
This list contains features to configure the digital I/O measurement control of the device |
DigitalIOMeasurementMode |
- |
- |
- |
Frequency_Hz_10msGate, Frequency_Hz_100msGate
|
This feature selects the digital I/O measurement mode |
DigitalIOMeasurementSource |
- |
- |
- |
Input0, Input1
|
This feature selects the source for the digital I/O measurement |
DigitalIOMeasurementResult |
- |
- |
- |
- |
This feature contains result of the last digital I/O measurement |
|
|
|