Time derivative of activation as described by Buchanan (https://www.sciencedirect.com/science/article/pii/S0021929003001520) More...

#include <StateDynamicsBuchanan.h>

Inheritance diagram for biorbd::muscles::StateDynamicsBuchanan:

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

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

	~StateDynamicsBuchanan ()
	Destroy class properly.

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

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

virtual const biorbd::utils::Scalar &	timeDerivativeExcitation (const Characteristics &characteristics, bool alreadyNormalized)
	Compute and return the excitation velocity. More...

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

virtual void	setNeuralCommand (const biorbd::utils::Scalar &val)
	Set the neural command. More...

void	shapeFactor (const biorbd::utils::Scalar &shape_factor)
	Set the shape factor. More...

const biorbd::utils::Scalar &	shapeFactor () const
	Return the shape factor. More...

void	setActivation (const biorbd::utils::Scalar &notUsed, bool turnOffWarnings=false)
	Set the muscle activation. 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...

const biorbd::utils::Scalar &	previousExcitation () const
	Return the previous 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 type to Buchanan.

Protected Attributes
std::shared_ptr< biorbd::utils::Scalar >	m_neuralCommand
	The muscle neural command.

std::shared_ptr< biorbd::utils::Scalar >	m_shapeFactor
	The shape factor (Buchanan2004, march 22nd, 2018)

std::shared_ptr< biorbd::utils::Scalar >	m_excitationDot
	The excitation velocity.

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

Time derivative of activation as described by Buchanan (https://www.sciencedirect.com/science/article/pii/S0021929003001520)

Definition at line 12 of file StateDynamicsBuchanan.h.

Constructor & Destructor Documentation

◆ StateDynamicsBuchanan() [1/2]

biorbd::muscles::StateDynamicsBuchanan::StateDynamicsBuchanan	(	const biorbd::utils::Scalar &	neuralCommand = `0`,
		const biorbd::utils::Scalar &	excitation = `0`
	)

Construct state dynamics.

Parameters

neuralCommand	The muscle neural command
excitation	The muscle excitation

Definition at line 6 of file StateDynamicsBuchanan.cpp.

◆ StateDynamicsBuchanan() [2/2]

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

Construct a state dynamics Buchanan from another state dynamics Buchanan.

Parameters

other The other state dynamics Buchanan

Definition at line 19 of file StateDynamicsBuchanan.cpp.

Member Function Documentation

◆ DeepCopy() [1/2]

biorbd::muscles::StateDynamicsBuchanan biorbd::muscles::StateDynamicsBuchanan::DeepCopy ( ) const

Deep copy of state dynamics Buchanan.

Returns: A deep copy of state dynamics Buchanan

Definition at line 34 of file StateDynamicsBuchanan.cpp.

◆ DeepCopy() [2/2]

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

Deep copy of state dynamics Buchanan into another state dynamics Buchanan.

Parameters

other The state dynamics Buchanan to copy

Definition at line 41 of file StateDynamicsBuchanan.cpp.

◆ setActivation()

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

virtual

Set the muscle activation.

Parameters

notUsed the activation is computed from the neuralCommand and excitation

Reimplemented from biorbd::muscles::StateDynamics.

Definition at line 99 of file StateDynamicsBuchanan.cpp.

◆ setExcitation()

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

virtual

Set the muscle excitation.

Parameters

val	Value of the muscle excitation
turnOffWarnings	If the warning should be silenced

Reimplemented from biorbd::muscles::StateDynamics.

Definition at line 83 of file StateDynamicsBuchanan.cpp.

◆ setNeuralCommand()

void biorbd::muscles::StateDynamicsBuchanan::setNeuralCommand ( const biorbd::utils::Scalar & val )

virtual

Set the neural command.

Parameters

val	Value of the neural command

Definition at line 93 of file StateDynamicsBuchanan.cpp.

◆ shapeFactor() [1/2]

const biorbd::utils::Scalar & biorbd::muscles::StateDynamicsBuchanan::shapeFactor ( ) const

Return the shape factor.

Returns: The shape factor

Definition at line 59 of file StateDynamicsBuchanan.cpp.

◆ shapeFactor() [2/2]

void biorbd::muscles::StateDynamicsBuchanan::shapeFactor ( const biorbd::utils::Scalar & shape_factor )

Set the shape factor.

Parameters

shape_factor Value of the shape factor

Definition at line 50 of file StateDynamicsBuchanan.cpp.

◆ timeDerivativeExcitation()

const biorbd::utils::Scalar & biorbd::muscles::StateDynamicsBuchanan::timeDerivativeExcitation	(	const Characteristics &	characteristics,
		bool	alreadyNormalized
	)

virtual

Compute and return the excitation velocity.

Parameters

characteristics	The muscle characteristics
alreadyNormalized	If already normalized

Returns: The excitation time derivative

Definition at line 64 of file StateDynamicsBuchanan.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

◆ StateDynamicsBuchanan() [1/2]

◆ StateDynamicsBuchanan() [2/2]

Member Function Documentation

◆ DeepCopy() [1/2]

◆ DeepCopy() [2/2]

◆ setActivation()

◆ setExcitation()

◆ setNeuralCommand()

◆ shapeFactor() [1/2]

◆ shapeFactor() [2/2]

◆ timeDerivativeExcitation()