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

A class for holding a set of generalized cross-validated splines. More...

+ Inheritance diagram for OpenSim::GCVSplineSet:

Public Member Functions

 GCVSplineSet ()
 
 GCVSplineSet (const char *aFileName)
 Construct a set of generalized cross-validated splines from file. More...
 
 GCVSplineSet (int aDegree, const Storage *aStore, double aErrorVariance=0.0)
 Construct a set of generalized cross-validated splines based on the states stored in an Storage object. More...
 
 GCVSplineSet (const TimeSeriesTable &table, const std::vector< std::string > &labels={}, int degree=5, double errorVariance=0.0)
 Construct a set of generalized cross-validated splines based on the states stored in a TimeSeriesTable. More...
 
virtual ~GCVSplineSet ()
 
GCVSplinegetGCVSpline (int aIndex) const
 Get the function at a specified index. More...
 
double getMinX () const
 
double getMaxX () const
 
StorageconstructStorage (int aDerivOrder, double aDX=-1)
 Construct a storage object (see Storage) for this spline set or for some derivative of this spline set. More...
 
- Public Member Functions inherited from OpenSim::FunctionSet
 FunctionSet ()
 
 FunctionSet (const std::string &aFileName)
 
virtual ~FunctionSet ()
 
virtual double evaluate (int aIndex, int aDerivOrder, double aX=0.0) const
 
virtual void evaluate (Array< double > &rValues, int aDerivOrder, double aX=0.0) const
 
- Public Member Functions inherited from OpenSim::Set< Function >
virtual ~Set ()
 Destructor. More...
 
 Set ()
 Default constructor. More...
 
 Set (const std::string &aFileName, bool aUpdateFromXMLNode=true)
 Construct from file. More...
 
 Set (const Set< Function, Object > &aSet)
 Copy constructor. More...
 
void setupGroups ()
 Setup groups (match group member names to set members). More...
 
Set< Function, Object > & operator= (const Set< Function, Object > &set)
 Assign this set to another set. More...
 
Functionoperator[] (int aIndex) const
 Get a pointer to the set object at a specified index. More...
 
void setMemoryOwner (bool aTrueFalse)
 Set whether or not this Set owns the memory pointed to by the pointers it holds. More...
 
bool getMemoryOwner () const
 Get whether or not this array owns the memory pointed to by the pointers in its array. More...
 
bool computeNewCapacity (int aMinCapacity, int &rNewCapacity)
 Compute a new capacity that is at least as large as a specified minimum capacity; this method does not change the capacity, it simply computes a new recommended capacity. More...
 
bool ensureCapacity (int aCapacity)
 Ensure that the capacity of this array is at least the specified amount. More...
 
void trim ()
 Trim the capacity of this array so that it is one larger than the size of this array. More...
 
int getCapacity () const
 Get the capacity of this storage instance. More...
 
void setCapacityIncrement (int aIncrement)
 Set the amount by which the capacity is increased when the capacity of of the array in exceeded. More...
 
int getCapacityIncrement () const
 Get the amount by which the capacity is increased. More...
 
virtual bool setSize (int aSize)
 Set the size of the array. More...
 
int getSize () const
 Get the size of the array. More...
 
virtual int getIndex (const Function *aObject, int aStartIndex=0) const
 Get the index of an object. More...
 
virtual int getIndex (const std::string &aName, int aStartIndex=0) const
 Get the index of an object by specifying its name. More...
 
void getGroupNamesContaining (const std::string &aObjectName, Array< std::string > &rGroupNames) const
 Get names of groups containing a given object. More...
 
virtual bool adoptAndAppend (Function *aObject)
 Append to the array, and adopt passed in pointer. More...
 
virtual bool cloneAndAppend (const Function &aObject)
 cloneAndAppend creates a clone of the passed in object and appends the clone to the array. More...
 
virtual bool insert (int aIndex, Function *aObject)
 Insert an object into the array at a specified index. More...
 
virtual bool insert (int aIndex, const Function &aObject)
 Insert an object into the array at a specified index. More...
 
virtual bool remove (int aIndex)
 Remove an object from the array at a specified index. More...
 
virtual bool remove (const Function *aObject)
 Remove an object from the array by specifying its address. More...
 
virtual void clearAndDestroy ()
 
virtual bool set (int aIndex, Function *aObject, bool preserveGroups=false)
 Set the object at a specified index. More...
 
virtual bool set (int aIndex, const Function &aObject, bool preserveGroups=false)
 Set the object at a specified index. More...
 
virtual Functionget (int aIndex) const
 Get the value at a specified array index. More...
 
Functionget (const std::string &aName)
 Get the first object that has a specified name. More...
 
const Functionget (const std::string &aName) const
 
bool contains (const std::string &aName) const
 Get whether this Set contains any object with the specified name. More...
 
virtual void getNames (OpenSim::Array< std::string > &rNames) const
 Get names of objects in the set. More...
 
virtual FunctiongetLast () const
 Get the last value in the array. More...
 
int searchBinary (const Function &aObject, bool aFindFirst=false, int aLo=-1, int aHi=-1) const
 Search for the largest value in the array that is less than or equal to a specified value. More...
 
int getNumGroups () const
 Get the number of groups. More...
 
void addGroup (const std::string &aGroupName)
 Add an empty group to the set. More...
 
void removeGroup (const std::string &aGroupName)
 Remove a group from the set. More...
 
void renameGroup (const std::string &oldGroupName, const std::string &newGroupName)
 Rename a group. More...
 
void addObjectToGroup (const std::string &aGroupName, const std::string &aObjectName)
 Add an object to a group. More...
 
void getGroupNames (Array< std::string > &rGroupNames) const
 Get names of all groups. More...
 
const ObjectGroupgetGroup (const std::string &aGroupName) const
 Get a group by name. More...
 
const ObjectGroupgetGroup (int aIndex) const
 Get a group by index. More...
 
Setclone () const override
 
const std::string & getConcreteClassName () const override
 
- 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 GCVSplineSetsafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "GCVSplineSet". More...
 
GCVSplineSetclone () 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::FunctionSet
static FunctionSetsafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "FunctionSet". More...
 
- Static Public Member Functions inherited from OpenSim::Set< Function >
static SetsafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "Set_<T>_". 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

A class for holding a set of generalized cross-validated splines.

See also
GCVSpline
Author
Frank C. Anderson

Constructor & Destructor Documentation

◆ GCVSplineSet() [1/4]

OpenSim::GCVSplineSet::GCVSplineSet ( )

◆ GCVSplineSet() [2/4]

OpenSim::GCVSplineSet::GCVSplineSet ( const char *  aFileName)

Construct a set of generalized cross-validated splines from file.

Parameters
aFileNameName of the file.

◆ GCVSplineSet() [3/4]

OpenSim::GCVSplineSet::GCVSplineSet ( int  aDegree,
const Storage aStore,
double  aErrorVariance = 0.0 
)

Construct a set of generalized cross-validated splines based on the states stored in an Storage object.

Each column in the Storage object is fit with a spline of the specified degree and is named the name of its corresponding column label. Note that column labels in the storage object are assumed to be tab delimited.

Parameters
aDegreeDegree of the constructed splines (1, 3, 5, or 7).
aStoreStorage object.
aErrorVarianceEstimate of the variance of the error in the data to be fit. If negative, the variance will be estimated. If 0.0, the fit will try to fit the data points exactly- no smoothing. If positive, the fits will be smoothed according to the specified variance. The larger the error variance, the more the smoothing. Note that this is the error variance assumed for each column in the Storage. If different variances should be set for the various columns, you will need to construct each GCVSpline individually.
See also
Storage
GCVSpline

◆ GCVSplineSet() [4/4]

OpenSim::GCVSplineSet::GCVSplineSet ( const TimeSeriesTable table,
const std::vector< std::string > &  labels = {},
int  degree = 5,
double  errorVariance = 0.0 
)

Construct a set of generalized cross-validated splines based on the states stored in a TimeSeriesTable.

Each column in the TimeSeriesTable is fit with a spline of the specified degree and is named the name of its corresponding column label.

Parameters
tableTimeSeriesTable object.
labelsColumns to use from TimeSeriesTable.
degreeDegree of the constructed splines (1, 3, 5, or 7).
errorVarianceEstimate of the variance of the error in the data to be fit. If negative, the variance will be estimated. If 0.0, the fit will try to fit the data points exactly- no smoothing. If positive, the fits will be smoothed according to the specified variance. The larger the error variance, the more the smoothing. Note that this is the error variance assumed for each column in the TimeSeriesTable. If different variances should be set for the various columns, you will need to construct each GCVSpline individually.
See also
TimeSeriesTable.
GCVSpline

◆ ~GCVSplineSet()

virtual OpenSim::GCVSplineSet::~GCVSplineSet ( )
virtual

Member Function Documentation

◆ clone()

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

Reimplemented from OpenSim::FunctionSet.

◆ constructStorage()

Storage* OpenSim::GCVSplineSet::constructStorage ( int  aDerivOrder,
double  aDX = -1 
)

Construct a storage object (see Storage) for this spline set or for some derivative of this spline set.

Parameters
aDerivOrderDerivative order. 0 constructs from the spline, 1 constructs from the first derivative of the spline, 2 constructs from the second derivative of the spline, etc.
aDXSpacing of the data points in the independent variable. If negative the spacing of the independent variable is taken from the original data, as determined from the first non-NULL spline in the set. aDX has a default value of -1.
Returns
Storage object. If a valid storage object cannot be constructed NULL is returned.
See also
Storage

◆ getClassName()

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

This returns "GCVSplineSet".

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

◆ getConcreteClassName()

const std::string& OpenSim::GCVSplineSet::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()

Reimplemented from OpenSim::FunctionSet.

◆ getGCVSpline()

GCVSpline* OpenSim::GCVSplineSet::getGCVSpline ( int  aIndex) const

Get the function at a specified index.

Parameters
aIndexIndex of the desired function: 0 <= aIndex < getSize().
Returns
Function at index aIndex. If aIndex is not a valid value NULL is returned.

◆ getMaxX()

double OpenSim::GCVSplineSet::getMaxX ( ) const

◆ getMinX()

double OpenSim::GCVSplineSet::getMinX ( ) const

◆ safeDownCast()

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

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

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


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