Class JoeScan::Pinchot::Profile¶
ClassList > JoeScan > Pinchot > Profile
Profile data from a scan head.
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.
Inherits the following classes: JoeScan::Pinchot::IProfile, ICloneable
Public Properties¶
| Type | Name |
|---|---|
| property Camera | Camera |
| property DataFormat | DataFormat |
| property IDictionary< Encoder, long > | EncoderValues |
| property ProfileFlags | Flags |
| property Laser | Laser |
| property ushort | LaserOnTimeUs |
| property uint | PacketsExpected |
| property uint | PacketsReceived |
| property Span< Point2D > | RawPoints |
| property uint | ScanHeadID |
| property uint | SequenceNumber |
| property ulong | TimestampNs |
| property uint | ValidPointCount |
Public Properties inherited from JoeScan::Pinchot::IProfile¶
See JoeScan::Pinchot::IProfile
| 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 |
|---|---|
| object | Clone () IProfile implements ICloneable. |
| IEnumerable< Point2D > | GetValidXYPoints () |
| void | GetValidXYPoints (Span< Point2D > validPoints) |
Public Functions inherited from JoeScan::Pinchot::IProfile¶
See JoeScan::Pinchot::IProfile
| 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¶
Camera Camera;
property DataFormat¶
DataFormat DataFormat;
property EncoderValues¶
IDictionary<Encoder, long> EncoderValues;
property Flags¶
ProfileFlags Flags;
property Laser¶
Laser Laser;
property LaserOnTimeUs¶
ushort LaserOnTimeUs;
property PacketsExpected¶
uint PacketsExpected;
property PacketsReceived¶
uint PacketsReceived;
property RawPoints¶
Span<Point2D> RawPoints;
property ScanHeadID¶
uint ScanHeadID;
property SequenceNumber¶
uint SequenceNumber;
property TimestampNs¶
ulong TimestampNs;
property ValidPointCount¶
uint ValidPointCount;
Public Functions Documentation¶
function Clone¶
IProfile implements ICloneable.
inline object JoeScan::Pinchot::Profile::Clone ()
Returns:
A shallow copy of the IProfile object.
function GetValidXYPoints [1/2]¶
inline IEnumerable< Point2D > JoeScan::Pinchot::Profile::GetValidXYPoints ()
function GetValidXYPoints [2/2]¶
inline void JoeScan::Pinchot::Profile::GetValidXYPoints (
Span< Point2D > validPoints
)
The documentation for this class was generated from the following file C:/Users/michp/Documents/Projects/fawkes/client-net/Api/src/JoeScan.Pinchot/src/Profile.cs