Class ScanHeadBeta

Beta functionality for a scan head. These functions are for preliminary testing and should be used with the expectation that the signature might change in a future revision.

Inheritance

object

ScanHeadBeta

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: JoeScan.Pinchot.Beta

Assembly: JoeScan.Pinchot.dll

Syntax

public static class ScanHeadBeta

Methods

CreateBrightnessCorrection(ScanHead)

Creates a new BrightnessCorrection with the dimension of the camera(s) of the scan head.

Declaration

public static BrightnessCorrection CreateBrightnessCorrection(this ScanHead scanHead)

Parameters

Type	Name	Description
ScanHead	scanHead

Returns

Type	Description
BrightnessCorrection	A default BrightnessCorrection.

SetBrightnessCorrection(ScanHead, Camera, BrightnessCorrection)

Sets the BrightnessCorrection for the camera supplied.

Declaration

public static void SetBrightnessCorrection(this ScanHead scanHead, Camera camera, BrightnessCorrection correction)

Parameters

Type	Name	Description
ScanHead	scanHead	The scan head that the correction will be applied to.
Camera	camera	The Camera that the correction will be applied to.
BrightnessCorrection	correction	The BrightnessCorrection to be applied.

Remarks

This is a beta feature that may be changed in the future. It is is offered here to provide access to functionality that may prove useful to end users and allow them to submit feedback back to JoeScan. In a future release, this code may change; care should be taken when adding to applications. For any questions, reach out to a JoeScan representative for guidance.

Exceptions

Type	Condition
InvalidOperationException	IsScanning is true.
ArgumentNullException	correction is null.
ArgumentException	Trying to use a camera-driven function with a laser-driven scan head. Use SetBrightnessCorrection(ScanHead, Laser, BrightnessCorrection) instead.

SetBrightnessCorrection(ScanHead, Laser, BrightnessCorrection)

Sets the BrightnessCorrection for the laser supplied.

Declaration

public static void SetBrightnessCorrection(this ScanHead scanHead, Laser laser, BrightnessCorrection correction)

Parameters

Type	Name	Description
ScanHead	scanHead	The scan head that the correction will be applied to.
Laser	laser	The Laser that the correction will be applied to.
BrightnessCorrection	correction	The BrightnessCorrection to be applied.

Remarks

This is a beta feature that may be changed in the future. It is is offered here to provide access to functionality that may prove useful to end users and allow them to submit feedback back to JoeScan. In a future release, this code may change; care should be taken when adding to applications. For any questions, reach out to a JoeScan representative for guidance.

Exceptions

Type	Condition
InvalidOperationException	IsScanning is true.
ArgumentNullException	correction is null.
ArgumentException	Trying to use a laser-driven function with a camera-driven scan head. Use SetBrightnessCorrection(ScanHead, Camera, BrightnessCorrection) instead.