go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
elastix::BaseComponent Class Reference

#include <elxBaseComponent.h>

Detailed Description

The BaseComponent class is a class that all elastix components should inherit from.

Most elastix component inherit both from an ITK class and from the elx::BaseComponent class. The BaseComponent class contains some methods that each component is supposed to have, but are not defined in itk::Object.

See also
BaseComponentSE

Definition at line 65 of file elxBaseComponent.h.

Inheritance diagram for elastix::BaseComponent:
Inheritance graph
[legend]

Public Member Functions

virtual void AfterEachIteration (void)
 
virtual void AfterEachIterationBase (void)
 
virtual void AfterEachResolution (void)
 
virtual void AfterEachResolutionBase (void)
 
virtual void AfterRegistration (void)
 
virtual void AfterRegistrationBase (void)
 
virtual int BeforeAll (void)
 
virtual int BeforeAllBase (void)
 
virtual void BeforeEachResolution (void)
 
virtual void BeforeEachResolutionBase (void)
 
virtual void BeforeRegistration (void)
 
virtual void BeforeRegistrationBase (void)
 
std::string ConvertSecondsToDHMS (const double totalSeconds, const unsigned int precision) const
 
virtual const char * elxGetClassName (void) const
 
virtual const char * GetComponentLabel (void) const
 
virtual void SetComponentLabel (const char *label, unsigned int idx)
 

Protected Member Functions

 BaseComponent ()
 
virtual ~BaseComponent ()
 

Private Member Functions

 BaseComponent (const BaseComponent &)
 
void operator= (const BaseComponent &)
 

Private Attributes

std::string m_ComponentLabel
 

Constructor & Destructor Documentation

elastix::BaseComponent::BaseComponent ( )
inlineprotected

Definition at line 126 of file elxBaseComponent.h.

virtual elastix::BaseComponent::~BaseComponent ( )
inlineprotectedvirtual

Definition at line 127 of file elxBaseComponent.h.

elastix::BaseComponent::BaseComponent ( const BaseComponent )
private

Member Function Documentation

virtual void elastix::BaseComponent::AfterEachIteration ( void  )
inlinevirtual
virtual void elastix::BaseComponent::AfterEachIterationBase ( void  )
inlinevirtual
virtual void elastix::BaseComponent::AfterEachResolution ( void  )
inlinevirtual
virtual void elastix::BaseComponent::AfterEachResolutionBase ( void  )
inlinevirtual

Reimplemented in elastix::ResamplerBase< TElastix >.

Definition at line 86 of file elxBaseComponent.h.

virtual void elastix::BaseComponent::AfterRegistration ( void  )
inlinevirtual
virtual void elastix::BaseComponent::AfterRegistrationBase ( void  )
inlinevirtual
virtual int elastix::BaseComponent::BeforeAll ( void  )
inlinevirtual
virtual int elastix::BaseComponent::BeforeAllBase ( void  )
inlinevirtual

Callback methods that each component of elastix is supposed to have. These methods can be overridden in each base component (like MetricBase, TransformBase, etc.). In this way similar behavior for a group of components can be implemented.

Reimplemented in elastix::ElastixBase, elastix::TransformBase< TElastix >, elastix::PolydataDummyPenalty< TElastix >, elastix::MissingStructurePenalty< TElastix >, and elastix::CorrespondingPointsEuclideanDistanceMetric< TElastix >.

Definition at line 75 of file elxBaseComponent.h.

virtual void elastix::BaseComponent::BeforeEachResolution ( void  )
inlinevirtual

Reimplemented in elastix::BSplineTransformWithDiffusion< TElastix >, elastix::ElastixTemplate< TFixedImage, TMovingImage >, elastix::AdvancedBSplineTransform< TElastix >, elastix::BSplineStackTransform< TElastix >, elastix::AdaptiveStochasticGradientDescent< TElastix >, elastix::MultiBSplineTransformWithNormal< TElastix >, elastix::TransformRigidityPenalty< TElastix >, elastix::MultiMetricMultiResolutionRegistration< TElastix >, elastix::AdvancedMattesMutualInformationMetric< TElastix >, elastix::VarianceOverLastDimensionMetric< TElastix >, elastix::NormalizedMutualInformationMetric< TElastix >, elastix::KNNGraphAlphaMutualInformationMetric< TElastix >, elastix::CMAEvolutionStrategy< TElastix >, elastix::StatisticalShapePenalty< TElastix >, elastix::MultiResolutionRegistrationWithFeatures< TElastix >, elastix::AdvancedMeanSquaresMetric< TElastix >, elastix::TransformBendingEnergyPenalty< TElastix >, elastix::ConjugateGradient< TElastix >, elastix::QuasiNewtonLBFGS< TElastix >, elastix::GradientDifferenceMetric< TElastix >, elastix::NormalizedGradientCorrelationMetric< TElastix >, elastix::PatternIntensityMetric< TElastix >, elastix::AdvancedNormalizedCorrelationMetric< TElastix >, elastix::MultiResolutionRegistration< TElastix >, elastix::FixedGenericPyramid< TElastix >, elastix::MovingGenericPyramid< TElastix >, elastix::SimultaneousPerturbation< TElastix >, elastix::ViolaWellsMutualInformationMetric< TElastix >, elastix::FiniteDifferenceGradientDescent< TElastix >, elastix::RayCastInterpolator< TElastix >, elastix::ConjugateGradientFRPR< TElastix >, elastix::FullSearch< TElastix >, elastix::RSGDEachParameterApart< TElastix >, elastix::StandardGradientDescent< TElastix >, elastix::MutualInformationHistogramMetric< TElastix >, elastix::RegularStepGradientDescent< TElastix >, elastix::BSplineInterpolator< TElastix >, elastix::BSplineInterpolatorFloat< TElastix >, elastix::ReducedDimensionBSplineInterpolator< TElastix >, elastix::Powell< TElastix >, and elastix::Simplex< TElastix >.

Definition at line 97 of file elxBaseComponent.h.

virtual void elastix::BaseComponent::BeforeEachResolutionBase ( void  )
inlinevirtual
virtual void elastix::BaseComponent::BeforeRegistration ( void  )
inlinevirtual

Callback methods that each component of elastix is supposed to have. These methods can be overridden in each single component (like MattesMutualInformationMetric) to achieve behavior, specific for that single component.

Reimplemented in elastix::BSplineTransformWithDiffusion< TElastix >, elastix::ElastixTemplate< TFixedImage, TMovingImage >, elastix::AdvancedBSplineTransform< TElastix >, elastix::BSplineStackTransform< TElastix >, elastix::AdaptiveStochasticGradientDescent< TElastix >, elastix::MultiBSplineTransformWithNormal< TElastix >, elastix::TransformRigidityPenalty< TElastix >, elastix::MultiMetricMultiResolutionRegistration< TElastix >, elastix::SplineKernelTransform< TElastix >, elastix::VarianceOverLastDimensionMetric< TElastix >, elastix::PolydataDummyPenalty< TElastix >, elastix::SimilarityTransformElastix< TElastix >, elastix::EulerTransformElastix< TElastix >, elastix::AffineDTITransformElastix< TElastix >, elastix::WeightedCombinationTransformElastix< TElastix >, elastix::AdvancedAffineTransformElastix< TElastix >, elastix::CMAEvolutionStrategy< TElastix >, elastix::MissingStructurePenalty< TElastix >, elastix::DistancePreservingRigidityPenalty< TElastix >, elastix::StatisticalShapePenalty< TElastix >, elastix::KNNGraphAlphaMutualInformationMetric< TElastix >, elastix::AdvancedKappaStatisticMetric< TElastix >, elastix::MultiResolutionRegistrationWithFeatures< TElastix >, elastix::ConjugateGradient< TElastix >, elastix::QuasiNewtonLBFGS< TElastix >, elastix::GradientDifferenceMetric< TElastix >, elastix::NormalizedGradientCorrelationMetric< TElastix >, elastix::PatternIntensityMetric< TElastix >, elastix::CorrespondingPointsEuclideanDistanceMetric< TElastix >, elastix::MultiResolutionRegistration< TElastix >, elastix::TranslationTransformElastix< TElastix >, elastix::SimultaneousPerturbation< TElastix >, elastix::FiniteDifferenceGradientDescent< TElastix >, elastix::RayCastInterpolator< TElastix >, elastix::ConjugateGradientFRPR< TElastix >, elastix::FullSearch< TElastix >, elastix::BSplineResampleInterpolator< TElastix >, elastix::RSGDEachParameterApart< TElastix >, elastix::StandardGradientDescent< TElastix >, elastix::BSplineResampleInterpolatorFloat< TElastix >, elastix::ReducedDimensionBSplineResampleInterpolator< TElastix >, elastix::OpenCLResampler< TElastix >, elastix::RegularStepGradientDescent< TElastix >, elastix::MutualInformationHistogramMetric< TElastix >, elastix::RayCastResampleInterpolator< TElastix >, elastix::CUDAResampler< TElastix >, elastix::OpenCLFixedGenericPyramid< TElastix >, elastix::OpenCLMovingGenericPyramid< TElastix >, elastix::Powell< TElastix >, and elastix::Simplex< TElastix >.

Definition at line 96 of file elxBaseComponent.h.

virtual void elastix::BaseComponent::BeforeRegistrationBase ( void  )
inlinevirtual

Callback methods that each component of elastix is supposed to have. These methods can be overridden in each base component (like MetricBase, TransformBase, etc.). In this way similar behavior for a group of components can be implemented.

Reimplemented in elastix::ElastixBase, elastix::TransformBase< TElastix >, elastix::ResamplerBase< TElastix >, elastix::MovingImagePyramidBase< TElastix >, and elastix::FixedImagePyramidBase< TElastix >.

Definition at line 84 of file elxBaseComponent.h.

std::string elastix::BaseComponent::ConvertSecondsToDHMS ( const double  totalSeconds,
const unsigned int  precision 
) const

Convenience function to convert seconds to day, hour, minute, second format.

virtual const char* elastix::BaseComponent::elxGetClassName ( void  ) const
virtual

The name of the component in the ComponentDatabase. Override this function not directly, but with the elxClassNameMacro("name").

virtual const char* elastix::BaseComponent::GetComponentLabel ( void  ) const
virtual

Get the componentlabel as a string: "Metric0" for example.

void elastix::BaseComponent::operator= ( const BaseComponent )
private
virtual void elastix::BaseComponent::SetComponentLabel ( const char *  label,
unsigned int  idx 
)
virtual

Set the component label, which consists of a label ( "Metric", "Transform") and an index number. In case more metrics are used simultaneously each metric will have its own index number. This can be used when reading the parameter file for example, to distinguish between options meant for Metric0 and for Metric1.

Field Documentation

std::string elastix::BaseComponent::m_ComponentLabel
private

Definition at line 134 of file elxBaseComponent.h.



Generated on 04-09-2015 for elastix by doxygen 1.8.9.1 elastix logo