API 4.4.1-2022-10-19-2c4045e59
For MATLAB, Python, Java, and C++ users
OpenSim::APDMDataReader Class Reference

APDMDataReader is a class that reads files produced by IMU manufacturer APDM and produces datatables from them. More...

+ Inheritance diagram for OpenSim::APDMDataReader:

Public Member Functions

 APDMDataReader ()=default
 
 APDMDataReader (const APDMDataReaderSettings &settings)
 
virtual ~APDMDataReader ()=default
 
APDMDataReaderclone () const override
 
- Public Member Functions inherited from OpenSim::IMUDataReader
 IMUDataReader ()=default
 
 IMUDataReader (const IMUDataReader &)=default
 
 IMUDataReader (IMUDataReader &&)=default
 
IMUDataReaderoperator= (const IMUDataReader &)=default
 
IMUDataReaderoperator= (IMUDataReader &&)=default
 
virtual ~IMUDataReader ()=default
 
- Public Member Functions inherited from OpenSim::DataAdapter
 DataAdapter ()=default
 
 DataAdapter (const DataAdapter &)=default
 
 DataAdapter (DataAdapter &&)=default
 
DataAdapteroperator= (const DataAdapter &)=default
 
DataAdapteroperator= (DataAdapter &&)=default
 
virtual ~DataAdapter ()=default
 
DataAdapter::OutputTables read (const std::string &dataSourceSpecification) const
 Public interface to read data from a dataSourceSpecification, typically a file or folder. More...
 
const std::shared_ptr< AbstractDataTablegetDataTable (const OutputTables &tables, const std::string tableName)
 Generic interface to retrieve a specific table by name from read result. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from OpenSim::IMUDataReader
static const TimeSeriesTable_< SimTK::Quaternion_< double > > & getOrientationsTable (const DataAdapter::OutputTables &tables)
 Custom accessors to retrieve tables of proper types without requiring users/scripters to cast. More...
 
static const TimeSeriesTableVec3getLinearAccelerationsTable (const DataAdapter::OutputTables &tables)
 get table of LinearAccelerations as TimeSeriesTableVec3 More...
 
static const TimeSeriesTableVec3getMagneticHeadingTable (const DataAdapter::OutputTables &tables)
 get table of MagneticHeading as TimeSeriesTableVec3 More...
 
static const TimeSeriesTableVec3getAngularVelocityTable (const DataAdapter::OutputTables &tables)
 get table of AngularVelocity as TimeSeriesTableVec3 More...
 
- Static Public Member Functions inherited from OpenSim::DataAdapter
static bool registerDataAdapter (const std::string &identifier, const DataAdapter &adapter)
 Register a concrete DataAdapter by its unique string identifier. More...
 

Detailed Description

APDMDataReader is a class that reads files produced by IMU manufacturer APDM and produces datatables from them.

This is intended to help consume IMU outputs.

Constructor & Destructor Documentation

◆ APDMDataReader() [1/2]

OpenSim::APDMDataReader::APDMDataReader ( )
default

◆ APDMDataReader() [2/2]

OpenSim::APDMDataReader::APDMDataReader ( const APDMDataReaderSettings settings)
inline

◆ ~APDMDataReader()

virtual OpenSim::APDMDataReader::~APDMDataReader ( )
virtualdefault

Member Function Documentation

◆ clone()

APDMDataReader * OpenSim::APDMDataReader::clone ( ) const
overridevirtual

Implements OpenSim::DataAdapter.

◆ extendRead()

DataAdapter::OutputTables OpenSim::APDMDataReader::extendRead ( const std::string &  fileName) const
overrideprotectedvirtual

Typically, APDM can export a trial as one .h5 file (binary that we don't parse as of now) or as .csv ASCII text file that is comma delimited, grouped in order by sensor.

The function below reads the csv file . It produces a list of tables depending on the contents of the file read.

  • One table for rotations,
  • one for LinearAccelerations
  • one for MagneticHeading data,
  • one for AngularVelocity data.
  • Barometer and Temperature data is ignored for now

    See also
    IMUDataReader class for utilities to extract/access specific table(s)

Implements OpenSim::DataAdapter.

◆ extendWrite()

virtual void OpenSim::APDMDataReader::extendWrite ( const DataAdapter::InputTables tables,
const std::string &  sinkName 
) const
inlineoverrideprotectedvirtual

Implements writing functionality, not implemented.


Implements OpenSim::DataAdapter.

◆ getSettings()

const APDMDataReaderSettings & OpenSim::APDMDataReader::getSettings ( ) const
inlineprotected

Method to get const reference to the internal APDMDataReaderSettings object maintained by this reader.

◆ updSettings()

APDMDataReaderSettings & OpenSim::APDMDataReader::updSettings ( )
inlineprotected

Method to get writable reference to the internal APDMDataReaderSettings object maintained by this reader, to allow modification after construction.


The documentation for this class was generated from the following file: