OpenSim::GCVSplineSet Class Reference

#include <GCVSplineSet.h>

Inheritance diagram for OpenSim::GCVSplineSet:

List of all members.

Public Member Functions
	GCVSplineSet ()
	Default constructor.
	GCVSplineSet (const char *aFileName)
	Construct a set of generalized cross-validated splines from file.
	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.
virtual	~GCVSplineSet ()
	Destructor.
GCVSpline *	getGCVSpline (int aIndex) const
	Get the function at a specified index.
double	getMinX () const
double	getMaxX () const
Storage *	constructStorage (int aDerivOrder, double aDX=-1)
	Construct a storage object (see Storage) for this spline \ or for some derivative of this spline set.

---

Constructor & Destructor Documentation

GCVSplineSet::GCVSplineSet

(

)

Default constructor.

GCVSplineSet::GCVSplineSet

(

const char *

aFileName

)

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

Parameters:

aFileName

Name of the file.

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:

	aDegree	Degree of the constructed splines (1, 3, 5, or 7).
	aStore	Storage object.
	aErrorVariance	Estimate 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 veriance, 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::~GCVSplineSet

(

)

[virtual]

Destructor.

---

Member Function Documentation

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

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

Parameters:

	aDerivOrder	Derivative 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.
	aDX	Spacing 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

GCVSpline * GCVSplineSet::getGCVSpline

(

int

aIndex

)

const

Get the function at a specified index.

Parameters:

aIndex

Index of the desired function: 0 <= aIndex < getSize().

Returns:

Function at index aIndex. If aIndex is not value NULL is returned.

double GCVSplineSet::getMaxX

(

)

const

double GCVSplineSet::getMinX

(

)

const

---

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

• OpenSim/Common/GCVSplineSet.h
• OpenSim/Common/GCVSplineSet.cpp