Table of Contents

Class PinPointDocument

Namespace
PclIO.Formats.PinPoint
Assembly
PclIO.dll

Represents a PinPoint / PointCab laser scanning project (.srf, .smf, ScanProject.json).

public sealed class PinPointDocument : PclDocument, IDisposable

Inheritance

Implements

Inherited Members

Remarks

Only the project manifest (scan names, ids, poses and, when present, point counts) is read from the JSON. Point data is streamed from the referenced .bin files. Unknown values stay unknown: a scan whose point count is not stored in the manifest and cannot be derived from its channel table reports a count of 0.

Properties

Kind

The format kind of this document.

public override PclFileKind Kind { get; }

Property Value

PclFileKind

ProjectName

Project name from the manifest, or the file name when the manifest has none.

public string ProjectName { 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 PinPoint project from a manifest file, a .srf file with its data folder, or a project folder.

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

Parameters

path string

Manifest (.smf, ScanProject.json), .srf file or project directory. When a directory holds several candidates and no ScanProject.json, the first .smf file in ordinal file-name order is used, else the first .srf file.

options PclReadOptions?

Currently unused; accepted for symmetry with the other readers.

Returns

PinPointDocument

Exceptions

FileNotFoundException

No manifest was found.

InvalidDataException

The manifest is not valid JSON, contains an invalid string, is too large, or names unsafe paths.