Crate chiron

source ·

Structs§

  • Analog data and parameters are stored as a struct. Definitions for data and parameters are from the C3D file format documentation.
  • Represents a parsed C3D file. Each field contains the data from the corresponding section of the file.
  • The Events struct contains the events from the C3D file header.
  • MarkerPoint contains both the points and residuals for a marker. The residuals are the average distance between the marker and the reconstructed point. Cameras is a bitfield of which cameras saw the marker.
  • The parameters of a C3D file are stored in a Parameters struct. Each group of parameters is stored in a separate struct. The raw_parameters field is a HashMap of HashMaps. The first key is the group name, and the second key is the parameter name. The value is a tuple of the parameter data and the description.
  • Common in older C3D files, this parameter section is used to store parameters related to how the raw data was processed. Although this section is not required, it is recommended to include since it provides useful information about the data if any issues need to be resolved related to collection or processing.
  • The STO struct contains the data for writing an STO file.
  • The TRC struct contains the data for writing a TRC file.

Enums§

  • Analog format describes whether the analog data is signed or unsigned.
  • An offset that is subtracted from the analog data before scaling.
  • Reports errors that occurred while parsing a C3D file. The error type is returned by the load and from_bytes methods.
  • Reports errors that occurred while writing a C3D file. The error type is returned by the write method.
  • All parameter data is stored as a vector of bytes, but the data type and dimensions of the data are also stored in the file. This struct stores the data type and dimensions, and provides methods to convert the data to a more useful format.
  • Processor type enum for determining endianess of the bytes during parsing and writing. Older C3D files may be stored in Dec or SgiMips format. Most modern C3D files are stored in Intel format. A parser that supports all three formats is required to read all C3D files.