Interface IProfile

Profile data from a scan head.

Namespace: JoeScan.Pinchot

Assembly: JoeScan.Pinchot.dll

Syntax

public interface IProfile

Properties

Camera

Gets the Camera the profile originates from.

Declaration

Camera Camera { get; }

Property Value

Type	Description
Camera	The Camera the profile originates from.

DataFormat

Gets the DataFormat of the profile.

Declaration

DataFormat DataFormat { get; }

Property Value

Type	Description
DataFormat	The DataFormat of the profile.

EncoderValues

Gets the Encoder positions when the profile was generated.

Declaration

IDictionary<Encoder, long> EncoderValues { get; }

Property Value

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

Flags

Gets the various conditions that can occur at the moment the profile was captured.

Declaration

ProfileFlags Flags { get; }

Property Value

Type	Description
ProfileFlags	The ProfileFlags associated with this profile.

Laser

Gets the Laser used to generate the profile.

Declaration

Laser Laser { get; }

Property Value

Type	Description
Laser	The Laser used to generate the profile.

LaserOnTimeUs

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

Declaration

ushort LaserOnTimeUs { get; }

Property Value

Type	Description
ushort	The laser on time in microseconds used to generate the profile.

PacketsExpected

Gets the total number of packets expected to comprise the profile.

Declaration

[Obsolete("Will be removed in a future release.")]
uint PacketsExpected { get; }

Property Value

Type	Description
uint	The total number of packets expected.

PacketsReceived

Gets the number of packets received for the profile. If less than PacketsExpected, then the profile data is incomplete. Generally, this implies some type of network issue.

Declaration

[Obsolete("Will be removed in a future release.")]
uint PacketsReceived { get; }

Property Value

Type	Description
uint	The number of packets received.

RawPoints

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

Declaration

Span<Point2D> RawPoints { get; }

Property Value

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

See Also

GetValidXYPoints()

GetValidXYPoints(Span<Point2D>)

ScanHeadID

Gets the ID of the ScanHead the profile originates from.

Declaration

uint ScanHeadID { get; }

Property Value

Type	Description
uint	The ID of the ScanHead the profile originates from.

SequenceNumber

Gets the monotonically increasing count of profiles generated by the camera associated with this profile.

Declaration

uint SequenceNumber { get; }

Property Value

Type	Description
uint	The count of profiles generated by the camera associated with this profile.

TimestampNs

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

Declaration

ulong TimestampNs { get; }

Property Value

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

ValidPointCount

Gets the number of valid Point2Ds in the profile.

Declaration

uint ValidPointCount { get; }

Property Value

Type	Description
uint	The number of valid Point2Ds in the profile.

Methods

GetValidXYPoints()

Gets the valid Point2Ds in the profile.

Declaration

IEnumerable<Point2D> GetValidXYPoints()

Returns

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

See Also

GetValidXYPoints(Span<Point2D>)

GetValidXYPoints(Span<Point2D>)

Gets the valid Point2Ds in the profile.

Declaration

void GetValidXYPoints(Span<Point2D> validPoints)

Parameters

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

See Also

GetValidXYPoints()