Class CameraImage

Image data from a scan head.

Inheritance

System.Object

CameraImage

Namespace: JoeScan.Pinchot

Assembly: JoeScan.Pinchot.dll

Syntax

public class CameraImage : object

Remarks

The CameraImage class provides properties and methods for accessing the information contained in an image received from a scan head. The properties include the image pixel data, timestamp, encoder values, and other properties.

Properties

Camera

Gets the Camera the CameraImage originates from.

Declaration

public Camera Camera { get; }

Property Value

Type	Description
Camera	The Camera the CameraImage originates from.

Data

Gets the of s representing the pixel data. Pixel data is one per pixel, Width pixels per row, Height rows per image.

Declaration

public IList<byte> Data { get; }

Property Value

Type	Description
IList<System.Byte>	The of s representing the pixel data.

DataFormat

Gets the DataFormat of the CameraImage.

Declaration

public DataFormat DataFormat { get; }

Property Value

Type	Description
DataFormat	The DataFormat of the CameraImage.

EncoderValues

Gets the encoder positions when the CameraImage was generated.

Declaration

public IDictionary<Encoder, long> EncoderValues { get; }

Property Value

Type	Description
IDictionary<Encoder, System.Int64>	A of encoder positions when the CameraImage was generated.

ExposureTime

Gets the camera exposure time in microseconds used to generate the CameraImage.

Declaration

public double ExposureTime { get; }

Property Value

Type	Description
System.Double	The camera exposure time in microseconds used to generate the CameraImage.

Height

Gets the height of the image in pixels.

Declaration

public int Height { get; }

Property Value

Type	Description
System.Int32	The height of the image in pixels.

Laser

Gets the Laser used to generate the CameraImage.

Declaration

public Laser Laser { get; }

Property Value

Type	Description
Laser	The Laser used to generate the CameraImage.

LaserOnTime

Gets the laser on time in microseconds used to generate the CameraImage.

Declaration

public double LaserOnTime { get; }

Property Value

Type	Description
System.Double	The laser on time in microseconds used to generate the CameraImage.

ScanHeadID

Gets the ID of the ScanHead the CameraImage originates from.

Declaration

public uint ScanHeadID { get; }

Property Value

Type	Description
System.UInt32	The ID of the ScanHead the CameraImage originates from.

Timestamp

Gets the time of the scan head in nanoseconds when the CameraImage was generated.

Declaration

public long Timestamp { get; }

Property Value

Type	Description
System.Int64	The time of the scan head in nanoseconds when the CameraImage was generated.

Width

Gets the width of the image in pixels.

Declaration

public int Width { get; }

Property Value

Type	Description
System.Int32	The width of the image in pixels.