stdlibXtf

Library that read the content of eXtended Triton Format files

Download as .zip Download as .tar.gz View on GitHub

XtfMainHeader (Class)

Namespace: stdlibXtf

An object that represent the header of the XTF document.

Constructors

XtfMainHeader() Initializes a new instance of the XtfMainHeader class that has default zero values.
XtfMainHeader(Byte[]) Initializes a new instance of the XtfMainHeader class that contain the values extracted from the given byte array.

Properties

FileFormat Gets XTF file format version. This value should be 123 as per Triton documentation.
SystemType Gets XTF system type. This value should be 1 as per Triton documentation.
RecordingProgramName Gets the name of the program used to create this XTF file.
The maximum size of the name is of 8 characters. Longer strings will be shortened.
RecordingProgramVersion Gets the version of the program used to create this XTF file.
It's best to use 223, for compability reasons, or 341 for newer format improvments.
The maximum size is of 8 characters. Longer strings will be shortened.
SonarName Gets the name of server used to access sonar.
The maximum size is of 16 characters. Longer strings will be shortened.
SonarType Gets the ID of the sonar type used to acquire the data.
NoteString Gets the annotations.
The maximum size is of 64 characters. Longer strings will be shortened.
ThisFileName Gets the name of this file, as stored in this document.
The maximum size is of 64 characters. Longer strings will be shortened.
NavigationCoordinateUnits Gets the units of the coordinates stored inside this document.
NumberOfSonarChannels Gets the number of sonar channels stored inside this document.
NumberOfBathymetryChannels Gets the number of bathymetry channels stored inside this document.
NumberOfSnippetChannels Gets the number of snippet channels stored inside this document.
NumberOfForwardLookArrays Gets the number of forward look sonar array channels stored inside this document.
NumberOfEchoStrengthChannels Gets the number of echo strength channels stored inside this document.
NumberOfInterferometryChannels Gets the number of interferometry channels stored inside this document.
ReferencePointHeight Gets the height of reference point above water line in meters.
NavigationLatency Gets the latency of nav system in milliceconds. Usually GPS latency.
NavigationOffsetX Gets the offset of nav system. Orientation of positive X is to starboard.
NavigationOffsetY Gets the offset of nav system. Orientation of positive Y is forward.
NavigationOffsetZ Gets the offset of nav system. Orientation of positive Z is down.
NavigationOffsetYaw Gets the offset of nav system. Orientation of positive Yaw is turn to right.
MRUOffsetX Gets the offset of MRU system. Orientation of positive X is to starboard.
MRUOffsetY Gets the offset of MRU system. Orientation of positive Y is forward.
MRUOffsetZ Gets the offset of MRU system. Orientation of positive Z is down.
MRUOffsetYaw Gets the offset of MRU system. Orientation of positive Yaw is turn to right.
MRUOffsetPitch Gets the offset of MRU system. Orientation of positive Pitch is nose up.
MRUOffsetRoll Gets the offset of MRU system. Orientation of positive Roll is lean to starboard.

Examples

example ...

Remarks

remarks ...