Class ScanHeadConfiguration

Configuration parameters for a physical scan head.

Inheritance

System.Object

ScanHeadConfiguration

Namespace: JoeScan.Pinchot

Assembly: JoeScan.Pinchot.dll

Syntax

public class ScanHeadConfiguration : ICloneable

Remarks

The ScanHeadConfiguration class provides properties and methods for setting and getting of configuration parameters for a physical scan head. Once created and configured, a ScanHeadConfiguration object is passed to a ScanHead using Configure(ScanHeadConfiguration).

Constructors

ScanHeadConfiguration()

Initializes a new instance of the ScanHeadConfiguration class.

Declaration

public ScanHeadConfiguration()

Properties

DefaultCameraExposureTime

Gets the starting value of the image mode auto-exposure algorithm in microseconds. Use SetCameraExposureTime(Double, Double, Double) to set all camera exposure values. This allows the API to validate that the parameters are valid and consistent.

Declaration

public double DefaultCameraExposureTime { get; }

Property Value

Type	Description
System.Double	The starting value of the image mode auto-exposure algorithm in microseconds.

See Also

SetCameraExposureTime(Double, Double, Double)

DefaultLaserOnTime

Gets the starting value of the auto-exposure algorithm in microseconds. Use SetLaserOnTime(Double, Double, Double) to set all laser timing control values. This allows the API to validate that the parameters are valid and consistent.

Declaration

public double DefaultLaserOnTime { get; }

Property Value

Type	Description
System.Double	The starting value of the auto-exposure algorithm in microseconds.

See Also

SetLaserOnTime(Double, Double, Double)

LaserDetectionThreshold

Gets or sets the minimum brightness a pixel must have to be considered a valid data point.
Value Range: 0-1023
Default : 120

Declaration

public int LaserDetectionThreshold { get; set; }

Property Value

Type	Description
System.Int32	The minimum brightness a pixel must have to be considered a valid data point.

MaxCameraExposureTime

Gets the upper bound of the image mode auto-exposure algorithm in microseconds. Use SetCameraExposureTime(Double, Double, Double) to set all camera exposure values. This allows the API to validate that the parameters are valid and consistent.

Declaration

public double MaxCameraExposureTime { get; }

Property Value

Type	Description
System.Double	The upper bound of the image mode auto-exposure algorithm in microseconds.

See Also

SetCameraExposureTime(Double, Double, Double)

MaxLaserOnTime

Gets the upper bound of the auto-exposure algorithm in microseconds. Use SetLaserOnTime(Double, Double, Double) to set all laser timing control values. This allows the API to validate that the parameters are valid and consistent.

Declaration

public double MaxLaserOnTime { get; }

Property Value

Type	Description
System.Double	The upper bound of the auto-exposure algorithm in microseconds.

See Also

SetLaserOnTime(Double, Double, Double)

MinCameraExposureTime

Gets the lower bound of the image mode auto-exposure algorithm in microseconds. Use SetCameraExposureTime(Double, Double, Double) to set all camera exposure values. This allows the API to validate that the parameters are valid and consistent.

Declaration

public double MinCameraExposureTime { get; }

Property Value

Type	Description
System.Double	The lower bound of the image mode auto-exposure algorithm in microseconds.

See Also

SetCameraExposureTime(Double, Double, Double)

MinLaserOnTime

Gets the lower bound of the auto-exposure algorithm in microseconds. Use SetLaserOnTime(Double, Double, Double) to set all laser timing control values. This allows the API to validate that the parameters are valid and consistent.

Declaration

public double MinLaserOnTime { get; }

Property Value

Type	Description
System.Double	The lower bound of the auto-exposure algorithm in microseconds.

See Also

SetLaserOnTime(Double, Double, Double)

SaturatedPercentage

Gets or sets the maximum percentage of valid pixels in a scan that are allowed to be brighter than SaturationThreshold.
Default: 30 (percent)

Declaration

public int SaturatedPercentage { get; set; }

Property Value

Type	Description
System.Int32	The maximum percentage of valid pixels in a scan that are allowed to be brighter than SaturationThreshold.

SaturationThreshold

Gets or sets the minimum brightness a pixel must have to be considered saturated.
Value Range: 0-1023
Default : 800

Declaration

public int SaturationThreshold { get; set; }

Property Value

Type	Description
System.Int32	The minimum brightness a pixel must have to be considered saturated.

ScanPhaseOffset

Gets or sets the time delay in microseconds to when a scan begins on a given scan head. This can be used to ensure that multiple scan heads are performing scans at distinct points in time rather than at the same time to avoid cross-talk and interference.
Default: 0μs

Declaration

public double ScanPhaseOffset { get; set; }

Property Value

Type	Description
System.Double	The time delay in microseconds to when a scan begins on a given scan head.

Methods

Clone()

ScanHeadConfiguration implements , which is used to make sure that once a ScanHeadConfiguration is set on a ScanHead via Configure(ScanHeadConfiguration), it will not change if the original is changed.

Declaration

public object Clone()

Returns

Type	Description
System.Object	A shallow copy of the ScanHeadConfiguration object.

SetCameraExposureTime(Double, Double, Double)

Sets the clamping values for the image mode auto-exposure algorithm in microseconds. To disable auto-exposure, set minTimeUs, defaultTimeUs and maxTimeUs to the same value.

Declaration

public void SetCameraExposureTime(double minTimeUs, double defaultTimeUs, double maxTimeUs)

Parameters

Type	Name	Description
System.Double	minTimeUs	Lower bound for the image mode auto-exposure algorithm. Value in microseconds. Must be smaller than or equal to defaultTimeUs. Allowed Range 15μs - 2,000,000μs. Default: 10,000μs
System.Double	defaultTimeUs	Starting value for the image mode auto-exposure algorithm. Value in microseconds. Must be smaller than or equal to maxTimeUs. Allowed Range 15μs - 2,000,000μs. Default: 500,000μs
System.Double	maxTimeUs	Upper bound for the image mode auto-exposure algorithm. Value in microseconds. Must be greater than defaultTimeUs. Allowed Range 15μs - 2,000,000μs. Default: 1,000,000μs

SetLaserOnTime(Double, Double, Double)

Sets the clamping values for the auto-exposure algorithm in microseconds. To disable auto-exposure, set minTimeUs, defaultTimeUs and maxTimeUs to the same value.

Declaration

public void SetLaserOnTime(double minTimeUs, double defaultTimeUs, double maxTimeUs)

Parameters

Type	Name	Description
System.Double	minTimeUs	Lower bound for the auto-exposure algorithm. Value in microseconds. Must be smaller than or equal to defaultTimeUs. Allowed Range 15μs - 650,000μs. Default: 100μs
System.Double	defaultTimeUs	Starting value for the auto-exposure algorithm. Value in microseconds. Must be smaller than or equal to maxTimeUs. Allowed Range 15μs - 650,000μs. Default: 500μs
System.Double	maxTimeUs	Upper bound for the auto-exposure algorithm. Value in microseconds. Must be greater than defaultTimeUs. Allowed Range 15μs - 650,000μs. Default: 1000μs