Class ScanHeadConfiguration

Configuration parameters for a physical scan head.

Inheritance

object

ScanHeadConfiguration

Implements

ICloneable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: JoeScan.Pinchot

Assembly: JoeScan.Pinchot.dll

Syntax

public class ScanHeadConfiguration : ICloneable

Remarks

This 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()

Remarks

This 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).

Properties

DefaultCameraExposureTimeUs

Gets the starting value of the image mode auto-exposure algorithm in microseconds.

Declaration

[Obsolete("Camera exposure is only used when getting a diagnostic image.")]
public uint DefaultCameraExposureTimeUs { get; }

Property Value

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

Remarks

This 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).

DefaultLaserOnTimeUs

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

Declaration

public uint DefaultLaserOnTimeUs { get; }

Property Value

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

Remarks

This 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).

See Also

SetLaserOnTime(uint, uint, uint)

IdleScanPeriodUs

Gets or sets the rate at which profiles should be queued when in an idle state. See MinimumEncoderTravel on how a scan head can drop to an idle state.

Declaration

public uint IdleScanPeriodUs { get; set; }

Property Value

Type	Description
uint	The scan period in microseconds of a scan head in an idle state.

Remarks

This 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).

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 uint LaserDetectionThreshold { get; set; }

Property Value

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

Remarks

This 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).

Exceptions

Type	Condition
ArgumentOutOfRangeException	Value out of range (0 - 1023)

MaxCameraExposureTimeUs

Gets the upper bound of the image mode auto-exposure algorithm in microseconds.

Declaration

[Obsolete("Camera exposure is only used when getting a diagnostic image.")]
public uint MaxCameraExposureTimeUs { get; }

Property Value

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

Remarks

This 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).

MaxLaserOnTimeUs

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

Declaration

public uint MaxLaserOnTimeUs { get; }

Property Value

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

Remarks

This 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).

See Also

SetLaserOnTime(uint, uint, uint)

MinCameraExposureTimeUs

Gets the lower bound of the image mode auto-exposure algorithm in microseconds.

Declaration

[Obsolete("Camera exposure is only used when getting a diagnostic image.")]
public uint MinCameraExposureTimeUs { get; }

Property Value

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

Remarks

This 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).

MinLaserOnTimeUs

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

Declaration

public uint MinLaserOnTimeUs { get; }

Property Value

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

Remarks

This 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).

See Also

SetLaserOnTime(uint, uint, uint)

MinimumEncoderTravel

Gets or sets the minimum number of encoder counts that must occur between the previous and the current profile to drop the scan head into an idle state. In an idle state, the rate at which profiles are queued is determined by IdleScanPeriodUs.

Declaration

public uint MinimumEncoderTravel { get; set; }

Property Value

Type	Description
uint	The minimum number of encoder counts between profiles needed to keep the scan head out of an idle state.

Remarks

Only Main is observed.

SaturationPercentage

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 uint SaturationPercentage { get; set; }

Property Value

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

Remarks

This 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).

Exceptions

Type	Condition
ArgumentOutOfRangeException	Value out of range (1 - 100)

SaturationThreshold

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

Declaration

public uint SaturationThreshold { get; set; }

Property Value

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

Remarks

This 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).

Exceptions

Type	Condition
ArgumentOutOfRangeException	Value out of range (0 - 1023)

Methods

Clone()

ScanHeadConfiguration implements ICloneable, 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
object	A shallow copy of the ScanHeadConfiguration object.

Remarks

This 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).

SetCameraExposureTime(uint, uint, uint)

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

[Obsolete("Camera exposure is only used when getting a diagnostic image.")]
public void SetCameraExposureTime(uint minTimeUs, uint defaultTimeUs, uint maxTimeUs)

Parameters

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

Remarks

This 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).

Exceptions

Type	Condition
ArgumentException	minTimeUs must be less or equal to defaultTimeUs -or- maxTimeUs must be greater or equal to defaultTimeUs

SetLaserOnTime(uint, uint, uint)

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(uint minTimeUs, uint defaultTimeUs, uint maxTimeUs)

Parameters

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

Remarks

This 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).

Exceptions

Type	Condition
ArgumentException	minTimeUs must be less or equal to defaultTimeUs -or- maxTimeUs must be greater or equal to defaultTimeUs

Implements

ICloneable