itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField > Class Template Reference

a cost function for optimization. More...

#include <itkMRIBiasFieldCorrectionFilter.h>

Inheritance diagram for itk::MRIBiasEnergyFunction:

[legend]Collaboration diagram for itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >:

[legend]List of all members.

Public Types
typedef MRIBiasEnergyFunction	Self
typedef SingleValuedCostFunction	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TImage	ImageType
typedef TImageMask	MaskType
typedef ImageType::Pointer	ImagePointer
typedef MaskType::Pointer	MaskPointer
typedef ImageType::PixelType	ImageElementType
typedef MaskType::PixelType	MaskElementType
typedef ImageType::IndexType	ImageIndexType
typedef ImageType::RegionType	ImageRegionType
typedef TBiasField	BiasFieldType
typedef Superclass::ParametersType	ParametersType
typedef Superclass::DerivativeType	DerivativeType
typedef Superclass::MeasureType	MeasureType
typedef CompositeValleyFunction	InternalEnergyFunction
Public Methods
virtual const char *	GetClassName () const
	itkStaticConstMacro (SpaceDimension, unsigned int, 3)
virtual void	SetImage (ImageType *_arg)
virtual void	SetMask (MaskType *_arg)
virtual void	SetRegion (ImageRegionType _arg)
virtual void	SetBiasField (BiasFieldType *_arg)
double	GetEnergy0 (double diff)
MeasureType	GetValue (const ParametersType &parameters) const
void	GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const
void	InitializeDistributions (Array< double > classMeans, Array< double > classSigmas)
unsigned int	GetNumberOfParameters (void) const
Static Public Methods
Pointer	New ()
Protected Methods
	MRIBiasEnergyFunction ()
virtual	~MRIBiasEnergyFunction ()

---

Detailed Description

template<class TImage, class TImageMask, class TBiasField>
class itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >

a cost function for optimization.

This is a wrapping class which provides interfaces between images, the bias field, the internal energy function (CompositeValleyFunction), and the Optimizer.

This class is templated over the type of the input image (TImage), the image mask (which tells which pixels in the input image should be included for energy value calculation), and the bias field (TBiasField).

Definition at line 46 of file itkMRIBiasFieldCorrectionFilter.h.

---

Member Typedef Documentation

template<class TImage, class TImageMask, class TBiasField> typedef TBiasField itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::BiasFieldType

Bias field type definition. Definition at line 73 of file itkMRIBiasFieldCorrectionFilter.h.

template<class TImage, class TImageMask, class TBiasField> typedef SmartPointer<const Self> itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::ConstPointer

Reimplemented from itk::SingleValuedCostFunction. Definition at line 53 of file itkMRIBiasFieldCorrectionFilter.h.

template<class TImage, class TImageMask, class TBiasField> typedef Superclass::DerivativeType itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::DerivativeType

Not used, but expected by SingleValuedNonLinearOptimizer class. Reimplemented from itk::SingleValuedCostFunction. Definition at line 80 of file itkMRIBiasFieldCorrectionFilter.h. Referenced by itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::GetDerivative().

template<class TImage, class TImageMask, class TBiasField> typedef ImageType::PixelType itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::ImageElementType

Definition at line 67 of file itkMRIBiasFieldCorrectionFilter.h.

template<class TImage, class TImageMask, class TBiasField> typedef ImageType::IndexType itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::ImageIndexType

Definition at line 69 of file itkMRIBiasFieldCorrectionFilter.h.

template<class TImage, class TImageMask, class TBiasField> typedef ImageType::Pointer itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::ImagePointer

Definition at line 65 of file itkMRIBiasFieldCorrectionFilter.h.

template<class TImage, class TImageMask, class TBiasField> typedef ImageType::RegionType itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::ImageRegionType

Definition at line 70 of file itkMRIBiasFieldCorrectionFilter.h.

template<class TImage, class TImageMask, class TBiasField> typedef TImage itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::ImageType

Image related type definitions. Definition at line 63 of file itkMRIBiasFieldCorrectionFilter.h.

template<class TImage, class TImageMask, class TBiasField> typedef CompositeValleyFunction itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::InternalEnergyFunction

The type of the internal energy function. Definition at line 89 of file itkMRIBiasFieldCorrectionFilter.h.

template<class TImage, class TImageMask, class TBiasField> typedef MaskType::PixelType itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::MaskElementType

Definition at line 68 of file itkMRIBiasFieldCorrectionFilter.h.

template<class TImage, class TImageMask, class TBiasField> typedef MaskType::Pointer itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::MaskPointer

Definition at line 66 of file itkMRIBiasFieldCorrectionFilter.h.

template<class TImage, class TImageMask, class TBiasField> typedef TImageMask itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::MaskType

Definition at line 64 of file itkMRIBiasFieldCorrectionFilter.h.

template<class TImage, class TImageMask, class TBiasField> typedef Superclass::MeasureType itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::MeasureType

The cost value type. Reimplemented from itk::SingleValuedCostFunction. Definition at line 83 of file itkMRIBiasFieldCorrectionFilter.h.

template<class TImage, class TImageMask, class TBiasField> typedef Superclass::ParametersType itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::ParametersType

Parameters type for optimizier (coefficients type for bias field estimate). Reimplemented from itk::SingleValuedCostFunction. Definition at line 77 of file itkMRIBiasFieldCorrectionFilter.h. Referenced by itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::GetDerivative().

template<class TImage, class TImageMask, class TBiasField> typedef SmartPointer<Self> itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::Pointer

Reimplemented from itk::SingleValuedCostFunction. Definition at line 52 of file itkMRIBiasFieldCorrectionFilter.h.

template<class TImage, class TImageMask, class TBiasField> typedef MRIBiasEnergyFunction itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::Self

Standard class typedefs. Reimplemented from itk::SingleValuedCostFunction. Definition at line 50 of file itkMRIBiasFieldCorrectionFilter.h.

template<class TImage, class TImageMask, class TBiasField> typedef SingleValuedCostFunction itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::Superclass

Reimplemented from itk::SingleValuedCostFunction. Definition at line 51 of file itkMRIBiasFieldCorrectionFilter.h.

---

Constructor & Destructor Documentation

template<class TImage, class TImageMask, class TBiasField> itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::MRIBiasEnergyFunction (    )  [protected]

Constructor:

template<class TImage, class TImageMask, class TBiasField> virtual itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::~MRIBiasEnergyFunction (    )  [protected, virtual]

Destructor:

---

Member Function Documentation

template<class TImage, class TImageMask, class TBiasField> virtual const char* itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::GetClassName (    )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::SingleValuedCostFunction.

template<class TImage, class TImageMask, class TBiasField> void itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::GetDerivative (  const ParametersType &    parameters, DerivativeType &    derivative )  const [inline, virtual]

Dummy implementation to confirm to the SingleValuedCostFunction interfaces. It is pure virtual in the superclass Implements itk::SingleValuedCostFunction. Definition at line 114 of file itkMRIBiasFieldCorrectionFilter.h. References itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::DerivativeType, and itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::ParametersType.

template<class TImage, class TImageMask, class TBiasField> double itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::GetEnergy0 (  double    diff )  [inline]

Get an energy value for the intensity difference between a pixel and its corresponding bias. Definition at line 105 of file itkMRIBiasFieldCorrectionFilter.h.

template<class TImage, class TImageMask, class TBiasField> unsigned int itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::GetNumberOfParameters (  void    )  const [virtual]

Return the number of parameters required to compute this cost function. This method MUST be overloaded by derived classes. Implements itk::CostFunction.

template<class TImage, class TImageMask, class TBiasField> MeasureType itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::GetValue (  const ParametersType &    parameters )  const [virtual]

Gets the total energy value of an image or a slice using the given parameters. Implements itk::SingleValuedCostFunction.

template<class TImage, class TImageMask, class TBiasField> void itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::InitializeDistributions (  Array< double >    classMeans, Array< double >    classSigmas )

Set Mean and Sigma for the normal distributions Warning: This method MUST be called before any attemp to evaluate the Function because it instantiate the internal energy function

template<class TImage, class TImageMask, class TBiasField> itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::itkStaticConstMacro (  SpaceDimension   , unsigned    int, 3    )

Not used, but expected by SingleValuedNonLinearOptimizer class.

template<class TImage, class TImageMask, class TBiasField> Pointer itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::New (    )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TImage, class TImageMask, class TBiasField> virtual void itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::SetBiasField (  BiasFieldType *    _arg )  [virtual]

Sets the BiasField object.

template<class TImage, class TImageMask, class TBiasField> virtual void itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::SetImage (  ImageType *    _arg )  [virtual]

Specify the input image.

template<class TImage, class TImageMask, class TBiasField> virtual void itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::SetMask (  MaskType *    _arg )  [virtual]

Specify the input mask image.

template<class TImage, class TImageMask, class TBiasField> virtual void itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >::SetRegion (  ImageRegionType    _arg )  [virtual]

Set the image region which will be included for energy calculation.

---

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

• itkMRIBiasFieldCorrectionFilter.h

---