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 | Protected Attributes | Private Member Functions
elastix::FullSearch< TElastix > Class Template Reference

An optimizer based on the itk::FullSearchOptimizer. More...

#include <elxFullSearchOptimizer.h>

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

Public Types

typedef
Superclass2::ConfigurationPointer 
ConfigurationPointer
typedef
Superclass2::ConfigurationType 
ConfigurationType
typedef SmartPointer< const SelfConstPointer
typedef
Superclass1::CostFunctionPointer 
CostFunctionPointer
typedef
Superclass1::CostFunctionType 
CostFunctionType
typedef std::map< unsigned int,
std::string > 
DimensionNameMapType
typedef Superclass2::ElastixPointer ElastixPointer
typedef Superclass2::ElastixType ElastixType
typedef Superclass2::ITKBaseType ITKBaseType
typedef Superclass1::MeasureType MeasureType
typedef
DimensionNameMapType::const_iterator 
NameIteratorType
typedef NDImageType::Pointer NDImagePointer
typedef NDImageBase< floatNDImageType
typedef Superclass1::ParametersType ParametersType
typedef
Superclass1::ParameterValueType 
ParameterValueType
typedef SmartPointer< SelfPointer
typedef Superclass1::RangeType RangeType
typedef Superclass1::RangeValueType RangeValueType
typedef
Superclass2::RegistrationPointer 
RegistrationPointer
typedef
Superclass2::RegistrationType 
RegistrationType
typedef
Superclass1::SearchSpaceIndexType 
SearchSpaceIndexType
typedef
Superclass1::SearchSpaceIteratorType 
SearchSpaceIteratorType
typedef
Superclass1::SearchSpacePointer 
SearchSpacePointer
typedef
Superclass1::SearchSpacePointType 
SearchSpacePointType
typedef
Superclass1::SearchSpaceSizeType 
SearchSpaceSizeType
typedef
Superclass1::SearchSpaceType 
SearchSpaceType
typedef FullSearch Self
typedef FullSearchOptimizer Superclass1
typedef OptimizerBase< TElastix > Superclass2

Public Member Functions

virtual void AfterEachIteration (void)
virtual void AfterEachResolution (void)
virtual void AfterRegistration (void)
virtual void BeforeEachResolution (void)
virtual void BeforeRegistration (void)
 elxClassNameMacro ("FullSearch")
virtual const char * GetClassName () const
virtual NDImageTypeGetOptimizationSurface ()

Static Public Member Functions

static Pointer New ()

Protected Member Functions

virtual bool CheckSearchSpaceRangeDefinition (const std::string &fullFieldName, const bool found, const unsigned int entry_nr) const
 FullSearch ()
virtual ~FullSearch ()

Protected Attributes

NDImagePointer m_OptimizationSurface
DimensionNameMapType m_SearchSpaceDimensionNames

Private Member Functions

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

Detailed Description

template<class TElastix>
class elastix::FullSearch< TElastix >

An optimizer based on the itk::FullSearchOptimizer.

Optimizer that scans a subspace of the parameter space and searches for the best parameters.

The results are written to the output-directory as an image OptimizationSurface.<elastixlevel>.R<resolution>.mhd", which is an N-dimensional float image, where N is the dimension of the search space.

The parameters used in this class are:

Parameters:
Optimizer: Select this optimizer as follows:
(Optimizer "FullSearch")
Parameters:
FullSearchSpace<r>: Defines for resolution r a range of parameters to scan.
Full syntax: (FullSearchSpace<r> <parameter_name> <parameter_nr> <min> <max> <stepsize> [...] )
example: (FullSearchSpace0 "translation_x" 2 -4.0 3.0 1.0 "rotation_y" 3 -1.0 1.0 0.5)
This varies the second transform parameter in the range [-4.0 3.0] with steps of 1.0 and the third parameter in the range [-1.0 1.0] with steps of 0.5. The names are used as column headers in the screen output.
See also:
FullSearchOptimizer

Definition at line 57 of file elxFullSearchOptimizer.h.


Member Typedef Documentation

template<class TElastix >
typedef Superclass2::ConfigurationPointer elastix::FullSearch< TElastix >::ConfigurationPointer

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 103 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef Superclass2::ConfigurationType elastix::FullSearch< TElastix >::ConfigurationType

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 102 of file elxFullSearchOptimizer.h.

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

Reimplemented from itk::FullSearchOptimizer.

Definition at line 70 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef Superclass1::CostFunctionPointer elastix::FullSearch< TElastix >::CostFunctionPointer

Reimplemented from itk::FullSearchOptimizer.

Definition at line 86 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef Superclass1::CostFunctionType elastix::FullSearch< TElastix >::CostFunctionType

Typedef's inherited from Superclass1.

Reimplemented from itk::FullSearchOptimizer.

Definition at line 85 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef std::map<unsigned int, std::string> elastix::FullSearch< TElastix >::DimensionNameMapType

To store the names of the search space dimensions

Definition at line 113 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef Superclass2::ElastixPointer elastix::FullSearch< TElastix >::ElastixPointer

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 101 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef Superclass2::ElastixType elastix::FullSearch< TElastix >::ElastixType

Typedef's inherited from Elastix.

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 100 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef Superclass2::ITKBaseType elastix::FullSearch< TElastix >::ITKBaseType

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 106 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef Superclass1::MeasureType elastix::FullSearch< TElastix >::MeasureType

Reimplemented from itk::FullSearchOptimizer.

Definition at line 88 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef DimensionNameMapType::const_iterator elastix::FullSearch< TElastix >::NameIteratorType

Definition at line 114 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef NDImageType::Pointer elastix::FullSearch< TElastix >::NDImagePointer

Definition at line 110 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef NDImageBase<float> elastix::FullSearch< TElastix >::NDImageType

To store the results of the full search

Definition at line 109 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef Superclass1::ParametersType elastix::FullSearch< TElastix >::ParametersType

Reimplemented from itk::FullSearchOptimizer.

Definition at line 87 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef Superclass1::ParameterValueType elastix::FullSearch< TElastix >::ParameterValueType

Reimplemented from itk::FullSearchOptimizer.

Definition at line 89 of file elxFullSearchOptimizer.h.

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

Reimplemented from itk::FullSearchOptimizer.

Definition at line 69 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef Superclass1::RangeType elastix::FullSearch< TElastix >::RangeType

Reimplemented from itk::FullSearchOptimizer.

Definition at line 91 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef Superclass1::RangeValueType elastix::FullSearch< TElastix >::RangeValueType

Reimplemented from itk::FullSearchOptimizer.

Definition at line 90 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef Superclass2::RegistrationPointer elastix::FullSearch< TElastix >::RegistrationPointer

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 105 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef Superclass2::RegistrationType elastix::FullSearch< TElastix >::RegistrationType

Reimplemented from elastix::OptimizerBase< TElastix >.

Definition at line 104 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef Superclass1::SearchSpaceIndexType elastix::FullSearch< TElastix >::SearchSpaceIndexType

Reimplemented from itk::FullSearchOptimizer.

Definition at line 96 of file elxFullSearchOptimizer.h.

Reimplemented from itk::FullSearchOptimizer.

Definition at line 94 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef Superclass1::SearchSpacePointer elastix::FullSearch< TElastix >::SearchSpacePointer

Reimplemented from itk::FullSearchOptimizer.

Definition at line 93 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef Superclass1::SearchSpacePointType elastix::FullSearch< TElastix >::SearchSpacePointType

Reimplemented from itk::FullSearchOptimizer.

Definition at line 95 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef Superclass1::SearchSpaceSizeType elastix::FullSearch< TElastix >::SearchSpaceSizeType

Reimplemented from itk::FullSearchOptimizer.

Definition at line 97 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef Superclass1::SearchSpaceType elastix::FullSearch< TElastix >::SearchSpaceType

Reimplemented from itk::FullSearchOptimizer.

Definition at line 92 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef FullSearch elastix::FullSearch< TElastix >::Self

Standard ITK.

Reimplemented from itk::FullSearchOptimizer.

Definition at line 66 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef FullSearchOptimizer elastix::FullSearch< TElastix >::Superclass1

Definition at line 67 of file elxFullSearchOptimizer.h.

template<class TElastix >
typedef OptimizerBase<TElastix> elastix::FullSearch< TElastix >::Superclass2

Definition at line 68 of file elxFullSearchOptimizer.h.


Constructor & Destructor Documentation

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

Definition at line 130 of file elxFullSearchOptimizer.h.

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

Member Function Documentation

template<class TElastix >
virtual void elastix::FullSearch< TElastix >::AfterEachIteration ( void  ) [virtual]

Reimplemented from elastix::BaseComponent.

template<class TElastix >
virtual void elastix::FullSearch< TElastix >::AfterEachResolution ( void  ) [virtual]

Reimplemented from elastix::BaseComponent.

template<class TElastix >
virtual void elastix::FullSearch< TElastix >::AfterRegistration ( void  ) [virtual]

Reimplemented from elastix::BaseComponent.

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

Reimplemented from elastix::BaseComponent.

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

Methods that have to be present everywhere.

Reimplemented from elastix::BaseComponent.

template<class TElastix >
virtual bool elastix::FullSearch< TElastix >::CheckSearchSpaceRangeDefinition ( const std::string &  fullFieldName,
const bool  found,
const unsigned int  entry_nr 
) const [protected, virtual]

Checks if an error generated while reading the search space ranges from the parameter file is a real error. Prints some error message if so.

template<class TElastix >
elastix::FullSearch< TElastix >::elxClassNameMacro ( "FullSearch< TElastix >"  )

Name of this class. Use this name in the parameter file to select this specific optimizer.
example: (Optimizer "FullSearch")

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

Run-time type information (and related methods).

Reimplemented from itk::FullSearchOptimizer.

template<class TElastix >
virtual NDImageType* elastix::FullSearch< TElastix >::GetOptimizationSurface ( ) [virtual]
Todo:
BeforeAll, checking parameters.

Get a pointer to the image containing the optimization surface.

template<class TElastix >
static Pointer elastix::FullSearch< TElastix >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::FullSearchOptimizer.

template<class TElastix >
void elastix::FullSearch< TElastix >::operator= ( const Self ) [private]

Field Documentation

template<class TElastix >
NDImagePointer elastix::FullSearch< TElastix >::m_OptimizationSurface [protected]

Definition at line 130 of file elxFullSearchOptimizer.h.

template<class TElastix >
DimensionNameMapType elastix::FullSearch< TElastix >::m_SearchSpaceDimensionNames [protected]

Definition at line 134 of file elxFullSearchOptimizer.h.



Generated on 24-10-2011 for elastix by doxygen 1.7.4 elastix logo