Class Profile

Profile data from a scan head.

Inheritance

System.Object

Profile

Namespace: JoeScan.Pinchot

Assembly: JoeScan.Pinchot.dll

Syntax

public class Profile : ICloneable

Remarks

The Profile class provides properties and methods for accessing the information contained in a profile received from a scan head. The properties include the raw Point2D data, timestamp, encoder values, and other properties. Methods for retrieving only valid Point2D data are also provided.

Properties

Camera

Gets the Camera the Profile originates from.

Declaration

public Camera Camera { get; }

Property Value

Type	Description
Camera	The Camera the Profile originates from.

DataFormat

Gets the DataFormat of the Profile.

Declaration

public DataFormat DataFormat { get; }

Property Value

Type	Description
DataFormat	The DataFormat of the Profile.

EncoderValues

Gets the encoder positions when the Profile was generated.

Declaration

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

Property Value

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

Laser

Gets the Laser used to generate the Profile.

Declaration

public Laser Laser { get; }

Property Value

Type	Description
Laser	The Laser used to generate the Profile.

LaserOnTime

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

Declaration

public double LaserOnTime { get; }

Property Value

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

RawPoints

Gets the Point2D data for the Profile, including invalid points.

Declaration

public Span<Point2D> RawPoints { get; }

Property Value

Type	Description
Span<Point2D>	A of Point2D data for the Profile.

ScanHeadID

Gets the ID of the ScanHead the Profile originates from.

Declaration

public uint ScanHeadID { get; }

Property Value

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

Timestamp

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

Declaration

public long Timestamp { get; }

Property Value

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

ValidPointCount

Gets the number of valid Point2Ds in RawPoints.

Declaration

public int ValidPointCount { get; }

Property Value

Type	Description
System.Int32	The number of valid Point2Ds in RawPoints.

Methods

Clone()

Profile implements .

Declaration

public object Clone()

Returns

Type	Description
System.Object	A shallow copy of the Profile object.

GetValidXYPoints()

Gets the valid Point2Ds in the Profile.

Declaration

public IEnumerable<Point2D> GetValidXYPoints()

Returns

Type	Description
IEnumerable<Point2D>	A of the valid Point2Ds in the Profile.

GetValidXYPoints(Span<Point2D>)

Gets the valid Point2Ds in the Profile.

Declaration

public void GetValidXYPoints(Span<Point2D> validPoints)

Parameters

Type	Name	Description
Span<Point2D>	validPoints	A of Point2D that is the storage location for the valid Point2Ds. Must be of length greater than or equal to ValidPointCount.