Sensor API v2.5.0
Macros
Parameters for Filtering

Macros

#define PARAM_DETECT_MISSING_FIRST_LAYER   "detect_missing_first_layer"
 
#define PARAM_DETECT_MISSING_FIRST_LAYERX   "detect_missing_first_layer_x"
 
#define PARAM_DETECT_MISSING_FIRST_LAYER_MIN_LENGTH   "detect_missing_first_layer_min_length"
 
#define PARAM_RESAMPLE_LINE_X_RESOLUTION   "resample_line_x_resolution"
 
#define PARAM_FILL_GAP_X_MAX   "fill_gap_x_max"
 
#define PARAM_AVERAGE_Z_FILTER_SIZE   "average_z_filter_size"
 
#define PARAM_AVERAGE_INTENSITY_FILTER_SIZE   "average_intensity_filter_size"
 
#define PARAM_MEDIAN_Z_FILTER_SIZE   "median_z_filter_size"
 
#define PARAM_MEDIAN_INTENSITY_FILTER_SIZE   "median_intensity_filter_size"
 
#define PARAM_NOISE_REMOVAL   "noise_removal"
 
#define PARAM_Z_COMPENSATION_Y_DIRECTION   "z_compensation_y_direction"
 
#define PARAM_Z_COMPENSATION_X_DIRECTION   "z_compensation_x_direction"
 
#define PARAM_Z_COMPENSATION_THRESHOLD   "z_compensation_threshold"
 
#define PARAM_Z_COMPENSATION_INTERPOLATE   "z_compensation_interpolate"
 
#define PARAM_Z_COMPENSATION_X_BRIGHT_TO_DARK_MUL   "z_compensation_x_bright_to_dark_mul"
 
#define PARAM_Z_COMPENSATION_X_DARK_TO_BRIGHT_MUL   "z_compensation_x_dark_to_bright_mul"
 
#define PARAM_Z_COMPENSATION_Y_BRIGHT_TO_DARK_MUL   "z_compensation_y_bright_to_dark_mul"
 
#define PARAM_Z_COMPENSATION_Y_DARK_TO_BRIGHT_MUL   "z_compensation_y_dark_to_bright_mul"
 
#define PARAM_MOVING_DIRECTION   "moving_direction"
 
#define PARAM_PEAK_X_FILTER   "peak_x_filter"
 
#define PARAM_TRIM_EDGES   "trim_edges"
 
#define PARAM_CLUSTERING_DISTANCE_X   "clustering_distance_x"
 
#define PARAM_CLUSTERING_DISTANCE_Z   "clustering_distance_z"
 
#define PARAM_CLUSTER_MINIMUM_LENGTH   "cluster_minimum_length"
 

Detailed Description

Macro Definition Documentation

◆ PARAM_AVERAGE_INTENSITY_FILTER_SIZE

#define PARAM_AVERAGE_INTENSITY_FILTER_SIZE   "average_intensity_filter_size" 

C# name:  SensorParameter.AverageIntensityFilterSize

Size of the averaging filter for the line callback intensity values.

  • Parameter type: float
  • Unit : Micrometers

◆ PARAM_AVERAGE_Z_FILTER_SIZE

#define PARAM_AVERAGE_Z_FILTER_SIZE   "average_z_filter_size" 

C# name:  SensorParameter.AverageZFilterSize

Size of the averaging filter for the line callback Z-values.

  • Parameter type: float
  • Unit : Micrometers

◆ PARAM_CLUSTER_MINIMUM_LENGTH

#define PARAM_CLUSTER_MINIMUM_LENGTH   "cluster_minimum_length" 

C# name:  SensorParameter.ClusterMinimumLength

Clusters which are shorter than specified length are removed. 0 if feature is disabled.

  • Parameter type: float
  • Unit : Micrometers

◆ PARAM_CLUSTERING_DISTANCE_X

#define PARAM_CLUSTERING_DISTANCE_X   "clustering_distance_x" 

C# name:  SensorParameter.ClusteringDistanceX

Maximum X distance between two points in a cluster. 0 if feature is disabled.

  • Parameter type: float
  • Unit : Micrometers

◆ PARAM_CLUSTERING_DISTANCE_Z

#define PARAM_CLUSTERING_DISTANCE_Z   "clustering_distance_z" 

C# name:  SensorParameter.ClusteringDistanceZ

Maximum Z distance between two points in a cluster. 0 if feature is disabled.

  • Parameter type: float
  • Unit : Micrometers

◆ PARAM_DETECT_MISSING_FIRST_LAYER

#define PARAM_DETECT_MISSING_FIRST_LAYER   "detect_missing_first_layer" 

C# name:  SensorParameter.DetectMissingFirstLayer

Correct the first surface by detecting areas where the next layer is visible but the first one missing (i.e. holes in the first layer). Takes effect for line callback functions. 0, disabled (default) >1, enabled, minimum distance between two layers in micrometers (typically 30 um is used)

  • Parameter type: float

◆ PARAM_DETECT_MISSING_FIRST_LAYER_MIN_LENGTH

#define PARAM_DETECT_MISSING_FIRST_LAYER_MIN_LENGTH   "detect_missing_first_layer_min_length" 

C# name:  SensorParameter.DetectMissingFirstLayerLength

Defines minimum length of the first surface. Can be used to reduce wrong detection of noise points to first layer. 0, disabled (default) >1, enabled, minimum length in micrometers

  • Parameter type: float

◆ PARAM_DETECT_MISSING_FIRST_LAYERX

#define PARAM_DETECT_MISSING_FIRST_LAYERX   "detect_missing_first_layer_x" 

C# name:  SensorParameter.DetectMissingFirstLayerX

Correct the first surface by detecting areas where the next layer is visible but the first one missing (i.e. holes in the first layer). Takes effect for line callback functions and only if PARAM_DETECT_MISSING_FIRST_LAYER is set. 0, disabled (default) >1, enabled, maximum x-coordinate distance between two points in micrometers

  • Parameter type: float

◆ PARAM_FILL_GAP_X_MAX

#define PARAM_FILL_GAP_X_MAX   "fill_gap_x_max" 

C# name:  SensorParameter.FillGapXmax

Defines maximum gap of missing measurement points filled by interpolation. PARAM_LAYER_MIN_THICKNESS parameter defines maximum Z difference for interpolated points. For opaque materials, a user can set parameter for the first layer.

  • Parameter type: float
  • Unit : Micrometers, 0 if feature is disabled.

◆ PARAM_MEDIAN_INTENSITY_FILTER_SIZE

#define PARAM_MEDIAN_INTENSITY_FILTER_SIZE   "median_intensity_filter_size" 

C# name:  SensorParameter.MedianIntensityFilterSize

Size of the median filter for the line callback intensity values. If an even value is specified, the function adds 1 and uses the odd value of the filter mask for median filtering.

  • Parameter type: int
  • Unit : Pixels

◆ PARAM_MEDIAN_Z_FILTER_SIZE

#define PARAM_MEDIAN_Z_FILTER_SIZE   "median_z_filter_size" 

C# name:  SensorParameter.MedianZFilterSize

Size of the median filter for the line callback intensity values. If an even value is specified, the function adds 1 and uses the odd value of the filter mask for median filtering.

  • Parameter type: int
  • Unit : Pixels

◆ PARAM_MOVING_DIRECTION

#define PARAM_MOVING_DIRECTION   "moving_direction" 

C# name:  SensorParameter.MovingDirection
Movement in y direction.
  • Parameter type: int
  • Values : 0 = towards (default), 1 = backwards

◆ PARAM_NOISE_REMOVAL

#define PARAM_NOISE_REMOVAL   "noise_removal" 

C# name:  SensorParameter.NoiseRemoval

Noise removal algorithm for the line callback. Noise filter suppresses the noise and allows to use lower threshold which improves the data acquisition. Noise filter removes single data points which do not have adjacent daqta points. Note! If noise removal for Y is enabled line callback has 1 profile delay

  • Parameter type: int
  • Values : 0 = noise removal is disabled, 1 = noise removal is enabled for X, 2 = noise removal is enabled for Y, 3 = noise removal is enabled for X and Y.

◆ PARAM_PEAK_X_FILTER

#define PARAM_PEAK_X_FILTER   "peak_x_filter" 

C# name:  SensorParameter.PeakXFilter

Set X-filter length to smooth the image before the peak detection. X-filter suppresses noise effectively, which allows to use of lower threshold. X-filter functionality can be used to smooth image in X direction before the peak detection.Valid values are 0 (disabled), 3, 5 or 7 pixels. Filter function averages (moving average) the raw image signal in X direction using the given number of pixels.

  • Parameter type: int
  • Values : Default value is 0 = disabled. Eligible values are 3, 5 and 7.

◆ PARAM_RESAMPLE_LINE_X_RESOLUTION

#define PARAM_RESAMPLE_LINE_X_RESOLUTION   "resample_line_x_resolution" 

C# name:  SensorParameter.ResampleLineXResolution

Change the resolution for the profile given in the line callback function. 0, disabled (default) >0, new resolution in micrometers. Must be bigger than the camera native resolution (i.e. for LCI1200 this must be bigger than 5.5 micrometers)

  • Parameter type: float

◆ PARAM_TRIM_EDGES

#define PARAM_TRIM_EDGES   "trim_edges" 

C# name:  SensorParameter.TrimEdges

Edge filter to remove artificial points detected at the end of the surfaces. The filter can be disabled/enabled at runtime in the line callback function and it takes effect on the next processed profiles.

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

◆ PARAM_Z_COMPENSATION_INTERPOLATE

#define PARAM_Z_COMPENSATION_INTERPOLATE   "z_compensation_interpolate" 

C# name:  SensorParameter.ZCompensationInterpolate

Interpolate Z-values for areas removed by removal function (PARAM_Z_COMPENSATION_THRESHOLD).

  • Parameter type: int
  • Values : 0 = interpolation is disabled (default), 1 = interpolation is enabled

◆ PARAM_Z_COMPENSATION_THRESHOLD

#define PARAM_Z_COMPENSATION_THRESHOLD   "z_compensation_threshold" 

C# name:  SensorParameter.ZCompensationThreshold

Remove all Z-coordinates where calculated Z-Compensation would be greater than specified threshold. Intensity values are not removed.

  • Parameter type: float
  • Unit : Micrometers
  • Values Threshold or 0.0 if removal is disabled (default):

◆ PARAM_Z_COMPENSATION_X_BRIGHT_TO_DARK_MUL

#define PARAM_Z_COMPENSATION_X_BRIGHT_TO_DARK_MUL   "z_compensation_x_bright_to_dark_mul" 

C# name:  SensorParameter.ZCompensationXBrightToDarkMul

Z-Compensation multiplication factor for X-edges from bright to dark. Direction is from left to right.
Parameter can be used to adjust compensation for different materials.

  • Parameter type: float
  • Values : 0 = no compensation, 1.0 default

◆ PARAM_Z_COMPENSATION_X_DARK_TO_BRIGHT_MUL

#define PARAM_Z_COMPENSATION_X_DARK_TO_BRIGHT_MUL   "z_compensation_x_dark_to_bright_mul" 

C# name:  SensorParameter.ZCompensationXDarkToBrightMul

Z-Compensation multiplication factor for X-edges from dark to bright. Direction is from left to right.
Parameter can be used to adjust compensation for different materials.

  • Parameter type: float
  • Values : 0 = no compensation, 1.0 default

◆ PARAM_Z_COMPENSATION_X_DIRECTION

#define PARAM_Z_COMPENSATION_X_DIRECTION   "z_compensation_x_direction" 

C# name:  SensorParameter.ZCompensationXDirection

Calculate Z-Compensation for X-direction based on surface texture variations.
The calibration file is loaded once when the calculation is enabled. By default, the file is loaded from c:\FocalSpec\Calibration folder if it is not specified by PARAM_SENSOR_Z_COMPENSATION_FILE.
Calculation is done for LineCallback and BatchCallback functions. Z-Compensation is processed only for the first layer.
Intensity calibration must be disabled when the Z-Compensation is used.

  • Parameter type: int
  • Values : 0 = calculation is disabled (default), 1 = calculation is enabled

◆ PARAM_Z_COMPENSATION_Y_BRIGHT_TO_DARK_MUL

#define PARAM_Z_COMPENSATION_Y_BRIGHT_TO_DARK_MUL   "z_compensation_y_bright_to_dark_mul" 

C# name:  SensorParameter.ZCompensationYBrightToDarkMul

Z-Compensation multiplication factor for Y-edges from bright to dark. Profile order is defined by /ref PARAM_MOVING_DIRECTION .
Parameter can be used to adjust compensation for different materials.

  • Parameter type: float
  • Values : 0 = no compensation, 1.0 default

◆ PARAM_Z_COMPENSATION_Y_DARK_TO_BRIGHT_MUL

#define PARAM_Z_COMPENSATION_Y_DARK_TO_BRIGHT_MUL   "z_compensation_y_dark_to_bright_mul" 

C# name:  SensorParameter.ZCompensationYDarkToBrightMul

Z-Compensation multiplication factor for Y-edges from dark to bright. Profile order is defined by /ref PARAM_MOVING_DIRECTION .
Parameter can be used to adjust compensation for different materials.

  • Parameter type: float
  • Values : 0 = no compensation, 1.0 default

◆ PARAM_Z_COMPENSATION_Y_DIRECTION

#define PARAM_Z_COMPENSATION_Y_DIRECTION   "z_compensation_y_direction" 

C# name:  SensorParameter.ZCompensationYDirection

Calculate Z-Compensation for Y-direction based on surface texture variations.
The calibration file is loaded once when the calculation is enabled. By default, the file is loaded from c:\FocalSpec\Calibration folder if it is not specified by PARAM_SENSOR_Z_COMPENSATION_FILE.
Calculation is done for BatchCallback functions. Z-Compensation is processed only for the first layer.
Intensity calibration must be disabled when the Z-Compensation is used.
Calculation works only with external triggering and PARAM_ENCODER_PULSE_WIDTH must be set properly.

  • Parameter type: int
  • Values : 0 = calculation is disabled (default), 1 = calculation is enabled