Sensor API v2.5.0
Macros
Parameters for Camera

Macros

#define PARAM_LOAD_RECIPE   "load_recipe"
 
#define PARAM_SAVE_RECIPE   "save_recipe"
 
#define PARAM_PEAK_ENABLE   "peak_enable"
 
#define PARAM_PEAK_THRESHOLD   "peak_treshold"
 
#define PARAM_PEAK_FIR_LENGTH   "peak_fir_length"
 
#define PARAM_SENSOR_DATA_IN_FLASH   "sensor_data_in_flash"
 
#define PARAM_SENSOR_CALIBRATION_FILE   "sensor_calibration_file"
 
#define PARAM_SENSOR_X_CALIBRATION_FILE   "sensor_x_calibration_file"
 
#define PARAM_SENSOR_INTENSITY_CALIBRATION_FILE   "sensor_intensity_calibration_file"
 
#define PARAM_SENSOR_Z_COMPENSATION_FILE   "sensor_z_compensation_file"
 
#define PARAM_PEAK_Y_UNIT   "peak_y_unit"
 
#define PARAM_PEAK_X_UNIT   "peak_x_unit"
 
#define PARAM_INTENSITY_CORRECTION_ENABLE   "intensity_correction_enable"
 
#define PARAM_SENSOR_TYPE   "sensor_type"
 
#define PARAM_GAIN   "gain"
 
#define PARAM_IMAGE_HEIGHT   "image_height"
 
#define PARAM_IMAGE_OFFSETY   "image_offsety"
 
#define PARAM_SURFACE_MODE   "surface_mode"
 
#define PARAM_HDR_ENABLED   "hdr_enable"
 
#define PARAM_HDR_KP1_POS   "hdr_kp1_pos"
 
#define PARAM_HDR_KP2_POS   "hdr_kp2_pos"
 
#define PARAM_HDR_VLOW2   "hdr_vlow2"
 
#define PARAM_HDR_VLOW3   "hdr_vlow3"
 
#define PARAM_HDR_KP1_POS_FLOAT   "hdr_kp1_pos_float"
 
#define PARAM_HDR_KP2_POS_FLOAT   "hdr_kp2_pos_float"
 
#define PARAM_HDR_VLOW2_FLOAT   "hdr_vlow2_float"
 
#define PARAM_HDR_VLOW3_FLOAT   "hdr_vlow3_float"
 
#define PARAM_X_LIMIT_MIN   "x_limit_min"
 
#define PARAM_X_LIMIT_MAX   "x_limit_max"
 
#define PARAM_SATURATION_COUNT   "saturation_count"
 
#define PARAM_AVERAGE_FRAME_INTENSITY   "average_frame_intensity"
 
#define PARAM_DYN_SENSOR_CTRL_ENABLE   "dyn_sensor_control_enable"
 
#define PARAM_MAX_POINT_COUNT   "max_point_count"
 
#define PARAM_MTU   "mtu"
 
#define PARAM_IFG   "ifg"
 
#define PARAM_HEARTBEAT   "heartbeat"
 
#define PARAM_IMAGE_HEIGHT_ZERO_POSITION   "image_height_zero_position"
 
#define PARAM_DEVICE_SERIAL_NUMBER   "device_serial_number"
 
#define PARAM_USER_FLASH_WRITE_TIME   "user_flash_write_time"
 
#define PARAM_SIGNAL_DETECTION_FILTER_LENGTH   "signal_detection_filter_length"
 
#define PARAM_PEAK_AVERAGE_INTENSITY_FILTER_LENGTH   "peak_average_intensity_filter_length"
 
#define PARAM_LAYER_INTENSITY_TYPE   "layer_intensity_type"
 
#define PARAM_LAYER_MAX_THICKNESS   "layer_max_thickness"
 
#define PARAM_LAYER_MIN_THICKNESS   "layer_min_thickness"
 
#define PARAM_LAYER_EFFECTIVE_REFRACTIVE_INDEX   "layer_refractive_index"
 
#define PARAM_THICKNESS_MODE   "thickness_mode"
 
#define PARAM_AVERAGE_X_PIXEL_SIZE   "average_x_pixel_size"
 
#define PARAM_AVERAGE_Z_PIXEL_SIZE   "average_z_pixel_size"
 

Detailed Description

Macro Definition Documentation

◆ PARAM_AVERAGE_FRAME_INTENSITY

#define PARAM_AVERAGE_FRAME_INTENSITY   "average_frame_intensity" 

C# name:  SensorParameter.AvgFrameIntensity

Average intensity level of a frame.

  • Parameter type: int
  • Unit : 8-bit grayscale intensity

◆ PARAM_AVERAGE_X_PIXEL_SIZE

#define PARAM_AVERAGE_X_PIXEL_SIZE   "average_x_pixel_size" 

C# name:  SensorParameter.AverageXPixelSize

Reads average x-pixel size in micrometers from the selected image ROI. Parameter is read only.

  • Parameter type: float

◆ PARAM_AVERAGE_Z_PIXEL_SIZE

#define PARAM_AVERAGE_Z_PIXEL_SIZE   "average_z_pixel_size" 

C# name:  SensorParameter.AverageZPixelSize

Reads average z-pixel size in micrometers from the selected image ROI. Parameter is read only.

  • Parameter type: float

◆ PARAM_DEVICE_SERIAL_NUMBER

#define PARAM_DEVICE_SERIAL_NUMBER   "device_serial_number" 

C# name:  SensorParameter.DeviceSerialNumber

Device Serial Number, defined by production.

  • Parameter type: string
  • Values : Null-terminated string of product serial number. "" if the serial number is not written (products manufactured before 02/2019).

◆ PARAM_DYN_SENSOR_CTRL_ENABLE

#define PARAM_DYN_SENSOR_CTRL_ENABLE   "dyn_sensor_control_enable" 

C# name:  SensorParameter.DynSensorCtrlEnable

Determines if dynamic sensor control is enabled or not. Dynamic control parameters given by interface function xxx to set register parameters REG_DYN_SENSOR_CTRL_N_LOCATION, REG_DYN_SENSOR_CTRL_N_HEIGHT, REG_DYN_SENSOR_CTRL_N_HEIGHT_OFFSET, REG_DYN_SENSOR_CTRL_N_PULSE_WIDTH N = 1, 2, ..., 10.

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

◆ PARAM_GAIN

#define PARAM_GAIN   "gain" 

C# name:  SensorParameter.Gain

Gain sets the sensitivity of the sensor. The higher the gain, the more sensitive the sensor. Image grabbing must be stopped before setting the gain in LCI1220 and LCI1620 sensors. The default setting is suitable for the most of the applications. Use higher Gain setting only when the signal is very weak or short LED Pulse Width is required due to high measurement frequency. Increasing Gain increases also noise and background signal level, therefore Gain increase might also require increasing the Threshold. Optimal Gain value for specific measurement must be found experimentally.

  • Parameter type: double
  • Range : 1.0 (default) - 3.2 for LCI401, LCI1200, LCI1201 and LCI1600 sensors
    2.0 (default) - 8.0 for LCI1220 and LCI1620 sensors

◆ PARAM_HDR_ENABLED

#define PARAM_HDR_ENABLED   "hdr_enable" 

C# name:  SensorParameter.HdrEnabled

Enables or disables the HDR mode, where the dynamic range of luminosity is greater than normally.

  • Parameter type: int
  • Values : 0 = disabled, 1 = enabled.

◆ PARAM_HDR_KP1_POS

#define PARAM_HDR_KP1_POS   "hdr_kp1_pos" 

C# name:  SensorParameter.Kp1Pos

The knee point 1 position for the HDR. This parameter is used only when the HDR is enabled.

  • Parameter type: int
  • Valid range: 1 - 99

◆ PARAM_HDR_KP1_POS_FLOAT

#define PARAM_HDR_KP1_POS_FLOAT   "hdr_kp1_pos_float" 

C# name:  SensorParameter.Kp1PosFloat

The knee point 1 position in % for the HDR. This parameter is used only when the HDR is enabled.

  • Parameter type: float
  • Valid range: 0.02 - 99.99

◆ PARAM_HDR_KP2_POS

#define PARAM_HDR_KP2_POS   "hdr_kp2_pos" 

C# name:  SensorParameter.Kp2Pos

The knee point 2 position for the HDR. This parameter is used only when the HDR is enabled.

  • Parameter type: int

◆ PARAM_HDR_KP2_POS_FLOAT

#define PARAM_HDR_KP2_POS_FLOAT   "hdr_kp2_pos_float" 

C# name:  SensorParameter.Kp2PosFloat

The knee point 2 position in % for the HDR. This parameter is used only when the HDR is enabled.

  • Parameter type: float

◆ PARAM_HDR_VLOW2

#define PARAM_HDR_VLOW2   "hdr_vlow2" 

C# name:  SensorParameter.VLow2

The VLow2 (sensitivity, reference voltage) value for the HDR. This parameter is used only when the HDR is enabled.

  • Parameter type: int

◆ PARAM_HDR_VLOW2_FLOAT

#define PARAM_HDR_VLOW2_FLOAT   "hdr_vlow2_float" 

C# name:  SensorParameter.VLow2Float

The VLow2 (sensitivity, reference voltage) value for the HDR. This parameter is used only when the HDR is enabled.

  • Parameter type: float

◆ PARAM_HDR_VLOW3

#define PARAM_HDR_VLOW3   "hdr_vlow3" 

C# name:  SensorParameter.VLow3

The VLow3 (sensitivity, reference voltage) value for the HDR. This parameter is used only when the HDR is enabled.

  • Parameter type: int

◆ PARAM_HDR_VLOW3_FLOAT

#define PARAM_HDR_VLOW3_FLOAT   "hdr_vlow3_float" 

C# name:  SensorParameter.VLow3Float

The VLow3 (sensitivity, reference voltage) value for the HDR. This parameter is used only when the HDR is enabled.

  • Parameter type: float

◆ PARAM_HEARTBEAT

#define PARAM_HEARTBEAT   "heartbeat" 

C# name:  SensorParameter.Heartbeat

Communication heartbeat value. Heartbeat is the interval in milliseconds to check if the connection is alive.

  • Parameter type: int
  • Values: In production use the heartbeat should be set to ~5000. For application debugging purposes, greater values, e.g. 99999, are often needed.

◆ PARAM_IFG

#define PARAM_IFG   "ifg" 

C# name:  SensorParameter.Ifg

Sets Interpacket Delay. Min. value is 20. Available only with LCI401, LCI1200, LCI1201 and LCI1600 sensors.

  • Parameter type: int
  • Unit : bit times

◆ PARAM_IMAGE_HEIGHT

#define PARAM_IMAGE_HEIGHT   "image_height" 

C# name:  SensorParameter.Height

Height of the sensor image in pixel unit. Small values can be used to achieve higher frequency. Used in conjunction with PARAM_IMAGE_OFFSETY. Sum of image height and image offset y shall not exceed the maximum sensor height.

  • Parameter type: int
  • Unit : pixels
  • Range : 8 - 1088 for LCI401, LCI1200, LCI1201 and LCI1600 sensors
    8 - 1400 for LCI1220 and LCI1620 sensors

◆ PARAM_IMAGE_HEIGHT_ZERO_POSITION

#define PARAM_IMAGE_HEIGHT_ZERO_POSITION   "image_height_zero_position" 

C# name:  SensorParameter.ImageHeightZeroPosition

Returns image row z coordinate where height has been tuned nearest to '0' by calibration file on use.

  • Parameter type: int
  • Unit : pixel location

◆ PARAM_IMAGE_OFFSETY

#define PARAM_IMAGE_OFFSETY   "image_offsety" 

C# name:  SensorParameter.OffsetY

Set the Y offset for the sensor. Used in conjunction with PARAM_IMAGE_HEIGHT.

  • Parameter type: int
  • Unit : pixels
  • Range : -1 - 1080 for LCI401, LCI1200, LCI1201 and LCI1600 sensors. -1 - 1392 for LCI1220 and LCI1620 sensors. If value is greater than 0, it should be noticed that the sum of PARAM_IMAGE_OFFSETY and PARAM_IMAGE_HEIGHT should not exceed the maximum sensor height. If value is -1 offset is calculated automatically from the calibration zero height (PARAM_IMAGE_HEIGHT must be set first).

◆ PARAM_INTENSITY_CORRECTION_ENABLE

#define PARAM_INTENSITY_CORRECTION_ENABLE   "intensity_correction_enable" 

C# name:  SensorParameter.IntensityCorrectionEnable

Enables or disables the intensity correction for the peak data.

  • Parameter type: int
  • Values : 0 = intensity correction is disabled (default), 1 = intensity correction is disabled.

◆ PARAM_LAYER_EFFECTIVE_REFRACTIVE_INDEX

#define PARAM_LAYER_EFFECTIVE_REFRACTIVE_INDEX   "layer_refractive_index" 

C# name:  SensorParameter.LayerRefractiveIndex

Specifies the effective refractive index of a material. _SetLayerFloatParameter function shall be used for this parameter.

  • Parameter type: float
  • Layer: layer id (0=first layer)
  • Values : The effective refractive index (1.0 by default)

◆ PARAM_LAYER_INTENSITY_TYPE

#define PARAM_LAYER_INTENSITY_TYPE   "layer_intensity_type" 

C# name:  SensorParameter.LayerIntensityType

Specifies which filter is used for intensity values in linecallback and batchcallback functions. _SetLayerIntParameter function shall be used for this parameter.

  • Parameter type: int
  • Layer: layer id (0=first layer)
  • Values : 0 = Average intensity filter, 1 = Signal detection filter

◆ PARAM_LAYER_MAX_THICKNESS

#define PARAM_LAYER_MAX_THICKNESS   "layer_max_thickness" 

C# name:  SensorParameter.LayerMaxThickness

Specifies maximum thickness for the layer. Used for missing surface detection. _SetLayerFloatParameter function shall be used for this parameter.

  • Parameter type: float
  • Layer: layer id (0=first layer)
  • Values : Thickness in um (0, if not used)

◆ PARAM_LAYER_MIN_THICKNESS

#define PARAM_LAYER_MIN_THICKNESS   "layer_min_thickness" 

C# name:  SensorParameter.LayerMinThickness

Specifies minimum thickness for the layer. _SetFloatParameter function sets same value for all layers. _SetLayerFloatParameter function shall be used if layer specific value is needed.

  • Parameter type: float
  • Layer: layer id (0=first layer)
  • Values : Thickness in um (0, if not used)

◆ PARAM_LOAD_RECIPE

#define PARAM_LOAD_RECIPE   "load_recipe" 

C# name:  SensorParameter.LoadRecipe

Loads a sensor configuration from the specified recipe.

  • Parameter type: string
  • Values : Name of the recipe. Loads from the default folder (C:\FocalSpec\SDK Recipes\ in Windows, ~/.local/share/fssdk/recipes/ in Linux) if path is not given.

◆ PARAM_MAX_POINT_COUNT

#define PARAM_MAX_POINT_COUNT   "max_point_count" 

C# name:  SensorParameter.MaxPointCount

Maximum point count per profile. Change this before calling _StartGrabbing(). Default value is fine if number of surfaces is less than 5.

  • Parameter type: int
  • Unit : Max number of points. Default value is 10000.

◆ PARAM_MTU

#define PARAM_MTU   "mtu" 

C# name:  SensorParameter.Mtu

Sets Maximum Transmission Unit (MTU). Available only with LCI401, LCI1200, LCI1201 and LCI1600 sensors.

  • Parameter type: int
  • Unit : bytes

◆ PARAM_PEAK_AVERAGE_INTENSITY_FILTER_LENGTH

#define PARAM_PEAK_AVERAGE_INTENSITY_FILTER_LENGTH   "peak_average_intensity_filter_length" 

C# name:  SensorParameter.PeakAverageIntensityFilterLength

The filter is used for averaging intensity values of the detected peaks. With high average intensity filter length, the best possible intensity image is produced.

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

◆ PARAM_PEAK_ENABLE

#define PARAM_PEAK_ENABLE   "peak_enable" 

C# name:  SensorParameter.PeakEnabled

Controls the output mode of the camera. If enabled, peaks are output to ProfileCallback, LineCallback and BatchCallback functions. If disabled, raw images are output to RawImageCallback.

  • Parameter type: int
  • Values : 0 = raw image output is active, 1 = peak cloud output is active.

◆ PARAM_PEAK_FIR_LENGTH

#define PARAM_PEAK_FIR_LENGTH   "peak_fir_length" 

C# name:  SensorParameter.FirLength

FIR parameter is used to find the detected peak position in the z-direction. Higher the FIR, more accurate the peak position is. With lower FIR, you can detect thinner layers in transparent layered material.

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

◆ PARAM_PEAK_THRESHOLD

#define PARAM_PEAK_THRESHOLD   "peak_treshold" 

C# name:  SensorParameter.PeakThreshold

The intensity threshold value used in peak detection. If the peak intensity is below this limit, the peak gets discarded

  • Parameter type: int
  • Unit: 8-bit grayscale intensity value (2-200). Default value is 20.

◆ PARAM_PEAK_X_UNIT

#define PARAM_PEAK_X_UNIT   "peak_x_unit" 

C# name:  SensorParameter.PeakXUnit

Controls the unit of measure of X of the peaks. Note that this parameter has effect only if peak cloud output is active (PARAM_PEAK_ENABLE is set to 1).

  • Parameter type: int
  • Values : 0 = peak X is in sensor pixel unit, 1 = peak X is in micrometers.

◆ PARAM_PEAK_Y_UNIT

#define PARAM_PEAK_Y_UNIT   "peak_y_unit" 

C# name:  SensorParameter.PeakYUnit

Controls the unit of measure of Y of the peaks. Note that this parameter has effect only if peak cloud output is active (PARAM_PEAK_ENABLE is set to 1).

  • Parameter type: int
  • Values : 0 = peak Y is in sensor pixel unit, 1 = peak Y is in micrometers.

◆ PARAM_SATURATION_COUNT

#define PARAM_SATURATION_COUNT   "saturation_count" 

C# name:  SensorParameter.SaturationCount

The number of sensor pixels in saturation state.

  • Parameter type: int
  • Unit : Count

◆ PARAM_SAVE_RECIPE

#define PARAM_SAVE_RECIPE   "save_recipe" 

C# name:  SensorParameter.SaveRecipe

Saves the current sensor configuration to the specified recipe.

  • Parameter type: string
  • Values : Name of the recipe. Saves to the default folder (C:\FocalSpec\SDK Recipes\ in Windows, ~/.local/share/fssdk/recipes/ in Linux) if path is not given.

◆ PARAM_SENSOR_CALIBRATION_FILE

#define PARAM_SENSOR_CALIBRATION_FILE   "sensor_calibration_file" 

C# name:  SensorParameter.ZCalibrationFile

Path of the sensor Z calibration file. No need to set if calibration files are in the sensor.

  • Parameter type: string
  • Values : Null-terminated string path to the file.

◆ PARAM_SENSOR_DATA_IN_FLASH

#define PARAM_SENSOR_DATA_IN_FLASH   "sensor_data_in_flash" 

C# name:  SensorParameter.SensorDataInFlash

Read flag if e.g. Sensor type and calibration data is written to sensor flash memory.

  • Parameter type: int
  • Unit : 1 if supported, 0 if not.

◆ PARAM_SENSOR_INTENSITY_CALIBRATION_FILE

#define PARAM_SENSOR_INTENSITY_CALIBRATION_FILE   "sensor_intensity_calibration_file" 

C# name:  SensorParameter.IntensityCalibrationFile

Path of the sensor intensity calibration file.

  • Parameter type: string
  • Values : Null-terminated string path to the file.

◆ PARAM_SENSOR_TYPE

#define PARAM_SENSOR_TYPE   "sensor_type" 

C# name:  SensorParameter.SensorType

Returns sensor type identifier without LCI prefix.

  • Parameter type: int
  • Values : 
                400 = LCI400 
           1200 = LCI1200 
           1600 = LCI1600
            401 = LCI401 
           1201 = LCI1201
           1220 = LCI1220
           1620 = LCI1620 
             -1 if not set

◆ PARAM_SENSOR_X_CALIBRATION_FILE

#define PARAM_SENSOR_X_CALIBRATION_FILE   "sensor_x_calibration_file" 

C# name:  SensorParameter.XCalibrationFile

Path of the sensor X calibration file. No need to set if calibration files are in the sensor.

  • Parameter type: string
  • Values : Null-terminated string path to the file.

◆ PARAM_SENSOR_Z_COMPENSATION_FILE

#define PARAM_SENSOR_Z_COMPENSATION_FILE   "sensor_z_compensation_file" 

C# name:  SensorParameter.SensorZCompensationFile

Path of the sensor Z-Compensation calibration file.

  • Parameter type: string
  • Values : Null-terminated string path to the file.

◆ PARAM_SIGNAL_DETECTION_FILTER_LENGTH

#define PARAM_SIGNAL_DETECTION_FILTER_LENGTH   "signal_detection_filter_length" 

C# name:  SensorParameter.SignalDetectionFilterLength

Detection filter is used to average the signal to reduce noise before threshold (PARAM_PEAK_THRESHOLD). Low detection filter length is useful when the detected signal is rather faint.

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

◆ PARAM_SURFACE_MODE

#define PARAM_SURFACE_MODE   "surface_mode" 

C# name:  SensorParameter.SurfaceMode

Sort peaks and filter top, bottom or brightest profile.

  • Parameter type: int
  • Values :
    Sensors LCI401, LCI1200, LCI1220 and LCI1620: 0 = disabled (default), 1 = bottom, 2 = top, 3 = brightest, 4 = two two top-most, 5 = two top-most.
    Sensors LCI1201 and LCI1600: 0 = disabled (default), 1 = top, 2 = bottom, 3 = brightest, 4 = two two top-most, 5 = two two top-most.

◆ PARAM_THICKNESS_MODE

#define PARAM_THICKNESS_MODE   "thickness_mode" 

C# name:  SensorParameter.ThicknessMode

Calculates thicknesses for layers in line and batch callback functions. The first surface is returned as a world z-coordinate and following layers are calculated as thickness values. Note that thickness mode parameter is not saved to the recipe.

  • Parameter type: int
  • Values : 1 - thickness mode enabled, 0 - disabled (default)

◆ PARAM_USER_FLASH_WRITE_TIME

#define PARAM_USER_FLASH_WRITE_TIME   "user_flash_write_time" 

C# name:  SensorParameter.UserFlashWriteTime

UTC timestamp when user data was written when available.

  • Parameter type: string
  • Values : Null-terminated formatted string from time of date value.

◆ PARAM_X_LIMIT_MAX

#define PARAM_X_LIMIT_MAX   "x_limit_max" 

C# name:  SensorParameter.XLimitMax

Upper X threshold for statistics collection (PARAM_SATURATION_COUNT, PARAM_AVERAGE_FRAME_INTENSITY) and AGC input profile.

  • Parameter type: int
  • Unit : Pixels
  • Range : Default value is 2047.

◆ PARAM_X_LIMIT_MIN

#define PARAM_X_LIMIT_MIN   "x_limit_min" 

C# name:  SensorParameter.XLimitMin

Lower X threshold for statistics collection (PARAM_SATURATION_COUNT, PARAM_AVERAGE_FRAME_INTENSITY) and AGC input profile.

  • Parameter type: int
  • Unit : Pixels
  • Range : Default value is 0.