Diffpack Documentation

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Search

MomentsFieldLattice Class Reference

estimation of expectation, variance, skewness and kurtosis of FD fields. More...

#include <ExpecVarFieldLattice.h>

Inheritance diagram for MomentsFieldLattice::

Public Methods
	MomentsFieldLattice ()
virtual	~MomentsFieldLattice ()
virtual void	estimator ()
virtual bool	redim (const FieldLattice &f)
virtual bool	ok () const
virtual void	init ()
virtual void	update (FieldLattice &u)
FieldLattice&	getSkew ()
FieldLattice&	getKurt ()
FieldLattice&	getThird ()
FieldLattice&	getFourth ()
Protected Attributes
Handle(FieldLattice)	z3
Handle(FieldLattice)	z4
Handle(FieldLattice)	SKEW
Handle(FieldLattice)	KURT
Handle(FieldLattice)	THIRD
Handle(FieldLattice)	FOURTH

Detailed Description

estimation of expectation, variance, skewness and kurtosis of FD fields.

NAME: MomentsFieldLattice - estimation of expectation, variance, skewness and kurtosis of FD fields

DESCRIPTION:

The class is like class "Moments", but applies to finite difference fields. See class "ExpecVarFieldFE" and "ExpecVarFieldLattice" for more documentation. The only extension of the current class is that it can handle the third and the fourth moment in addition to the expectation and the variance.

Constructor & Destructor Documentation

MomentsFieldLattice::MomentsFieldLattice ( )

MomentsFieldLattice::~MomentsFieldLattice ( ) [virtual]

Member Function Documentation

void MomentsFieldLattice::estimator ( ) [virtual]

Reimplemented from ExpecVarFieldLattice.

FieldLattice & MomentsFieldLattice::getFourth ( )

FieldLattice & MomentsFieldLattice::getKurt ( )

FieldLattice & MomentsFieldLattice::getSkew ( )

FieldLattice & MomentsFieldLattice::getThird ( )

void MomentsFieldLattice::init ( ) [virtual]

initializes the values of the internal data structures used for the estimation. In other words, "redim" alloocates the data structures, while "init" sets the field entries to zero (initializing the statistics for the mean and variance). It is usually called from an "initEstimator" function in the simulator class.
Reimplemented from ExpecVarFieldLattice.

bool MomentsFieldLattice::ok ( ) const [virtual]

Reimplemented from ExpecVarFieldLattice.

bool MomentsFieldLattice::redim ( const FieldLattice & f ) [virtual]

redimensions the internal data structures so that they correspond in size to the field given as argument to the function.
Reimplemented from ExpecVarFieldLattice.

void MomentsFieldLattice::update ( FieldLattice & u ) [virtual]

adds a sample of a random field to the internal statistics for the mean and variance estimation. For example, the sample field is just added to the estimator for the expectation, and the square of the field values are added to the estimator for the variance.
Reimplemented from ExpecVarFieldLattice.

Member Data Documentation

Handle(FieldLattice) MomentsFieldLattice::FOURTH [protected]

Handle(FieldLattice) MomentsFieldLattice::KURT [protected]

Handle(FieldLattice) MomentsFieldLattice::SKEW [protected]

Handle(FieldLattice) MomentsFieldLattice::THIRD [protected]

Handle(FieldLattice) MomentsFieldLattice::z3 [protected]

Handle(FieldLattice) MomentsFieldLattice::z4 [protected]

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

ExpecVarFieldLattice.h