Interface JoeScan::Pinchot::IProfile¶
ClassList > JoeScan > Pinchot > IProfile
Profile data from a scan head.
Inherited by the following classes: JoeScan::Pinchot::Profile
Public Properties¶
| Type | Name |
|---|---|
| property Camera | Camera Gets the Pinchot.Camera the profile originates from. |
| property DataFormat | DataFormat Gets the DataFormat of the profile. |
| property IDictionary< Encoder, long > | EncoderValues Gets the Encoder positions when the profile was generated. |
| property ProfileFlags | Flags Gets the various conditions that can occur at the moment the profile was captured. |
| property Laser | Laser Gets the Pinchot.Laser used to generate the profile. |
| property ushort | LaserOnTimeUs Gets the laser on time in microseconds used to generate the profile. |
| property uint | PacketsExpected Gets the total number of packets expected to comprise the profile. |
| property uint | 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. |
| property Span< Point2D > | RawPoints Gets the Point2D data for the profile, including invalid points. |
| property uint | ScanHeadID Gets the ScanHead.ID of theScanHead the profile originates from. |
| property uint | SequenceNumber Gets the monotonically increasing count of profiles generated by the camera associated with this profile. |
| property ulong | TimestampNs Gets the time of the scan head in nanoseconds when the profile was generated. |
| property uint | ValidPointCount Gets the number of valid Point2D s in the profile. |
Public Functions¶
| Type | Name |
|---|---|
| IEnumerable< Point2D > | GetValidXYPoints () Gets the valid Point2D s in the profile. |
| void | GetValidXYPoints (Span< Point2D > validPoints) Gets the valid Point2D s in the profile. |
Public Properties Documentation¶
property Camera¶
Gets the Pinchot.Camera the profile originates from.
Camera Camera;
The Pinchot.Camera the profile originates from.
property DataFormat¶
Gets the DataFormat of the profile.
DataFormat DataFormat;
The DataFormat of the profile.
property EncoderValues¶
Gets the Encoder positions when the profile was generated.
IDictionary<Encoder, long> EncoderValues;
A IDictionary<TKey,TValue> of encoder positions when the profile was generated.
property Flags¶
Gets the various conditions that can occur at the moment the profile was captured.
ProfileFlags Flags;
The ProfileFlags associated with this profile.
property Laser¶
Gets the Pinchot.Laser used to generate the profile.
Laser Laser;
The Pinchot.Laser used to generate the profile.
property LaserOnTimeUs¶
Gets the laser on time in microseconds used to generate the profile.
ushort LaserOnTimeUs;
The laser on time in microseconds used to generate the profile.
property PacketsExpected¶
Gets the total number of packets expected to comprise the profile.
uint PacketsExpected;
The total number of packets expected.
property 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.
uint PacketsReceived;
The number of packets received.
property RawPoints¶
Gets the Point2D data for the profile, including invalid points.
Span<Point2D> RawPoints;
A Span<T> of Point2D data for the profile.
See also: GetValidXYPoints(), GetValidXYPoints(Span<Point2D>)
property ScanHeadID¶
Gets the ScanHead.ID of theScanHead the profile originates from.
uint ScanHeadID;
The ScanHead.ID of the ScanHead the profile originates from.
property SequenceNumber¶
Gets the monotonically increasing count of profiles generated by the camera associated with this profile.
uint SequenceNumber;
The count of profiles generated by the camera associated with this profile.
property TimestampNs¶
Gets the time of the scan head in nanoseconds when the profile was generated.
ulong TimestampNs;
The time of the scan head in nanoseconds when the profile was generated.
property ValidPointCount¶
Gets the number of valid Point2D s in the profile.
uint ValidPointCount;
The number of valid Point2Ds in the profile.
Public Functions Documentation¶
function GetValidXYPoints [1/2]¶
Gets the valid Point2D s in the profile.
IEnumerable< Point2D > JoeScan::Pinchot::IProfile::GetValidXYPoints ()
Returns:
A IEnumerable<Point2D> of the valid Point2Ds in the profile.
See also: GetValidXYPoints(Span<Point2D>)
function GetValidXYPoints [2/2]¶
Gets the valid Point2D s in the profile.
void JoeScan::Pinchot::IProfile::GetValidXYPoints (
Span< Point2D > validPoints
)
Parameters:
validPointsA 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()