API  4.2
For MATLAB, Python, Java, and C++ users
OpenSim::MuscleAnalysis Class Reference

A class for recording and computing basic quantities (length, shortening velocity, tendon length, ...) for muscles during a simulation. More...

+ Inheritance diagram for OpenSim::MuscleAnalysis:

Public Member Functions

 MuscleAnalysis (Model *aModel=0)
 
 MuscleAnalysis (const std::string &aFileName)
 
 MuscleAnalysis (const MuscleAnalysis &aObject)
 
virtual ~MuscleAnalysis ()
 
MuscleAnalysisoperator= (const MuscleAnalysis &aMuscleAnalysis)
 
void setModel (Model &aModel) override
 set pointer to model to be analyzed. More...
 
void setStorageCapacityIncrements (int aIncrement)
 
StoragegetPennationAngleStorage () const
 
StoragegetMuscleTendonLengthStorage () const
 
StoragegetFiberLengthStorage () const
 
StoragegetNormalizedFiberLengthStorage () const
 
StoragegetTendonLengthStorage () const
 
StoragegetFiberVelocityStorage () const
 
StoragegetNormalizedFiberVelocityStorage () const
 
StoragegetPennationAngularVelocityStorage () const
 
StoragegetForceStorage () const
 
StoragegetFiberForceStorage () const
 
StoragegetActiveFiberForceStorage () const
 
StoragegetPassiveFiberForceStorage () const
 
StoragegetActiveFiberForceAlongTendonStorage () const
 
StoragegetPassiveFiberForceAlongTendonStorage () const
 
StoragegetFiberActivePowerStorage () const
 
StoragegetFiberPassivePowerStorage () const
 
StoragegetTendonPowerStorage () const
 
StoragegetMusclePowerStorage () const
 
void setMuscles (Array< std::string > &aMuscles)
 
void setCoordinates (Array< std::string > &aCoordinates)
 
void setComputeMoments (bool aTrueFalse)
 
bool getComputeMoments () const
 
const ArrayPtrs< StorageCoordinatePair > & getMomentArmStorageArray () const
 
int begin (const SimTK::State &s) override
 
int step (const SimTK::State &s, int setNumber) override
 
int end (const SimTK::State &s) override
 
int printResults (const std::string &aBaseName, const std::string &aDir="", double aDT=-1.0, const std::string &aExtension=".sto") override
 Print the results of the analysis. More...
 
void allocateStorageObjects ()
 Intended for use only by GUI that holds one MuscleAnalysis and keeps changing attributes to generate various plots For all other use cases, the code handles the allocation/deallocation of resources internally. More...
 
- Public Member Functions inherited from OpenSim::Analysis
 Analysis (Model *aModel=0)
 Default constructor. More...
 
 Analysis (const std::string &aFileName, bool aUpdateFromXMLNode=true)
 Construct an object from file. More...
 
 Analysis (const Analysis &aAnalysis)
 Copy constructor. More...
 
virtual ~Analysis ()
 
Analysisoperator= (const Analysis &aAnalysis)
 Assignment operator. More...
 
virtual void setStatesStore (const Storage &aStatesStore)
 set states storage for analysis. More...
 
void setOn (bool aTrueFalse)
 
bool getOn () const
 
void setStartTime (double aStartTime)
 
double getStartTime () const
 
void setEndTime (double aEndTime)
 
double getEndTime () const
 
void setInDegrees (bool aTrueFalse)
 Set whether or not to write the output of angles in degrees. More...
 
bool getInDegrees () const
 
virtual bool proceed (int aStep=0)
 
void setStepInterval (int aStepInterval)
 
int getStepInterval () const
 
void setColumnLabels (const Array< std::string > &aLabels)
 Set the column labels for this analysis. More...
 
const Array< std::string > & getColumnLabels () const
 
void setStorageInterval (int aInterval)
 
int getStorageInterval () const
 
virtual ArrayPtrs< Storage > & getStorageList ()
 
void setPrintResultFiles (bool aToWrite)
 
bool getPrintResultFiles () const
 
- Public Member Functions inherited from OpenSim::Object
virtual ~Object ()
 Virtual destructor for cleanup. 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. 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...
 
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...
 
void updateXMLNode (SimTK::Xml::Element &parent, const AbstractProperty *prop=nullptr) const
 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...
 
int getDocumentFileVersion () const
 If there is a document associated with this object then return its version number. More...
 
void setAllPropertiesUseDefault (bool aUseDefault)
 
bool print (const std::string &fileName) const
 Write this Object into an XML file of the given name; conventionally the suffix to use is ".osim". More...
 
std::string dump () const
 dump the XML representation of this Object into an std::string and return it. 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
 

Static Public Member Functions

Auto-generated functions
static MuscleAnalysissafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
- Static Public Member Functions inherited from OpenSim::Analysis
static AnalysissafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "Analysis"
More...
 
- 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 bool PrintPropertyInfo (std::ostream &os, const std::string &classNameDotPropertyName, bool printFlagInfo=true)
 Dump formatted property information to a given output stream, useful for creating a "help" facility for registered objects. More...
 
static bool PrintPropertyInfo (std::ostream &os, const std::string &className, const std::string &propertyName, bool printFlagInfo=true)
 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 amount of logging output. More...
 
static int getDebugLevel ()
 Get the 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...
 

Auto-generated functions <br>

static const std::string & getClassName ()
 This returns "MuscleAnalysis"
More...
 
MuscleAnalysisclone () const override
 Create a new heap-allocated copy of the concrete object to which this Object refers. More...
 
const std::string & getConcreteClassName () const override
 Returns the class name of the concrete Object-derived class of the actual object referenced by this Object, as a string. More...
 

Detailed Description

A class for recording and computing basic quantities (length, shortening velocity, tendon length, ...) for muscles during a simulation.

Author
Ajay Seth, Matthew Millard, Katherine Holzbaur, Frank C. Anderson
Version
1.0

Constructor & Destructor Documentation

◆ MuscleAnalysis() [1/3]

OpenSim::MuscleAnalysis::MuscleAnalysis ( Model aModel = 0)

◆ MuscleAnalysis() [2/3]

OpenSim::MuscleAnalysis::MuscleAnalysis ( const std::string &  aFileName)

◆ MuscleAnalysis() [3/3]

OpenSim::MuscleAnalysis::MuscleAnalysis ( const MuscleAnalysis aObject)

◆ ~MuscleAnalysis()

virtual OpenSim::MuscleAnalysis::~MuscleAnalysis ( )
virtual

Member Function Documentation

◆ allocateStorageObjects()

void OpenSim::MuscleAnalysis::allocateStorageObjects ( )

Intended for use only by GUI that holds one MuscleAnalysis and keeps changing attributes to generate various plots For all other use cases, the code handles the allocation/deallocation of resources internally.

◆ begin()

int OpenSim::MuscleAnalysis::begin ( const SimTK::State &  s)
overridevirtual

Reimplemented from OpenSim::Analysis.

◆ clone()

MuscleAnalysis* OpenSim::MuscleAnalysis::clone ( ) const
inlineoverridevirtual

Create a new heap-allocated copy of the concrete object to which this Object refers.

It is up to the caller to delete the returned object when no longer needed. Every concrete object deriving from Object implements this pure virtual method automatically, via the declaration macro it invokes (e.g., OpenSim_DECLARE_CONCRETE_OBJECT()). Note that the concrete class overrides modify the return type to be a pointer to the concrete object; that still overrides the base class method because the return type is covariant with (that is, derives from) Object.

Implements OpenSim::Analysis.

◆ end()

int OpenSim::MuscleAnalysis::end ( const SimTK::State &  s)
overridevirtual

Reimplemented from OpenSim::Analysis.

◆ getActiveFiberForceAlongTendonStorage()

Storage* OpenSim::MuscleAnalysis::getActiveFiberForceAlongTendonStorage ( ) const
inline

◆ getActiveFiberForceStorage()

Storage* OpenSim::MuscleAnalysis::getActiveFiberForceStorage ( ) const
inline

◆ getClassName()

static const std::string& OpenSim::MuscleAnalysis::getClassName ( )
inlinestatic

This returns "MuscleAnalysis"

See getConcreteClassName() if you want the class name of the underlying concrete object instead.

◆ getComputeMoments()

bool OpenSim::MuscleAnalysis::getComputeMoments ( ) const
inline

◆ getConcreteClassName()

const std::string& OpenSim::MuscleAnalysis::getConcreteClassName ( ) const
inlineoverridevirtual

Returns the class name of the concrete Object-derived class of the actual object referenced by this Object, as a string.

This is the string that is used as the tag for this concrete object in an XML file. Every concrete class derived from Object automatically overrides this method via the declaration macro it uses. See getClassName() to get the class name of the referencing (possibly abstract) class rather than the concrete object.

See also
getClassName()

Implements OpenSim::Analysis.

◆ getFiberActivePowerStorage()

Storage* OpenSim::MuscleAnalysis::getFiberActivePowerStorage ( ) const
inline

◆ getFiberForceStorage()

Storage* OpenSim::MuscleAnalysis::getFiberForceStorage ( ) const
inline

◆ getFiberLengthStorage()

Storage* OpenSim::MuscleAnalysis::getFiberLengthStorage ( ) const
inline

◆ getFiberPassivePowerStorage()

Storage* OpenSim::MuscleAnalysis::getFiberPassivePowerStorage ( ) const
inline

◆ getFiberVelocityStorage()

Storage* OpenSim::MuscleAnalysis::getFiberVelocityStorage ( ) const
inline

◆ getForceStorage()

Storage* OpenSim::MuscleAnalysis::getForceStorage ( ) const
inline

◆ getMomentArmStorageArray()

const ArrayPtrs<StorageCoordinatePair>& OpenSim::MuscleAnalysis::getMomentArmStorageArray ( ) const
inline

◆ getMusclePowerStorage()

Storage* OpenSim::MuscleAnalysis::getMusclePowerStorage ( ) const
inline

◆ getMuscleTendonLengthStorage()

Storage* OpenSim::MuscleAnalysis::getMuscleTendonLengthStorage ( ) const
inline

◆ getNormalizedFiberLengthStorage()

Storage* OpenSim::MuscleAnalysis::getNormalizedFiberLengthStorage ( ) const
inline

◆ getNormalizedFiberVelocityStorage()

Storage* OpenSim::MuscleAnalysis::getNormalizedFiberVelocityStorage ( ) const
inline

◆ getPassiveFiberForceAlongTendonStorage()

Storage* OpenSim::MuscleAnalysis::getPassiveFiberForceAlongTendonStorage ( ) const
inline

◆ getPassiveFiberForceStorage()

Storage* OpenSim::MuscleAnalysis::getPassiveFiberForceStorage ( ) const
inline

◆ getPennationAngleStorage()

Storage* OpenSim::MuscleAnalysis::getPennationAngleStorage ( ) const
inline

◆ getPennationAngularVelocityStorage()

Storage* OpenSim::MuscleAnalysis::getPennationAngularVelocityStorage ( ) const
inline

◆ getTendonLengthStorage()

Storage* OpenSim::MuscleAnalysis::getTendonLengthStorage ( ) const
inline

◆ getTendonPowerStorage()

Storage* OpenSim::MuscleAnalysis::getTendonPowerStorage ( ) const
inline

◆ operator=()

MuscleAnalysis& OpenSim::MuscleAnalysis::operator= ( const MuscleAnalysis aMuscleAnalysis)

◆ printResults()

int OpenSim::MuscleAnalysis::printResults ( const std::string &  aBaseName,
const std::string &  aDir = "",
double  aDT = -1.0,
const std::string &  aExtension = ".sto" 
)
overridevirtual

Print the results of the analysis.

Parameters
aBaseNameBase name of file to which to print the data.
aDirDirectory name.
aDTTime interval between results (linear interpolation is used). If not supplied as an argument or negative, all time steps are printed without interpolation.
aExtensionFile extension if not the default ".sto".
Returns
-1 on error, 0 otherwise.

Reimplemented from OpenSim::Analysis.

◆ record()

virtual int OpenSim::MuscleAnalysis::record ( const SimTK::State &  s)
protectedvirtual

◆ safeDownCast()

static MuscleAnalysis* OpenSim::MuscleAnalysis::safeDownCast ( OpenSim::Object obj)
inlinestatic

For use in MATLAB and Python to access the concrete class.

Example: cObj = MuscleAnalysis.safeDownCast(obj). This is equivalent to dynamic_cast<MuscleAnalysis*>(obj) in C++.

◆ setComputeMoments()

void OpenSim::MuscleAnalysis::setComputeMoments ( bool  aTrueFalse)
inline

◆ setCoordinates()

void OpenSim::MuscleAnalysis::setCoordinates ( Array< std::string > &  aCoordinates)

◆ setModel()

void OpenSim::MuscleAnalysis::setModel ( Model aModel)
overridevirtual

set pointer to model to be analyzed.

Parameters
aModel

Reimplemented from OpenSim::Analysis.

◆ setMuscles()

void OpenSim::MuscleAnalysis::setMuscles ( Array< std::string > &  aMuscles)

◆ setStorageCapacityIncrements()

void OpenSim::MuscleAnalysis::setStorageCapacityIncrements ( int  aIncrement)

◆ step()

int OpenSim::MuscleAnalysis::step ( const SimTK::State &  s,
int  setNumber 
)
overridevirtual

Reimplemented from OpenSim::Analysis.


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