EMG with the capability to compute the time derivative. More...

#include <StateDynamics.h>

Inheritance diagram for biorbd::muscles::StateDynamics:

Public Member Functions
	StateDynamics (const biorbd::utils::Scalar &excitation=0, const biorbd::utils::Scalar &activation=0)
	Construct the state dynamics. More...

	StateDynamics (const biorbd::muscles::StateDynamics &other)
	Construct a state dynamics from another state dynamics. More...

virtual	~StateDynamics ()
	Destroy class properly.

biorbd::muscles::StateDynamics	DeepCopy () const
	Deep copy of state dynamics. More...

void	DeepCopy (const biorbd::muscles::StateDynamics &other)
	Deep copy of state dynamics into another state dynamics. More...

virtual void	setExcitation (const biorbd::utils::Scalar &val, bool turnOffWarnings=false)
	Set the muscle excitation. More...

const biorbd::utils::Scalar &	previousExcitation () const
	Return the previous activation. More...

virtual void	setActivation (const biorbd::utils::Scalar &val, bool turnOffWarnings=false)
	Set the muscle activation. More...

const biorbd::utils::Scalar &	previousActivation () const
	Return the previous activation. More...

virtual const biorbd::utils::Scalar &	timeDerivativeActivation (const biorbd::utils::Scalar &excitation, const biorbd::utils::Scalar &activation, const Characteristics &characteristics, bool alreadyNormalized=false)
	Compute and return the activation time derivative from the excitation and activation. More...

virtual const biorbd::utils::Scalar &	timeDerivativeActivation (const biorbd::muscles::State &emg, const biorbd::muscles::Characteristics &characteristics, bool alreadyNormalized=false)
	Compute and return the activation time derivative. More...

virtual const biorbd::utils::Scalar &	timeDerivativeActivation (const biorbd::muscles::Characteristics &characteristics, bool alreadyNormalized=false)
	Compute and return the activation time derivative. More...

virtual const biorbd::utils::Scalar &	timeDerivativeActivation ()
	Return the previously computed activation time derivative. More...

Public Member Functions inherited from biorbd::muscles::State
	State (const biorbd::utils::Scalar &excitation=0, const biorbd::utils::Scalar &activation=0)
	Construct a state. More...

	State (const biorbd::muscles::State &other)
	Construct a muscle state from another state. More...

virtual	~State ()
	Destroy class properly.

biorbd::muscles::State	DeepCopy () const
	Deep copy of state. More...

void	DeepCopy (const biorbd::muscles::State &other)
	Deep copy of state into another state. More...

const biorbd::utils::Scalar &	excitation () const
	Return the muscle excitation. More...

const biorbd::utils::Scalar &	normalizeExcitation (const biorbd::muscles::State &emgMax, bool turnOffWarnings=false)
	Compute and return the normalized excitation. More...

void	setExcitationNorm (const biorbd::utils::Scalar &val)
	Force set the normalized excitation. More...

const biorbd::utils::Scalar &	excitationNorm () const
	Return the previously normalized excitation. More...

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

biorbd::muscles::STATE_TYPE	type () const
	Return the state type. More...

Protected Member Functions
virtual void	setType ()
	Set the type to simple_state.

Protected Attributes
std::shared_ptr< biorbd::utils::Scalar >	m_previousExcitation
	The previous excitation.

std::shared_ptr< biorbd::utils::Scalar >	m_previousActivation
	The previous activation.

std::shared_ptr< biorbd::utils::Scalar >	m_activationDot
	The activation velocity.

Protected Attributes inherited from biorbd::muscles::State
std::shared_ptr< biorbd::muscles::STATE_TYPE >	m_stateType
	The state type.

std::shared_ptr< biorbd::utils::Scalar >	m_excitation
	The muscle excitation.

std::shared_ptr< biorbd::utils::Scalar >	m_excitationNorm
	The normalized excitation.

std::shared_ptr< biorbd::utils::Scalar >	m_activation
	The muscle activation.

Detailed Description

EMG with the capability to compute the time derivative.

Definition at line 13 of file StateDynamics.h.

Constructor & Destructor Documentation

◆ StateDynamics() [1/2]

biorbd::muscles::StateDynamics::StateDynamics	(	const biorbd::utils::Scalar &	excitation = `0`,
		const biorbd::utils::Scalar &	activation = `0`
	)

Construct the state dynamics.

Parameters

excitation	The muscle excitation
activation	The muscle activation

Definition at line 8 of file StateDynamics.cpp.

◆ StateDynamics() [2/2]

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

Construct a state dynamics from another state dynamics.

Parameters

other The other state dynamics

Definition at line 19 of file StateDynamics.cpp.

Member Function Documentation

◆ DeepCopy() [1/2]

biorbd::muscles::StateDynamics biorbd::muscles::StateDynamics::DeepCopy ( ) const

Deep copy of state dynamics.

Returns: A deep copy of state dynamics

Definition at line 34 of file StateDynamics.cpp.

◆ DeepCopy() [2/2]

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

Deep copy of state dynamics into another state dynamics.

Parameters

other The state dynamics to copy

Definition at line 41 of file StateDynamics.cpp.

◆ previousActivation()

const biorbd::utils::Scalar & biorbd::muscles::StateDynamics::previousActivation ( ) const

Return the previous activation.

Returns: The previous activation

Definition at line 144 of file StateDynamics.cpp.

◆ previousExcitation()

const biorbd::utils::Scalar & biorbd::muscles::StateDynamics::previousExcitation ( ) const

Return the previous activation.

Returns: The previous activation

Definition at line 132 of file StateDynamics.cpp.

◆ setActivation()

void biorbd::muscles::StateDynamics::setActivation	(	const biorbd::utils::Scalar &	val,
		bool	turnOffWarnings = `false`
	)

virtual

Set the muscle activation.

Parameters

val	The value of the muscle activation
turnOffWarnings	If the warnings should be OFF or ON.

Even if the warning on the activation being lower than 0 is set to OFF it changes it to 0 anyway, but doesn't send a warning saying it.

Even if the warning on the activation being higher than 1 is set to OFF it changes it to 1 anyway, but doesn't send a warning saying it.

Reimplemented from biorbd::muscles::State.

Reimplemented in biorbd::muscles::StateDynamicsBuchanan.

Definition at line 137 of file StateDynamics.cpp.

◆ setExcitation()

void biorbd::muscles::StateDynamics::setExcitation	(	const biorbd::utils::Scalar &	val,
		bool	turnOffWarnings = `false`
	)

virtual

Set the muscle excitation.

Parameters

val	The value of the muscle excitation
turnOffWarnings	If the warnings should be OFF or ON.

Even if the warning on the excitation being lower than 0 is set to OFF it changes it to 0 anyway, but doesn't send a warning saying it.

Reimplemented from biorbd::muscles::State.

Reimplemented in biorbd::muscles::StateDynamicsBuchanan.

Definition at line 125 of file StateDynamics.cpp.

◆ timeDerivativeActivation() [1/4]

const biorbd::utils::Scalar & biorbd::muscles::StateDynamics::timeDerivativeActivation ( )

virtual

Return the previously computed activation time derivative.

Returns: The activation time derivative

Definition at line 120 of file StateDynamics.cpp.

◆ timeDerivativeActivation() [2/4]

const biorbd::utils::Scalar & biorbd::muscles::StateDynamics::timeDerivativeActivation	(	const biorbd::muscles::Characteristics &	characteristics,
		bool	alreadyNormalized = `false`
	)

virtual

Compute and return the activation time derivative.

Parameters

characteristics	The muscle characteristics
alreadyNormalized	If already normalized

Returns: The activation time derivative

Reimplemented in biorbd::muscles::StateDynamicsDeGroote.

Definition at line 69 of file StateDynamics.cpp.

◆ timeDerivativeActivation() [3/4]

const biorbd::utils::Scalar & biorbd::muscles::StateDynamics::timeDerivativeActivation	(	const biorbd::muscles::State &	emg,
		const biorbd::muscles::Characteristics &	characteristics,
		bool	alreadyNormalized = `false`
	)

virtual

Compute and return the activation time derivative.

Parameters

emg	The emg
characteristics	The muscle characteristics
alreadyNormalized	If already normalized

Returns: The activation time derivative

Definition at line 51 of file StateDynamics.cpp.

◆ timeDerivativeActivation() [4/4]

const biorbd::utils::Scalar & biorbd::muscles::StateDynamics::timeDerivativeActivation	(	const biorbd::utils::Scalar &	excitation,
		const biorbd::utils::Scalar &	activation,
		const Characteristics &	characteristics,
		bool	alreadyNormalized = `false`
	)

virtual

Compute and return the activation time derivative from the excitation and activation.

Parameters

excitation	The muscle excitation
activation	The muscle activation
characteristics	The muscle characteristics
alreadyNormalized	If already normalized

Returns: The activation time derivative

Definition at line 59 of file StateDynamics.cpp.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ StateDynamics() [1/2]

◆ StateDynamics() [2/2]

Member Function Documentation

◆ DeepCopy() [1/2]

◆ DeepCopy() [2/2]

◆ previousActivation()

◆ previousExcitation()

◆ setActivation()

◆ setExcitation()

◆ timeDerivativeActivation() [1/4]

◆ timeDerivativeActivation() [2/4]

◆ timeDerivativeActivation() [3/4]

◆ timeDerivativeActivation() [4/4]