API  4.3
For MATLAB, Python, Java, and C++ users
OpenSim::MocoSumSquaredStateGoal Class Reference

Minimize the sum of squared states, integrated over the phase. More...

+ Inheritance diagram for OpenSim::MocoSumSquaredStateGoal:

OpenSim Properties, Sockets, Outputs, Inputs

Properties (single-value)
MocoWeightSet state_weights
 "Set of weight objects to weight the individual " "state variables in the cost." More...
 
Properties (optional)
std::string pattern
 "If provided, only states matching this regular expression are " "included (default: no pattern). If no pattern is provided, then " "all states are used." More...
 
- OpenSim Properties, Sockets, Outputs, Inputs inherited from OpenSim::MocoGoal
bool enabled
 "This bool indicates whether this goal is enabled." More...
 
double weight
 "In cost mode, the goal is multiplied by this weight (default: " "1)." More...
 
std::string mode
 "'cost' to enforce as a penalty, 'endpoint_constraint' to enforce " "as a constraint." More...
 
MocoConstraintInfo MocoConstraintInfo
 "The bounds and labels for this MocoGoal, if applied as an " "endpoint constraint." More...
 
MocoScaleFactor scale_factors
 "Scale factors added by derived MocoGoal classes that are optimized " "via a MocoParameter. A copy of each MocoScaleFactor component is " "added to the model internal to MocoProblem, which makes the scale " "factors values available when computing the cost function for each " "MocoGoal." More...
 

Public Member Functions

 MocoSumSquaredStateGoal ()
 
 MocoSumSquaredStateGoal (std::string name)
 
 MocoSumSquaredStateGoal (std::string name, double weight)
 
void setWeightSet (const MocoWeightSet &weightSet)
 Provide a MocoWeightSet to weight the state variables in the cost. More...
 
void setWeightForState (const std::string &stateName, const double &weight)
 Set the weight for an individual state variable. More...
 
void setPattern (std::string pattern)
 Only state paths matching the regular expression are included. More...
 
void clearPattern ()
 Unset the pattern, which causes all states to be matched. More...
 
std::string getPattern () const
 
- Public Member Functions inherited from OpenSim::MocoGoal
 MocoGoal ()
 
 MocoGoal (std::string name)
 
 MocoGoal (std::string name, double weight)
 
void setEnabled (bool enabled)
 Set whether this goal is used in the problem. More...
 
bool getEnabled () const
 
void setWeight (double weight)
 In cost mode, the goal is multiplied by this weight. More...
 
double getWeight () const
 
void setMode (std::string mode)
 Set the mode property to either 'cost' or 'endpoint_constraint'. More...
 
std::string getModeAsString () const
 This returns the default mode of the goal, unless the user overrode the default using setMode(). More...
 
Mode getMode () const
 
bool getModeIsCost () const
 
bool getModeIsEndpointConstraint () const
 
Mode getDefaultMode () const
 Types of goals have a class-level default for whether they are enforced as a cost or endpoint constraint. More...
 
bool getSupportsEndpointConstraint () const
 Can this goal be used in endpoint constraint mode? More...
 
const MocoConstraintInfogetConstraintInfo () const
 Get bounds for the constraints that are enforced when using this goal in endpoint constraint mode. More...
 
MocoConstraintInfoupdConstraintInfo ()
 
int getNumOutputs () const
 Get the length of the return value of calcGoal(). More...
 
int getNumIntegrals () const
 Get the number of integrals required by this cost. More...
 
SimTK::Stage getStageDependency () const
 Obtain the stage that this goal depends on. More...
 
SimTK::Real calcIntegrand (const IntegrandInput &input) const
 Calculate the integrand that should be integrated and passed to calcCost(). More...
 
void calcGoal (const GoalInput &input, SimTK::Vector &goal) const
 In cost mode, the returned cost includes the weight, and the elements of the returned vector should be summed by the caller to obtain the total cost. More...
 
void initializeOnModel (const Model &model) const
 Perform error checks on user input for this goal, and cache quantities needed when computing the goal value. More...
 
std::vector< MocoScaleFactorgetScaleFactors () const
 Get a vector of the MocoScaleFactors added to this MocoGoal. More...
 
void printDescription () const
 Print the name type and mode of this goal. More...
 
- 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
 

Auto-generated functions

static MocoSumSquaredStateGoalsafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "MocoSumSquaredStateGoal". More...
 
MocoSumSquaredStateGoalclone () 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from OpenSim::MocoGoal
static MocoGoalsafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "MocoGoal". 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...
 

Detailed Description

Minimize the sum of squared states, integrated over the phase.

For example, this can be used to minimize muscle activations, as is done in MocoInverse.

This goal is computed as follows:

\[ \int_{t_i}^{t_f} \sum_{s \in S} w_s y_s(t)^2 ~dt \]

We use the following notation:

  • \( t_i \): the initial time of this phase.
  • \( t_f \): the final time of this phase.
  • \( S \): the set of state variables selected for this goal.
  • \( w_s \): the weight for state variable \( s \).
  • \( y_s(t) \): state variable \( s \).

Select which states to minimize by using a regex pattern with setPattern(). Provide weights for each state through setWeightSet() or setWeightForState().

Constructor & Destructor Documentation

◆ MocoSumSquaredStateGoal() [1/3]

OpenSim::MocoSumSquaredStateGoal::MocoSumSquaredStateGoal ( )

◆ MocoSumSquaredStateGoal() [2/3]

OpenSim::MocoSumSquaredStateGoal::MocoSumSquaredStateGoal ( std::string  name)
inline

◆ MocoSumSquaredStateGoal() [3/3]

OpenSim::MocoSumSquaredStateGoal::MocoSumSquaredStateGoal ( std::string  name,
double  weight 
)
inline

Member Function Documentation

◆ calcGoalImpl()

void OpenSim::MocoSumSquaredStateGoal::calcGoalImpl ( const GoalInput input,
SimTK::Vector &  goal 
) const
inlineoverrideprotectedvirtual

You may need to realize the state to the stage required for your calculations.

Do NOT realize to a stage higher than the goal's stage dependency; doing so will cause an exception to be thrown. The Lagrange multipliers for kinematic constraints are not available.

Implements OpenSim::MocoGoal.

References OpenSim::MocoGoal::GoalInput::integral.

◆ calcIntegrandImpl()

void OpenSim::MocoSumSquaredStateGoal::calcIntegrandImpl ( const IntegrandInput input,
SimTK::Real &  integrand 
) const
overrideprotectedvirtual

You may need to realize the state to the stage required for your calculations.

Do NOT realize to a stage higher than the goal's stage dependency; doing so will cause an exception to be thrown. The Lagrange multipliers for kinematic constraints are not available.

Reimplemented from OpenSim::MocoGoal.

◆ clearPattern()

void OpenSim::MocoSumSquaredStateGoal::clearPattern ( )
inline

Unset the pattern, which causes all states to be matched.

◆ clone()

MocoSumSquaredStateGoal* OpenSim::MocoSumSquaredStateGoal::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::MocoGoal.

◆ getClassName()

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

This returns "MocoSumSquaredStateGoal".

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

◆ getConcreteClassName()

const std::string& OpenSim::MocoSumSquaredStateGoal::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::MocoGoal.

◆ getPattern()

std::string OpenSim::MocoSumSquaredStateGoal::getPattern ( ) const
inline

◆ initializeOnModelImpl()

void OpenSim::MocoSumSquaredStateGoal::initializeOnModelImpl ( const Model ) const
overrideprotectedvirtual

Perform any caching before the problem is solved.

You must override this function and invoke setRequirements().

Precondition(s):
The model is initialized (initSystem()) and getModel() is available. The passed-in model is equivalent to getModel(). Use this opportunity to check for errors in user input.

Implements OpenSim::MocoGoal.

◆ printDescriptionImpl()

void OpenSim::MocoSumSquaredStateGoal::printDescriptionImpl ( ) const
overrideprotectedvirtual

Print a more detailed description unique to each goal.

Reimplemented from OpenSim::MocoGoal.

◆ safeDownCast()

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

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

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

◆ setPattern()

void OpenSim::MocoSumSquaredStateGoal::setPattern ( std::string  pattern)
inline

Only state paths matching the regular expression are included.

The regular expression must match the entire state path for a state path to be included (that is, we use std::regex_match, not std::regex_search). To include only generalized coordinates, use .*value$. To include generalized coordinates and speeds, use .*(value|speed)$. To include only activations, use .*activation$.

◆ setWeightForState()

void OpenSim::MocoSumSquaredStateGoal::setWeightForState ( const std::string &  stateName,
const double &  weight 
)
inline

Set the weight for an individual state variable.

If a weight is already set for the requested state, then the provided weight replaces the previous weight. An exception is thrown if a weight for an unknown state is provided.

◆ setWeightSet()

void OpenSim::MocoSumSquaredStateGoal::setWeightSet ( const MocoWeightSet weightSet)
inline

Provide a MocoWeightSet to weight the state variables in the cost.

Replaces the weight set if it already exists.

OpenSim Property, Socket, Output, Input Documentation

◆ pattern

std::string OpenSim::MocoSumSquaredStateGoal::pattern

"If provided, only states matching this regular expression are " "included (default: no pattern). If no pattern is provided, then " "all states are used."

This property appears in XML files under the tag <pattern>. This property was generated with the OpenSim_DECLARE_OPTIONAL_PROPERTY macro; see Property to learn about the property system.

See also
get_pattern(), upd_pattern(), set_pattern()

◆ state_weights

MocoWeightSet OpenSim::MocoSumSquaredStateGoal::state_weights

"Set of weight objects to weight the individual " "state variables in the cost."

This property appears in XML files under the tag <state_weights>. This property was generated with the OpenSim_DECLARE_PROPERTY macro; see Property to learn about the property system.

See also
get_state_weights(), upd_state_weights(), set_state_weights()

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