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

Holder for the marker set. More...

#include <Markers.h>

Inheritance diagram for BIORBD_NAMESPACE::rigidbody::Markers:
BIORBD_NAMESPACE::Model

Public Member Functions

 Markers ()
 Construct a marker set.
 Markers (const Markers &other)
 Construct markers from another marker set.
virtual ~Markers ()
 Destroy class properly.
Markers DeepCopy () const
 Deep copy of the markers.
void DeepCopy (const Markers &other)
 Deep copy of the markers.
void addMarker (const NodeSegment &pos, const utils::String &name, const utils::String &parentName, bool technical, bool anatomical, const utils::String &axesToRemove, int id=-1)
 Add a marker to the set.
void setMarker (size_t index, const NodeSegment &pos)
 Change the values of a specific marker without changing other parameters.
std::vector< utils::String > markerNames () const
 Return the names of all the markers.
std::vector< utils::String > technicalMarkerNames () const
 Return the names of all the technical markers.
std::vector< utils::String > anatomicalMarkerNames () const
 Return the names of all the anatomical markers.
const NodeSegment & marker (size_t idx) const
 Return a marker of index idx in the marker set.
NodeSegment markerAxesRemoved (size_t idx) const
 Return a marker of index idx in the marker set with the axes removed.
NodeSegment marker (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, const NodeSegment &node, bool removeAxis=true)
 Compute and return the position of a marker at given Q in the global reference frame.
NodeSegment marker (const GeneralizedCoordinates &Q, const NodeSegment &node, bool updateKin=true, bool removeAxis=true)
 Compute and return the position of a marker at given Q in the global reference frame.
NodeSegment marker (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, size_t idx, bool removeAxis=true)
 Compute and return the position of the marker of index idx at given Q in the global reference frame.
NodeSegment marker (const GeneralizedCoordinates &Q, size_t idx, bool updateKin=true, bool removeAxis=true)
 Compute and return the position of the marker of index idx at given Q in the global reference frame.
std::vector< NodeSegment > markers (bool removeAxis=true) const
 Return a copy of all the markers in their respective parent reference frame.
std::vector< NodeSegment > markers (const utils::String &segmentName, bool removeAxis=true) const
 Return the markers on a segment.
std::vector< NodeSegment > markers (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, bool removeAxis=true)
 Return all the markers at a given Q in the global reference frame.
std::vector< NodeSegment > markers (const GeneralizedCoordinates &Q, bool updateKin=true, bool removeAxis=true)
 Return all the markers at a given Q in the global reference frame.
NodeSegment markerVelocity (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, size_t idx, bool removeAxis=true)
 Return the linear velocity of a marker.
NodeSegment markerVelocity (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, size_t idx, bool updateKin=true, bool removeAxis=true)
 Return the linear velocity of a marker.
NodeSegment markerAngularVelocity (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, size_t idx, bool removeAxis=true)
 Return the angular velocity of a marker.
NodeSegment markerAngularVelocity (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, size_t idx, bool updateKin=true, bool removeAxis=true)
 Return the angular velocity of a marker.
std::vector< NodeSegment > markersVelocity (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, bool removeAxis=true)
 Return the linear velocity of all the markers.
std::vector< NodeSegment > markersVelocity (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, bool updateKin=true, bool removeAxis=true)
 Return the linear velocity of all the markers.
std::vector< NodeSegment > markersAngularVelocity (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, bool removeAxis=true)
 Return the angular velocity of all the markers.
std::vector< NodeSegment > markersAngularVelocity (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, bool updateKin=true, bool removeAxis=true)
 Return the angular velocity of all the markers.
NodeSegment markerAcceleration (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration &Qddot, size_t idx, bool removeAxis=true)
 Return the acceleration of a marker.
NodeSegment markerAcceleration (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration &Qddot, size_t idx, bool updateKin=true, bool removeAxis=true)
 Return the acceleration of a marker.
std::vector< NodeSegment > markerAcceleration (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration &dQdot, bool removeAxis=true)
 Return the acceleration of all the markers.
std::vector< NodeSegment > markerAcceleration (const GeneralizedCoordinates &Q, const GeneralizedVelocity &Qdot, const rigidbody::GeneralizedAcceleration &dQdot, bool updateKin=true, bool removeAxis=true)
 Return the acceleration of all the markers.
std::vector< NodeSegment > technicalMarkers (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, bool removeAxis=true)
 Return all the technical markers at a given Q in the global reference frame.
std::vector< NodeSegment > technicalMarkers (const GeneralizedCoordinates &Q, bool updateKin=true, bool removeAxis=true)
 Return all the technical markers at a given Q in the global reference frame.
std::vector< NodeSegment > technicalMarkers () const
 Return the technical markers in their respective parent reference frame.
std::vector< NodeSegment > technicalMarkersAxesRemoved () const
 Return the technical markers in their respective parent reference frame.
std::vector< NodeSegment > anatomicalMarkers (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, bool removeAxis=true)
 Return all the anatomical markers at a given Q in the global reference frame.
std::vector< NodeSegment > anatomicalMarkers (const GeneralizedCoordinates &Q, bool updateKin=true, bool removeAxis=true)
 Return all the anatomical markers at a given Q in the global reference frame.
std::vector< NodeSegment > anatomicalMarkers () const
 Return the anatomical markers in their respective parent reference frame.
std::vector< NodeSegment > anatomicalMarkersAxesRemoved () const
 Return the anatomical markers in their respective parent reference frame.
std::vector< NodeSegment > segmentMarkers (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, size_t idx, bool removeAxis=true)
 Return all the markers of the segment idx at a given Q in the global reference frame.
std::vector< NodeSegment > segmentMarkers (const GeneralizedCoordinates &Q, size_t idx, bool updateKin=true, bool removeAxis=true)
 Return all the markers of the segment idx at a given Q in the global reference frame.
size_t nbMarkers () const
 Return the number of markers.
size_t nbMarkers (size_t idxSegment) const
 Return the number of markers on the segment idxSegment.
size_t nbTechnicalMarkers ()
 Return the number of technical markers.
size_t nbTechnicalMarkers (size_t idxSegment)
 Return the number of technical markers on the segment idxSegment.
size_t nbAnatomicalMarkers ()
 Return the number of anatomical markers.
std::vector< utils::Matrix > markersJacobian (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, bool removeAxis=true)
 Return the jacobian of the markers.
std::vector< utils::Matrix > markersJacobian (const GeneralizedCoordinates &Q, bool updateKin=true, bool removeAxis=true)
 Return the jacobian of the markers.
std::vector< utils::Matrix > technicalMarkersJacobian (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, bool removeAxis=true)
 Return the jacobian of the technical markers.
std::vector< utils::Matrix > technicalMarkersJacobian (const GeneralizedCoordinates &Q, bool updateKin=true, bool removeAxis=true)
 Return the jacobian of the technical markers.
utils::Matrix markersJacobian (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, const utils::String &parentName, const NodeSegment &p, bool removeAxis=true)
 Return the jacobian of a chosen marker.
utils::Matrix markersJacobian (const GeneralizedCoordinates &Q, const utils::String &parentName, const NodeSegment &p, bool updateKin=true, bool removeAxis=true)
 Return the jacobian of a chosen marker.
bool inverseKinematics (const std::vector< NodeSegment > &markers, const GeneralizedCoordinates &Qinit, GeneralizedCoordinates &Q, bool removeAxis=true)
 Performs an inverse kinematics.

Protected Member Functions

std::vector< utils::Matrix > markersJacobian (rigidbody::Joints &updatedModel, const GeneralizedCoordinates &Q, bool lookForTechnical, bool removeAxis)
 Compute the jacobian of the markers.

Protected Attributes

std::shared_ptr< std::vector< NodeSegment > > m_marks
 The markers.

Detailed Description

Holder for the marker set.

Definition at line 26 of file Markers.h.

Constructor & Destructor Documentation

◆ Markers() [1/2]

rigidbody::Markers::Markers ( )

Construct a marker set.

Definition at line 21 of file Markers.cpp.

◆ Markers() [2/2]

rigidbody::Markers::Markers ( const Markers & other)

Construct markers from another marker set.

Parameters
otherThe other marker set

Definition at line 26 of file Markers.cpp.

◆ ~Markers()

rigidbody::Markers::~Markers ( )
virtual

Destroy class properly.

Definition at line 29 of file Markers.cpp.

Member Function Documentation

◆ addMarker()

void rigidbody::Markers::addMarker ( const NodeSegment & pos,
const utils::String & name,
const utils::String & parentName,
bool technical,
bool anatomical,
const utils::String & axesToRemove,
int id = -1 )

Add a marker to the set.

Parameters
posThe position of the marker
nameThe name of the marker
parentNameThe name of the segment the marker is attached on
technicalIf the marker is technical
anatomicalIf the marker is anatomical
axesToRemoveAxes to remove while projecting the marker
idThe index of the parent segment

Definition at line 47 of file Markers.cpp.

◆ anatomicalMarkerNames()

std::vector< utils::String > rigidbody::Markers::anatomicalMarkerNames ( ) const

Return the names of all the anatomical markers.

Returns
The names of the anatomical markers

Definition at line 731 of file Markers.cpp.

◆ anatomicalMarkers() [1/3]

std::vector< rigidbody::NodeSegment > rigidbody::Markers::anatomicalMarkers ( ) const

Return the anatomical markers in their respective parent reference frame.

Returns
A vector of all the anatomical markers in their parent reference frame

Definition at line 464 of file Markers.cpp.

◆ anatomicalMarkers() [2/3]

std::vector< rigidbody::NodeSegment > rigidbody::Markers::anatomicalMarkers ( const GeneralizedCoordinates & Q,
bool updateKin = true,
bool removeAxis = true )

Return all the anatomical markers at a given Q in the global reference frame.

Parameters
QThe generalized coordinates
updateKinIf the model should be updated
removeAxisIf there are axis to remove from the position variables
Returns
A vector of all the anatomical markers

Definition at line 448 of file Markers.cpp.

◆ anatomicalMarkers() [3/3]

std::vector< rigidbody::NodeSegment > rigidbody::Markers::anatomicalMarkers ( rigidbody::Joints & updatedModel,
const GeneralizedCoordinates & Q,
bool removeAxis = true )

Return all the anatomical markers at a given Q in the global reference frame.

Parameters
updatedModelThe joint model updated to the proper kinematics level
QThe generalized coordinates
removeAxisIf there are axis to remove from the position variables
Returns
A vector of all the anatomical markers

Definition at line 435 of file Markers.cpp.

◆ anatomicalMarkersAxesRemoved()

std::vector< rigidbody::NodeSegment > rigidbody::Markers::anatomicalMarkersAxesRemoved ( ) const

Return the anatomical markers in their respective parent reference frame.

Returns
A vector of all the anatomical markers in their parent reference frame

Definition at line 475 of file Markers.cpp.

◆ DeepCopy() [1/2]

rigidbody::Markers rigidbody::Markers::DeepCopy ( ) const

Deep copy of the markers.

Returns
Deep copy of the markers

Definition at line 33 of file Markers.cpp.

◆ DeepCopy() [2/2]

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

Deep copy of the markers.

Parameters
otherThe markers to copy from

Definition at line 39 of file Markers.cpp.

◆ inverseKinematics()

bool rigidbody::Markers::inverseKinematics ( const std::vector< NodeSegment > & markers,
const GeneralizedCoordinates & Qinit,
GeneralizedCoordinates & Q,
bool removeAxis = true )

Performs an inverse kinematics.

Parameters
markersThe markers to track
QinitThe initial guess for the generalized coordinates
QThe generalized coordinates (output) that tracks the markers
removeAxisIf the axesToRemove should be removed
Returns
If the problem converged

Definition at line 612 of file Markers.cpp.

◆ marker() [1/5]

rigidbody::NodeSegment rigidbody::Markers::marker ( const GeneralizedCoordinates & Q,
const NodeSegment & node,
bool updateKin = true,
bool removeAxis = true )

Compute and return the position of a marker at given Q in the global reference frame.

Parameters
QThe generalized coordinates
nodeThe position of the marker in its parent reference frame
updateKinIf the model should be updated
removeAxisIf there are axis to remove from the position variables
Returns
The marker in the global reference frame

Definition at line 80 of file Markers.cpp.

◆ marker() [2/5]

rigidbody::NodeSegment rigidbody::Markers::marker ( const GeneralizedCoordinates & Q,
size_t idx,
bool updateKin = true,
bool removeAxis = true )

Compute and return the position of the marker of index idx at given Q in the global reference frame.

Parameters
QThe generalized coordinates
idxThe index of the marker in the marker set
updateKinIf the model should be updated
removeAxisIf there are axis to remove from the position variables
Returns
The marker idx in the global reference frame

Definition at line 116 of file Markers.cpp.

◆ marker() [3/5]

rigidbody::NodeSegment rigidbody::Markers::marker ( rigidbody::Joints & updatedModel,
const GeneralizedCoordinates & Q,
const NodeSegment & node,
bool removeAxis = true )

Compute and return the position of a marker at given Q in the global reference frame.

Parameters
updatedModelThe joint model updated to the proper kinematics level
QThe generalized coordinates
nodeThe position of the marker in its parent reference frame
removeAxisIf there are axis to remove from the position variables
Returns
The marker in the global reference frame

Definition at line 107 of file Markers.cpp.

◆ marker() [4/5]

rigidbody::NodeSegment rigidbody::Markers::marker ( rigidbody::Joints & updatedModel,
const GeneralizedCoordinates & Q,
size_t idx,
bool removeAxis = true )

Compute and return the position of the marker of index idx at given Q in the global reference frame.

Parameters
updatedModelThe joint model updated to the proper kinematics level
QThe generalized coordinates
idxThe index of the marker in the marker set
removeAxisIf there are axis to remove from the position variables
Returns
The marker idx in the global reference frame

Definition at line 124 of file Markers.cpp.

◆ marker() [5/5]

const rigidbody::NodeSegment & rigidbody::Markers::marker ( size_t idx) const

Return a marker of index idx in the marker set.

Parameters
idxThe index of the marker
Returns
The marker of index idx

Definition at line 72 of file Markers.cpp.

◆ markerAcceleration() [1/4]

std::vector< rigidbody::NodeSegment > rigidbody::Markers::markerAcceleration ( const GeneralizedCoordinates & Q,
const GeneralizedVelocity & Qdot,
const rigidbody::GeneralizedAcceleration & dQdot,
bool updateKin = true,
bool removeAxis = true )

Return the acceleration of all the markers.

Parameters
QThe generalized coordinates
QdotThe generalized velocities
dQdotThe generalized accelerations
updateKinIf the model should be updated
removeAxisIf there are axis to remove from the position variables
Returns
The acceleration of all the markers

Definition at line 364 of file Markers.cpp.

◆ markerAcceleration() [2/4]

rigidbody::NodeSegment rigidbody::Markers::markerAcceleration ( const GeneralizedCoordinates & Q,
const GeneralizedVelocity & Qdot,
const rigidbody::GeneralizedAcceleration & Qddot,
size_t idx,
bool updateKin = true,
bool removeAxis = true )

Return the acceleration of a marker.

Parameters
QThe generalized coordinates
QdotThe generalized velocities
QddotThe generalized accelerations
idxThe index of the marker in the marker set
updateKinIf the model should be updated
removeAxisIf there are axis to remove from the position variables
Returns
The acceleration of a marker

Definition at line 329 of file Markers.cpp.

◆ markerAcceleration() [3/4]

std::vector< rigidbody::NodeSegment > rigidbody::Markers::markerAcceleration ( rigidbody::Joints & updatedModel,
const GeneralizedCoordinates & Q,
const GeneralizedVelocity & Qdot,
const rigidbody::GeneralizedAcceleration & dQdot,
bool removeAxis = true )

Return the acceleration of all the markers.

Parameters
updatedModelThe joint model updated to the proper kinematics level
QThe generalized coordinates
QdotThe generalized velocities
dQdotThe generalized accelerations
removeAxisIf there are axis to remove from the position variables
Returns
The acceleration of all the markers

Definition at line 349 of file Markers.cpp.

◆ markerAcceleration() [4/4]

rigidbody::NodeSegment rigidbody::Markers::markerAcceleration ( rigidbody::Joints & updatedModel,
const GeneralizedCoordinates & Q,
const GeneralizedVelocity & Qdot,
const rigidbody::GeneralizedAcceleration & Qddot,
size_t idx,
bool removeAxis = true )

Return the acceleration of a marker.

Parameters
updatedModelThe joint model updated to the proper kinematics level
QThe generalized coordinates
QdotThe generalized velocities
QddotThe generalized accelerations
idxThe index of the marker in the marker set
removeAxisIf there are axis to remove from the position variables
Returns
The acceleration of a marker

Definition at line 311 of file Markers.cpp.

◆ markerAngularVelocity() [1/2]

rigidbody::NodeSegment rigidbody::Markers::markerAngularVelocity ( const GeneralizedCoordinates & Q,
const GeneralizedVelocity & Qdot,
size_t idx,
bool updateKin = true,
bool removeAxis = true )

Return the angular velocity of a marker.

Parameters
QThe generalized coordinates
QdotThe generalized velocities
idxThe index of the marker in the marker set
updateKinIf the model should be updated
removeAxisIf there are axis to remove from the position variables
Returns
The angular velocity of a marker

Definition at line 235 of file Markers.cpp.

◆ markerAngularVelocity() [2/2]

rigidbody::NodeSegment rigidbody::Markers::markerAngularVelocity ( rigidbody::Joints & updatedModel,
const GeneralizedCoordinates & Q,
const GeneralizedVelocity & Qdot,
size_t idx,
bool removeAxis = true )

Return the angular velocity of a marker.

Parameters
updatedModelThe joint model updated to the proper kinematics level
QThe generalized coordinates
QdotThe generalized velocities
idxThe index of the marker in the marker set
removeAxisIf there are axis to remove from the position variables
Returns
The angular velocity of a marker

Definition at line 216 of file Markers.cpp.

◆ markerAxesRemoved()

rigidbody::NodeSegment rigidbody::Markers::markerAxesRemoved ( size_t idx) const

Return a marker of index idx in the marker set with the axes removed.

Parameters
idxThe index of the marker
Returns
The marker of index idx

Definition at line 76 of file Markers.cpp.

◆ markerNames()

std::vector< utils::String > rigidbody::Markers::markerNames ( ) const

Return the names of all the markers.

Returns
The names of the markers

Definition at line 710 of file Markers.cpp.

◆ markers() [1/4]

std::vector< rigidbody::NodeSegment > rigidbody::Markers::markers ( bool removeAxis = true) const

Return a copy of all the markers in their respective parent reference frame.

Parameters
removeAxisIf there are axis to remove from the position variables
Returns
All the markers

Definition at line 133 of file Markers.cpp.

◆ markers() [2/4]

std::vector< rigidbody::NodeSegment > rigidbody::Markers::markers ( const GeneralizedCoordinates & Q,
bool updateKin = true,
bool removeAxis = true )

Return all the markers at a given Q in the global reference frame.

Parameters
QThe generalized coordinates
updateKinIf the model should be updated
removeAxisIf there are axis to remove from the position variables
Returns
All the markers in the global reference frame

Definition at line 169 of file Markers.cpp.

◆ markers() [3/4]

std::vector< rigidbody::NodeSegment > rigidbody::Markers::markers ( const utils::String & segmentName,
bool removeAxis = true ) const

Return the markers on a segment.

Parameters
segmentNameName of the segment
removeAxisIf there are axis to remove from the position variables
Returns
The markers on the segment

Definition at line 143 of file Markers.cpp.

◆ markers() [4/4]

std::vector< rigidbody::NodeSegment > rigidbody::Markers::markers ( rigidbody::Joints & updatedModel,
const GeneralizedCoordinates & Q,
bool removeAxis = true )

Return all the markers at a given Q in the global reference frame.

Parameters
updatedModelThe joint model updated to the proper kinematics level
QThe generalized coordinates
removeAxisIf there are axis to remove from the position variables
Returns
All the markers in the global reference frame

Definition at line 157 of file Markers.cpp.

◆ markersAngularVelocity() [1/2]

std::vector< rigidbody::NodeSegment > rigidbody::Markers::markersAngularVelocity ( const GeneralizedCoordinates & Q,
const GeneralizedVelocity & Qdot,
bool updateKin = true,
bool removeAxis = true )

Return the angular velocity of all the markers.

Parameters
QThe generalized coordinates
QdotThe generalized velocities
updateKinIf the model should be updated
removeAxisIf there are axis to remove from the position variables
Returns
The angular velocity of all the markers

Definition at line 295 of file Markers.cpp.

◆ markersAngularVelocity() [2/2]

std::vector< rigidbody::NodeSegment > rigidbody::Markers::markersAngularVelocity ( rigidbody::Joints & updatedModel,
const GeneralizedCoordinates & Q,
const GeneralizedVelocity & Qdot,
bool removeAxis = true )

Return the angular velocity of all the markers.

Parameters
updatedModelThe joint model updated to the proper kinematics level
QThe generalized coordinates
QdotThe generalized velocities
removeAxisIf there are axis to remove from the position variables
Returns
The angular velocity of all the markers

Definition at line 283 of file Markers.cpp.

◆ markersJacobian() [1/5]

std::vector< utils::Matrix > rigidbody::Markers::markersJacobian ( const GeneralizedCoordinates & Q,
bool updateKin = true,
bool removeAxis = true )

Return the jacobian of the markers.

Parameters
QThe generalized coordinates
updateKinIf the model should be updated
removeAxisIf there are axis to remove from the position variables
Returns
The jacobian of the markers

Definition at line 545 of file Markers.cpp.

◆ markersJacobian() [2/5]

utils::Matrix rigidbody::Markers::markersJacobian ( const GeneralizedCoordinates & Q,
const utils::String & parentName,
const NodeSegment & p,
bool updateKin = true,
bool removeAxis = true )

Return the jacobian of a chosen marker.

Parameters
QThe generalized coordinates of the model
parentNameThe name of the segment the marker lies on
pThe position of the point in the parent reference frame
updateKinIf the model should be updated
removeAxisIf there are axis to remove from the position variables
Returns
The jacobian of the chosen marker

Definition at line 594 of file Markers.cpp.

◆ markersJacobian() [3/5]

std::vector< utils::Matrix > rigidbody::Markers::markersJacobian ( rigidbody::Joints & updatedModel,
const GeneralizedCoordinates & Q,
bool lookForTechnical,
bool removeAxis )
protected

Compute the jacobian of the markers.

Parameters
updatedModelThe joint model updated to the proper kinematics level
QThe generalized coordinates
lookForTechnicalCheck if only technical markers are to be computed
removeAxisIf there are axis to remove from the position variables
Returns
The jacobian of the markers

Definition at line 648 of file Markers.cpp.

◆ markersJacobian() [4/5]

std::vector< utils::Matrix > rigidbody::Markers::markersJacobian ( rigidbody::Joints & updatedModel,
const GeneralizedCoordinates & Q,
bool removeAxis = true )

Return the jacobian of the markers.

Parameters
updatedModelThe joint model updated to the proper kinematics level
QThe generalized coordinates
removeAxisIf there are axis to remove from the position variables
Returns
The jacobian of the markers

Definition at line 538 of file Markers.cpp.

◆ markersJacobian() [5/5]

utils::Matrix rigidbody::Markers::markersJacobian ( rigidbody::Joints & updatedModel,
const GeneralizedCoordinates & Q,
const utils::String & parentName,
const NodeSegment & p,
bool removeAxis = true )

Return the jacobian of a chosen marker.

Parameters
updatedModelThe joint model updated to the proper kinematics level
QThe generalized coordinates of the model
parentNameThe name of the segment the marker lies on
pThe position of the point in the parent reference frame
removeAxisIf there are axis to remove from the position variables
Returns
The jacobian of the chosen marker

Definition at line 583 of file Markers.cpp.

◆ markersVelocity() [1/2]

std::vector< rigidbody::NodeSegment > rigidbody::Markers::markersVelocity ( const GeneralizedCoordinates & Q,
const GeneralizedVelocity & Qdot,
bool updateKin = true,
bool removeAxis = true )

Return the linear velocity of all the markers.

Parameters
QThe generalized coordinates
QdotThe generalized velocities
updateKinIf the model should be updated
removeAxisIf there are axis to remove from the position variables
Returns
The linear velocity of all the markers

Definition at line 267 of file Markers.cpp.

◆ markersVelocity() [2/2]

std::vector< rigidbody::NodeSegment > rigidbody::Markers::markersVelocity ( rigidbody::Joints & updatedModel,
const GeneralizedCoordinates & Q,
const GeneralizedVelocity & Qdot,
bool removeAxis = true )

Return the linear velocity of all the markers.

Parameters
updatedModelThe joint model updated to the proper kinematics level
QThe generalized coordinates
QdotThe generalized velocities
removeAxisIf there are axis to remove from the position variables
Returns
The linear velocity of all the markers

Definition at line 253 of file Markers.cpp.

◆ markerVelocity() [1/2]

rigidbody::NodeSegment rigidbody::Markers::markerVelocity ( const GeneralizedCoordinates & Q,
const GeneralizedVelocity & Qdot,
size_t idx,
bool updateKin = true,
bool removeAxis = true )

Return the linear velocity of a marker.

Parameters
QThe generalized coordinates
QdotThe generalized velocities
idxThe index of the marker in the marker set
updateKinIf the model should be updated
removeAxisIf there are axis to remove from the position variables
Returns
The linear velocity of a marker

Definition at line 198 of file Markers.cpp.

◆ markerVelocity() [2/2]

rigidbody::NodeSegment rigidbody::Markers::markerVelocity ( rigidbody::Joints & updatedModel,
const GeneralizedCoordinates & Q,
const GeneralizedVelocity & Qdot,
size_t idx,
bool removeAxis = true )

Return the linear velocity of a marker.

Parameters
updatedModelThe joint model updated to the proper kinematics level
QThe generalized coordinates
QdotThe generalized velocities
idxThe index of the marker in the marker set
removeAxisIf there are axis to remove from the position variables
Returns
The linear velocity of a marker

Definition at line 185 of file Markers.cpp.

◆ nbAnatomicalMarkers()

size_t rigidbody::Markers::nbAnatomicalMarkers ( )

Return the number of anatomical markers.

Returns
The number of anatomical markers

Definition at line 699 of file Markers.cpp.

◆ nbMarkers() [1/2]

size_t rigidbody::Markers::nbMarkers ( ) const

Return the number of markers.

Returns
The number of markers

Definition at line 518 of file Markers.cpp.

◆ nbMarkers() [2/2]

size_t rigidbody::Markers::nbMarkers ( size_t idxSegment) const

Return the number of markers on the segment idxSegment.

Parameters
idxSegmentThe index of the segment
Returns
The number of markers of segment idxSegment

Definition at line 520 of file Markers.cpp.

◆ nbTechnicalMarkers() [1/2]

size_t rigidbody::Markers::nbTechnicalMarkers ( )

Return the number of technical markers.

Returns
The number of technical markers

Definition at line 670 of file Markers.cpp.

◆ nbTechnicalMarkers() [2/2]

size_t rigidbody::Markers::nbTechnicalMarkers ( size_t idxSegment)

Return the number of technical markers on the segment idxSegment.

Parameters
idxSegmentThe index of the segment
Returns
The number of technical markers of segment idxSegment

Definition at line 681 of file Markers.cpp.

◆ segmentMarkers() [1/2]

std::vector< rigidbody::NodeSegment > rigidbody::Markers::segmentMarkers ( const GeneralizedCoordinates & Q,
size_t idx,
bool updateKin = true,
bool removeAxis = true )

Return all the markers of the segment idx at a given Q in the global reference frame.

Parameters
QThe generalized coordinates
idxThe index of the segment
updateKinIf the model should be updated
removeAxisIf there are axis to remove from the position variables
Returns
All the markers of the segment idx

Definition at line 502 of file Markers.cpp.

◆ segmentMarkers() [2/2]

std::vector< rigidbody::NodeSegment > rigidbody::Markers::segmentMarkers ( rigidbody::Joints & updatedModel,
const GeneralizedCoordinates & Q,
size_t idx,
bool removeAxis = true )

Return all the markers of the segment idx at a given Q in the global reference frame.

Parameters
updatedModelThe joint model updated to the proper kinematics level
QThe generalized coordinates
idxThe index of the segment
removeAxisIf there are axis to remove from the position variables
Returns
All the markers of the segment idx

Definition at line 483 of file Markers.cpp.

◆ setMarker()

void rigidbody::Markers::setMarker ( size_t index,
const NodeSegment & pos )

Change the values of a specific marker without changing other parameters.

Parameters
indexThe index of the marker to change. If biorbd is compiled with SKIP_ASSERT, then no check is performed to ensure index is within bounds
posThe new position of the marker

Definition at line 60 of file Markers.cpp.

◆ technicalMarkerNames()

std::vector< utils::String > rigidbody::Markers::technicalMarkerNames ( ) const

Return the names of all the technical markers.

Returns
The names of the technical markers

Definition at line 720 of file Markers.cpp.

◆ technicalMarkers() [1/3]

std::vector< rigidbody::NodeSegment > rigidbody::Markers::technicalMarkers ( ) const

Return the technical markers in their respective parent reference frame.

Returns
A vector of all the technical markers in their parent reference frame

Definition at line 414 of file Markers.cpp.

◆ technicalMarkers() [2/3]

std::vector< rigidbody::NodeSegment > rigidbody::Markers::technicalMarkers ( const GeneralizedCoordinates & Q,
bool updateKin = true,
bool removeAxis = true )

Return all the technical markers at a given Q in the global reference frame.

Parameters
QThe generalized coordinates
updateKinIf the model should be updated
removeAxisIf there are axis to remove from the position variables
Returns
A vector of all the technical markers

Definition at line 398 of file Markers.cpp.

◆ technicalMarkers() [3/3]

std::vector< rigidbody::NodeSegment > rigidbody::Markers::technicalMarkers ( rigidbody::Joints & updatedModel,
const GeneralizedCoordinates & Q,
bool removeAxis = true )

Return all the technical markers at a given Q in the global reference frame.

Parameters
updatedModelThe joint model updated to the proper kinematics level
QThe generalized coordinates
removeAxisIf there are axis to remove from the position variables
Returns
A vector of all the technical markers

Definition at line 384 of file Markers.cpp.

◆ technicalMarkersAxesRemoved()

std::vector< rigidbody::NodeSegment > rigidbody::Markers::technicalMarkersAxesRemoved ( ) const

Return the technical markers in their respective parent reference frame.

Returns
A vector of all the technical markers in their parent reference frame

Definition at line 426 of file Markers.cpp.

◆ technicalMarkersJacobian() [1/2]

std::vector< utils::Matrix > rigidbody::Markers::technicalMarkersJacobian ( const GeneralizedCoordinates & Q,
bool updateKin = true,
bool removeAxis = true )

Return the jacobian of the technical markers.

Parameters
QThe generalized coordinates
updateKinIf the model should be updated
removeAxisIf there are axis to remove from the position variables
Returns
The jacobian of the technical markers

Definition at line 568 of file Markers.cpp.

◆ technicalMarkersJacobian() [2/2]

std::vector< utils::Matrix > rigidbody::Markers::technicalMarkersJacobian ( rigidbody::Joints & updatedModel,
const GeneralizedCoordinates & Q,
bool removeAxis = true )

Return the jacobian of the technical markers.

Parameters
updatedModelThe joint model updated to the proper kinematics level
QThe generalized coordinates
removeAxisIf there are axis to remove from the position variables
Returns
The jacobian of the technical markers

Definition at line 561 of file Markers.cpp.

Member Data Documentation

◆ m_marks

std::shared_ptr<std::vector<NodeSegment> > BIORBD_NAMESPACE::rigidbody::Markers::m_marks
protected

The markers.

Definition at line 664 of file Markers.h.


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