glotzdynanalysis::DynamicsAnalysis Class Reference

The base class that all dynamics analyses inherit from. More...

#include <DynamicsAnalysis.h>

Inheritance diagram for glotzdynanalysis::DynamicsAnalysis:

List of all members.

Public Member Functions
	DynamicsAnalysis ()
	Constructor.
virtual	~DynamicsAnalysis ()
	Destructor.
virtual void	CombineWith (DynamicsAnalysis *)
virtual void	SetBoundaryConditions (glotzsimapi::BoundaryConditions *)
virtual void	AddNextSnapshot (SystemSnapshot *)
SystemSnapshot *	GetReferenceSnapshot ()
void	Print ()
virtual void	Print (std::ostream &)
void	SetMaxTimeWindow (int)
void	AddStatistic (glotzmath::Statistic *)
void	RemoveStatistic (glotzmath::Statistic *)
void	InitializeMaps (int)
virtual glotzmath::Function1d	GetFunction (glotzmath::Statistic *)
virtual glotzmath::Function1d	GetFunction ()
Protected Member Functions
virtual void	ComputeNextDatapoint (SystemSnapshot *)
Protected Attributes
glotzsimapi::BoundaryConditions *	mBoundary
SystemSnapshot *	mReferenceSnapshot
int	mInitialTime
bool	mUseMovingReference
bool	mIgnoreFirstDataPoint
	Ingores a time window of zero (e.g. for log-log plots).
int	mMaxTimeWindow
glotzutil::ManagedList < glotzmath::Statistic * >	mStatistic
std::map < std::string, std::map< int, glotzmath::Statistic * > >	mData
Private Member Functions
void	NextSnapshotMovingReference (SystemSnapshot *)
void	NextSnapshotStationaryReference (SystemSnapshot *)
Private Attributes
bool	mIsFirstTime

---

Detailed Description

The base class that all dynamics analyses inherit from.

Author:

Aaron Keys

---

Constructor & Destructor Documentation

glotzdynanalysis::DynamicsAnalysis::DynamicsAnalysis

(

)

Constructor.

glotzdynanalysis::DynamicsAnalysis::~DynamicsAnalysis

(

)

[virtual]

Destructor.

---

Member Function Documentation

void glotzdynanalysis::DynamicsAnalysis::CombineWith

(

DynamicsAnalysis *

a

)

[virtual]

Reimplemented in glotzdynanalysis::NonGaussianParameter.

void glotzdynanalysis::DynamicsAnalysis::SetBoundaryConditions

(

glotzsimapi::BoundaryConditions *

bc

)

[virtual]

Sets the boundary conditions, if applicable

Reimplemented in glotzdynanalysis::NonGaussianParameter.

void glotzdynanalysis::DynamicsAnalysis::AddNextSnapshot

(

SystemSnapshot *

currentSnapshot

)

[virtual]

Reimplemented in glotzdynanalysis::AveragedOverlapParameter, glotzdynanalysis::AveragedSquaredDisplacement, glotzdynanalysis::AveragedStructureSelfCorrelation, glotzdynanalysis::DistanceMatrix, glotzdynanalysis::NonGaussianParameter, glotzdynanalysis::OverlapMatrix, and glotzdynanalysis::StructureSelfCorrelationMatrix.

SystemSnapshot * glotzdynanalysis::DynamicsAnalysis::GetReferenceSnapshot

(

)

void glotzdynanalysis::DynamicsAnalysis::Print

(

)

void glotzdynanalysis::DynamicsAnalysis::Print

(

std::ostream &

os

)

[virtual]

Reimplemented in glotzdynanalysis::AveragedOverlapParameter, glotzdynanalysis::AveragedSquaredDisplacement, glotzdynanalysis::AveragedStructureSelfCorrelation, glotzdynanalysis::DistanceMatrix, glotzdynanalysis::NonGaussianParameter, glotzdynanalysis::OverlapMatrix, and glotzdynanalysis::StructureSelfCorrelationMatrix.

void glotzdynanalysis::DynamicsAnalysis::SetMaxTimeWindow

(

int

window

)

void glotzdynanalysis::DynamicsAnalysis::AddStatistic

(

glotzmath::Statistic *

s

)

Parameters:

s

is the statistic to add to the calculation

Each type of DynamicsAnalysis calculates some quantity. We may want the average of the quantity calculated, or the variance or the probability distribution or some combination thereof. For each calculation that we want to perform, we add a "Statistic," which computes it. For example, if we want the MeanSquaredDisplacement, we use the analsysis class that calculates the squared displacement for each particle and add the Mean statistic.

Reimplemented in glotzdynanalysis::OverlapParameterAnalysis.

void glotzdynanalysis::DynamicsAnalysis::RemoveStatistic

(

glotzmath::Statistic *

s

)

Parameters:

s

is the statistic to remove from the calculation

void glotzdynanalysis::DynamicsAnalysis::InitializeMaps

(

int

t

)

glotzmath::Function1d glotzdynanalysis::DynamicsAnalysis::GetFunction

(

glotzmath::Statistic *

s

)

[virtual]

Reimplemented in glotzdynanalysis::NonGaussianParameter.

glotzmath::Function1d glotzdynanalysis::DynamicsAnalysis::GetFunction

(

)

[virtual]

Reimplemented in glotzdynanalysis::NonGaussianParameter.

void glotzdynanalysis::DynamicsAnalysis::ComputeNextDatapoint

(

SystemSnapshot *

s

)

[protected, virtual]

Reimplemented in glotzdynanalysis::DisplacementAnalysis, glotzdynanalysis::MobileClusterAnalysis, glotzdynanalysis::OverlapParameterAnalysis, glotzdynanalysis::StringAnalysis, and glotzdynanalysis::StructureSelfCorrelationAnalysis.

void glotzdynanalysis::DynamicsAnalysis::NextSnapshotMovingReference

(

SystemSnapshot *

currentSnapshot

)

[private]

void glotzdynanalysis::DynamicsAnalysis::NextSnapshotStationaryReference

(

SystemSnapshot *

currentSnapshot

)

[private]

---

Member Data Documentation

glotzsimapi::BoundaryConditions* glotzdynanalysis::DynamicsAnalysis::mBoundary [protected]

SystemSnapshot* glotzdynanalysis::DynamicsAnalysis::mReferenceSnapshot [protected]

Reimplemented in glotzdynanalysis::AveragedOverlapParameter, glotzdynanalysis::AveragedSquaredDisplacement, glotzdynanalysis::DistanceMatrix, glotzdynanalysis::OverlapMatrix, and glotzdynanalysis::StructureSelfCorrelationMatrix.

int glotzdynanalysis::DynamicsAnalysis::mInitialTime [protected]

bool glotzdynanalysis::DynamicsAnalysis::mUseMovingReference [protected]

bool glotzdynanalysis::DynamicsAnalysis::mIgnoreFirstDataPoint [protected]

Ingores a time window of zero (e.g. for log-log plots).

int glotzdynanalysis::DynamicsAnalysis::mMaxTimeWindow [protected]

glotzutil::ManagedList<glotzmath::Statistic*> glotzdynanalysis::DynamicsAnalysis::mStatistic [protected]

std::map<std::string, std::map<int, glotzmath::Statistic*> > glotzdynanalysis::DynamicsAnalysis::mData [protected]

bool glotzdynanalysis::DynamicsAnalysis::mIsFirstTime [private]

---

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

• Glotzilla/src/glotzdynanalysis/trunk/SourceCode/DynamicsAnalysis.h
• Glotzilla/src/glotzdynanalysis/trunk/SourceCode/DynamicsAnalysis.cpp

---