Memory for typed array similarity computation. More...

#include <cmtkTypedArraySimilarityMemory.h>

Inheritance diagram for cmtk::TypedArraySimilarityMemory:

Public Member Functions
	TypedArraySimilarityMemory (const bool repeatCheck=true)
	Initialize a similarity instance with memory.
const Types::DataItemRange	GetRangeX (const TypedArray *array, const size_t numBins)
	Get range of X distribution.
const Types::DataItemRange	GetRangeY (const TypedArray *array, const size_t numBins)
	Get range of Y distribution.
void	SetMinNumBins (const size_t minNumBins)
	Set minimum number of histogram bins.
void	SetMaxNumBins (const size_t maxNumBins)
	Set maximum number of histogram bins.
JointHistogram< unsigned int > ::SmartPtr	CreateHistogram (const TypedArray array0, const TypedArray array1)
	Create histogram based on memorized settings.
Private Attributes
bool	RepeatCheck
	Repeat range check with each call to GetRangeX and GetRangeY.
bool	ValidX
	Flag whether memory for X distribution is already initialized.
Types::DataItemRange	RangeX
	Remembered range of X values.
size_t	NumberBinsX
	Remembered number of bins for the X distribution.
bool	ValidY
	Flag whether memory for X distribution is already initialized.
Types::DataItemRange	RangeY
	Remembered range of Y values.
size_t	NumberBinsY
	Remembered number of bins for the Y distribution.
size_t	MinNumBins
	Minimum number of histogram bins.
size_t	MaxNumBins
	Maximum number of histogram bins.
Friends
class	TypedArraySimilarity
	Allow similarity computation class access.

Detailed Description

Memory for typed array similarity computation.

This class provides for optional persistent memory between similarity computations. This ensures, for example, identical value ranges in histogram-based similarity measures.

Definition at line 52 of file cmtkTypedArraySimilarityMemory.h.

Constructor & Destructor Documentation

cmtk::TypedArraySimilarityMemory::TypedArraySimilarityMemory ( const bool repeatCheck = true ) [inline]

Initialize a similarity instance with memory.

By instantiating a class object, the otherwise static member functions can be given a memory that coordinates their behaviour between calls. For example, we can make sure that all evaluations of Mutual Information use the same histogram resolution.

Parameters:

repeatCheck If this flag is set, the object will repeat the range check for every call to GetRangeX or GetRangeY. If the current data range exceeds the one stored in this object, the latter will be adapted accordingly.

Definition at line 65 of file cmtkTypedArraySimilarityMemory.h.