itk::ParticleEnsembleEntropyFunction

Inherits from itk::ParticleVectorFunction< VDimension >, LightObject

Public Types

	Name
typedef ParticleEnsembleEntropyFunction	Self
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef ParticleVectorFunction< VDimension >	Superclass
typedef Superclass::ParticleSystemType	ParticleSystemType
typedef ParticleShapeMatrixAttribute< double, VDimension >	ShapeMatrixType
typedef ShapeMatrixType::DataType	DataType
typedef Superclass::VectorType	VectorType
typedef ParticleSystemType::PointType	PointType
typedef vnl_vector< DataType >	vnl_vector_type
typedef vnl_matrix< DataType >	vnl_matrix_type

Public Functions

	Name
	itkTypeMacro(ParticleEnsembleEntropyFunction , ParticleVectorFunction )
	itkNewMacro(Self )
	itkStaticConstMacro(Dimension , unsigned int , VDimension )
virtual VectorType	Evaluate(unsigned int , unsigned int , const ParticleSystemType * , double & , double & ) const
virtual VectorType	Evaluate(unsigned int , unsigned int , const ParticleSystemType * , double & maxtimestep) const
virtual double	Energy(unsigned int a, unsigned int b, const ParticleSystemType * c) const
void	WriteModes(const std::string & , int ) const
void	SetShapeMatrix(ShapeMatrixType * s)
ShapeMatrixType *	GetShapeMatrix()
const ShapeMatrixType *	GetShapeMatrix() const
virtual void	BeforeIteration()
virtual void	AfterIteration()
void	SetMinimumVariance(double d)
double	GetMinimumVariance() const
void	SetMinimumVarianceDecay(double initial_value, double final_value, double time_period)
bool	GetMinimumVarianceDecayConstant() const
void	PrintShapeMatrix()
void	UseMeanEnergy()
void	UseEntropy()
bool	GetHoldMinimumVariance() const
void	SetHoldMinimumVariance(bool b)
void	SetRecomputeCovarianceInterval(int i)
int	GetRecomputeCovarianceInterval() const
virtual ParticleVectorFunction< VDimension >::Pointer	Clone()

Protected Functions

	Name
	ParticleEnsembleEntropyFunction()
virtual	~ParticleEnsembleEntropyFunction()
void	operator=(const ParticleEnsembleEntropyFunction & )
	ParticleEnsembleEntropyFunction(const ParticleEnsembleEntropyFunction & )
virtual void	ComputeCovarianceMatrix()

Protected Attributes

	Name
ShapeMatrixType::Pointer	m_ShapeMatrix
std::shared_ptr< vnl_matrix_type >	m_PointsUpdate
double	m_MinimumVariance
double	m_MinimumEigenValue
double	m_CurrentEnergy
bool	m_HoldMinimumVariance
double	m_MinimumVarianceDecayConstant
int	m_RecomputeCovarianceInterval
int	m_Counter
bool	m_UseMeanEnergy
std::shared_ptr< vnl_matrix_type >	m_points_mean
std::shared_ptr< vnl_matrix_type >	m_InverseCovMatrix

Additional inherited members

Public Functions inherited from itk::ParticleVectorFunction< VDimension >

	Name
virtual void	ResetBuffers()
virtual void	BeforeEvaluate(unsigned int , unsigned int , const ParticleSystemType * )
virtual void	SetParticleSystem(ParticleSystemType * p)
virtual ParticleSystemType *	GetParticleSystem() const
virtual void	SetDomainNumber(unsigned int i)
virtual int	GetDomainNumber() const

Protected Functions inherited from itk::ParticleVectorFunction< VDimension >

	Name
	ParticleVectorFunction()
virtual	~ParticleVectorFunction()
	ParticleVectorFunction(const ParticleVectorFunction & )

Protected Attributes inherited from itk::ParticleVectorFunction< VDimension >

	Name
ParticleSystemType *	m_ParticleSystem
unsigned int	m_DomainNumber

Detailed Description

template <unsigned int VDimension>
class itk::ParticleEnsembleEntropyFunction;

Public Types Documentation

typedef Self

typedef ParticleEnsembleEntropyFunction itk::ParticleEnsembleEntropyFunction< VDimension >::Self;

Standard class typedefs.

typedef Pointer

typedef SmartPointer<Self> itk::ParticleEnsembleEntropyFunction< VDimension >::Pointer;

typedef ConstPointer

typedef SmartPointer<const Self> itk::ParticleEnsembleEntropyFunction< VDimension >::ConstPointer;

typedef Superclass

typedef ParticleVectorFunction<VDimension> itk::ParticleEnsembleEntropyFunction< VDimension >::Superclass;

typedef ParticleSystemType

typedef Superclass::ParticleSystemType itk::ParticleEnsembleEntropyFunction< VDimension >::ParticleSystemType;

Type of particle system.

typedef ShapeMatrixType

typedef ParticleShapeMatrixAttribute<double, VDimension> itk::ParticleEnsembleEntropyFunction< VDimension >::ShapeMatrixType;

typedef DataType

typedef ShapeMatrixType::DataType itk::ParticleEnsembleEntropyFunction< VDimension >::DataType;

typedef VectorType

typedef Superclass::VectorType itk::ParticleEnsembleEntropyFunction< VDimension >::VectorType;

Vector & Point types.

typedef PointType

typedef ParticleSystemType::PointType itk::ParticleEnsembleEntropyFunction< VDimension >::PointType;

typedef vnl_vector_type

typedef vnl_vector<DataType> itk::ParticleEnsembleEntropyFunction< VDimension >::vnl_vector_type;

typedef vnl_matrix_type

typedef vnl_matrix<DataType> itk::ParticleEnsembleEntropyFunction< VDimension >::vnl_matrix_type;

Public Functions Documentation

function itkTypeMacro

itkTypeMacro(
    ParticleEnsembleEntropyFunction ,
    ParticleVectorFunction 
)

function itkNewMacro

itkNewMacro(
    Self 
)

Method for creation through the object factory.

function itkStaticConstMacro

itkStaticConstMacro(
    Dimension ,
    unsigned int ,
    VDimension 
)

Dimensionality of the domain of the particle system.

function Evaluate

virtual VectorType Evaluate(
    unsigned int ,
    unsigned int ,
    const ParticleSystemType * ,
    double & ,
    double & 
) const

Reimplements: itk::ParticleVectorFunction::Evaluate

The first argument is a pointer to the particle system. The second argument is the index of the domain within that particle system. The third argument is the index of the particle location within the given domain.

function Evaluate

inline virtual VectorType Evaluate(
    unsigned int ,
    unsigned int ,
    const ParticleSystemType * ,
    double & maxtimestep
) const

Reimplements: itk::ParticleVectorFunction::Evaluate

The first argument is a pointer to the particle system. The second argument is the index of the domain within that particle system. The third argument is the index of the particle location within the given domain.

function Energy

inline virtual double Energy(
    unsigned int a,
    unsigned int b,
    const ParticleSystemType * c
) const

Reimplements: itk::ParticleVectorFunction::Energy

function WriteModes

void WriteModes(
    const std::string & ,
    int 
) const

Write the first n modes to +- 3 std dev and the mean of the model described by the covariance matrix. The string argument is a prefix to the file names.

function SetShapeMatrix

inline void SetShapeMatrix(
    ShapeMatrixType * s
)

Access the shape matrix.

function GetShapeMatrix

inline ShapeMatrixType * GetShapeMatrix()

function GetShapeMatrix

inline const ShapeMatrixType * GetShapeMatrix() const

function BeforeIteration

inline virtual void BeforeIteration()

Reimplements: itk::ParticleVectorFunction::BeforeIteration

Called before each iteration of a solver.

function AfterIteration

inline virtual void AfterIteration()

Reimplements: itk::ParticleVectorFunction::AfterIteration

Called after each iteration of the solver.

function SetMinimumVariance

inline void SetMinimumVariance(
    double d
)

function GetMinimumVariance

inline double GetMinimumVariance() const

function SetMinimumVarianceDecay

inline void SetMinimumVarianceDecay(
    double initial_value,
    double final_value,
    double time_period
)

function GetMinimumVarianceDecayConstant

inline bool GetMinimumVarianceDecayConstant() const

function PrintShapeMatrix

inline void PrintShapeMatrix()

function UseMeanEnergy

inline void UseMeanEnergy()

function UseEntropy

inline void UseEntropy()

function GetHoldMinimumVariance

inline bool GetHoldMinimumVariance() const

function SetHoldMinimumVariance

inline void SetHoldMinimumVariance(
    bool b
)

function SetRecomputeCovarianceInterval

inline void SetRecomputeCovarianceInterval(
    int i
)

function GetRecomputeCovarianceInterval

inline int GetRecomputeCovarianceInterval() const

function Clone

inline virtual ParticleVectorFunction< VDimension >::Pointer Clone()

Reimplements: itk::ParticleVectorFunction::Clone

Protected Functions Documentation

function ParticleEnsembleEntropyFunction

inline ParticleEnsembleEntropyFunction()

function ~ParticleEnsembleEntropyFunction

inline virtual ~ParticleEnsembleEntropyFunction()

function operator=

void operator=(
    const ParticleEnsembleEntropyFunction & 
)

function ParticleEnsembleEntropyFunction

ParticleEnsembleEntropyFunction(
    const ParticleEnsembleEntropyFunction & 
)

function ComputeCovarianceMatrix

virtual void ComputeCovarianceMatrix()

Protected Attributes Documentation

variable m_ShapeMatrix

ShapeMatrixType::Pointer m_ShapeMatrix;

variable m_PointsUpdate

std::shared_ptr< vnl_matrix_type > m_PointsUpdate;

variable m_MinimumVariance

double m_MinimumVariance;

variable m_MinimumEigenValue

double m_MinimumEigenValue;

variable m_CurrentEnergy

double m_CurrentEnergy;

variable m_HoldMinimumVariance

bool m_HoldMinimumVariance;

variable m_MinimumVarianceDecayConstant

double m_MinimumVarianceDecayConstant;

variable m_RecomputeCovarianceInterval

int m_RecomputeCovarianceInterval;

variable m_Counter

int m_Counter;

variable m_UseMeanEnergy

bool m_UseMeanEnergy;

variable m_points_mean

std::shared_ptr< vnl_matrix_type > m_points_mean;

variable m_InverseCovMatrix

std::shared_ptr< vnl_matrix_type > m_InverseCovMatrix;

Updated on 2022-07-23 at 17:50:02 -0600