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

#include <StateDynamicsDeGroote.h>

Inheritance diagram for biorbd::muscles::StateDynamicsDeGroote:

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

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

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

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

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

Public Member Functions inherited from biorbd::muscles::StateDynamics
	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 ()
	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.

Additional Inherited Members
Protected Attributes inherited from biorbd::muscles::StateDynamics
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 12 of file StateDynamicsDeGroote.h.

Constructor & Destructor Documentation

◆ StateDynamicsDeGroote() [1/2]

biorbd::muscles::StateDynamicsDeGroote::StateDynamicsDeGroote	(	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 9 of file StateDynamicsDeGroote.cpp.

◆ StateDynamicsDeGroote() [2/2]

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

Construct a state dynamics from another state dynamics.

Parameters

other The other state dynamics

Definition at line 17 of file StateDynamicsDeGroote.cpp.

Member Function Documentation

◆ DeepCopy() [1/2]

biorbd::muscles::StateDynamicsDeGroote biorbd::muscles::StateDynamicsDeGroote::DeepCopy ( ) const

Deep copy of state dynamics.

Returns: A deep copy of state dynamics

Definition at line 24 of file StateDynamicsDeGroote.cpp.

◆ DeepCopy() [2/2]

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

Deep copy of state dynamics into another state dynamics.

Parameters

other The state dynamics to copy

Definition at line 31 of file StateDynamicsDeGroote.cpp.

◆ timeDerivativeActivation()

const biorbd::utils::Scalar & biorbd::muscles::StateDynamicsDeGroote::timeDerivativeActivation	(	const 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 from biorbd::muscles::StateDynamics.

Definition at line 36 of file StateDynamicsDeGroote.cpp.

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StateDynamicsDeGroote() [1/2]

◆ StateDynamicsDeGroote() [2/2]

Member Function Documentation

◆ DeepCopy() [1/2]

◆ DeepCopy() [2/2]

◆ timeDerivativeActivation()