Class CameraImage

Image data from a scan head.

Inheritance

object

CameraImage

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 CameraImage

Remarks

The camera image 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 camera image originates from.

Declaration

public Camera Camera { get; }

Property Value

Type	Description
Camera	The Camera the camera image originates from.

Remarks

The camera image 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.

Data

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

Declaration

public byte[] Data { get; }

Property Value

Type	Description
byte[]	The array of bytes representing the pixel data.

Remarks

The camera image 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.

EncoderValues

Gets the encoder positions when the camera image was generated.

Declaration

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

Property Value

Type	Description
IDictionary<Encoder, long>	A IDictionary<TKey, TValue> of encoder positions when the camera image was generated.

Remarks

The camera image 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.

ExposureTimeUs

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

Declaration

public uint ExposureTimeUs { get; }

Property Value

Type	Description
uint	The camera exposure time in microseconds used to generate the camera image.

Remarks

The camera image 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.

Height

Gets the height of the image in pixels.

Declaration

public uint Height { get; }

Property Value

Type	Description
uint	The height of the image in pixels.

Remarks

The camera image 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.

Laser

Gets the Laser used to generate the camera image.

Declaration

public Laser Laser { get; }

Property Value

Type	Description
Laser	The Laser used to generate the camera image.

Remarks

The camera image 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.

LaserOnTimeUs

Gets the laser on time in microseconds used to generate the camera image.

Declaration

public uint LaserOnTimeUs { get; }

Property Value

Type	Description
uint	The laser on time in microseconds used to generate the camera image.

Remarks

The camera image 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.

ScanHeadID

Gets the ID of the ScanHead the camera image originates from.

Declaration

public uint ScanHeadID { get; }

Property Value

Type	Description
uint	The ID of the ScanHead the camera image originates from.

Remarks

The camera image 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.

Timestamp

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

Declaration

public ulong Timestamp { get; }

Property Value

Type	Description
ulong	The time of the scan head in nanoseconds when the camera image was generated.

Remarks

The camera image 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.

Width

Gets the width of the image in pixels.

Declaration

public uint Width { get; }

Property Value

Type	Description
uint	The width of the image in pixels.

Remarks

The camera image 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.