Table of Contents

Class FaroFlsDocument

Namespace
PclIO.Formats.Faro
Assembly
PclIO.dll

Represents a FARO scan stored as a single container file or as a folder structure (.fls).

public sealed class FaroFlsDocument : PclDocument, IDisposable

Inheritance

Implements

Inherited Members

Remarks

The scan grid (rows, columns and angular ranges) is read from the scan parameters of the file; when it is missing or inconsistent, opening fails with System.IO.InvalidDataException. The point count is the declared grid size (limited by the available data for folder scans), not a count of valid returns.

Properties

ColEndAngle

Azimuth angle after the last column, in radians.

public double ColEndAngle { get; }

Property Value

double

Kind

The format kind of this document.

public override PclFileKind Kind { get; }

Property Value

PclFileKind

NumCols

Number of columns (horizontal samples) of the scan grid.

public int NumCols { get; }

Property Value

int

NumRows

Number of rows (vertical samples) of the scan grid.

public int NumRows { get; }

Property Value

int

RowEndAngle

Elevation angle after the last row, in radians.

public double RowEndAngle { get; }

Property Value

double

RowStartAngle

Elevation angle of the first row, in radians.

public double RowStartAngle { get; }

Property Value

double

ScannerModel

Scanner model from the file, or "unknown" when it is not stored.

public string ScannerModel { get; }

Property Value

string

ScannerSerialNumber

Scanner serial number from the file, or "unknown" when it is not stored.

public string ScannerSerialNumber { get; }

Property Value

string

Scans

The scans contained in the document, in file order.

public override IReadOnlyList<PclScan> Scans { get; }

Property Value

IReadOnlyList<PclScan>

Methods

Open(string, PclReadOptions?)

Opens a FARO scan container file or scan folder and reads its scan parameters.

public static FaroFlsDocument Open(string path, PclReadOptions? options = null)

Parameters

path string

Path of a container file, of a scan folder, or of a file inside a scan folder.

options PclReadOptions?

Read options; currently unused when opening.

Returns

FaroFlsDocument

Exceptions

InvalidDataException

The scan grid parameters are missing, malformed or inconsistent.