PLMD::analysis::LandmarkSelectionBase Class Reference

#include <LandmarkSelectionBase.h>

Inheritance diagram for PLMD::analysis::LandmarkSelectionBase:

Public Member Functions
	LandmarkSelectionBase (const LandmarkSelectionOptions &lo)
virtual	~LandmarkSelectionBase ()
void	checkRead () const
	Check everything was read in. More...
std::string	description ()
	Return a description of the landmark selection protocol. More...
virtual std::string	rest_of_description ()
	Overwrite this to have a more descriptive output. More...
void	selectLandmarks (MultiReferenceBase *)
	Actually do landmark selection. More...
virtual void	select (MultiReferenceBase *)=0

Protected Member Functions
unsigned	getNumberOfLandmarks () const
	Return the numbe of landmarks. More...
Communicator &	getCommunicator ()
	Return the communicator. More...
template<class T >
void	parse (const std::string &, T &)
	Read a keywords from the input. More...
void	parseFlag (const std::string &key, bool &t)
	Read a flag from the input. More...
unsigned	getNumberOfFrames () const
	Get the number of frames in the underlying action. More...
double	getWeightOfFrame (const unsigned &)
	Get the weight of the ith frame. More...
double	getDistanceBetweenFrames (const unsigned &, const unsigned &)
	Calculate the distance between the ith and jth frames. More...
void	selectFrame (const unsigned &, MultiReferenceBase *)
	Transfer frame i in the underlying action to the object we are going to analyze. More...

Private Attributes
std::string	style
	Name of the method we are using for landmark selection. More...
unsigned	nlandmarks
	The number of landmarks we are selecting. More...
std::vector< std::string >	input
	The input to the landmark selection object. More...
AnalysisWithLandmarks *	action
	A pointer to the underlying action. More...
bool	novoronoi
	How do we treat weights. More...
bool	noweights

Friends
class	AnalysisWithLandmarks
class	CopyAllFrames

Constructor & Destructor Documentation

PLMD::analysis::LandmarkSelectionBase::LandmarkSelectionBase ( const LandmarkSelectionOptions &  lo )

explicit

PLMD::analysis::LandmarkSelectionBase::~LandmarkSelectionBase ( )

virtual

Member Function Documentation

void PLMD::analysis::LandmarkSelectionBase::checkRead

(

)

const

Check everything was read in.

std::string PLMD::analysis::LandmarkSelectionBase::description

(

)

Return a description of the landmark selection protocol.

Communicator & PLMD::analysis::LandmarkSelectionBase::getCommunicator ( )

inlineprotected

Return the communicator.

double PLMD::analysis::LandmarkSelectionBase::getDistanceBetweenFrames ( const unsigned &  iframe, const unsigned &  jframe  )

protected

Calculate the distance between the ith and jth frames.

unsigned PLMD::analysis::LandmarkSelectionBase::getNumberOfFrames ( ) const

inlineprotected

Get the number of frames in the underlying action.

unsigned PLMD::analysis::LandmarkSelectionBase::getNumberOfLandmarks ( ) const

inlineprotected

Return the numbe of landmarks.

double PLMD::analysis::LandmarkSelectionBase::getWeightOfFrame ( const unsigned &  iframe )

protected

Get the weight of the ith frame.

template<class T >

void PLMD::analysis::LandmarkSelectionBase::parse ( const std::string &  key, T &  t  )

protected

Read a keywords from the input.

void PLMD::analysis::LandmarkSelectionBase::parseFlag ( const std::string &  key, bool &  t  )

protected

Read a flag from the input.

virtual std::string PLMD::analysis::LandmarkSelectionBase::rest_of_description ( )

inlinevirtual

Overwrite this to have a more descriptive output.

virtual void PLMD::analysis::LandmarkSelectionBase::select ( MultiReferenceBase *  )

pure virtual

Implemented in PLMD::analysis::CopyAllFrames.

void PLMD::analysis::LandmarkSelectionBase::selectFrame ( const unsigned &  iframe, MultiReferenceBase *  myframes  )

protected

Transfer frame i in the underlying action to the object we are going to analyze.

void PLMD::analysis::LandmarkSelectionBase::selectLandmarks

(

MultiReferenceBase *

myframes

)

Actually do landmark selection.

Friends And Related Function Documentation

friend class AnalysisWithLandmarks

friend

friend class CopyAllFrames

friend

Member Data Documentation

AnalysisWithLandmarks* PLMD::analysis::LandmarkSelectionBase::action

private

A pointer to the underlying action.

std::vector<std::string> PLMD::analysis::LandmarkSelectionBase::input

private

The input to the landmark selection object.

unsigned PLMD::analysis::LandmarkSelectionBase::nlandmarks

private

The number of landmarks we are selecting.

bool PLMD::analysis::LandmarkSelectionBase::novoronoi

private

How do we treat weights.

bool PLMD::analysis::LandmarkSelectionBase::noweights

private

std::string PLMD::analysis::LandmarkSelectionBase::style

private

Name of the method we are using for landmark selection.

---

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

• analysis/LandmarkSelectionBase.h
• analysis/LandmarkSelectionBase.cpp