Class Holds that muscle characteristics. More...

#include <Characteristics.h>

Public Member Functions
	Characteristics ()
	Construct characteristics.

	Characteristics (const biorbd::muscles::Characteristics &other)
	Construct characteristics from other characteristics. More...

	Characteristics (const biorbd::utils::Scalar &optLength, const biorbd::utils::Scalar &fmax, const biorbd::utils::Scalar &PCSA, const biorbd::utils::Scalar &tendonSlackLength, const biorbd::utils::Scalar &pennAngle, const biorbd::muscles::State &emgMax, const biorbd::muscles::FatigueParameters &fatigueParameters, const biorbd::utils::Scalar &torqueAct=0.01, const biorbd::utils::Scalar &torqueDeact=0.04, const biorbd::utils::Scalar &minAct=0.01)
	Construct characteristics. More...

virtual	~Characteristics ()
	Destroy the class properly.

biorbd::muscles::Characteristics	DeepCopy () const
	Deep copy of characteristics. More...

void	DeepCopy (const biorbd::muscles::Characteristics &other)
	Deep copy of characteristics from another characteristics. More...

void	setOptimalLength (const biorbd::utils::Scalar &val)
	Set the length without tension. More...

virtual const biorbd::utils::Scalar &	optimalLength () const
	Return the optimal length at which maximal force occurs. More...

virtual void	setForceIsoMax (const biorbd::utils::Scalar &val)
	Set the maximal isometric force. More...

const biorbd::utils::Scalar &	forceIsoMax () const
	Return the maximal isometric force at optimal length. More...

void	setTendonSlackLength (const biorbd::utils::Scalar &val)
	Set the tendon slack length. More...

const biorbd::utils::Scalar &	tendonSlackLength () const
	Return the tendon slack length. More...

void	setPennationAngle (const biorbd::utils::Scalar &val)
	Set the angle of pennation. More...

const biorbd::utils::Scalar &	pennationAngle () const
	Return the angle of pennation. More...

void	setPCSA (const biorbd::utils::Scalar &val)
	Set the physiological cross-sectional area of the muscle. More...

const biorbd::utils::Scalar &	PCSA () const
	Return the physiological cross-sectional area of the muscle. More...

void	setMinActivation (const biorbd::utils::Scalar &val)
	Set the minimal activation of the muscle. More...

const biorbd::utils::Scalar &	minActivation () const
	Return the minimal activation of the muscle. More...

void	setTorqueActivation (const biorbd::utils::Scalar &val)
	Set the time activation constant. More...

const biorbd::utils::Scalar &	torqueActivation () const
	Return the time activation constant. More...

void	setTorqueDeactivation (const biorbd::utils::Scalar &val)
	Set the time deactivation constant. More...

const biorbd::utils::Scalar &	torqueDeactivation () const
	Return the time deactivation constant. More...

void	setStateMax (const biorbd::muscles::State &emgMax)
	Set the maximal excitation and activation of the muscle. More...

const biorbd::muscles::State &	stateMax () const
	Return the maximal excitation and activation of the muscle. More...

void	setFatigueParameters (const biorbd::muscles::FatigueParameters &fatigueParameters)
	Set the fatigue parameters. More...

const biorbd::muscles::FatigueParameters &	fatigueParameters () const
	Return the fatigue parameters. More...

Protected Attributes
std::shared_ptr< biorbd::utils::Scalar >	m_optimalLength
	Length without tension.

std::shared_ptr< biorbd::utils::Scalar >	m_fIsoMax
	Maximal isometric force Force maximale isométrique.

std::shared_ptr< biorbd::utils::Scalar >	m_PCSA
	Physiological cross-sectional area of the muscle.

std::shared_ptr< biorbd::utils::Scalar >	m_tendonSlackLength
	Tendon slack length.

std::shared_ptr< biorbd::utils::Scalar >	m_pennationAngle
	Angle of pennation.

std::shared_ptr< biorbd::muscles::State >	m_stateMax
	Maximal excitation et activation of the muscle.

std::shared_ptr< biorbd::utils::Scalar >	m_minActivation
	Minimal activation.

std::shared_ptr< biorbd::utils::Scalar >	m_torqueActivation
	Time activation constant.

std::shared_ptr< biorbd::utils::Scalar >	m_torqueDeactivation
	Time deactivation constant.

std::shared_ptr< biorbd::muscles::FatigueParameters >	m_fatigueParameters
	Fatigue parameters.

Detailed Description

Class Holds that muscle characteristics.

Definition at line 16 of file Characteristics.h.

Constructor & Destructor Documentation

◆ Characteristics() [1/2]

biorbd::muscles::Characteristics::Characteristics ( const biorbd::muscles::Characteristics & other )

Construct characteristics from other characteristics.

Parameters

other The other characteristics

Definition at line 22 of file Characteristics.cpp.

◆ Characteristics() [2/2]

biorbd::muscles::Characteristics::Characteristics	(	const biorbd::utils::Scalar &	optLength,
		const biorbd::utils::Scalar &	fmax,
		const biorbd::utils::Scalar &	PCSA,
		const biorbd::utils::Scalar &	tendonSlackLength,
		const biorbd::utils::Scalar &	pennAngle,
		const biorbd::muscles::State &	emgMax,
		const biorbd::muscles::FatigueParameters &	fatigueParameters,
		const biorbd::utils::Scalar &	torqueAct = `0.01`,
		const biorbd::utils::Scalar &	torqueDeact = `0.04`,
		const biorbd::utils::Scalar &	minAct = `0.01`
	)

Construct characteristics.

Parameters

optLength	Optimal length (where maximal force occurs)
fmax	The maximal isometric force at optimal length
PCSA	Physiological cross-sectional area of the muscle
tendonSlackLength	The tendon slack length
pennAngle	The angle of pennation
emgMax	Maximal excitation and activation of the muscle
fatigueParameters	The fatigue model
torqueAct	Time activation constant (default: 0.01)
torqueDeact	Time deactivation constant (default: 0.04)
minAct	Minimal activation (default: 0.01)

Definition at line 38 of file Characteristics.cpp.

Member Function Documentation

◆ DeepCopy() [1/2]

biorbd::muscles::Characteristics biorbd::muscles::Characteristics::DeepCopy ( ) const

Deep copy of characteristics.

Returns: A depp copy of characteristics

Definition at line 68 of file Characteristics.cpp.

◆ DeepCopy() [2/2]

void biorbd::muscles::Characteristics::DeepCopy ( const biorbd::muscles::Characteristics & other )

Deep copy of characteristics from another characteristics.

Parameters

other The characteristics to copy from

Definition at line 75 of file Characteristics.cpp.

◆ fatigueParameters()

const biorbd::muscles::FatigueParameters & biorbd::muscles::Characteristics::fatigueParameters ( ) const

Return the fatigue parameters.

Returns: The fatigue parameters

Definition at line 184 of file Characteristics.cpp.

◆ forceIsoMax()

const biorbd::utils::Scalar & biorbd::muscles::Characteristics::forceIsoMax ( ) const

Return the maximal isometric force at optimal length.

Returns: The maximal isometric force

Definition at line 106 of file Characteristics.cpp.

◆ minActivation()

const biorbd::utils::Scalar & biorbd::muscles::Characteristics::minActivation ( ) const

Return the minimal activation of the muscle.

Returns: The minimal activation of the muscle

Definition at line 146 of file Characteristics.cpp.

◆ optimalLength()

const biorbd::utils::Scalar & biorbd::muscles::Characteristics::optimalLength ( ) const

virtual

Return the optimal length at which maximal force occurs.

Returns: The length without tension

Definition at line 96 of file Characteristics.cpp.

◆ PCSA()

const biorbd::utils::Scalar & biorbd::muscles::Characteristics::PCSA ( ) const

Return the physiological cross-sectional area of the muscle.

Returns: The physiological cross-sectional area of the muscle

Definition at line 136 of file Characteristics.cpp.

◆ pennationAngle()

const biorbd::utils::Scalar & biorbd::muscles::Characteristics::pennationAngle ( ) const

Return the angle of pennation.

Returns: The angle of pennation

Definition at line 126 of file Characteristics.cpp.

◆ setFatigueParameters()

void biorbd::muscles::Characteristics::setFatigueParameters ( const biorbd::muscles::FatigueParameters & fatigueParameters )

Set the fatigue parameters.

Parameters

fatigueParameters The values of the fatigue parameters

Definition at line 180 of file Characteristics.cpp.

◆ setForceIsoMax()

void biorbd::muscles::Characteristics::setForceIsoMax ( const biorbd::utils::Scalar & val )

virtual

Set the maximal isometric force.

Parameters

val	Value of the maximal isometric force

Definition at line 101 of file Characteristics.cpp.

◆ setMinActivation()

void biorbd::muscles::Characteristics::setMinActivation ( const biorbd::utils::Scalar & val )

Set the minimal activation of the muscle.

Parameters

val	The value of the minimal activation of the muscle

Definition at line 141 of file Characteristics.cpp.

◆ setOptimalLength()

void biorbd::muscles::Characteristics::setOptimalLength ( const biorbd::utils::Scalar & val )

Set the length without tension.

Parameters

val	Value of the length without tension

Definition at line 91 of file Characteristics.cpp.

◆ setPCSA()

void biorbd::muscles::Characteristics::setPCSA ( const biorbd::utils::Scalar & val )

Set the physiological cross-sectional area of the muscle.

Parameters

val	Value of the physiological cross-sectional area of the muscle

Definition at line 131 of file Characteristics.cpp.

◆ setPennationAngle()

void biorbd::muscles::Characteristics::setPennationAngle ( const biorbd::utils::Scalar & val )

Set the angle of pennation.

Parameters

val	Value of the angle of pennation

Definition at line 121 of file Characteristics.cpp.

◆ setStateMax()

void biorbd::muscles::Characteristics::setStateMax ( const biorbd::muscles::State & emgMax )

Set the maximal excitation and activation of the muscle.

Parameters

emgMax Value of the maximal excitation and activation of the muscle

Definition at line 172 of file Characteristics.cpp.

◆ setTendonSlackLength()

void biorbd::muscles::Characteristics::setTendonSlackLength ( const biorbd::utils::Scalar & val )

Set the tendon slack length.

Parameters

val	Value of the tendon slack length

Definition at line 111 of file Characteristics.cpp.

◆ setTorqueActivation()

void biorbd::muscles::Characteristics::setTorqueActivation ( const biorbd::utils::Scalar & val )

Set the time activation constant.

Parameters

val	The value of the time activation constant

Definition at line 151 of file Characteristics.cpp.

◆ setTorqueDeactivation()

void biorbd::muscles::Characteristics::setTorqueDeactivation ( const biorbd::utils::Scalar & val )

Set the time deactivation constant.

Parameters

val	The value of the time deactivation constant

Definition at line 161 of file Characteristics.cpp.

◆ stateMax()

const biorbd::muscles::State & biorbd::muscles::Characteristics::stateMax ( ) const

Return the maximal excitation and activation of the muscle.

Returns: The maximal excitation and activation of the muscle

Definition at line 176 of file Characteristics.cpp.

◆ tendonSlackLength()

const biorbd::utils::Scalar & biorbd::muscles::Characteristics::tendonSlackLength ( ) const

Return the tendon slack length.

Returns: The tendon slack length

Definition at line 116 of file Characteristics.cpp.

◆ torqueActivation()

const biorbd::utils::Scalar & biorbd::muscles::Characteristics::torqueActivation ( ) const

Return the time activation constant.

Returns: The time activation constant

Definition at line 156 of file Characteristics.cpp.

◆ torqueDeactivation()

const biorbd::utils::Scalar & biorbd::muscles::Characteristics::torqueDeactivation ( ) const

Return the time deactivation constant.

Returns: The time deactivation constant

Definition at line 166 of file Characteristics.cpp.

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Characteristics() [1/2]

◆ Characteristics() [2/2]

Member Function Documentation

◆ DeepCopy() [1/2]

◆ DeepCopy() [2/2]

◆ fatigueParameters()

◆ forceIsoMax()

◆ minActivation()

◆ optimalLength()

◆ PCSA()

◆ pennationAngle()

◆ setFatigueParameters()

◆ setForceIsoMax()

◆ setMinActivation()

◆ setOptimalLength()

◆ setPCSA()

◆ setPennationAngle()

◆ setStateMax()

◆ setTendonSlackLength()

◆ setTorqueActivation()

◆ setTorqueDeactivation()

◆ stateMax()

◆ tendonSlackLength()

◆ torqueActivation()

◆ torqueDeactivation()