Minimize the error between a model's step time asymmetry and a specified target asymmetry value over a gait cycle.
More...
|
| MocoStepLengthAsymmetryGoal () |
|
| MocoStepLengthAsymmetryGoal (std::string name) |
|
| MocoStepLengthAsymmetryGoal (std::string name, double weight) |
|
void | setLeftFootFrame (const std::string &frame) |
| Set the body frame associated with the left foot. More...
|
|
std::string | getLeftFootFrame () |
|
void | setRightFootFrame (const std::string &frame) |
| Set the body frame associated with the right foot. More...
|
|
std::string | getRightFootFrame () |
|
void | setTargetAsymmetry (double asymmetry) |
| Set the asymmetry value targeted by this goal. More...
|
|
double | getTargetAsymmetry () |
|
void | setStrideLength (double length) |
| Set the known stride length of your walking simulation. More...
|
|
double | getStrideLength () |
|
void | setWalkingDirection (const std::string &direction) |
| Set the walking direction of the model in the ground frame, which is used to compute step lengths. More...
|
|
std::string | getWalkingDirection () |
|
void | setAsymmetrySmoothing (double smoothing) |
| Set the values that determines the smoothing of the asymmetry computation. More...
|
|
double | getAsymmetrySmoothing () |
|
| 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 MocoConstraintInfo & | getConstraintInfo () const |
| Get bounds for the constraints that are enforced when using this goal in endpoint constraint mode. More...
|
|
MocoConstraintInfo & | updConstraintInfo () |
|
void | setEndpointConstraintBounds (const std::vector< MocoBounds > &bounds) |
| Set the vector of endpoint constraint bounds for this MocoGoal. More...
|
|
std::vector< MocoBounds > | getEndpointConstraintBounds () const |
| Get the vector of the endpoint constraint bounds for this MocoGoal. More...
|
|
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< MocoScaleFactor > | getScaleFactors () 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...
|
|
void | setDivideByDisplacement (bool tf) |
| Set if the goal should be divided by the displacement of the system's center of mass over the phase. More...
|
|
bool | getDivideByDisplacement () const |
|
void | setDivideByDuration (bool tf) |
| Set if the goal should be divided by the phase duration. More...
|
|
bool | getDivideByDuration () const |
|
void | setDivideByMass (bool tf) |
| Set if the goal should be divided by the model's mass. More...
|
|
bool | getDivideByMass () const |
|
std::unordered_map< std::string, int > | getInputControlIndexMap () const |
| Get a map between Input control names and their indexes in the Input controls vector. More...
|
|
const SimTK::Vector & | getInputControls (const SimTK::State &state) const |
| Get the vector of all InputController controls. More...
|
|
void | assign (Object &aObject) override |
| This allows copy assignment in the Java GUI. More...
|
|
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...
|
|
Object & | operator= (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 AbstractProperty & | getPropertyByIndex (int propertyIndex) const |
| Get a const reference to a property by its index number, returned as an AbstractProperty. More...
|
|
AbstractProperty & | updPropertyByIndex (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 AbstractProperty & | getPropertyByName (const std::string &name) const |
| Get a const reference to a property by its name, returned as an AbstractProperty. More...
|
|
AbstractProperty & | updPropertyByName (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 > |
const Property< T > & | getPropertyByName (const std::string &name) 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...
|
|
template<class T > |
Property< T > & | updPropertyByName (const std::string &name) |
| 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...
|
|
PropertySet & | getPropertySet () |
| OBSOLETE: Get a reference to the PropertySet maintained by the Object. More...
|
|
const PropertySet & | getPropertySet () const |
|
|
void | initializeOnModelImpl (const Model &) const override |
| Perform any caching before the problem is solved. More...
|
|
void | calcIntegrandImpl (const IntegrandInput &input, double &integrand) const override |
|
void | calcGoalImpl (const GoalInput &input, SimTK::Vector &cost) const override |
| You may need to realize the state to the stage required for your calculations. More...
|
|
void | printDescriptionImpl () const override |
| Print a more detailed description unique to each goal. More...
|
|
void | setRequirements (int numIntegrals, int numOutputs, SimTK::Stage stageDependency=SimTK::Stage::Acceleration) const |
| Set the number of integral terms required by this goal and the length of the vector passed into calcGoalImpl(). More...
|
|
virtual Mode | getDefaultModeImpl () const |
|
virtual bool | getSupportsEndpointConstraintImpl () const |
|
virtual void | calcIntegrandImpl (const IntegrandInput &input, SimTK::Real &integrand) const |
| You may need to realize the state to the stage required for your calculations. More...
|
|
const Model & | getModel () const |
| For use within virtual function implementations. More...
|
|
double | calcSystemDisplacement (const GoalInput &input) const |
| Calculate the displacement of the system's center of mass over the phase. More...
|
|
double | calcDuration (const GoalInput &input) const |
| Calculate the duration of the phase. More...
|
|
double | calcSystemMass (const GoalInput &input) const |
| Calculate the mass of the system. More...
|
|
void | appendScaleFactor (const MocoScaleFactor &scaleFactor) |
| Append a MocoScaleFactor to this MocoGoal. More...
|
|
| Object () |
| The default constructor is only for use by constructors of derived types. More...
|
|
| Object (const std::string &fileName, bool aUpdateFromXMLNode=true) |
| 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...
|
|
template<class T > |
void | checkPropertyValueIsPositive (const Property< T > &p) const |
| Throw an exception if any of the property's values are not positive. More...
|
|
template<class T > |
void | checkPropertyValueIsInSet (const Property< T > &p, const std::set< T > &set) const |
| Throw an exception if any of the property's values are not in the provided set. More...
|
|
template<class T > |
void | checkPropertyValueIsInRangeOrSet (const Property< T > &p, const T &lower, const T &upper, const std::set< T > &set) const |
| Throw an exception if any of the property's values are neither in the provided range nor in the provided set. 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...
|
|
void | clearObjectIsUpToDateWithProperties () |
| For testing or debugging purposes, manually clear the "object is up to
date with respect to properties" flag. More...
|
|
void | makeObjectNamesConsistentWithProperties () |
| Make sure the name of an object is consistent with its property type. 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 *) |
| Unconditionally set the XMLDocument associated with this object. More...
|
|
const XMLDocument * | getDocument () const |
| Get a const pointer to the document (if any) associated with this object. More...
|
|
XMLDocument * | updDocument () |
| Get a writable pointer to the document (if any) associated with this object. More...
|
|
|
static MocoGoal * | safeDownCast (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 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 Object * | getDefaultInstanceOfType (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 Object * | newInstanceOfType (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 Object * | makeObjectFromFile (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 Object * | SafeCopy (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 const std::string | DEFAULT_NAME |
| Name used for default objects when they are serialized. More...
|
|
PropertySet | _propertySet |
| OBSOLETE: Property_Deprecated set for serializable member variables of this and derived classes. More...
|
|
#define | OpenSim_DECLARE_CONCRETE_OBJECT(ConcreteClass, SuperClass) |
| Macro to be included as the first line of the class declaration for any non-templatized, concrete class that derives from OpenSim::Object. More...
|
|
#define | OpenSim_DECLARE_ABSTRACT_OBJECT(ConcreteClass, SuperClass) |
| Macro to be included as the first line of the class declaration for any still-abstract class that derives from OpenSim::Object. More...
|
|
#define | OpenSim_DECLARE_CONCRETE_OBJECT_T(ConcreteClass, TArg, SuperClass) |
| Macro to be included as the first line of the class declaration for any templatized, concrete class that derives from OpenSim::Object, like Set<T>. More...
|
|
#define | OpenSim_DECLARE_ABSTRACT_OBJECT_T(ConcreteClass, TArg, SuperClass) |
| Macro to be included as the first line of the class declaration for any templatized, still-abstract class that derives from OpenSim::Object. More...
|
|
Minimize the error between a model's step time asymmetry and a specified target asymmetry value over a gait cycle.
Step Length Asymmetry (SLA) is a ratio and is calculated as follows: The Right Step Length (RSL) is the distance between feet at right foot strike The Left Step Length (LSL) is the distance between feet at left foot strike Step Length Asymmetry = (RSL - LSL) / (RSL + LSL)
In this goal, the distance between feet, or "foot frames", is limited throughout the gait cycle. The goal calculates the distance between the left foot and right foot, then limits the distance between feet to not pass beyond minimum (negative) or maximum (positive) bounds. There are two limits used: one that limits the distance between feet when the right foot is in front, and one that limits the distance between feet when the left foot is in front.
Users must provide the target asymmetry value via 'setTargetAsymmetry()'. Asymmetry values ranges from -1.0 to 1.0. For example, 0.20 is 20% positive step length asymmetry with greater right step length than left step length. A symmetric step length solution can be achieved by setting this property to zero. This goal can be used only in 'cost' mode. To make this goal suitable for gradient-based optimization, step length values are assigned via a smoothing function which can be controlled via 'setAsymmetrySmoothing()'.
Users must also prescribe the stride length via 'setStrideLength()'. The goal then calculates the minimum and maximum bounds on the distance between right and left foot. Users must ensure that this stride length is met via problem bounds or other goals; the value provided to MocoStepLengthAsymmetryGoal is only used to compute the model's asymmetry in the cost function.
- Note
- This goal is designed for simulations of bipedal gait.
-
Since this goal approximates step length asymmetry, users should calculate the true asymmetry value after running an optimization.