go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions
elastix::KNNGraphAlphaMutualInformationMetric< TElastix > Class Template Reference

#include <elxKNNGraphAlphaMutualInformationMetric.h>

Inheritance diagram for elastix::KNNGraphAlphaMutualInformationMetric< TElastix >:
Inheritance graph
[legend]
Collaboration diagram for elastix::KNNGraphAlphaMutualInformationMetric< TElastix >:
Collaboration graph
[legend]

Public Types

typedef
Superclass2::ConfigurationPointer 
ConfigurationPointer
typedef
Superclass2::ConfigurationType 
ConfigurationType
typedef SmartPointer< const SelfConstPointer
typedef Superclass1::DerivativeType DerivativeType
typedef Superclass2::ElastixPointer ElastixPointer
typedef Superclass2::ElastixType ElastixType
typedef FixedImageType FixedFeatureImageType
typedef
Superclass1::FixedImageConstPointer 
FixedImageConstPointer
typedef Superclass1::FixedImageType FixedImageType
typedef
Superclass1::InterpolatorType 
InterpolatorType
typedef Superclass2::ITKBaseType ITKBaseType
typedef Superclass1::MeasureType MeasureType
typedef MovingImageType MovingFeatureImageType
typedef
Superclass1::MovingImageConstPointer 
MovingImageConstPointer
typedef
Superclass1::MovingImageType 
MovingImageType
typedef Superclass1::ParametersType ParametersType
typedef SmartPointer< SelfPointer
typedef
Superclass2::RegistrationPointer 
RegistrationPointer
typedef
Superclass2::RegistrationType 
RegistrationType
typedef
KNNGraphAlphaMutualInformationMetric 
Self
typedef
KNNGraphAlphaMutualInformationImageToImageMetric
< typename MetricBase
< TElastix >::FixedImageType,
typename MetricBase< TElastix >
::MovingImageType
Superclass1
typedef MetricBase< TElastix > Superclass2
typedef TimerType::Pointer TimerPointer
typedef tmr::Timer TimerType
typedef
Superclass1::TransformJacobianType 
TransformJacobianType
typedef
Superclass1::TransformPointer 
TransformPointer
typedef Superclass1::TransformType TransformType

Public Member Functions

virtual void BeforeEachResolution (void)
virtual void BeforeRegistration (void)
 elxClassNameMacro ("KNNGraphAlphaMutualInformation")
virtual const char * GetClassName () const
virtual void Initialize (void) throw (ExceptionObject)
 itkStaticConstMacro (FixedImageDimension, unsigned int, FixedImageType::ImageDimension)
 itkStaticConstMacro (MovingImageDimension, unsigned int, MovingImageType::ImageDimension)

Static Public Member Functions

static Pointer New ()

Protected Member Functions

 KNNGraphAlphaMutualInformationMetric ()
virtual ~KNNGraphAlphaMutualInformationMetric ()

Private Member Functions

 KNNGraphAlphaMutualInformationMetric (const Self &)
void operator= (const Self &)

Detailed Description

template<class TElastix>
class elastix::KNNGraphAlphaMutualInformationMetric< TElastix >

A metric based on the itk::KNNGraphAlphaMutualInformationImageToImageMetric.

The parameters used in this class are:

Parameters:
Metric: Select this metric as follows:
(Metric "KNNGraphAlphaMutualInformation")
Parameters:
Alpha: since this metric calculates alpha - mutual information.
(Alpha 0.5)
Choose a value between 0.0 and 1.0. The default is 0.5.
Parameters:
TreeType: The type of the kNN binary tree.
(TreeType "BDTree" "BruteForceTree")
Choose one of { KDTree, BDTree, BruteForceTree }.
The default is "KDTree" for all resolutions.
Parameters:
BucketSize: The maximum number of samples in one bucket.
This parameter influences the calculation time only, and is not appropiate for the BruteForceTree.
(BucketSize 5 100 50)
The default is 50 for all resolutions.
Parameters:
SplittingRule: This rule defines how the feature space is split.
(SplittingRule "ANN_KD_STD" "ANN_KD_FAIR")
Choose one of { ANN_KD_STD, ANN_KD_MIDPT, ANN_KD_SL_MIDPT, ANN_KD_FAIR, ANN_KD_SL_FAIR, ANN_KD_SUGGEST }
The default is "ANN_KD_SL_MIDPT" for all resolutions.
Parameters:
ShrinkingRule: This rule defines how the feature space is shrinked.
(ShrinkingRule "ANN_BD_CENTROID" "ANN_BD_NONE")
Choose one of { ANN_BD_NONE, ANN_BD_SIMPLE, ANN_BD_CENTROID, ANN_BD_SUGGEST }
The default is "ANN_BD_SIMPLE" for all resolutions.
Parameters:
TreeSearchType: The type of the binary tree searcher.
(TreeSearchType "Standard" "FixedRadius")
Choose one of { Standard, FixedRadius, Priority }
The default is "Standard" for all resolutions.
Parameters:
KNearestNeighbours: The number of nearest neighbours to be searched.
(KNearestNeighbours 50 20 35)
The default is 20 for all resolutions.
Parameters:
ErrorBound: error accepted in finding the nearest neighbours.
An ErrorBound of 0.0 equals exact searching, higher error bounds should result in smaller computation times.
(ErrorBound 32.0 8.0 0.0)
The default is 0.0 for all resolutions.
Parameters:
SquaredSearchRadius: the radius of the sphere where there is searched for neighbours.
This option is only appropiate for FixedRadius search.
(SquaredSearchRadius 32.0 8.0 8.0)
The default is 0.0 for all resolutions, which means no radius.
Parameters:
AvoidDivisionBy: a small number to avoid division by zero in the implentation.
(AvoidDivisionBy 0.000000001)
The default is 1e-5.
Warning:
Note that we assume the FixedFeatureImageType to have the same pixeltype as the FixedImageType
See also:
KNNGraphAlphaMutualInformationImageToImageMetric, ParzenWindowMutualInformationImageToImageMetric

Definition at line 82 of file elxKNNGraphAlphaMutualInformationMetric.h.


Member Typedef Documentation

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 137 of file elxKNNGraphAlphaMutualInformationMetric.h.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 136 of file elxKNNGraphAlphaMutualInformationMetric.h.

template<class TElastix >
typedef SmartPointer<const Self> elastix::KNNGraphAlphaMutualInformationMetric< TElastix >::ConstPointer

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 135 of file elxKNNGraphAlphaMutualInformationMetric.h.

Typedef's inherited from Elastix.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 134 of file elxKNNGraphAlphaMutualInformationMetric.h.

Typedefs for feature images.

Definition at line 143 of file elxKNNGraphAlphaMutualInformationMetric.h.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 121 of file elxKNNGraphAlphaMutualInformationMetric.h.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 140 of file elxKNNGraphAlphaMutualInformationMetric.h.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 118 of file elxKNNGraphAlphaMutualInformationMetric.h.

Definition at line 144 of file elxKNNGraphAlphaMutualInformationMetric.h.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 122 of file elxKNNGraphAlphaMutualInformationMetric.h.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 120 of file elxKNNGraphAlphaMutualInformationMetric.h.

template<class TElastix >
typedef SmartPointer<Self> elastix::KNNGraphAlphaMutualInformationMetric< TElastix >::Pointer

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 139 of file elxKNNGraphAlphaMutualInformationMetric.h.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 138 of file elxKNNGraphAlphaMutualInformationMetric.h.

Standard ITK-stuff.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 92 of file elxKNNGraphAlphaMutualInformationMetric.h.

Definition at line 95 of file elxKNNGraphAlphaMutualInformationMetric.h.

template<class TElastix >
typedef MetricBase<TElastix> elastix::KNNGraphAlphaMutualInformationMetric< TElastix >::Superclass2

Definition at line 96 of file elxKNNGraphAlphaMutualInformationMetric.h.

template<class TElastix >
typedef TimerType::Pointer elastix::KNNGraphAlphaMutualInformationMetric< TElastix >::TimerPointer

Typedef for timer.

Definition at line 149 of file elxKNNGraphAlphaMutualInformationMetric.h.

template<class TElastix >
typedef tmr::Timer elastix::KNNGraphAlphaMutualInformationMetric< TElastix >::TimerType

Typedef for timer.

Definition at line 147 of file elxKNNGraphAlphaMutualInformationMetric.h.


Constructor & Destructor Documentation

template<class TElastix >
elastix::KNNGraphAlphaMutualInformationMetric< TElastix >::KNNGraphAlphaMutualInformationMetric ( ) [inline, protected]

The constructor.

Definition at line 182 of file elxKNNGraphAlphaMutualInformationMetric.h.

template<class TElastix >
virtual elastix::KNNGraphAlphaMutualInformationMetric< TElastix >::~KNNGraphAlphaMutualInformationMetric ( ) [inline, protected, virtual]

The destructor.

Definition at line 184 of file elxKNNGraphAlphaMutualInformationMetric.h.

template<class TElastix >
elastix::KNNGraphAlphaMutualInformationMetric< TElastix >::KNNGraphAlphaMutualInformationMetric ( const Self ) [private]

The private constructor.


Member Function Documentation

template<class TElastix >
virtual void elastix::KNNGraphAlphaMutualInformationMetric< TElastix >::BeforeEachResolution ( void  ) [virtual]

Execute stuff before each new pyramid resolution:

  • Set the tree type.
  • Set the bucket size, if appropiate.
  • Set the splitting rule, if appropiate.
  • Set the shrinking rule, if appropiate.
  • Set the tree searcher type.
  • Set the k NearestNeighbours.
  • Set the error bound epsilon for ANN search.
  • Set the squared search radius, if appropiate.

Reimplemented from elastix::BaseComponent.

template<class TElastix >
virtual void elastix::KNNGraphAlphaMutualInformationMetric< TElastix >::BeforeRegistration ( void  ) [virtual]

Execute stuff before the registration:

  • Set the alpha from alpha - MI.
  • Set the number of fixed feature images.
  • Set the number of moving feature images.
  • Set the fixed feature images filenames.
  • Set the moving feature images filenames.
  • Set the spline orders of the fixed feature interpolators.
  • Set the spline orders of the moving feature interpolators.

Reimplemented from elastix::BaseComponent.

template<class TElastix >
elastix::KNNGraphAlphaMutualInformationMetric< TElastix >::elxClassNameMacro ( "KNNGraphAlphaMutualInformation"  )

Name of this class. Use this name in the parameter file to select this specific metric.
example: (Metric "KNNGraphAlphaMutualInformation")

template<class TElastix >
virtual const char* elastix::KNNGraphAlphaMutualInformationMetric< TElastix >::GetClassName ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from elastix::MetricBase< TElastix >.

template<class TElastix >
virtual void elastix::KNNGraphAlphaMutualInformationMetric< TElastix >::Initialize ( void  ) throw (ExceptionObject) [virtual]

Sets up a timer to measure the intialisation time and calls the Superclass' implementation.

Reimplemented from itk::KNNGraphAlphaMutualInformationImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >.

template<class TElastix >
elastix::KNNGraphAlphaMutualInformationMetric< TElastix >::itkStaticConstMacro ( FixedImageDimension  ,
unsigned  int,
FixedImageType::ImageDimension   
)

The fixed image dimension

Reimplemented from elastix::MetricBase< TElastix >.

template<class TElastix >
elastix::KNNGraphAlphaMutualInformationMetric< TElastix >::itkStaticConstMacro ( MovingImageDimension  ,
unsigned  int,
MovingImageType::ImageDimension   
)

The moving image dimension.

Reimplemented from elastix::MetricBase< TElastix >.

template<class TElastix >
static Pointer elastix::KNNGraphAlphaMutualInformationMetric< TElastix >::New ( ) [static]
template<class TElastix >
void elastix::KNNGraphAlphaMutualInformationMetric< TElastix >::operator= ( const Self ) [private]

The private copy constructor.



Generated on 11-05-2012 for elastix by doxygen 1.7.6.1 elastix logo