Macros
#define	PARAM_REG_PULSE_DIVIDER "reg_pulse_divider"

#define	PARAM_ENCODER_PULSE_WIDTH "encoder_pulse_width"

#define	PARAM_REG_PULSE_FREQ "reg_pulse_freq"

#define	PARAM_REORDERING "reordering"

#define	PARAM_REORDERING_SPAN "reordering_span"

#define	PARAM_REORDERING_DEVIATION "reordering_deviation"

#define	PARAM_FREQUENCY_CALCULATION "frequency_calculation"

#define	PARAM_LINE_CALLBACK_MAX_LENGTH "line_callback_max_length"

#define	PARAM_LINE_CALLBACK_XRES "line_callback_xres"

#define	PARAM_BATCH_LENGTH "batch_length"

#define	PARAM_BATCH_TIMEOUT "batch_timeout"

#define	PARAM_GRABBING "grabbing"

Detailed Description

Macro Definition Documentation

◆ PARAM_BATCH_LENGTH

#define PARAM_BATCH_LENGTH "batch_length"

C# name:  SensorParameter.BatchLength

Defines batch length (number of lines) on the batch run.

Parameter type: int
Unit : Line count

◆ PARAM_BATCH_TIMEOUT

#define PARAM_BATCH_TIMEOUT "batch_timeout"

C# name:  SensorParameter.BatchTimeout

Defines batch timeout timer. Interrupts collecting batch if total count lines not received before time expires. Incomplete batch is delivered for callback.

Parameter type: int
Unit : Milliseconds

◆ PARAM_ENCODER_PULSE_WIDTH

#define PARAM_ENCODER_PULSE_WIDTH "encoder_pulse_width"

C# name:  SensorParameter.EncoderPulseWidth

Encoder pulse width for external triggering.
If only single channel is used, pulse width is physical distance between rising edges of the signal.
If two channels are used (quadrature encoder), pulse width must be divided by factor 2.

Parameter type: float
Unit : Micrometers

◆ PARAM_FREQUENCY_CALCULATION

#define PARAM_FREQUENCY_CALCULATION "frequency_calculation"

C# name:  SensorParameter.FrequencyCalculation

Enable or disable frequency calculation in header of the profile. 0 = disabled, 1 = enabled (default)

Parameter type: int

◆ PARAM_GRABBING

#define PARAM_GRABBING "grabbing"

C# name:  SensorParameter.Grabbing

Read only value indicating the camera grabbing status.

Parameter type: int
Values : 0 = stopped, 1 = grabbing is on.

◆ PARAM_LINE_CALLBACK_MAX_LENGTH

#define PARAM_LINE_CALLBACK_MAX_LENGTH "line_callback_max_length"

C# name:  SensorParameter.LineCallbackMaxLength

Number of pixels expected from the line callback function. Can be called before grabbing but after initialization. Parameter is read-only.

Parameter type: int
Unit : number of pixels

◆ PARAM_LINE_CALLBACK_XRES

#define PARAM_LINE_CALLBACK_XRES "line_callback_xres"

C# name:  SensorParameter.LineCallbackXRes

Pixel size expected from the line callback function. Can be called before grabbing but after initialization. Parameter is read-only.

Parameter type: float
Unit : Micrometers

◆ PARAM_REG_PULSE_DIVIDER

#define PARAM_REG_PULSE_DIVIDER "reg_pulse_divider"

C# name:  SensorParameter.PulseDivider

Skips camera trigger pulses. If value if N, then every Nth pulses are triggered. If value is equal to one, then all trigger pulses are served.

Parameter type: int
Unit: N

◆ PARAM_REG_PULSE_FREQ

#define PARAM_REG_PULSE_FREQ "reg_pulse_freq"

C# name:  SensorParameter.PulseFrequency

Set the frequency for image capture.

Parameter type: int
Unit: Hz
Value: 0 = external pulsing, > 0 internal pulsing.

◆ PARAM_REORDERING

#define PARAM_REORDERING "reordering"

C# name:  SensorParameter.Reordering

Enable or disable line reordering according to header.index attribute. 0 = disabled (default), 1 = enabled

Parameter type: int

◆ PARAM_REORDERING_DEVIATION

#define PARAM_REORDERING_DEVIATION "reordering_deviation"

C# name:  SensorParameter.ReorderingDeviation

Defines reordering maximum index step deviation between subsequent lines. Exceeding triggers buffer clearing.

Parameter type: int

◆ PARAM_REORDERING_SPAN

#define PARAM_REORDERING_SPAN "reordering_span"

C# name:  SensorParameter.ReorderingSpan

Defines reordering time span max time window in milliseconds.

Parameter type: int

Macros