Namespace JoeScan::Pinchot¶

Namespace List > JoeScan > Pinchot

Classes¶

Type	Name
class	CameraImage Image data from a scan head.
class	DiscoveredDevice Information of a scan head found on the network.
struct	DiscoveredScanSync Basic information of a ScanSync found on the network.
class	ExclusionMask An exclusion mask determines which pixels on the sensor image should be ignored.
class	Globals Globally available variables.
interface	IFrame Frame data from a scan system.
interface	IProfile Profile data from a scan head.
struct	Point2D A data point consisting of X and Y spatial coordinates and a brightness value. Invalid points have an X and Y value of Globals.ProfileDataInvalidXY and a brightness of Globals.ProfileDataInvalidBrightness.
class	ScanHead An interface to a physical scan head.
class	ScanHeadCapabilities The various physical limits and features of a ScanHead .
class	ScanHeadConfiguration Configuration parameters for a physical scan head.
class	ScanHeadStatus Scan head status data.
struct	ScanHeadVersionInformation Scan head firmware version information.
struct	ScanSyncData Global time synchronization and encoder information sent from the ScanSync to all ScanHead s. This data should only be used for diagnostic purposes. Any relevant optimization information relating to timing or the encoder will be in the IProfile .
class	ScanSyncUpdateEvent Event args passed to the ScanSystem.ScanSyncUpdateEvent event.
struct	ScanSyncVersionInformation ScanSync firmware version information.
class	ScanSystem A complete system of ScanHead s.
class	ScanWindow A scan window within which valid IProfile __ Point2D s are to be measured.
class	StartScanningOptions A set of options for configuring how a ScanSystem should scan.
class	VersionCompatibilityException This exception is thrown when the scan head is not compatible with the operation being performed.
class	VersionInformation API version information.

Public Types¶

Type	Name
enum	Camera Enumeration for identifying a camera on a scan head.
enum	DataFormat Enumeration for identifying scan data format.
enum	DiagnosticImageType Enumeration for configuring the image data type when getting a diagnostic image.
enum	Encoder Enumeration for identifying an encoder on a scan head.
enum uint	EncoderFlags Various input and error conditions of the ScanSync.
enum	Laser Enumeration for identifying a laser on a scan head.
enum uint	ProductType Enumeration for identifying a scan head product type.
enum ulong	ProfileFlags Various conditions that can occur at the moment the profile was captured.
enum	ScanHeadOrientation Enumeration for identifying the orientation of a physical scan head.
enum	ScanHeadState The current state of a ScanHead .
enum	ScanSystemUnits The units that a given ScanSystem and all associated ScanHead s will use for configuration and returned data.
enum	ScanWindowType Enumeration for identifying a scan window type.
enum	ScanningMode Enumeration for setting the scanning mode of the ScanSystem .
enum	TemperatureSensor Enumeration for identifying a temperature sensor on a scan head.

Public Types Documentation¶

Camera¶

Enumeration for identifying a camera on a scan head.

enum Camera {
    Invalid = 0,
    CameraA,
    CameraB
};

DataFormat¶

Enumeration for identifying scan data format.

enum DataFormat {
    XYBrightnessFull = AllDataFormat.XYBrightnessFull,
    XYBrightnessHalf = AllDataFormat.XYBrightnessHalf,
    XYBrightnessQuarter = AllDataFormat.XYBrightnessQuarter,
    XYFull = AllDataFormat.XYFull,
    XYHalf = AllDataFormat.XYHalf,
    XYQuarter = AllDataFormat.XYQuarter
};

DiagnosticImageType¶

Enumeration for configuring the image data type when getting a diagnostic image.

enum DiagnosticImageType {
    Masked = ImageDataType.MERGED_MASK_IMAGE,
    Raw = ImageDataType.RAW_IMAGE
};

Encoder¶

Enumeration for identifying an encoder on a scan head.

enum Encoder {
    Main = EncoderRole.MAIN,
    Auxiliary1 = EncoderRole.AUX_1,
    Auxiliary2 = EncoderRole.AUX_2
};

EncoderFlags¶

Various input and error conditions of the ScanSync.

enum EncoderFlags {
    None = 0,
    EncoderMainFaultA = Server::ScanSyncFlags.FAULT_A,
    EncoderMainFaultB = Server::ScanSyncFlags.FAULT_B,
    EncoderMainFaultY = Server::ScanSyncFlags.FAULT_Y,
    EncoderMainFaultZ = Server::ScanSyncFlags.FAULT_Z,
    EncoderMainOverrun = Server::ScanSyncFlags.OVERRUN,
    EncoderMainTerminationEnable = Server::ScanSyncFlags.TERMINATION_ENABLE,
    EncoderMainIndexZ = Server::ScanSyncFlags.INDEX_Z,
    EncoderMainSync = Server::ScanSyncFlags.SYNC,
    EncoderMainAuxY = Server::ScanSyncFlags.AUX_Y,
    EncoderMainFaultSync = Server::ScanSyncFlags.FAULT_SYNC,
    EncoderMainLaserDisable = Server::ScanSyncFlags.LASER_DISABLE,
    EncoderMainFaultLaserDisable = Server::ScanSyncFlags.FAULT_LASER_DISABLE
};

Laser¶

Enumeration for identifying a laser on a scan head.

enum Laser {
    Invalid = 0,
    Laser1,
    Laser2,
    Laser3,
    Laser4,
    Laser5,
    Laser6,
    Laser7,
    Laser8
};

ProductType¶

Enumeration for identifying a scan head product type.

enum ProductType {
    Invalid = ScanHeadType.INVALID,
    JS50WX = ScanHeadType.JS50WX,
    JS50WSC = ScanHeadType.JS50WSC,
    JS50X6B20 = ScanHeadType.JS50X6B20,
    JS50X6B30 = ScanHeadType.JS50X6B30,
    JS50MX = ScanHeadType.JS50MX,
    JS50Z820 = ScanHeadType.JS50Z820,
    JS50Z830 = ScanHeadType.JS50Z830
};

ProfileFlags¶

Various conditions that can occur at the moment the profile was captured.

enum ProfileFlags {
    None = 0,
    EncoderMainFaultA = EncoderFlags.EncoderMainFaultA,
    EncoderMainFaultB = EncoderFlags.EncoderMainFaultB,
    EncoderMainFaultY = EncoderFlags.EncoderMainFaultY,
    EncoderMainFaultZ = EncoderFlags.EncoderMainFaultZ,
    EncoderMainOverrun = EncoderFlags.EncoderMainOverrun,
    EncoderMainTerminationEnable = EncoderFlags.EncoderMainTerminationEnable,
    EncoderMainIndexZ = EncoderFlags.EncoderMainIndexZ,
    EncoderMainSync = EncoderFlags.EncoderMainSync,
    EncoderMainAuxY = EncoderFlags.EncoderMainAuxY,
    EncoderMainFaultSync = EncoderFlags.EncoderMainFaultSync,
    EncoderMainLaserDisable = EncoderFlags.EncoderMainLaserDisable,
    EncoderMainFaultLaserDisable = EncoderFlags.EncoderMainFaultLaserDisable
};

ScanHeadOrientation¶

Enumeration for identifying the orientation of a physical scan head.

enum ScanHeadOrientation {
    CableIsUpstream,
    CableIsDownstream
};

ScanHeadState¶

The current state of a ScanHead .

enum ScanHeadState {
    Invalid = Server::ScanHeadState.INVALID,
    Standby = Server::ScanHeadState.STANDBY,
    Connected = Server::ScanHeadState.CONNECTED,
    Scanning = Server::ScanHeadState.SCANNING,
    IdleScanning = Server::ScanHeadState.SCANNING_IDLE
};

ScanSystemUnits¶

The units that a given ScanSystem and all associated ScanHead s will use for configuration and returned data.

enum ScanSystemUnits {
    Invalid = 0,
    Inches,
    Millimeters
};

ScanWindowType¶

Enumeration for identifying a scan window type.

enum ScanWindowType {
    Invalid = 0,
    Unconstrained,
    Rectangular,
    Polygonal
};

ScanningMode¶

Enumeration for setting the scanning mode of the ScanSystem .

enum ScanningMode {
    Profile,
    Frame
};

TemperatureSensor¶

Enumeration for identifying a temperature sensor on a scan head.

enum TemperatureSensor {
    CameraA = AllTemperatureSensor.CameraA,
    CameraB = AllTemperatureSensor.CameraB
};