itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram > Class Template Reference

#include <itkLogLikelihoodGoodnessOfFitFunction.h>

Inheritance diagram for itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >:

[legend]

Collaboration diagram for itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >:

[legend]

List of all members.

Detailed Description

template<class TInputHistogram>
class itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >

calculates loglikelihood ratio statistics

This function needs an expected histogram in addition to the observed histogram.

The statistics is $\sum^{k}_{i=1}x_{i}\log(x_{i}/n\pi_{0i})$

where $x_{i}$ is the observed frequency of the $i$ th bin, and $n\pi_{0i}$ is the expected frequency.

See also:: GoodnessOfFitFunctionBase, GoodnessOfFitMixtureModelCostFunction

Definition at line 42 of file itkLogLikelihoodGoodnessOfFitFunction.h.


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TInputHistogram	InputHistogramType
typedef TInputHistogram	InputSampleType
typedef TInputHistogram::MeasurementType	MeasurementType
typedef unsigned int	MeasurementVectorSizeType
typedef TInputHistogram::MeasurementVectorType	MeasurementVectorType
typedef double	OutputType
typedef SmartPointer< Self >	Pointer
typedef LogLikelihoodGoodnessOfFitFunction	Self
typedef GoodnessOfFitFunctionBase < TInputHistogram >	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
InputHistogramType *	GetExpectedHistogram ()
const TInputHistogram *	GetInputSample () const
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
InputHistogramType *	GetObservedHistogram ()
OutputType &	GetOutput ()
virtual int	GetReferenceCount () const
virtual bool	GetUseExpectedHistogram ()
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
	itkStaticConstMacro (MeasurementVectorSize, unsigned int, TInputHistogram::MeasurementVectorSize)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetExpectedHistogram (InputHistogramType *histogram)
virtual void	SetMeasurementVectorSize (MeasurementVectorSizeType _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetObservedHistogram (InputHistogramType *histogram)
virtual void	SetReferenceCount (int)
void	SetTotalObservedScale (double *scale)
virtual void	UnRegister () const
void	Update ()

unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)

void	SetInputSample (const TInputHistogram *sample)
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Types

typedef int	InternalReferenceCountType
Protected Member Functions
virtual void	GenerateData ()
virtual const float &	GetEpsilon ()
virtual const float &	GetLogEpsilon ()
	LogLikelihoodGoodnessOfFitFunction ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	SetUseExpectedHistogram (bool _arg)
virtual	~LogLikelihoodGoodnessOfFitFunction ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

Member Typedef Documentation

template<class TInputHistogram>

typedef SmartPointer< const Self > itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >::ConstPointer

Reimplemented from itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >.

Definition at line 50 of file itkLogLikelihoodGoodnessOfFitFunction.h.

template<class TInputHistogram>

typedef TInputHistogram itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::InputHistogramType [inherited]

Definition at line 61 of file itkGoodnessOfFitFunctionBase.h.

typedef TInputHistogram itk::Statistics::SampleAlgorithmBase< TInputHistogram >::InputSampleType [inherited]

Sample typedefs alias

Definition at line 59 of file itkSampleAlgorithmBase.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

template<class TInputHistogram>

typedef TInputHistogram::MeasurementType itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >::MeasurementType

Reimplemented from itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >.

Definition at line 62 of file itkLogLikelihoodGoodnessOfFitFunction.h.

typedef unsigned int itk::Statistics::SampleAlgorithmBase< TInputHistogram >::MeasurementVectorSizeType [inherited]

Length of a measurement vector

Definition at line 52 of file itkSampleAlgorithmBase.h.

template<class TInputHistogram>

typedef TInputHistogram::MeasurementVectorType itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >::MeasurementVectorType

Reimplemented from itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >.

Definition at line 63 of file itkLogLikelihoodGoodnessOfFitFunction.h.

template<class TInputHistogram>

typedef double itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::OutputType [inherited]

Definition at line 91 of file itkGoodnessOfFitFunctionBase.h.

template<class TInputHistogram>

typedef SmartPointer< Self > itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >::Pointer

Reimplemented from itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >.

Definition at line 49 of file itkLogLikelihoodGoodnessOfFitFunction.h.

template<class TInputHistogram>

typedef LogLikelihoodGoodnessOfFitFunction itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >::Self

Standard class typedefs

Reimplemented from itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >.

Definition at line 47 of file itkLogLikelihoodGoodnessOfFitFunction.h.

template<class TInputHistogram>

typedef GoodnessOfFitFunctionBase< TInputHistogram > itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >::Superclass

Reimplemented from itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >.

Definition at line 48 of file itkLogLikelihoodGoodnessOfFitFunction.h.

Constructor & Destructor Documentation

template<class TInputHistogram>

itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >::LogLikelihoodGoodnessOfFitFunction ( ) [protected]

template<class TInputHistogram>

virtual itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >::~LogLikelihoodGoodnessOfFitFunction ( ) [inline, protected, virtual]

Definition at line 67 of file itkLogLikelihoodGoodnessOfFitFunction.h.

Member Function Documentation

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

template<class TInputHistogram>

virtual void itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >::GenerateData ( ) [protected, virtual]

calculates the loglikelihood ratio statistics

Reimplemented from itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >.

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

template<class TInputHistogram>

virtual const float& itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::GetEpsilon ( ) [protected, virtual, inherited]

template<class TInputHistogram>

InputHistogramType* itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::GetExpectedHistogram ( ) [inline, inherited]

Gets the expected histogram input

Definition at line 74 of file itkGoodnessOfFitFunctionBase.h.

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

const TInputHistogram * itk::Statistics::SampleAlgorithmBase< TInputHistogram >::GetInputSample ( ) const [inline, inherited]

Definition at line 82 of file itkSampleAlgorithmBase.h.

template<class TInputHistogram>

virtual const float& itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::GetLogEpsilon ( ) [protected, virtual, inherited]

virtual MeasurementVectorSizeType itk::Statistics::SampleAlgorithmBase< TInputHistogram >::GetMeasurementVectorSize ( ) const [virtual, inherited]

Get Macro to get the length of a measurement vector. This is equal to the length of each measurement vector contained in the samples that are plugged in as input to this class. GetMeasurementVectorSize() will return zero until the SetInputSample() method has been called

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

template<class TInputHistogram>

virtual const char* itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >.

template<class TInputHistogram>

InputHistogramType* itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::GetObservedHistogram ( ) [inline, inherited]

Gets the observed histogram

Definition at line 67 of file itkGoodnessOfFitFunctionBase.h.

template<class TInputHistogram>

OutputType& itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::GetOutput ( void ) [inline, inherited]

Definition at line 93 of file itkGoodnessOfFitFunctionBase.h.

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

template<class TInputHistogram>

virtual bool itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::GetUseExpectedHistogram ( ) [virtual, inherited]

Sets the flag that tells if a subclass needs the expected histogram for goodness-of-fit statistics calculation. This flag should be set only by a subclass

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

template<class TInputHistogram>

itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >::itkStaticConstMacro	(	MeasurementVectorSize	,
		unsigned	int,
		TInputHistogram::MeasurementVectorSize
	)

typedefs from InputHistogram

Reimplemented from itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >.

virtual void itk::Object::Modified ( ) const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TInputHistogram>

static Pointer itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)			const `[inherited]`

Cause the object to print itself out.

Referenced by itk::WeakPointer< itk::ProcessObject >::Print(), and itk::SmartPointer< itk::MutualInformationImageToImageMetric >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

template<class TInputHistogram>

void itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Statistics::SampleAlgorithmBase< TInputHistogram >.

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

virtual void itk::Object::Register ( ) const [virtual, inherited]

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

template<class TInputHistogram>

void itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetExpectedHistogram ( InputHistogramType * histogram ) [inherited]

Sets the expected histogram input

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Statistics::SampleAlgorithmBase< TInputHistogram >::SetInputSample ( const TInputHistogram * sample ) [inline, inherited]

Stores the sample pointer

Definition at line 63 of file itkSampleAlgorithmBase.h.

virtual void itk::Statistics::SampleAlgorithmBase< TInputHistogram >::SetMeasurementVectorSize ( MeasurementVectorSizeType _arg ) [virtual, inherited]

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

template<class TInputHistogram>

void itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetObservedHistogram ( InputHistogramType * histogram ) [inherited]

Sets the observed histogram input

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

template<class TInputHistogram>

void itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale ( double * scale ) [inline, inherited]

Definition at line 82 of file itkGoodnessOfFitFunctionBase.h.

References itk::Object::Modified().

template<class TInputHistogram>

virtual void itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetUseExpectedHistogram ( bool _arg ) [protected, virtual, inherited]

virtual void itk::Object::UnRegister ( ) const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

Referenced by itk::SmartPointer< itk::MutualInformationImageToImageMetric >::operator=().

void itk::Statistics::SampleAlgorithmBase< TInputHistogram >::Update ( void ) [inline, inherited]

dummy function that calls the GenerateData() function to generate output. It exists for future compatibility with ProcessObject without streaming

Definition at line 88 of file itkSampleAlgorithmBase.h.

References HardConnectedComponentImageFilter::GenerateData().

Member Data Documentation

InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

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

itkLogLikelihoodGoodnessOfFitFunction.h

itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram > Class Template Reference

Detailed Description

template<class TInputHistogram> class itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TInputHistogram>
class itk::Statistics::LogLikelihoodGoodnessOfFitFunction< TInputHistogram >