Biorbd Release_1.13.0
Loading...
Searching...
No Matches
BIORBD_NAMESPACE::rigidbody::IMUs Class Reference

Hold a set of IMUs. More...

#include <IMUs.h>

Inheritance diagram for BIORBD_NAMESPACE::rigidbody::IMUs:
BIORBD_NAMESPACE::Model

Public Member Functions

 IMUs ()
 Construct inertial measurement units set.
 IMUs (const IMUs &other)
 Construct inertial measurement units set from another set.
virtual ~IMUs ()
 Destroy the class properly.
IMUs DeepCopy () const
 Deep copy of the inertial measurement units data.
void DeepCopy (const IMUs &other)
 Deep copy the inertial measurement units data.
void addIMU (bool technical=true, bool anatomical=true)
 Add a new inertial measurement unit to the set.
void addIMU (const utils::RotoTransNode &RotoTrans, bool technical=true, bool anatomical=true)
 Add a new inertial measurement unit to the set.
size_t nbIMUs () const
 Return the number of inertial measurement units (IMU) in the set.
std::vector< utils::String > IMUsNames ()
 Return the names of the inertial measurement units (IMU).
std::vector< utils::String > technicalIMUsNames ()
 Return the names of the technical inertial measurement units (IMU).
std::vector< utils::String > anatomicalIMUsNames ()
 Return the names of the anatomical inertial measurement units (IMU).
const std::vector< rigidbody::IMU > & IMU () const
 Return all the IMU in the local reference of the segment.
std::vector< rigidbody::IMU > IMU (const utils::String &segmentName)
 Return all the inertial measurement units (IMU) of a segment.
const rigidbody::IMU & IMU (size_t idx)
 Return the inertial measurement unit (IMU) of a specified index.
std::vector< rigidbody::IMU > IMU (const GeneralizedCoordinates &Q, bool updateKin=true)
 Compute and return all the inertial measurement units (IMU) at the position given by Q.
rigidbody::IMU IMU (const GeneralizedCoordinates &Q, size_t idx, bool updateKin=true)
 Compute and return one inertial meausrement unit (IMU) at the position given by Q.
std::vector< rigidbody::IMU > segmentIMU (const GeneralizedCoordinates &Q, size_t idx, bool updateKin=true)
 Return all the inertial measurement units (IMU) on a specified segment.
size_t nbTechIMUs ()
 Return the number of technical inertial measurement units (IMU).
size_t nbAnatIMUs ()
 Return the number of anatomical inertial measurement units (IMU).
std::vector< rigidbody::IMU > technicalIMU (const GeneralizedCoordinates &Q, bool updateKin=true)
 Return all the technical inertial measurement units (IMU).
std::vector< rigidbody::IMU > technicalIMU ()
 Return all the technical inertial measurement units (IMU) in their respective segment local reference frame.
std::vector< rigidbody::IMU > anatomicalIMU (const GeneralizedCoordinates &Q, bool updateKin=true)
 Return all the anatomical inertial measurement units (IMU).
std::vector< rigidbody::IMU > anatomicalIMU ()
 Return all the anatomical inertial measurement units (IMU) in their respective segment local reference frame.
std::vector< utils::Matrix > IMUJacobian (const GeneralizedCoordinates &Q, bool updateKin=true)
 Return the jacobian of the inertial measurement units (IMU).
std::vector< utils::Matrix > TechnicalIMUJacobian (const GeneralizedCoordinates &Q, bool updateKin=true)
 Return the jacobian of the technical inertial measurement units (IMU).

Protected Member Functions

std::vector< utils::Matrix > IMUJacobian (const GeneralizedCoordinates &Q, bool updateKin, bool lookForTechnical)
 Compute and return the jacobian of all the inertial measurement units (IMU).

Protected Attributes

std::shared_ptr< std::vector< rigidbody::IMU > > m_IMUs
 All the inertial Measurement Units.

Detailed Description

Hold a set of IMUs.

Definition at line 22 of file IMUs.h.

Constructor & Destructor Documentation

◆ IMUs() [1/2]

rigidbody::IMUs::IMUs ( )

Construct inertial measurement units set.

Definition at line 18 of file IMUs.cpp.

◆ IMUs() [2/2]

rigidbody::IMUs::IMUs ( const IMUs & other)

Construct inertial measurement units set from another set.

Parameters
otherThe other IMU set

Definition at line 23 of file IMUs.cpp.

◆ ~IMUs()

rigidbody::IMUs::~IMUs ( )
virtual

Destroy the class properly.

Definition at line 25 of file IMUs.cpp.

Member Function Documentation

◆ addIMU() [1/2]

void rigidbody::IMUs::addIMU ( bool technical = true,
bool anatomical = true )

Add a new inertial measurement unit to the set.

Parameters
technicalTrue if the IMU is technical
anatomicalTrue if the IMU is anatomical

Definition at line 40 of file IMUs.cpp.

◆ addIMU() [2/2]

void rigidbody::IMUs::addIMU ( const utils::RotoTransNode & RotoTrans,
bool technical = true,
bool anatomical = true )

Add a new inertial measurement unit to the set.

Parameters
RotoTransThe RotaTrans of the IMU
technicalTrue if the IMU is technical
anatomicalTrue if the IMU is anatomical

Definition at line 45 of file IMUs.cpp.

◆ anatomicalIMU() [1/2]

std::vector< rigidbody::IMU > rigidbody::IMUs::anatomicalIMU ( )

Return all the anatomical inertial measurement units (IMU) in their respective segment local reference frame.

Returns
All the anatomical IMU

Definition at line 134 of file IMUs.cpp.

◆ anatomicalIMU() [2/2]

std::vector< rigidbody::IMU > rigidbody::IMUs::anatomicalIMU ( const GeneralizedCoordinates & Q,
bool updateKin = true )

Return all the anatomical inertial measurement units (IMU).

Parameters
QThe generalized coordinates
updateKinIf the model should be updated
Returns
all the anatomical IMU

Definition at line 122 of file IMUs.cpp.

◆ anatomicalIMUsNames()

std::vector< utils::String > rigidbody::IMUs::anatomicalIMUsNames ( )

Return the names of the anatomical inertial measurement units (IMU).

Returns
The names of the anatomical IMU

Definition at line 252 of file IMUs.cpp.

◆ DeepCopy() [1/2]

rigidbody::IMUs rigidbody::IMUs::DeepCopy ( ) const

Deep copy of the inertial measurement units data.

Returns
A copy of the inertial measurement units data

Definition at line 27 of file IMUs.cpp.

◆ DeepCopy() [2/2]

void rigidbody::IMUs::DeepCopy ( const IMUs & other)

Deep copy the inertial measurement units data.

Parameters
otherThe IMU data to copy

Definition at line 33 of file IMUs.cpp.

◆ IMU() [1/5]

const std::vector< rigidbody::IMU > & rigidbody::IMUs::IMU ( ) const

Return all the IMU in the local reference of the segment.

Returns
All the inertial measurement units in local reference frame

Definition at line 55 of file IMUs.cpp.

◆ IMU() [2/5]

std::vector< rigidbody::IMU > rigidbody::IMUs::IMU ( const GeneralizedCoordinates & Q,
bool updateKin = true )

Compute and return all the inertial measurement units (IMU) at the position given by Q.

Parameters
QThe generalized coordinates
updateKinIf the model should be updated
Returns
All the IMU at the position given by Q

Definition at line 75 of file IMUs.cpp.

◆ IMU() [3/5]

rigidbody::IMU rigidbody::IMUs::IMU ( const GeneralizedCoordinates & Q,
size_t idx,
bool updateKin = true )

Compute and return one inertial meausrement unit (IMU) at the position given by Q.

Parameters
QThe generalized coordinates
idxThe index of the IMU in the set
updateKinIf the model should be updated
Returns
The IMU of index idx at the position given by Q

Definition at line 88 of file IMUs.cpp.

◆ IMU() [4/5]

std::vector< rigidbody::IMU > rigidbody::IMUs::IMU ( const utils::String & segmentName)

Return all the inertial measurement units (IMU) of a segment.

Parameters
segmentNameThe name of the segment to return the IMU
Returns
All the IMU of attached to the segment

Definition at line 59 of file IMUs.cpp.

◆ IMU() [5/5]

const rigidbody::IMU & rigidbody::IMUs::IMU ( size_t idx)

Return the inertial measurement unit (IMU) of a specified index.

Parameters
idxThe index of the IMU in the set
Returns
IMU of idx i

Definition at line 70 of file IMUs.cpp.

◆ IMUJacobian() [1/2]

std::vector< utils::Matrix > rigidbody::IMUs::IMUJacobian ( const GeneralizedCoordinates & Q,
bool updateKin,
bool lookForTechnical )
protected

Compute and return the jacobian of all the inertial measurement units (IMU).

Parameters
QThe generalized coordinates
updateKinIf the model should be updated
lookForTechnicalIf true, only computes for the technical IMU
Returns
The jacobian of all the IMUs

Definition at line 179 of file IMUs.cpp.

◆ IMUJacobian() [2/2]

std::vector< utils::Matrix > rigidbody::IMUs::IMUJacobian ( const GeneralizedCoordinates & Q,
bool updateKin = true )

Return the jacobian of the inertial measurement units (IMU).

Parameters
QThe generalized coordinates
updateKinIf the model should be updated
Returns
The jacobien of the IMU

Definition at line 165 of file IMUs.cpp.

◆ IMUsNames()

std::vector< utils::String > rigidbody::IMUs::IMUsNames ( )

Return the names of the inertial measurement units (IMU).

Returns
The names of the IMU

Definition at line 232 of file IMUs.cpp.

◆ nbAnatIMUs()

size_t rigidbody::IMUs::nbAnatIMUs ( )

Return the number of anatomical inertial measurement units (IMU).

Returns
The number of anatomical IMU

Definition at line 221 of file IMUs.cpp.

◆ nbIMUs()

size_t rigidbody::IMUs::nbIMUs ( ) const

Return the number of inertial measurement units (IMU) in the set.

Returns
The number of IMU

Definition at line 52 of file IMUs.cpp.

◆ nbTechIMUs()

size_t rigidbody::IMUs::nbTechIMUs ( )

Return the number of technical inertial measurement units (IMU).

Returns
The number of technical IMU

Definition at line 210 of file IMUs.cpp.

◆ segmentIMU()

std::vector< rigidbody::IMU > rigidbody::IMUs::segmentIMU ( const GeneralizedCoordinates & Q,
size_t idx,
bool updateKin = true )

Return all the inertial measurement units (IMU) on a specified segment.

Parameters
QThe generalized coordinates
idxThe index of the segment
updateKinIf the model should be updated
Returns
All the IMU on the segment of index idx

Definition at line 143 of file IMUs.cpp.

◆ technicalIMU() [1/2]

std::vector< rigidbody::IMU > rigidbody::IMUs::technicalIMU ( )

Return all the technical inertial measurement units (IMU) in their respective segment local reference frame.

Returns
All the technical IMU

Definition at line 112 of file IMUs.cpp.

◆ technicalIMU() [2/2]

std::vector< rigidbody::IMU > rigidbody::IMUs::technicalIMU ( const GeneralizedCoordinates & Q,
bool updateKin = true )

Return all the technical inertial measurement units (IMU).

Parameters
QThe generalized coordinates
updateKinIf the model should be updated
Returns
all the technical IMU

Definition at line 100 of file IMUs.cpp.

◆ TechnicalIMUJacobian()

std::vector< utils::Matrix > rigidbody::IMUs::TechnicalIMUJacobian ( const GeneralizedCoordinates & Q,
bool updateKin = true )

Return the jacobian of the technical inertial measurement units (IMU).

Parameters
QThe generalized coordinates
updateKinIf the model should be updated
Returns
The jacobian of the technical IMU

Definition at line 172 of file IMUs.cpp.

◆ technicalIMUsNames()

std::vector< utils::String > rigidbody::IMUs::technicalIMUsNames ( )

Return the names of the technical inertial measurement units (IMU).

Returns
The names of the technical IMU

Definition at line 241 of file IMUs.cpp.

Member Data Documentation

◆ m_IMUs

std::shared_ptr<std::vector<rigidbody::IMU> > BIORBD_NAMESPACE::rigidbody::IMUs::m_IMUs
protected

All the inertial Measurement Units.

Definition at line 235 of file IMUs.h.


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