OpenSim  OpenSim 3.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
OpenSim::GCVSpline Class Reference

#include <GCVSpline.h>

Inheritance diagram for OpenSim::GCVSpline:
OpenSim::Function OpenSim::Object

Public Member Functions

 GCVSpline ()
 GCVSpline (int aDegree, int aN, const double *aTimes, const double *aValues, const std::string &aName="", double aErrorVariance=0.0)
 GCVSpline (const GCVSpline &aSpline)
virtual ~GCVSpline ()
virtual void updateFromXMLNode (SimTK::Xml::Element &aNode, int versionNumber=-1)
 Use this method to deserialize an object from a SimTK::Xml::Element.
GCVSplineoperator= (const GCVSpline &aSpline)
void setDegree (int aDegree)
int getDegree () const
int getOrder () const
int getHalfOrder () const
int getSize () const
const Array< double > & getX () const
virtual const double * getXValues () const
virtual const double * getYValues () const
const Array< double > & getCoefficients () const
virtual int getNumberOfPoints () const
virtual double getX (int aIndex) const
virtual double getY (int aIndex) const
virtual double getZ (int aIndex) const
virtual void setX (int aIndex, double aValue)
virtual void setY (int aIndex, double aValue)
virtual double getMinX () const
virtual double getMaxX () const
virtual bool deletePoint (int aIndex)
virtual bool deletePoints (const Array< int > &indices)
virtual int addPoint (double aX, double aY)
SimTK::Function * createSimTKFunction () const
- Public Member Functions inherited from OpenSim::Function
 Function ()
 Function (const Function &aFunction)
virtual ~Function ()
virtual void init (Function *aFunction)
Functionoperator= (const Function &aFunction)
virtual double calcValue (const SimTK::Vector &x) const
 Calculate the value of this function at a particular point.
virtual double calcDerivative (const std::vector< int > &derivComponents, const SimTK::Vector &x) const
 Calculate a partial derivative of this function at a particular point.
virtual int getArgumentSize () const
 Get the number of components expected in the input vector.
virtual int getMaxDerivativeOrder () const
 Get the maximum derivative order this Function object can calculate.
- Public Member Functions inherited from OpenSim::Object
virtual ~Object ()
 Virtual destructor for cleanup.
virtual Objectclone () const =0
 
Create a new heap-allocated copy of the concrete object to which this 

Object refers.

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.

virtual const VisibleObjectgetDisplayer () const
 Methods to support making the object displayable in the GUI or Visualizer Implemented only in few objects.
virtual VisibleObjectupdDisplayer ()
 get Non const pointer to VisibleObject
bool isEqualTo (const Object &aObject) const
 Equality operator wrapper for use from languages not supporting operator overloading.
Objectoperator= (const Object &aObject)
 
Copy assignment copies he base class fields, including the 

properties.

virtual bool operator== (const Object &aObject) const
 Determine if two objects are equal.
virtual bool operator< (const Object &aObject) const
 
Provide an ordering for objects so they can be put in sorted

containers.

void setName (const std::string &name)
 Set the name of the Object.
const std::string & getName () const
 Get the name of this Object.
void setDescription (const std::string &description)
 Set description, a one-liner summary.
const std::string & getDescription () const
 Get description, a one-liner summary.
const std::string & getAuthors () const
 Get Authors of this Object.
void setAuthors (const std::string &authors)
 Set Authors of this object, call this method in your constructor if needed.
const std::string & getReferences () const
 Get references or publications to cite if using this object.
void setReferences (const std::string &references)
 Set references or publications to cite if using this object.
int getNumProperties () const
 Determine how many properties are stored with this Object.
const AbstractPropertygetPropertyByIndex (int propertyIndex) const
 
Get a const reference to a property by its index number, returned as

an AbstractProperty.

AbstractPropertyupdPropertyByIndex (int propertyIndex)
 
Get a writable reference to a property by its index number, returned as

an AbstractProperty.

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.

const AbstractPropertygetPropertyByName (const std::string &name) const
 
Get a const reference to a property by its name, returned as

an AbstractProperty.

AbstractPropertyupdPropertyByName (const std::string &name)
 
Get a writable reference to a property by its name, returned as

an AbstractProperty.

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.

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.

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.

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.

bool isObjectUpToDateWithProperties () const
 
Returns \c true if any property's value has changed since the last time

setObjectIsUpToDateWithProperties() was called.

void readObjectFromXMLNodeOrFile (SimTK::Xml::Element &objectElement, int versionNumber)
 We're given an XML element from which we are to populate this Object.
virtual void updateXMLNode (SimTK::Xml::Element &parent)
 Serialize this object into the XML node that represents it.
bool getInlined () const
 
Inlined means an in-memory Object that is not associated with

an XMLDocument.

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.

std::string getDocumentFileName () const
 
If there is a document associated with this object then return the

file name maintained by the document.

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".

std::string dump (bool dumpName=false)
 dump the XML representation of this Object into an std::string and return it.
void clearObjectIsUpToDateWithProperties ()
 
For testing or debugging purposes, manually clear the "object is up to 

date with respect to properties" flag.

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.

const std::string & toString () const
 
Wrapper to be used on Java side to display objects in tree; this returns

just the object's name.

PropertySetgetPropertySet ()
 
OBSOLETE: Get a reference to the PropertySet maintained by the 

Object.

const PropertySetgetPropertySet () const

Protected Attributes

PropertyInt _propHalfOrder
 Half order of the spline (degree+1)/2.
PropertyDbl _propErrorVariance
 Error variance for the data and spline fit.
PropertyDblArray _propX
 
Array of values for the independent variables (i.e., the spline knot

sequence).

PropertyDblArray _propWeights
 Array of weight values, one for each data point.
PropertyDblArray _propCoefficients
 Spline coefficients.
PropertyDblArray _propY
 Spline Y values.
int & _halfOrder
 Reference to the value of the HalfOrder property.
double & _errorVariance
 Reference to the value of the ErrorVariance property.
Array< double > & _x
 Reference to the value of the X property.
Array< double > & _weights
 Reference to the value of the Weights property.
Array< double > & _coefficients
 Reference to the value of the Coefficients property.
Array< double > & _y
 Y (dependent) values of the function.
std::vector< int > _workDeriv
 A workspace used when calculating derivatives of the spline.
- Protected Attributes inherited from OpenSim::Function
SimTK::Function * _function
- Protected Attributes inherited from OpenSim::Object
PropertySet _propertySet
 
OBSOLETE: Property_Deprecated set for serializable member variables of 

this and derived classes.

Additional Inherited Members

- Static Public Member Functions inherited from OpenSim::Function
static FunctionmakeFunctionOfType (Function *aFunction, const std::string &aNewTypeName)
- Static Public Attributes inherited from OpenSim::Object
static const std::string DEFAULT_NAME
 Name used for default objects when they are serialized.
- Protected Member Functions inherited from OpenSim::Function
void resetFunction ()
 This should be called whenever this object has been modified.

Constructor & Destructor Documentation

OpenSim::GCVSpline::GCVSpline ( )
OpenSim::GCVSpline::GCVSpline ( int  aDegree,
int  aN,
const double *  aTimes,
const double *  aValues,
const std::string &  aName = "",
double  aErrorVariance = 0.0 
)
OpenSim::GCVSpline::GCVSpline ( const GCVSpline aSpline)
virtual OpenSim::GCVSpline::~GCVSpline ( )
virtual

Member Function Documentation

virtual int OpenSim::GCVSpline::addPoint ( double  aX,
double  aY 
)
virtual
SimTK::Function* OpenSim::GCVSpline::createSimTKFunction ( ) const
virtual

Implements OpenSim::Function.

virtual bool OpenSim::GCVSpline::deletePoint ( int  aIndex)
virtual
virtual bool OpenSim::GCVSpline::deletePoints ( const Array< int > &  indices)
virtual
const Array<double>& OpenSim::GCVSpline::getCoefficients ( ) const
int OpenSim::GCVSpline::getDegree ( ) const
int OpenSim::GCVSpline::getHalfOrder ( ) const
virtual double OpenSim::GCVSpline::getMaxX ( ) const
virtual
virtual double OpenSim::GCVSpline::getMinX ( ) const
virtual
virtual int OpenSim::GCVSpline::getNumberOfPoints ( ) const
inlinevirtual
int OpenSim::GCVSpline::getOrder ( ) const
int OpenSim::GCVSpline::getSize ( ) const
const Array<double>& OpenSim::GCVSpline::getX ( ) const
virtual double OpenSim::GCVSpline::getX ( int  aIndex) const
virtual
virtual const double* OpenSim::GCVSpline::getXValues ( ) const
virtual
virtual double OpenSim::GCVSpline::getY ( int  aIndex) const
virtual
virtual const double* OpenSim::GCVSpline::getYValues ( ) const
virtual
virtual double OpenSim::GCVSpline::getZ ( int  aIndex) const
inlinevirtual
GCVSpline& OpenSim::GCVSpline::operator= ( const GCVSpline aSpline)
void OpenSim::GCVSpline::setDegree ( int  aDegree)
virtual void OpenSim::GCVSpline::setX ( int  aIndex,
double  aValue 
)
virtual
virtual void OpenSim::GCVSpline::setY ( int  aIndex,
double  aValue 
)
virtual
virtual void OpenSim::GCVSpline::updateFromXMLNode ( SimTK::Xml::Element &  objectElement,
int  versionNumber = -1 
)
virtual

Use this method to deserialize an object from a SimTK::Xml::Element.

The element is assumed to be in the format consistent with the passed-in versionNumber. If there is a file attribute in objectElement it will be ignored; if you want it processed you should call readObjectFromXMLNodeOrFile() instead.

Reimplemented from OpenSim::Object.

Member Data Documentation

Array<double>& OpenSim::GCVSpline::_coefficients
protected

Reference to the value of the Coefficients property.

double& OpenSim::GCVSpline::_errorVariance
protected

Reference to the value of the ErrorVariance property.

int& OpenSim::GCVSpline::_halfOrder
protected

Reference to the value of the HalfOrder property.

PropertyDblArray OpenSim::GCVSpline::_propCoefficients
protected

Spline coefficients.

PropertyDbl OpenSim::GCVSpline::_propErrorVariance
protected

Error variance for the data and spline fit.

The smoothing factor p is computed based on the error variance.

PropertyInt OpenSim::GCVSpline::_propHalfOrder
protected

Half order of the spline (degree+1)/2.

PropertyDblArray OpenSim::GCVSpline::_propWeights
protected

Array of weight values, one for each data point.

PropertyDblArray OpenSim::GCVSpline::_propX
protected

Array of values for the independent variables (i.e., the spline knot

sequence).

This array must be monotonically increasing.

PropertyDblArray OpenSim::GCVSpline::_propY
protected

Spline Y values.

Array<double>& OpenSim::GCVSpline::_weights
protected

Reference to the value of the Weights property.

std::vector<int> OpenSim::GCVSpline::_workDeriv
mutableprotected

A workspace used when calculating derivatives of the spline.

Array<double>& OpenSim::GCVSpline::_x
protected

Reference to the value of the X property.

Array<double>& OpenSim::GCVSpline::_y
protected

Y (dependent) values of the function.

These are called aF in the constructor and are stored here so that the function can be scaled later on.


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