Acquisition Control

Name

AcquisitionMode

Standard

Description

Sets the acquisition mode of the device. It defines mainly the number of frames to capture during an acquisition and the way the acquisition stops.

Interface

Enumeration

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

See enum entries table below.

Default value

Continuous

Availability

ALL

Notes

-

Error behavior

-

Name

Description

Continuous

Frames are captured continuously until stopped with the AcquisitionStop command.

SingleFrame

One Frame is captured.

Name

AcquisitionStart

Standard

Description

Starts the Acquisition of the device. The number of frames captured is specified by AcquisitionMode.

Interface

Command

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

1

Default value

1

Availability

ALL

Notes

-

Error behavior

Success is returned on successful start otherwise some error code.

See the device error code documentation.

Name

AcquisitionStop

Standard

Description

Stops the Acquisition of the device at the end of the current Frame.

Interface

Command

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

[0, 1]

For writing only command value 1 is supported.

Default value

1

Availability

ALL

Notes

The command will return immediately however it is not finished and will continue execution in background.
As soon as the command value changes from 1 to 0 the command has finished.
Features locked by TLParamsLocked can be modified first after AcquisitionStop has finished execution completely.

Error behavior

See the device error code documentation.

Name

AcquisitionAbort

Standard

Description

Aborts the Acquisition immediately.

Interface

Command

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

[0, 1]

For writing only command value 1 is supported.

Default value

1

Availability

ALL

Notes

When command is executed, it aborts the current frame immediately without completing the current frame.

Error behavior

See the device error code documentation.

Name

FrameCount

Standard

Description

Indicates the number of frames captured during an acquisition period.

Interface

Integer

Access mode

Read only

Adjustable

while grabbing

-

Value range

[0, 65535]

Default value

1

Availability

ALL

Notes

This feature value will be resetted during an UserSet load.

Error behavior

-

Name

ExposureTimeMode

Standard

Description

Sets the configuration mode of the Exposure Time feature.

Interface

Enumeration

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

See enum entries table below.

Default value

Common

Availability

ALL

Notes

-

Error behavior

See the device error code documentation.

Name

Availability

Description

Common

ALL

The exposure time is common to all the color components.

Individual

g8_X

The exposure time is individual for each color component.

Name

ExposureTimeSelector

Standard

Description

Selects which exposure time is controlled by the Exposure Time feature. This allows for independent control over the exposure components.

Interface

Enumeration

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

See enum entries table below.

Default value

Common

Availability

ALL

Notes

-

Error behavior

See the device error code documentation.

Name

Availability

Description

Common

ALL

Selects the common ExposureTime.

White

g8_X

Selects the White ExposureTime.

Infrared

g8_X

Selects the Infrared ExposureTime.

Red

g8_X

Selects the Red ExposureTime.

Green

g8_X

Selects the Green ExposureTime.

Blue

g8_X

Selects the Blue ExposureTime.

Name

ExposureTime[ExposureTimeSelector]

Standard

Description

This controls the duration during which the photosensitive cells are exposed to light.

Interface

Float

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

Freerun:

The exposure time must be smaller than the Acquisition Line Time plus an offset.

LineTirgger On or Salve camera (MSMode is set to Slave):

The exposure time must be smaller than the maximum exposure time.

The minimum difference of Acquisition Line Time and ExposureTime are camera variant specific. Therefore, query the min and max entries of this feature.

Default value

30

Availability

ALL

Notes

The unit is micro-seconds.

Error behavior

See the device error code documentation.

Name

AcquisitionIntegrationTime

Custom

Description

Controls the integration time. (unit: micro-seconds)

Interface

Float

Access mode

Read/Write

Adjustable

while grabbing

-

Value range

See the value range of Exposure Time

Default value

-

Notes

This feature is deprecated please use Exposure Time instead.

Error behavior

See the device error code documentation.

Name

AcquisitionIntegrationTimeMin

Custom

Description

Displays the minimum integration time. (unit: micro-seconds)

Interface

Float

Access mode

Read only

Adjustable

while grabbing

-

Value range

Default value

-

Notes

This feature is deprecated; query the min and max values from Exposure Time instead.

Error behavior

-

Name

AcquisitionLineRate

Standard

Description

Controls the rate (in Hertz) at which the Lines in a Frame are captured.

Interface

Float

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

[(1 / Acquisition Line Time.Max), (1 / Acquisition Line Time.Min)]

Default value

18.18 KHz

Availability

ALL

Notes

This is the inverse of the Acquisition Line Time

This feature is not available if MasterSlaveMode is configured as Slave or LedFlashEnable is enabled.

Error behavior

See the device error code documentation.

Name

AcquisitionLineRateMax

Custom

Description

This value is calculated by the camera. It limits the AcquisitionLineRate. The unit is Hertz.

Interface

Float

Access mode

Read only

Adjustable

while grabbing

-

Value range

-

Default value

-

Notes

Please use the min and max node entries of the Acquisition Line Rate feature.

Error behavior

-

Name

AcquisitionLineTime

Custom

Description

Controls the processing time per scan line.

Interface

Float

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

The value range depends on:

• The transport layer configuration (Link configuration, packet size)
• The region width
• The Exposure Time
• Reduction parameters Binning Horizontal , Decimation Horizontal Float

Query the min and max values of the acquisition line time feature to get the valid range for current setting.

The exposure time always must be smaller than the line time:
Range defined by exposure time: [Exposure Time + gap μs, 27900 μs]

Gap = {ax_X = 1.5 ; g8_X = 2.0}

Example range for gige-vision with one and two physical links connected.

1. [37.43¹ μs, 13981 μs] – For single link (10Gbps) + ax_X
2. [30.88¹ μs, 13981 μs] – For dual link (20Gbps) + ax_X
3. [37.43¹ μs, 13107.1875 μs] – For single link (10Gbps) + g8_X
4. [30.88¹ μs, 13107.1875 μs] – For dual link (20Gbps) + g8_X

¹ For Region Width: 15360, GevSCPSPacketSize: 8240 and AcquisitionFrameRate disabled.

Default value

55

Availability

ALL

Notes

This is the inverse of the Acquisition Line Rate .

If AcquisitionLineTime is set for higher values, then make sure to adopt image timeout to avoid timeout issues while grabbing.

This parameter influences the value range of AcquisitionFrameRate. Please read the AcquisitionFrameRate feature documentation for further details.

This feature is not available if MasterSlaveMode is configured as Slave or LedFlashEnable is enabled.

Error behavior

See the device error code documentation.

Name

AcquisitionLineTimeMin

Custom

Description

Displays the minimum processing time per scan line in μs.

Interface

Float

Access mode

Read only

Adjustable

while grabbing

-

Value range

[Exposure Time + 1.5 μs]

Default value

-

Notes

Please query the min and max values of the Acquisition Line Time feature instead of using this feature.

Error behavior

-

Name

AcquisitionFrameRateEnable

Standard

Description

Controls whether the AcquisitionFrameRate feature is writable and used to control the acquisition rate. Otherwise, the acquisition rate is implicitly controlled by the combination of other features such as AcquisitionLineTime.

Interface

Boolean

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

True, False

Default value

False

Availability

ALL

Notes

The FrameActive and FrameStart triggers must be set to Off to enable this feature.

This feature is not available if MasterSlaveMode is configured as Slave or LedFlashEnable is enabled.

Error behavior

See the device error code documentation.

Name

AcquisitionFrameRate

Standard

Description

Controls the acquisition rate (in Hertz) at which the frames are captured.

Interface

Float

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

The value range depends on the line time as well as on the image height:

Min Acquisition Frame Rate:

Max Acquisition Frame Rate:

Default value

10

Availability

ALL

Notes

The Acquisition Frame Rate is based on the given AcquisitionLineTime even if a line trigger is used. Therefore, the real frame rate depends on the line trigger if this is used. The accuracy of this feature is limited.

This feature is writeable only if AcquisitionFrameRateEnable is set to True.

Changing the image height or the acquisition line time influences the value range of the AcquisitionFrameRate. It may be that while these parameters are changed. The current value for the AcquisitionFrameRate gets out of range. In this case the real acquisition frame rate is clamped internally to the maximum possible frame rate.

This feature is not available if MasterSlaveMode is configured as Slave or LedFlashEnable is enabled.

Error behavior

See the device error code documentation.

Name

TimeDelayIntegrationMode

Custom

Description

Selects the Time Delay Integration Mode. This is not enabling or disabling the TDI, but choosing if high sensitivity or a high dynamic range is desired.

Interface

Enumeration

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

See enum entries table below.

Default value

HighSensitivity

Availability

ALL

Notes

• Enabling the TDI will be done by setting the TimeDelayIntegration feature to a value greater than 1
• The DSNU and PRNU data sets must be created with the desired TDI Mode. When changing the mode, the DSNU/PRNU references must be recreated.

Error behavior

See the device error code documentation.

Name

Availability

Description

HighSensitivity

ALL

The sensivitiy will be increased in this TDI mode.

This is achieved by summing up the lines.

HighSNR

ALL

Opposed to HighSensitivity this mode leads to a higher dynamic range. The SNR will be greater.

This is achieved by averaging the lines.

Name

TimeDelayIntegration

Custom

Description

Selects the number of photo-sensitive cells combined (average).

Interface

Integer

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

[1, 3]

Default value

1

Availability

ALL

Notes

This feature is available for the Mono Cameras and the g8 sensor.
For the g8 sensor the sensor hardware revision should be at least 2 to support this feature for RGB(Ir). The sensor hardware version can be retrieved by the Device Version feature.

Error behavior

See the device error code documentation.

Name

MasterSlaveMode

Custom

Description

Specifies the master slave mode of the camera.

Interface

Enumeration

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

See enum entries table below.

Default value

Off

Availability

ALL

Notes

Whenever the Master and Slave camera maximum operating line frequency differs make sure to configure the Master to operate in the lower speed. Otherwise, the images delivered by Slave may be corrupt.

The camera’s maximum line frequency may differ e.g., by different Width, Pixel Format, Decimation Horizontal Float, Binning Horizontal or Exposure Time parameter.

To be sure about the setting check the maximum value of Acquisition Line Rate by querying it from the camera.

The following features are not available if the mode is set to Slave or AutoSelect (Slave):

• TriggerSelector, TriggerMode, TriggerSource, TriggerActivation, TriggerDelayLines, TriggerDivider, TriggerSignalDetectionMode, ExtendLines, LineTime(Measured), LineTriggerStatus
• AcquisitionLineTime
• EncoderControl
• LedFlashControl

Error behavior

See the device error code documentation.

Name

Description

Off

No master slave is selected.

Master

Selects the camera to be Master.

Slave

Selects the camera to be Slave.

AutoSelect

Automatically selects the camera to be either Master or Slave.

AutoSelect (Master)

This is available if AutoSelect is selected. If Line3 is in low level, then AutoSelect in Master mode.

AutoSelect (Slave)

This is available if AutoSelect is selected. If Line3 via pull-up(high level), then AutoSelect in Slave Mode.

Name

MasterSlaveInterface[MasterSlaveMode]

Custom

Description

Specifies the interface type to be used for master/slave.

Interface

Enumeration

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

See enum entries table below.

Default value

External

Availability

ALL

Notes

This feature is deprecated, use MasterSlaveSource, MasterSlaveAutoSelectSource and Digital IO configuration.
It will be removed from package 3.0.0

For External interface,

Master – Line9 as output

Slave – Line4 as input and Line9 as output

Error behavior

See the device error code documentation.

Name

Description

External

Interface between master and slave camera is external(physical)

Internal

Interface between master and slave camera is internal

Name

MasterSlaveInterfaceEnable[MasterSlaveInterface]

Custom

Description

Enables the selected master/slave interface.

Interface

Boolean

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

True – Enables selected master/slave interface.

False – Disables selected master/slave interface.

Default value

False

Availability

ALL

Notes

This feature is deprecated, use MasterSlaveSource, MasterSlaveAutoSelectSource and Digital IO configuration.
It will be removed from package 3.0.0

Error behavior

See the device error code documentation.

Name

MasterSlaveSource

Custom

Description

Specifies the source to be used for master/slave.

Interface

Enumeration

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

See enum entries table below.

Default value

Off

Availability

ALL

Notes

Only Line4 and Line11 are available for allPIXAEvo

Error behavior

See the device error code documentation.

Name

Description

Line1

Specifies physical line (or pin) Line1 to use as source for the master slave signal.

Line2

Specifies physical line (or pin) Line2 to use as source for the master slave signal.

Line3

Specifies physical line (or pin) Line3 to use as source for the master slave signal.

Line4

Specifies physical line (or pin) Line4 to use as source for the master slave signal.

Line5

Specifies physical line (or pin) Line5 to use as source for the master slave signal.

Line6

Specifies physical line (or pin) Line6 to use as source for the master slave signal.

Line7

Specifies physical line (or pin) Line7 to use as source for the master slave signal.

Line8

Specifies physical line (or pin) Line8 to use as source for the master slave signal.

Line9

Specifies physical line (or pin) Line9 to use as source for the master slave signal.

Line10

Specifies physical line (or pin) Line10 to use as source for the master slave signal.

Line11

Specifies physical line (or pin) Line11 to use as source for the master slave signal.

Name

MasterSlaveAutoSelectSource

Custom

Description

Specifies the source to be used for AutoSelect.

Interface

Enumeration

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

See enum entries table below.

Default value

Off

Availability

ALL

Notes

Only Line3 is available for allPIXAEvo

Error behavior

See the device error code documentation.

Name

Description

Line1

Specifies physical line (or pin) Line1 to use as source for the autoselect signal.

Line2

Specifies physical line (or pin) Line2 to use as source for the autoselect signal.

Line3

Specifies physical line (or pin) Line3 to use as source for the autoselect signal.

Line4

Specifies physical line (or pin) Line4 to use as source for the autoselect signal.

Line5

Specifies physical line (or pin) Line5 to use as source for the autoselect signal.

Line6

Specifies physical line (or pin) Line6 to use as source for the autoselect signal.

Line7

Specifies physical line (or pin) Line7 to use as source for the autoselect signal.

Line8

Specifies physical line (or pin) Line8 to use as source for the autoselect signal.

Line9

Specifies physical line (or pin) Line9 to use as source for the autoselect signal.

Name

MasterSlaveDelayLines

Custom

Description

Specifies the delay in number of lines for the slave camera.

Interface

Integer

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

The value range varies when led flash is enabled depending on the number of patterns.

1. [0 , 32764] – LedFlashEnable is disabled
2. [0,  32764] – LedFlashEnable is enabled and NumberOfPattern=1
3. [0,  16382] – LedFlashEnable is enabled and NumberOfPattern=2
4. [0,  10921] – LedFlashEnable is enabled and NumberOfPattern=3
5. [0,  8191] – LedFlashEnable is enabled and NumberOfPattern=4

Default value

0

Availability

ALL

Notes

This feature is valid and available only for the Slave Camera.

Error behavior

See the device error code documentation.

Name

AcquisitionBurstFrameCount

Standard

Description

Specifies the number of frames to acquire for each FrameBurstStart trigger

Interface

Integer

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

[1 , AcquisitionBurstFrameCount Max]

Default value

1

Availability

ALL

Notes

This feature is valid and available only for FrameBurstStart and if MasterSlaveMode is not configured as Slave.

Error behavior

See the device error code documentation.

Name

TriggerSelector

Standard

Description

Selects the type of trigger to configure.

Interface

Enumeration

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

See enum entries table below.

Default value

FrameStart

Availability

ALL

Notes

This feature is not available if MasterSlaveMode is configured as Slave.

Error behavior

See the device error code documentation.

Name

Description

FrameStart

Selects a trigger starting the capture of one frame.

FrameActive

Selects a trigger controlling the duration of one frame.

FrameBurstStart

Selects a trigger starting of the bursts of frames in an acquisition.

LineStart

Selects a trigger starting the capture of one Line of a Frame.

Name

TriggerMode[TriggerSelector]

Standard

Description

Controls whether the selected trigger is active.

Interface

Enumeration

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

See enum entries table below.

Default value

Off

Availability

ALL

Notes

This feature is not available if MasterSlaveMode is configured as Slave.

Error behavior

See the device error code documentation.

Name

Description

Off

Disables the selected trigger.

On

Enables the selected trigger.

Name

TriggerSource[TriggerSelector]

Standard

Description

Specifies the internal signal or physical input Line to use as the trigger source.

Interface

Enumeration

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

See the enum entries for more information.

Default value

-

Availability

ALL

Notes

This feature is not available if MasterSlaveMode is configured as Slave.

Error behavior

See the device error code documentation.

Name

Description

Notes

Encoder0

Specifies Encoder0 signal to use as internal source for the trigger.

This enum entry is valid and available only for LineStart

Line1

Specifies physical line (or pin) Line1 and associated I/O control block to use as external source for the trigger signal.

This enum entry is valid and available only for LineStart

Line2

Specifies physical line (or pin) Line2 and associated I/O control block to use as external source for the trigger signal.

This enum entry is valid and available only for Frame Trigger

Line3

Specifies physical line (or pin) Line3 and associated I/O control block to use as external source for the trigger signal.

This enum entry is valid and available for Frame or Line trigger

Line4

Specifies physical line (or pin) Line4 and associated I/O control block to use as external source for the trigger signal.

This enum entry is valid and available for Frame or Line trigger

Name

TriggerActivation[TriggerSelector]

Standard

Description

Specifies the activation mode of the trigger.

Interface

Enumeration

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

See enum entries table below.

Default value

-

Availability

ALL

Notes

This feature is not available if MasterSlaveMode is configured as Slave.

Error behavior

See the device error code documentation.

Name

Description

Notes

RisingEdge

Specifies that the trigger is considered valid on the rising edge of the source signal.

This enum entry is valid and available only for LineStart or FrameStart or FrameBurstStart

FallingEdge

Specifies that the trigger is considered valid on the falling edge of the source signal.

This enum entry is valid and available only for FrameStart or FrameBurstStart

LevelHigh

Specifies that the trigger is considered valid if the level of the source signal is high.

This enum entry is valid and available only for FrameActive

LevelLow

Specifies that the trigger is considered valid if the level of the source signal is low.

This enum entry is valid and available only for FrameActive

Name

TriggerDelayLines[TriggerSelector]

Custom

Description

Specifies the delay in number of lines to apply after the trigger reception before activating it

Interface

Integer

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

The value range varies when led flash is enabled depending on the number of patterns.

1. [0 , 32764] – LedFlashEnable is disabled
2. [0,  32764] – LedFlashEnable is enabled and NumberOfPattern=1
3. [0,  16382] – LedFlashEnable is enabled and NumberOfPattern=2
4. [0,  10921] – LedFlashEnable is enabled and NumberOfPattern=3

[0,  8191] – LedFlashEnable is enabled and NumberOfPattern=4

Default value

0

Availability

ALL

Notes

This feature is valid and available only for FrameStart, FrameBurstStart and FrameActive.

This feature is not available if MasterSlaveMode is configured as Slave.

Error behavior

See the device error code documentation.

Name

TriggerDivider[TriggerSelector]

Standard

Description

Specifies a division factor for the incoming line trigger pulses

Interface

Integer

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

[1 , 256]

Default value

1

Availability

ALL

Notes

This feature is valid and available only for LineStart and if MasterSlaveMode is not configured as Slave.

Error behavior

See the device error code documentation.

Name

TriggerSignalDetectionMode[TriggerSelector]

Custom

Description

Specifies the debounce type to be evaluated.

Interface

Enumeration

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

See enum entries table below.

Default value

FrameStart  - PeakholderDetection

FrameBurstStart - PeakholderDetection

FrameActive – Debouncing4Lines

Availability

ALL

Notes

This feature is valid and available only for FrameStart, FrameBurstStart and FrameActive and if MasterSlaveMode is not configured as Slave.

The incoming Frame Trigger Signal can be delayed by the Trigger Delay Lines feature.

Error behavior

See the device error code documentation.

Name

Description

PeakholderDetection

Peakholder detects very short input pulse. (Sensitive to spikes.)

Debouncing4Clocks

Debouncing 4 clocks.
Very short debouncing by four FPGA internal clock cycles.

Debouncing4Lines

Debouncing 4 lines.
Requires a 4-line stable trigger input signal, this leads to an image delay of 4 lines.

Debouncing60Lines

Debouncing 60 lines.
Requires a 60 line stable trigger input signal, leading to an image delay of 60 lines.

Name

FrameActiveExtendLines[TriggerSelector]

Custom

Description

Specifies the number of additional output lines for FrameActive.

Interface

Integer

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

[0, 65535]

Default value

0

Availability

ALL

Notes

This feature is valid and available only for FrameActive and if MasterSlaveMode is not configured as Slave.

Error behavior

See the device error code documentation.

Name

MeasuredLineTime[TriggerSelector]

Custom

Description

Measure the processing time per scan line during line/encoder trigger in us.

Interface

Float

Access mode

Read only

Adjustable

while grabbing

-

Value range

In freerun this feature holds the same value as AcquisitionLineTime.

During LineStart mode ‘ON’, it displays the actual line trigger speed.

But in both cases the maximum line time it can display is 13,107 us.

Default value

-

Availability

ALL

Notes

This feature is valid and available only for LineStart and if MasterSlaveMode is not configured as Slave.

Error behavior

Name

LineTriggerStatus[TriggerSelector]

Custom

Description

Display the line trigger status.

Interface

Enumeration

Access mode

Read only

Adjustable

while grabbing

-

Value range

See enum entries table below.

Default value

-

Availability

ALL

Notes

This feature is valid and available only for LineStart and if MasterSlaveMode is not configured as Slave.

Error behavior

-

Name

Description

OK

OK

SpeedToHigh

Speed to high