Biorbd Release_1.13.0
Loading...
Searching...
No Matches
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
 NBIORBD_NAMESPACE
  Ninternal_forces
   Nactuator
    CActuatorClass Actuator
    CActuatorConstantClass ActuatorConstant is a joint actuator type which maximum is contant
    CActuatorGauss3pClass ActuatorGauss3p is a joint actuator type which maximum is 3 parameter gaussian (Gauss3p) Please note that all parameters are given in degrees
    CActuatorGauss6pClass ActuatorGauss6p is a joint actuator type which maximum is bimodal 6 parameter gaussian (Gauss6p) Please note that all parameters are given in degrees
    CActuatorLinearClass ActuatorLinear is a joint actuator type that linearly evolves
    CActuatorsClass holder for a set of actuators
    CActuatorSigmoidGauss3pClass ActuatorSigmoidGauss3p is a joint actuator type which maximum is 3 parameter gaussian (Gauss3p) Please note that all parameters are given in degrees
   Nligaments
    CLigamentBase class of all ligament
    CLigamentCharacteristicsClass Holds that ligament characteristics
    CLigamentConstantBase class for ligament constant
    CLigamentsLigament holder
    CLigamentSpringLinearClass LigamentSpringLinear is a ligament with same behavior than linear spring defined by: k(l-l0) with k is the stiffness
    CLigamentSpringSecondOrderClass LigamentSpringSecondOrder is a ligament with same behavior than second order spring defined by: (k/2) * ((l-l0) + sqrt((l-l0)*(l-l0) + epsilon*epsilon)) with k is the stiffness and espilon a small parameter to avoid negative values. https://ieeexplore.ieee.org/abstract/document/6755458
   Nmuscles
    CCharacteristicsClass Holds that muscle characteristics
    CFatigueDynamicStateClass A state of fatigue that dynamically evolves over the usage of the muscle
    CFatigueDynamicStateXiaImplementation of Xia (https://www.sciencedirect.com/science/article/pii/S0021929008003692) dynamic fatigue model
    CFatigueModelClass Fatigue model of a muscle
    CFatigueParametersClass FatigueParameters that holds the muscle fatigue parameters
    CFatigueStateBase class for Fatigue states models
    CHillDeGrooteActiveOnlyTypeMuscle of Hill type augmented by Thelen (https://simtk-confluence.stanford.edu/display/OpenSim/Thelen+2003+Muscle+Model)
    CHillDeGrooteTypeMuscle based on DeGroote 2016 https://link.springer.com/article/10.1007%2Fs10439-016-1591-9
    CHillDeGrooteTypeFatigableAdd a fatigue model to the HillDeGroote type Note that useful defaults values for the FatigueParameters characteristics are: fatigueRate = 0.01 recoveryRate = 0.002 developFactor = 10 recoverFactor = 10
    CHillThelenActiveOnlyTypeMuscle of Hill type augmented by Thelen (https://simtk-confluence.stanford.edu/display/OpenSim/Thelen+2003+Muscle+Model)
    CHillThelenTypeMuscle of Hill type augmented by Thelen https://simtk-confluence.stanford.edu/display/OpenSim/Thelen+2003+Muscle+Model
    CHillThelenTypeFatigableAdd a fatigue model to the HillThelen type Note that useful defaults values for the FatigueParameters characteristics are: fatigueRate = 0.01 recoveryRate = 0.002 developFactor = 10 recoverFactor = 10
    CHillTypeBase class for all HillType muscles
    CIdealizedActuatorMuscle that has a constant maximal force
    CMuscleBase class of all muscle
    CMuscleGeometryClass muscle geometry of the muscle
    CMuscleGroupA muscle group is muscle that share parents for both origin and insertion
    CMusclesMuscle group holder
    CStateEMG holder to interact with the muscle
    CStateDynamicsEMG with the capability to compute the time derivative
    CStateDynamicsBuchananTime derivative of activation as described by Buchanan (https://www.sciencedirect.com/science/article/pii/S0021929003001520)
    CStateDynamicsDeGrooteEMG with the capability to compute the time derivative
    CStaticOptimizationBase class for a Static Optimization algorithm
    CStaticOptimizationIpoptThe actual implementation of the Static Optimization problem
    CStaticOptimizationIpoptLinearizedThe actual implementation of the Static Optimization problem using a linearized approach
   Npassive_torques
    CPassiveTorqueClass PassiveTorque
    CPassiveTorqueConstantClass PassiveTorqueConstant is a joint passive torque type which maximum is contant
    CPassiveTorqueExponentialClass PassiveTorqueExponential is a joint passive torque type that linearly evolves passive torque is defined by :(B1 * np.exp(k1 * (q-qmid)) + B2 * np.exp(k2 * (q-qmid))) * (1-p_beta*qdot/(s_v*omega_max)) * (q[0] - delta_p) + tau_eq from : https://pubmed.ncbi.nlm.nih.gov/31000347/
    CPassiveTorqueLinearClass PassiveTorqueLinear is a joint passive torque type that linearly evolves Linear passive torque define by : mx+b
    CPassiveTorquesClass holder for a set of passive torques
   CCompoundClass compound is a very generic definition of what a muscle is. It should be the base class of every muscles
   CGeometryClass Geometry of the muscle
   CPathModifiersHolder of all the path modifiers of a muscle
   CViaPointVia point of a muscle
   CWrappingHalfCylinderHalf cylinder of infinite length (the length only affect the graphical representation) object that makes the muscle to wrap around
    CNodeMusclePairPair of 2 muscles points
   CWrappingObjectBase class for the wrapping objects
   CWrappingSphereSphere object that makes the muscle to wrap around
  Nrigidbody
   CContactsClass Contacts
   CExternalForceSetAn External force set that can apply forces to the model while computing the dynamics
    CLocalForcesInternalThis is an internal structure holding the information for the local forces. RotoTransNodes could have suffised, but we need to have a structure that was holding the spatial vector as well
   CGeneralizedAccelerationClass GeneralizedAcceleration
   CGeneralizedCoordinatesClass GeneralizedCoordinates
   CGeneralizedTorqueClass GeneralizedTorque
   CGeneralizedVelocityClass GeneralizedVelocity
   CIMUClass IMU
   CIMUsHold a set of IMUs
   CJointsThis is the core of the musculoskeletal model in biorbd
   CKalmanParamParameters of the reconstruction
   CKalmanReconsClass Kinematic reconstruction algorithm using an Extended Kalman Filter
   CKalmanReconsIMUClass Kinematic reconstruction algorithm using an Extended Kalman Filter for IMU
   CKalmanReconsMarkersClass Kinematic reconstruction algorithm using an Extended Kalman Filter using skin markers
   CMarkersHolder for the marker set
   CMeshA class that holds the geometry of a segment
   CMeshFaceThe face of the mesh
   CNodeSegmentA point attached to a segment, generally speaking a skin marker
   CRotoTransNodesHold a set of RotoTransNodes
   CSegmentDescription of a segment
   CSegmentCharacteristicsCharacteristics of a segment, namely the mass, the center of mass, the inertia, the length and its mesh geometry
   CSoftContactNodeA point attached to a contact node, generally speaking a skin marker
   CSoftContactsHolder for the biorbd contact set
   CSoftContactSphereA point attached to a contact node, generally speaking a skin marker
  Nutils
   CBenchmarkCollection of method to supercifically benchmark the code
   CEquationStrings that are to be interpreted as equation that can be evaluated
   CErrorRaise error or warning while biorbding
   CIfStreamWrapper for the an std::ifstream with increased capacities
   CMatrixA wrapper for the Eigen::MatrixXd
   CMatrix2dA wrapper for the Eigen::MatrixXd
   CMatrix3dA wrapper for the Eigen::MatrixXd
   CNodeA node is an abstract element which is assigned to a parent
   CPathCollection of methods to manipulate path
   CQuaternion
   CRangeClass Range
   CRotationRotation matrix
   CRotoTransHomogenous matrix to describe translations and rotations simultaneously
   CRotoTransNodeA RotoTrans which is attached to a segment
   CSpatialTransformWrapper of the SpatialTransform (rotation and translation)
   CSpatialVectorWrapper of the Eigen::Matrix<double, 6, 1> or Casadi::MX(6, 1)
   CStringWrapper around the std::string class with augmented functionality
   CTimerWrapper around timer function in C++
   CVectorWrapper of the Eigen VectorXd
   CVector2dWrapper around Eigen Vector2d and attach it to a parent
   CVector3dWrapper around Eigen Vector3d and attach it to a parent
  CModelThe actual musculoskeletal model that holds everything in biorbd
  CReaderReader for bioMod files
  CWriterMain class for writer