OpenSim  OpenSim 3.2
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
OpenSim::MuscleActivationDynamics Class Referenceabstract

An abstract class for modeling muscle activation dynamics. More...

#include <MuscleActivationDynamics.h>

Inheritance diagram for OpenSim::MuscleActivationDynamics:
OpenSim::ModelComponent OpenSim::Object OpenSim::ConstantMuscleActivation OpenSim::FirstOrderMuscleActivationDynamics OpenSim::ZerothOrderMuscleActivationDynamics

Classes

class  ExcitationGetter
 The ExcitationGetter abstract class defines a standard interface for supplying muscle excitation to activation models. More...
 

Public Member Functions

virtual double getActivation (const SimTK::State &s) const =0
 Get the current activation. More...
 
virtual void setActivation (SimTK::State &s, double activation) const =0
 Set activation to the value provided. More...
 
double getExcitation (const SimTK::State &s) const
 Get the muscle excitation using the ExcitationGetter object. More...
 
Property Declarations

These are the serializable properties associated with this class.

 OpenSim_DECLARE_PROPERTY (minimum_activation, double,"Smallest permitted activation value")
 
 OpenSim_DECLARE_PROPERTY (maximum_activation, double,"Largest permitted activation value")
 
 OpenSim_DECLARE_PROPERTY (default_activation, double,"Default activation value")
 
Constructors and Destructor
 MuscleActivationDynamics ()
 Creates an activation dynamic model with the default property values and assigns it a default name. More...
 
 MuscleActivationDynamics (const std::string &name, ExcitationGetter *getter)
 Creates an activation dynamic model with the default property values, the specified name, and the specified ExcitationGetter. More...
 
 ~MuscleActivationDynamics ()
 Deletes the ExcitationGetter object. More...
 
Accessors and Mutators
double getMinimumActivation () const
 Get the smallest permitted activation value. More...
 
void setMinimumActivation (double minimumActivation)
 Set the smallest permitted activation value. More...
 
double getMaximumActivation () const
 Get the largest permitted activation value. More...
 
void setMaximumActivation (double maximumActivation)
 Set the largest permitted activation value. More...
 
double getDefaultActivation () const
 Get the default activation value. More...
 
void setDefaultActivation (double defaultActivation)
 Set the default activation value. More...
 
void setExcitationGetter (ExcitationGetter *getter)
 Define an ExcitationGetter for obtaining muscle excitation. More...
 
- Public Member Functions inherited from OpenSim::ModelComponent
 ModelComponent ()
 Default constructor. More...
 
 ModelComponent (const std::string &aFileName, bool aUpdateFromXMLNode=true) SWIG_DECLARE_EXCEPTION
 Construct ModelComponent from an XML file. More...
 
 ModelComponent (SimTK::Xml::Element &aNode)
 Construct ModelComponent from a specific node in an XML document. More...
 
 ModelComponent (const ModelComponent &source)
 Construct ModelComponent with its contents copied from another ModelComponent; this is a deep copy so nothing is shared with the source after the copy. More...
 
virtual ~ModelComponent ()
 Destructor is virtual to allow concrete model component cleanup. More...
 
ModelComponentoperator= (const ModelComponent &aModelComponent)
 Assignment operator to copy contents of an existing component. More...
 
const ModelgetModel () const
 Get a const reference to the Model this component is part of. More...
 
ModelupdModel ()
 Get a modifiable reference to the Model this component is part of. More...
 
virtual void updateDisplayer (const SimTK::State &s) const
 In case the ModelComponent has a visual representation (VisualObject), override this method to update it. More...
 
virtual int getNumStateVariables () const
 Get the number of "Continuous" state variables maintained by the ModelComponent and its specified subcomponents. More...
 
virtual Array< std::string > getStateVariableNames () const
 Get the names of "continuous" state variables maintained by the ModelComponent and its subcomponents. More...
 
virtual SimTK::SystemYIndex getStateVariableSystemIndex (const std::string &stateVariableName) const
 Get the System Index of a state variable allocated by this ModelComponent. More...
 
int getModelingOption (const SimTK::State &state, const std::string &name) const
 Get a ModelingOption flag for this ModelComponent by name. More...
 
void setModelingOption (SimTK::State &state, const std::string &name, int flag) const
 Set the value of a ModelingOption flag for this ModelComponent. More...
 
double getStateVariable (const SimTK::State &state, const std::string &name) const
 Get the value of a state variable allocated by this ModelComponent. More...
 
void setStateVariable (SimTK::State &state, const std::string &name, double value) const
 Set the value of a state variable allocated by this ModelComponent by name. More...
 
double getDiscreteVariable (const SimTK::State &state, const std::string &name) const
 Get the value of a discrete variable allocated by this ModelComponent by name. More...
 
void setDiscreteVariable (SimTK::State &state, const std::string &name, double value) const
 Set the value of a discrete variable allocated by this ModelComponent by name. More...
 
template<typename T >
const T & getCacheVariable (const SimTK::State &state, const std::string &name) const
 Get the value of a cache variable allocated by this ModelComponent by name. More...
 
template<typename T >
T & updCacheVariable (const SimTK::State &state, const std::string &name) const
 Obtain a writable cache variable value allocated by this ModelComponent by name. More...
 
void markCacheVariableValid (const SimTK::State &state, const std::string &name) const
 After updating a cache variable value allocated by this ModelComponent, you can mark its value as valid, which will not change until the realization stage falls below the minimum set at the time the cache variable was created. More...
 
void markCacheVariableInvalid (const SimTK::State &state, const std::string &name) const
 Mark a cache variable value allocated by this ModelComponent as invalid. More...
 
bool isCacheVariableValid (const SimTK::State &state, const std::string &name) const
 Enables the to monitor the validity of the cache variable value using the returned flag. More...
 
template<typename T >
void setCacheVariable (const SimTK::State &state, const std::string &name, const T &value) const
 Set cache variable value allocated by this ModelComponent by name. More...
 
- Public Member Functions inherited from OpenSim::Object
virtual ~Object ()
 Virtual destructor for cleanup. More...
 
virtual Objectclone () const =0
 Create a new heap-allocated copy of the concrete object to which this Object refers. More...
 
virtual const std::string & getConcreteClassName () const =0
 Returns the class name of the concrete Object-derived class of the actual object referenced by this Object, as a string. More...
 
virtual const VisibleObjectgetDisplayer () const
 Methods to support making the object displayable in the GUI or Visualizer Implemented only in few objects. More...
 
virtual VisibleObjectupdDisplayer ()
 get Non const pointer to VisibleObject More...
 
bool isEqualTo (const Object &aObject) const
 Equality operator wrapper for use from languages not supporting operator overloading. More...
 
Objectoperator= (const Object &aObject)
 Copy assignment copies he base class fields, including the properties. More...
 
virtual bool operator== (const Object &aObject) const
 Determine if two objects are equal. More...
 
virtual bool operator< (const Object &aObject) const
 Provide an ordering for objects so they can be put in sorted containers. More...
 
void setName (const std::string &name)
 Set the name of the Object. More...
 
const std::string & getName () const
 Get the name of this Object. More...
 
void setDescription (const std::string &description)
 Set description, a one-liner summary. More...
 
const std::string & getDescription () const
 Get description, a one-liner summary. More...
 
const std::string & getAuthors () const
 Get Authors of this Object. More...
 
void setAuthors (const std::string &authors)
 Set Authors of this object, call this method in your constructor if needed. More...
 
const std::string & getReferences () const
 Get references or publications to cite if using this object. More...
 
void setReferences (const std::string &references)
 Set references or publications to cite if using this object. More...
 
int getNumProperties () const
 Determine how many properties are stored with this Object. More...
 
const AbstractPropertygetPropertyByIndex (int propertyIndex) const
 Get a const reference to a property by its index number, returned as an AbstractProperty. More...
 
AbstractPropertyupdPropertyByIndex (int propertyIndex)
 Get a writable reference to a property by its index number, returned as an AbstractProperty. More...
 
bool hasProperty (const std::string &name) const
 Return true if this Object has a property of any type with the given name, which must not be empty. More...
 
const AbstractPropertygetPropertyByName (const std::string &name) const
 Get a const reference to a property by its name, returned as an AbstractProperty. More...
 
AbstractPropertyupdPropertyByName (const std::string &name)
 Get a writable reference to a property by its name, returned as an AbstractProperty. More...
 
template<class T >
bool hasProperty () const
 Return true if this Object contains an unnamed, one-object property that contains objects of the given template type T. More...
 
template<class T >
const Property< T > & getProperty (const PropertyIndex &index) const
 Get property of known type Property<T> as a const reference; the property must be present and have the right type. More...
 
template<class T >
Property< T > & updProperty (const PropertyIndex &index)
 Get property of known type Property<T> as a writable reference; the property must be present and have the right type. More...
 
void setObjectIsUpToDateWithProperties ()
 When an object is initialized using the current values of its properties, it can set a flag indicating that it is up to date. More...
 
bool isObjectUpToDateWithProperties () const
 Returns true if no property's value has changed since the last time setObjectIsUpToDateWithProperties() was called. More...
 
void readObjectFromXMLNodeOrFile (SimTK::Xml::Element &objectElement, int versionNumber)
 We're given an XML element from which we are to populate this Object. More...
 
virtual void updateFromXMLNode (SimTK::Xml::Element &objectElement, int versionNumber)
 Use this method to deserialize an object from a SimTK::Xml::Element. More...
 
virtual void updateXMLNode (SimTK::Xml::Element &parent)
 Serialize this object into the XML node that represents it. More...
 
bool getInlined () const
 Inlined means an in-memory Object that is not associated with an XMLDocument. More...
 
void setInlined (bool aInlined, const std::string &aFileName="")
 Mark this as inlined or not and optionally provide a file name to associate with the new XMLDocument for the non-inline case. More...
 
std::string getDocumentFileName () const
 If there is a document associated with this object then return the file name maintained by the document. More...
 
void setAllPropertiesUseDefault (bool aUseDefault)
 
bool print (const std::string &fileName)
 Write this Object into an XML file of the given name; conventionally the suffix to use is ".osim". More...
 
std::string dump (bool dumpName=false)
 dump the XML representation of this Object into an std::string and return it. More...
 
void clearObjectIsUpToDateWithProperties ()
 For testing or debugging purposes, manually clear the "object is up to date with respect to properties" flag. More...
 
virtual bool isA (const char *type) const
 The default implementation returns true only if the supplied string is "Object"; each Object-derived class overrides this to match its own class name. More...
 
const std::string & toString () const
 Wrapper to be used on Java side to display objects in tree; this returns just the object's name. More...
 
PropertySetgetPropertySet ()
 OBSOLETE: Get a reference to the PropertySet maintained by the Object. More...
 
const PropertySetgetPropertySet () const
 

Protected Member Functions

double clampToValidInterval (double val) const
 Clamp to the interval [minimum_activation, maximum_activation]. More...
 
- Protected Member Functions inherited from OpenSim::ModelComponent
virtual void connectToModel (Model &model)
 Perform any necessary initializations required to connect the component into the Model, and check for error conditions. More...
 
virtual void addToSystem (SimTK::MultibodySystem &system) const
 Add appropriate Simbody elements (if needed) to the System corresponding to this component and specify needed state resources. More...
 
virtual void initStateFromProperties (SimTK::State &state) const
 Transfer property values or other state-independent initial values into this component's state variables in the passed-in state argument. More...
 
virtual void setPropertiesFromState (const SimTK::State &state)
 Update this component's property values to match the specified State, if the component has created any state variable that is intended to correspond to a property. More...
 
virtual SimTK::Vector computeStateVariableDerivatives (const SimTK::State &s) const
 If a model component has allocated any continuous state variables using the addStateVariable() method, then computeStateVariableDerivatives() must be implemented to provide time derivatives for those states. More...
 
virtual void generateDecorations (bool fixed, const ModelDisplayHints &hints, const SimTK::State &state, SimTK::Array_< SimTK::DecorativeGeometry > &appendToThis) const
 Optional method for generating arbitrary display geometry that reflects this ModelComponent at the specified state. More...
 
virtual void realizeTopology (SimTK::State &state) const
 Obtain state resources that are needed unconditionally, and perform computations that depend only on the system topology. More...
 
virtual void realizeModel (SimTK::State &state) const
 Obtain state resources that may be needed, depending on modeling options, and perform computations that depend only on topology and selected modeling options. More...
 
virtual void realizeInstance (const SimTK::State &state) const
 Perform computations that depend only on instance variables, like lengths and masses. More...
 
virtual void realizeTime (const SimTK::State &state) const
 Perform computations that depend only on time and earlier stages. More...
 
virtual void realizePosition (const SimTK::State &state) const
 Perform computations that depend only on position-level state variables and computations performed in earlier stages (including time). More...
 
virtual void realizeVelocity (const SimTK::State &state) const
 Perform computations that depend only on velocity-level state variables and computations performed in earlier stages (including position, and time). More...
 
virtual void realizeDynamics (const SimTK::State &state) const
 Perform computations (typically forces) that may depend on dynamics-stage state variables, and on computations performed in earlier stages (including velocity, position, and time), but not on other forces, accelerations, constraint multipliers, or reaction forces. More...
 
virtual void realizeAcceleration (const SimTK::State &state) const
 Perform computations that may depend on applied forces. More...
 
virtual void realizeReport (const SimTK::State &state) const
 Perform computations that may depend on anything but are only used for reporting and cannot affect subsequent simulation behavior. More...
 
void includeAsSubComponent (ModelComponent *aComponent)
 Include another ModelComponent as a Subcomponent of this ModelComponent. More...
 
void addModelingOption (const std::string &optionName, int maxFlagValue) const
 Add a modeling option (integer flag stored in the State) for use by this ModelComponent. More...
 
void addStateVariable (const std::string &stateVariableName, SimTK::Stage invalidatesStage=SimTK::Stage::Dynamics) const
 Add a continuous system state variable belonging to this ModelComponent, and assign a name by which to refer to it. More...
 
void addDiscreteVariable (const std::string &discreteVariableName, SimTK::Stage invalidatesStage) const
 Add a system discrete variable belonging to this ModelComponent, give it a name by which it can be referenced, and declare the lowest Stage that should be invalidated if this variable's value is changed. More...
 
template<class T >
void addCacheVariable (const std::string &cacheVariableName, const T &variablePrototype, SimTK::Stage dependsOnStage) const
 Add a state cache entry belonging to this ModelComponent to hold calculated values that must be automatically invalidated when certain state values change. More...
 
const int getStateIndex (const std::string &name) const
 Get the index of a ModelComponent's continuous state variable in the Subsystem for allocations. More...
 
const SimTK::DiscreteVariableIndex getDiscreteVariableIndex (const std::string &name) const
 Get the index of a ModelComponent's discrete variable in the Subsystem for allocations. More...
 
const SimTK::CacheEntryIndex getCacheVariableIndex (const std::string &name) const
 Get the index of a ModelComponent's cache variable in the Subsystem for allocations. More...
 
- Protected Member Functions inherited from OpenSim::Object
 Object ()
 The default constructor is only for use by constructors of derived types. More...
 
 Object (const std::string &fileName, bool aUpdateFromXMLNode=true) SWIG_DECLARE_EXCEPTION
 Constructor from a file, to be called from other constructors that take a file as input. More...
 
 Object (const Object &source)
 Copy constructor is invoked automatically by derived classes with default copy constructors; otherwise it must be invoked explicitly. More...
 
 Object (SimTK::Xml::Element &aElement)
 Construct the base class portion of an Object from a given Xml element that describes this Object. More...
 
template<class T >
PropertyIndex addProperty (const std::string &name, const std::string &comment, const T &value)
 Define a new single-value property of known type T, with the given name, associated comment, and initial value. More...
 
template<class T >
PropertyIndex addOptionalProperty (const std::string &name, const std::string &comment)
 Add an optional property, meaning it can contain either no value or a single value. More...
 
template<class T >
PropertyIndex addOptionalProperty (const std::string &name, const std::string &comment, const T &value)
 Add an optional property, meaning it can contain either no value or a single value. More...
 
template<class T >
PropertyIndex addListProperty (const std::string &name, const std::string &comment, int minSize, int maxSize)
 Define a new list-valued property of known type T, with the given name, associated comment, minimum (==0) and maximum (>0) allowable list lengths, and a zero-length initial value. More...
 
template<class T , template< class > class Container>
PropertyIndex addListProperty (const std::string &name, const std::string &comment, int minSize, int maxSize, const Container< T > &valueList)
 Define a new list-valued property as above, but assigning an initial value via some templatized container class that supports size() and indexing. More...
 
PropertyIndex getPropertyIndex (const std::string &name) const
 Look up a property by name and return its PropertyIndex if it is found. More...
 
template<class T >
PropertyIndex getPropertyIndex () const
 Look up an unnamed property by the type of object it contains, and return its PropertyIndex if it is found. More...
 
void updateFromXMLDocument ()
 Use this method only if you're deserializing from a file and the object is at the top level; that is, primarily in constructors that take a file name as input. More...
 
void setDocument (XMLDocument *doc)
 Unconditionally set the XMLDocument associated with this object. More...
 
const XMLDocumentgetDocument () const
 Get a const pointer to the document (if any) associated with this object. More...
 
XMLDocumentupdDocument ()
 Get a writable pointer to the document (if any) associated with this object. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from OpenSim::Object
static void registerType (const Object &defaultObject)
 Register an instance of a class; if the class is already registered it will be replaced. More...
 
static void renameType (const std::string &oldTypeName, const std::string &newTypeName)
 Support versioning by associating the current Object type with an old name. More...
 
static const ObjectgetDefaultInstanceOfType (const std::string &concreteClassName)
 Return a pointer to the default instance of the registered (concrete) Object whose class name is given, or NULL if the type is not registered. More...
 
template<class T >
static bool isObjectTypeDerivedFrom (const std::string &concreteClassName)
 Return true if the given concrete object type represents a subclass of the template object type T, and thus could be referenced with a T*. More...
 
static ObjectnewInstanceOfType (const std::string &concreteClassName)
 Create a new instance of the concrete Object type whose class name is given as concreteClassName. More...
 
static void getRegisteredTypenames (Array< std::string > &typeNames)
 Retrieve all the typenames registered so far. More...
 
template<class T >
static void getRegisteredObjectsOfGivenType (ArrayPtrs< T > &rArray)
 Return an array of pointers to the default instances of all registered (concrete) Object types that derive from a given Object-derived type that does not have to be concrete. More...
 
static void PrintPropertyInfo (std::ostream &os, const std::string &classNameDotPropertyName)
 Dump formatted property information to a given output stream, useful for creating a "help" facility for registered objects. More...
 
static void PrintPropertyInfo (std::ostream &os, const std::string &className, const std::string &propertyName)
 Same as the other signature but the class name and property name are provided as two separate strings. More...
 
static ObjectmakeObjectFromFile (const std::string &fileName)
 Create an OpenSim object whose type is based on the tag at the root node of the XML file passed in. More...
 
static const std::string & getClassName ()
 Return the name of this class as a string; i.e., "Object". More...
 
static void setSerializeAllDefaults (bool shouldSerializeDefaults)
 Static function to control whether all registered objects and their properties are written to the defaults section of output files rather than only those values for which the default was explicitly overwritten when read in from an input file or set programmatically. More...
 
static bool getSerializeAllDefaults ()
 Report the value of the "serialize all defaults" flag. More...
 
static bool isKindOf (const char *type)
 Returns true if the passed-in string is "Object"; each Object-derived class defines a method of this name for its own class name. More...
 
static void setDebugLevel (int newLevel)
 Set the debug level to get verbose output. More...
 
static int getDebugLevel ()
 Get current setting of debug level. More...
 
static ObjectSafeCopy (const Object *aObject)
 Use the clone() method to duplicate the given object unless the pointer is null in which case null is returned. More...
 
static void RegisterType (const Object &defaultObject)
 OBSOLETE alternate name for registerType(). More...
 
static void RenameType (const std::string &oldName, const std::string &newName)
 OBSOLETE alternate name for renameType(). More...
 
- Static Public Attributes inherited from OpenSim::Object
static const std::string DEFAULT_NAME
 Name used for default objects when they are serialized. More...
 
- Protected Attributes inherited from OpenSim::ModelComponent
Model_model
 The model this component belongs to. More...
 

Detailed Description

An abstract class for modeling muscle activation dynamics.

Activation models that derive from this base class are responsible for creating and maintaining whatever states and/or cache variables they require to override the getActivation() and setActivation() pure virtual methods.

Properties

  • minimum_activation: Smallest permitted activation value.
  • maximum_activation: Largest permitted activation value.
  • default_activation: Default activation value.

Conditions

0 <= minimum_activation <= default_activation <= maximum_activation <= 1

Default Property Values

minimum_activation .... 0
maximum_activation .... 1
default_activation .... 0.5
Author
Thomas Uchida, Ajay Seth, Michael Sherman

Constructor & Destructor Documentation

OpenSim::MuscleActivationDynamics::MuscleActivationDynamics ( )

Creates an activation dynamic model with the default property values and assigns it a default name.

An ExcitationGetter must be created for obtaining muscle excitation.

OpenSim::MuscleActivationDynamics::MuscleActivationDynamics ( const std::string &  name,
ExcitationGetter getter 
)

Creates an activation dynamic model with the default property values, the specified name, and the specified ExcitationGetter.

Takes ownership of the ExcitationGetter object.

OpenSim::MuscleActivationDynamics::~MuscleActivationDynamics ( )

Deletes the ExcitationGetter object.

Member Function Documentation

double OpenSim::MuscleActivationDynamics::clampToValidInterval ( double  val) const
protected

Clamp to the interval [minimum_activation, maximum_activation].

virtual double OpenSim::MuscleActivationDynamics::getActivation ( const SimTK::State &  s) const
pure virtual
double OpenSim::MuscleActivationDynamics::getDefaultActivation ( ) const

Get the default activation value.

double OpenSim::MuscleActivationDynamics::getExcitation ( const SimTK::State &  s) const

Get the muscle excitation using the ExcitationGetter object.

Returns zero if no ExcitationGetter exists.

double OpenSim::MuscleActivationDynamics::getMaximumActivation ( ) const

Get the largest permitted activation value.

double OpenSim::MuscleActivationDynamics::getMinimumActivation ( ) const

Get the smallest permitted activation value.

OpenSim::MuscleActivationDynamics::OpenSim_DECLARE_PROPERTY ( minimum_activation  ,
double  ,
"Smallest permitted activation value"   
)
OpenSim::MuscleActivationDynamics::OpenSim_DECLARE_PROPERTY ( maximum_activation  ,
double  ,
"Largest permitted activation value"   
)
OpenSim::MuscleActivationDynamics::OpenSim_DECLARE_PROPERTY ( default_activation  ,
double  ,
"Default activation value"   
)
virtual void OpenSim::MuscleActivationDynamics::setActivation ( SimTK::State &  s,
double  activation 
) const
pure virtual
void OpenSim::MuscleActivationDynamics::setDefaultActivation ( double  defaultActivation)

Set the default activation value.

Clamps default_activation to the interval [minimum_activation, maximum_activation].

void OpenSim::MuscleActivationDynamics::setExcitationGetter ( ExcitationGetter getter)

Define an ExcitationGetter for obtaining muscle excitation.

Takes ownership of the ExcitationGetter object.

void OpenSim::MuscleActivationDynamics::setMaximumActivation ( double  maximumActivation)

Set the largest permitted activation value.

Clamps maximum_activation to the interval [minimum_activation, 1] and default_activation to the interval [minimum_activation, maximum_activation].

void OpenSim::MuscleActivationDynamics::setMinimumActivation ( double  minimumActivation)

Set the smallest permitted activation value.

Clamps minimum_activation to the interval [0, maximum_activation] and default_activation to the interval [minimum_activation, maximum_activation].


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