OpenSim::MarkersReference Class Reference

#include <MarkersReference.h>

Inheritance diagram for OpenSim::MarkersReference:

Public Member Functions
virtual	~MarkersReference ()
	MarkersReference ()
	An implementation of the MarkersReference.
	MarkersReference (const std::string filename, Units modelUnits=Units(Units::Meters))
	MarkersReference (MarkerData &aMarkerData, const Set< MarkerWeight > *aMarkerWeightSet=NULL)
	Convenience constructor to be used for Marker placement.
MarkersReference &	operator= (const MarkersReference &aRef)
	Assign this object to the values of another.
void	copyData (const MarkersReference &aRef)
void	loadMarkersFile (const std::string markerFile, Units modelUnits=Units(Units::Meters))
	load the marker data for this MarkersReference from markerFile
virtual int	getNumRefs () const
	get the number of referettes (individual signals) in this Reference.
virtual SimTK::Vec2	getValidTimeRange () const
	get the time range for which the MarkersReference values are valid, based on the loaded marker data.
virtual const SimTK::Array_ < std::string > &	getNames () const
	get the names of the markers serving as references
virtual void	getValues (const SimTK::State &s, SimTK::Array_< SimTK::Vec3 > &values) const
	get the value of the MarkersReference
virtual void	getSpeedValues (const SimTK::State &s, SimTK::Array_< SimTK::Vec3 > &speedValues) const
	get the speed value of the MarkersReference
virtual void	getAccelerationValues (const SimTK::State &s, SimTK::Array_< SimTK::Vec3 > &accValues) const
	get the acceleration value of the MarkersReference
virtual void	getWeights (const SimTK::State &s, SimTK::Array_< double > &weights) const
	get the weighting (importance) of meeting this MarkersReference in the same order as names
double	getSamplingFrequency ()
Set< MarkerWeight > &	updMarkerWeightSet ()
void	setMarkerWeightSet (Set< MarkerWeight > &markerWeights)
void	setDefaultWeight (double weight)
Protected Attributes
PropertyStr	_markersFileProp
	Specify the reference markers value from a file of columns in time.
std::string &	_markersFile
PropertyObj	_markerWeightSetProp
	Specify the individual weightings of markers to be matched.
Set< MarkerWeight > &	_markerWeightSet
PropertyDbl	_defaultWeightProp
	Specify the default weight for markers not specified individually.
double &	_defaultWeight

Constructor & Destructor Documentation

virtual OpenSim::MarkersReference::~MarkersReference ( ) [inline, virtual]

OpenSim::MarkersReference::MarkersReference ( )

An implementation of the MarkersReference.

Parameters:

model

to assemble

OpenSim::MarkersReference::MarkersReference	(	const std::string	filename,
		Units	modelUnits = `Units(Units::Meters)`
	)

OpenSim::MarkersReference::MarkersReference	(	MarkerData &	aMarkerData,
		const Set< MarkerWeight > *	aMarkerWeightSet = `NULL`
	)

Convenience constructor to be used for Marker placement.

Parameters:

aMarkerData,:

MarkerData, assumed to be in the correct units already

Member Function Documentation

void OpenSim::MarkersReference::copyData ( const MarkersReference & aRef ) [inline]

virtual void OpenSim::MarkersReference::getAccelerationValues	(	const SimTK::State &	s,
		SimTK::Array_< SimTK::Vec3 > &	accValues
	)			const `[virtual]`

get the acceleration value of the MarkersReference

const SimTK::Array_< std::string > & OpenSim::MarkersReference::getNames ( ) const [virtual]

get the names of the markers serving as references

Implements OpenSim::Reference_< SimTK::Vec3 >.

virtual int OpenSim::MarkersReference::getNumRefs ( ) const [inline, virtual]

get the number of referettes (individual signals) in this Reference.

All return arrays are gauranteed to be this length

Implements OpenSim::Reference_< SimTK::Vec3 >.

double OpenSim::MarkersReference::getSamplingFrequency ( ) [inline]

virtual void OpenSim::MarkersReference::getSpeedValues	(	const SimTK::State &	s,
		SimTK::Array_< SimTK::Vec3 > &	speedValues
	)			const `[virtual]`

get the speed value of the MarkersReference

SimTK::Vec2 OpenSim::MarkersReference::getValidTimeRange ( ) const [virtual]

get the time range for which the MarkersReference values are valid, based on the loaded marker data.

Reimplemented from OpenSim::Reference_< SimTK::Vec3 >.

virtual void OpenSim::MarkersReference::getValues	(	const SimTK::State &	s,
		SimTK::Array_< SimTK::Vec3 > &	values
	)			const `[virtual]`

get the value of the MarkersReference

Implements OpenSim::Reference_< SimTK::Vec3 >.

void OpenSim::MarkersReference::getWeights	(	const SimTK::State &	s,
		SimTK::Array_< double > &	weights
	)			const `[virtual]`

get the weighting (importance) of meeting this MarkersReference in the same order as names

get the weights of the Markers

Implements OpenSim::Reference_< SimTK::Vec3 >.

void OpenSim::MarkersReference::loadMarkersFile	(	const std::string	markerFile,
		Units	modelUnits = `Units(Units::Meters)`
	)

load the marker data for this MarkersReference from markerFile

MarkersReference& OpenSim::MarkersReference::operator= ( const MarkersReference & aObject ) [inline]

Assign this object to the values of another.

The XML-associated variable members are not copied-- the XML nodes and/or document must be generated anew for a copied object.

Returns:: Reference to this object.

See also:: updateXMLNode(); generateXMLNode()

Reimplemented from OpenSim::Object.

void OpenSim::MarkersReference::setDefaultWeight ( double weight ) [inline]

void OpenSim::MarkersReference::setMarkerWeightSet ( Set< MarkerWeight > & markerWeights )

Set<MarkerWeight>& OpenSim::MarkersReference::updMarkerWeightSet ( ) [inline]

Member Data Documentation

double& OpenSim::MarkersReference::_defaultWeight [protected]

PropertyDbl OpenSim::MarkersReference::_defaultWeightProp [protected]

Specify the default weight for markers not specified individually.

std::string& OpenSim::MarkersReference::_markersFile [protected]

PropertyStr OpenSim::MarkersReference::_markersFileProp [protected]

Specify the reference markers value from a file of columns in time.

Set<MarkerWeight>& OpenSim::MarkersReference::_markerWeightSet [protected]

PropertyObj OpenSim::MarkersReference::_markerWeightSetProp [protected]

Specify the individual weightings of markers to be matched.

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

OpenSim/Simulation/MarkersReference.h
OpenSim/Simulation/MarkersReference.cpp

OpenSim::MarkersReference Class Reference

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation