OpenSim::MarkerPlacer Class Reference

A class implementing a set of parameters describing how to place markers on a model (presumably after it has been scaled to fit a subject). More...

#include <MarkerPlacer.h>

Inheritance diagram for OpenSim::MarkerPlacer:

List of all members.

Public Member Functions
	MarkerPlacer ()
	Default constructor.
	MarkerPlacer (const MarkerPlacer &aMarkerPlacementParams)
	Copy constructor.
virtual	~MarkerPlacer ()
	Destructor.
virtual Object *	copy () const
	Copy this marker placement params and return a pointer to the copy.
void	copyData (const MarkerPlacer &aMarkerPlacementParams)
	Copy data members from one MarkerPlacer to another.
MarkerPlacer &	operator= (const MarkerPlacer &aMarkerPlacementParams)
	Assignment operator.
bool	processModel (SimTK::State &s, Model *aModel, const std::string &aPathToSubject="")
bool	getApply () const
void	setApply (bool aApply)
const std::string &	getStaticPoseFileName () const
void	setStaticPoseFileName (const std::string &aFileName)
const Array< double > &	getTimeRange () const
void	setTimeRange (const Array< double > &timeRange)
IKTaskSet &	getIKTaskSet ()
const std::string &	getCoordinateFileName () const
void	setCoordinateFileName (const std::string &aCoordinateFileName)
double	getMaxMarkerMovement () const
void	setMaxMarkerMovement (double aMaxMarkerMovement)
const std::string &	getOutputModelFileName () const
void	setOutputModelFileName (const std::string &aOutputModelFileName)
const std::string &	getOutputJointFileName () const
void	setOutputJointFileName (const std::string &outputJointFileName)
const std::string &	getOutputMuscleFileName () const
void	setOutputMuscleFileName (const std::string &outputMuscleFileName)
const std::string &	getOutputMarkerFileName () const
void	setOutputMarkerFileName (const std::string &outputMarkerFileName)
const std::string &	getOutputMotionFileName () const
void	setOutputMotionFileName (const std::string &outputMotionFileName)
void	setPrintResultFiles (bool aToWrite)
bool	getMoveModelMarkers ()
void	setMoveModelMarkers (bool aMove)
Storage *	getOutputStorage ()
IKTrial *	getIKTrial ()
Protected Attributes
PropertyBool	_applyProp
bool &	_apply
PropertyStr	_markerFileNameProp
std::string &	_markerFileName
PropertyDblArray	_timeRangeProp
Array< double > &	_timeRange
PropertyObj	_ikTaskSetProp
IKTaskSet &	_ikTaskSet
PropertyStr	_coordinateFileNameProp
std::string &	_coordinateFileName
PropertyStr	_outputJointFileNameProp
std::string &	_outputJointFileName
PropertyStr	_outputMuscleFileNameProp
std::string &	_outputMuscleFileName
PropertyStr	_outputModelFileNameProp
std::string &	_outputModelFileName
PropertyStr	_outputMarkerFileNameProp
std::string &	_outputMarkerFileName
PropertyStr	_outputMotionFileNameProp
std::string &	_outputMotionFileName
PropertyDbl	_maxMarkerMovementProp
double &	_maxMarkerMovement
PropertyStr	_optimizerAlgorithmProp
	Preferred optimizer algorithm.
std::string &	_optimizerAlgorithm
bool	_printResultFiles
bool	_moveModelMarkers
IKTrial *	_ikTrial

---

Detailed Description

A class implementing a set of parameters describing how to place markers on a model (presumably after it has been scaled to fit a subject).

Author:

Peter Loan

Version:

1.0

---

Constructor & Destructor Documentation

MarkerPlacer::MarkerPlacer

(

)

Default constructor.

MarkerPlacer::MarkerPlacer

(

const MarkerPlacer &

aMarkerPlacer

)

Copy constructor.

Parameters:

aMarkerPlacer

MarkerPlacer to be copied.

MarkerPlacer::~MarkerPlacer

(

)

[virtual]

Destructor.

---

Member Function Documentation

Object * MarkerPlacer::copy

(

)

const [virtual]

Copy this marker placement params and return a pointer to the copy.

The copy constructor for this class is used.

Returns:

Pointer to a copy of this MarkerPlacer.

Reimplemented from OpenSim::Object.

void MarkerPlacer::copyData

(

const MarkerPlacer &

aMarkerPlacer

)

Copy data members from one MarkerPlacer to another.

Parameters:

aMarkerPlacer

MarkerPlacer to be copied.

bool OpenSim::MarkerPlacer::getApply

(

)

const [inline]

const std::string& OpenSim::MarkerPlacer::getCoordinateFileName

(

)

const [inline]

IKTaskSet& OpenSim::MarkerPlacer::getIKTaskSet

(

)

[inline]

IKTrial* OpenSim::MarkerPlacer::getIKTrial

(

)

[inline]

double OpenSim::MarkerPlacer::getMaxMarkerMovement

(

)

const [inline]

bool OpenSim::MarkerPlacer::getMoveModelMarkers

(

)

[inline]

const std::string& OpenSim::MarkerPlacer::getOutputJointFileName

(

)

const [inline]

const std::string& OpenSim::MarkerPlacer::getOutputMarkerFileName

(

)

const [inline]

const std::string& OpenSim::MarkerPlacer::getOutputModelFileName

(

)

const [inline]

const std::string& OpenSim::MarkerPlacer::getOutputMotionFileName

(

)

const [inline]

const std::string& OpenSim::MarkerPlacer::getOutputMuscleFileName

(

)

const [inline]

Storage * MarkerPlacer::getOutputStorage

(

)

const std::string& OpenSim::MarkerPlacer::getStaticPoseFileName

(

)

const [inline]

const Array<double>& OpenSim::MarkerPlacer::getTimeRange

(

)

const [inline]

MarkerPlacer & MarkerPlacer::operator=

(

const MarkerPlacer &

aMarkerPlacer

)

Assignment operator.

Returns:

Reference to this object.

Reimplemented from OpenSim::Object.

bool OpenSim::MarkerPlacer::processModel	(	SimTK::State &	s,
		Model *	aModel,
		const std::string &	aPathToSubject = ""
	)

void OpenSim::MarkerPlacer::setApply

(

bool

aApply

)

[inline]

void OpenSim::MarkerPlacer::setCoordinateFileName

(

const std::string &

aCoordinateFileName

)

[inline]

void OpenSim::MarkerPlacer::setMaxMarkerMovement

(

double

aMaxMarkerMovement

)

[inline]

void OpenSim::MarkerPlacer::setMoveModelMarkers

(

bool

aMove

)

[inline]

void OpenSim::MarkerPlacer::setOutputJointFileName

(

const std::string &

outputJointFileName

)

[inline]

void OpenSim::MarkerPlacer::setOutputMarkerFileName

(

const std::string &

outputMarkerFileName

)

[inline]

void OpenSim::MarkerPlacer::setOutputModelFileName

(

const std::string &

aOutputModelFileName

)

[inline]

void OpenSim::MarkerPlacer::setOutputMotionFileName

(

const std::string &

outputMotionFileName

)

[inline]

void OpenSim::MarkerPlacer::setOutputMuscleFileName

(

const std::string &

outputMuscleFileName

)

[inline]

void OpenSim::MarkerPlacer::setPrintResultFiles

(

bool

aToWrite

)

[inline]

void OpenSim::MarkerPlacer::setStaticPoseFileName

(

const std::string &

aFileName

)

[inline]

void OpenSim::MarkerPlacer::setTimeRange

(

const Array< double > &

timeRange

)

[inline]

---

Member Data Documentation

bool& OpenSim::MarkerPlacer::_apply [protected]

PropertyBool OpenSim::MarkerPlacer::_applyProp [protected]

std::string& OpenSim::MarkerPlacer::_coordinateFileName [protected]

PropertyStr OpenSim::MarkerPlacer::_coordinateFileNameProp [protected]

IKTaskSet& OpenSim::MarkerPlacer::_ikTaskSet [protected]

PropertyObj OpenSim::MarkerPlacer::_ikTaskSetProp [protected]

IKTrial* OpenSim::MarkerPlacer::_ikTrial [protected]

std::string& OpenSim::MarkerPlacer::_markerFileName [protected]

PropertyStr OpenSim::MarkerPlacer::_markerFileNameProp [protected]

double& OpenSim::MarkerPlacer::_maxMarkerMovement [protected]

PropertyDbl OpenSim::MarkerPlacer::_maxMarkerMovementProp [protected]

bool OpenSim::MarkerPlacer::_moveModelMarkers [protected]

std::string& OpenSim::MarkerPlacer::_optimizerAlgorithm [protected]

PropertyStr OpenSim::MarkerPlacer::_optimizerAlgorithmProp [protected]

Preferred optimizer algorithm.

std::string& OpenSim::MarkerPlacer::_outputJointFileName [protected]

PropertyStr OpenSim::MarkerPlacer::_outputJointFileNameProp [protected]

std::string& OpenSim::MarkerPlacer::_outputMarkerFileName [protected]

PropertyStr OpenSim::MarkerPlacer::_outputMarkerFileNameProp [protected]

std::string& OpenSim::MarkerPlacer::_outputModelFileName [protected]

PropertyStr OpenSim::MarkerPlacer::_outputModelFileNameProp [protected]

std::string& OpenSim::MarkerPlacer::_outputMotionFileName [protected]

PropertyStr OpenSim::MarkerPlacer::_outputMotionFileNameProp [protected]

std::string& OpenSim::MarkerPlacer::_outputMuscleFileName [protected]

PropertyStr OpenSim::MarkerPlacer::_outputMuscleFileNameProp [protected]

bool OpenSim::MarkerPlacer::_printResultFiles [protected]

Array<double>& OpenSim::MarkerPlacer::_timeRange [protected]

PropertyDblArray OpenSim::MarkerPlacer::_timeRangeProp [protected]

---

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

• OpenSim/Tools/MarkerPlacer.h
• OpenSim/Tools/MarkerPlacer.cpp