Deprecated Parameters

Macros
#define	PARAM_PEAK_AVER_FIR_LENGTH   "peak_aver_fir_length"
#define	PARAM_IMAGE_WIDTH   "image_width"
#define	PARAM_IMAGE_OFFSETX   "image_offsetx"
#define	PARAM_INTERLEAVE_FACTOR   "interleavefactor"
#define	PARAM_INTERLEAVE_FILTER   "interleavefilter"
#define	PARAM_INTERLEAVE_TARGET_INTENSITY   "interleavetargetintensity"
#define	PARAM_INTERLEAVE_Y_THRESHOLD   "interleaveythreshold"
#define	PARAM_LED_DURATION   "led_duration"
#define	PARAM_FLIP_X_X0   "flip_x_x0"
#define	PARAM_FLIP_X_ENABLED   "flip_x_enabled"
#define	PARAM_FLIP_Z_Z0   "flip_z_z0"
#define	PARAM_FLIP_Z_ENABLED   "flip_z_enabled"

Detailed Description

Macro Definition Documentation

PARAM_FLIP_X_ENABLED

#define PARAM_FLIP_X_ENABLED   "flip_x_enabled"

C# name:  SensorParameter.FlipXEnabled

Determines if flip x is enabled or not. See PARAM_FLIP_X_X0 on how to define X0.

• Parameter type: int
• Unit : 1 enabled, 0 disabled.

PARAM_FLIP_X_X0

#define PARAM_FLIP_X_X0   "flip_x_x0"

C# name:  SensorParameter.FlipX0

Set the X0[um] of flip x. If PARAM_FLIP_X_ENABLED is enabled, the X[um] of the points (X[um], Z[um]) are flipped with respect to X0.

• Parameter type: float
• Unit : Micrometers

PARAM_FLIP_Z_ENABLED

#define PARAM_FLIP_Z_ENABLED   "flip_z_enabled"

C# name:  SensorParameter.FlipZEnabled

Determines if flip z is enabled or not. See PARAM_FLIP_Z_Z0 on how to define Z0.

• Parameter type: int
• Unit : 1 enabled, 0 disabled.

PARAM_FLIP_Z_Z0

#define PARAM_FLIP_Z_Z0   "flip_z_z0"

C# name:  SensorParameter.FlipZ0

Set the Z0[um] of flip z. If PARAM_FLIP_Z_ENABLED is enabled, the Z[um] of the points (X[um], Z[um]) are flipped with respect to Z0.

• Parameter type: float
• Unit : Micrometers

PARAM_IMAGE_OFFSETX

#define PARAM_IMAGE_OFFSETX   "image_offsetx"

C# name:  SensorParameter.OffsetX

Set the X offset for the image capture.

• Parameter type: Int.
• Unit : Pixels
• Values : Typically 0. If value is non-zero, it should be noticed that the sum of offset X and image width shall not exceed the sensor width.

PARAM_IMAGE_WIDTH

#define PARAM_IMAGE_WIDTH   "image_width"

C# name:  SensorParameter.Width

Width of the sensor image in pixel unit.

• Parameter type: Int.
• Unit : Pixels
• Values : For full camera sensor 2048.

PARAM_INTERLEAVE_FACTOR

#define PARAM_INTERLEAVE_FACTOR   "interleavefactor"

C# name:  SensorParameter.InterleaveFactor

Sets the value used to enable or disable interleaving. Interleaving applies different exposure for even and odd rows of the sensor. The exposure for odd rows is as-is, whereas even rows have short exposure, namely current_exposure / PARAM_INTERLEAVE_FACTOR.

• Parameter type: float
• Values : 1.0 disables interleaving. Any other value divides the exposure of even rows, but leaves the exposure of odd rows as-is.

PARAM_INTERLEAVE_FILTER

#define PARAM_INTERLEAVE_FILTER   "interleavefilter"

C# name:  SensorParameter.InterleaveFilterMode

Sets the interleaving filter. Used only if PARAM_INTERLEAVE_FACTOR is other than 1.0.

• Parameter type: int
• Values : 0 = do not filter (the application should filter), 1 = filter using PARAM_INTERLEAVE_TARGET_INTENSITY and PARAM_INTERLEAVE_Y_THRESHOLD

PARAM_INTERLEAVE_TARGET_INTENSITY

#define PARAM_INTERLEAVE_TARGET_INTENSITY   "interleavetargetintensity"

C# name:  SensorParameter.InterleaveFilterTargetIntensity

Sets the target intensity for the interleaving. See PARAM_INTERLEAVE_FILTER for more information.

• Parameter type: float
• Values : 8-bit grayscale intensity (0.0 - 255.0)

PARAM_INTERLEAVE_Y_THRESHOLD

#define PARAM_INTERLEAVE_Y_THRESHOLD   "interleaveythreshold"

C# name:  SensorParameter.InterleaveFilterYThreshold

Sets the Y threshold [px] for interleaving. See PARAM_INTERLEAVE_FILTER for more information.

• Parameter type: float
• Values : Y threshold [px] value.

PARAM_LED_DURATION

#define PARAM_LED_DURATION   "led_duration"

C# name:  SensorParameter.LedDuration

The time which the LED is ON. LED cannot be ON all the time between two trigger pulses (PARAM_REG_PULSE_FREQ). To achieve this see chapter LED Pulse Duration.

• Parameter type: int
• Unit: Microseconds
• Values : Values should be greater than 1.

PARAM_PEAK_AVER_FIR_LENGTH

#define PARAM_PEAK_AVER_FIR_LENGTH   "peak_aver_fir_length"

C# name:  SensorParameter.FirAverLength

The length of averaging filter used for both detection and intensity calculation. Parameter is deprecated. Please use parameters PARAM_SIGNAL_DETECTION_FILTER_LENGTH and PARAM_PEAK_AVERAGE_INTENSITY_FILTER_LENGTH.

• Parameter type: int
• Values : Eligible values are 2, 4, 6, 8, 10, 12, 14 or 16.