![]() |
ITK
4.13.0
Insight Segmentation and Registration Toolkit
|
#include <itkRegistrationParameterScalesEstimator.h>
Implements a registration helper class for estimating scales of transform parameters and step sizes.
Its input is a metric, from which the fixed/moving images and transform objects are obtained.
This class implements some common methods as building blocks called by subclasses with various estimation strategies. One of these methods is SampleVirtualDomain, which provides various choices of sampling the image domain.
Definition at line 54 of file itkRegistrationParameterScalesEstimator.h.
Public Types | |
typedef SmartPointer< const Self > | ConstPointer |
typedef FixedTransformType::ConstPointer | FixedTransformConstPointer |
typedef MetricType::FixedTransformType | FixedTransformType |
typedef Superclass::FloatType | FloatType |
typedef TMetric::JacobianType | JacobianType |
typedef MetricType::ConstPointer | MetricConstPointer |
typedef MetricType::Pointer | MetricPointer |
typedef TMetric | MetricType |
typedef MovingTransformType::ConstPointer | MovingTransformConstPointer |
typedef MetricType::MovingTransformType | MovingTransformType |
typedef Superclass::ParametersType | ParametersType |
typedef SmartPointer< Self > | Pointer |
typedef std::vector < VirtualPointType > | SamplePointContainerType |
enum | SamplingStrategyType { FullDomainSampling = 0, CornerSampling, RandomSampling, CentralRegionSampling, VirtualDomainPointSetSampling } |
typedef Superclass::ScalesType | ScalesType |
typedef RegistrationParameterScalesEstimator | Self |
typedef OptimizerParameterScalesEstimatorTemplate < typename TMetric::ParametersValueType > | Superclass |
typedef TMetric::VirtualImageConstPointer | VirtualImageConstPointer |
typedef TMetric::VirtualImagePointer | VirtualImagePointer |
typedef TMetric::VirtualImageType | VirtualImageType |
typedef TMetric::VirtualIndexType | VirtualIndexType |
typedef TMetric::VirtualPointSetPointer | VirtualPointSetPointer |
typedef TMetric::VirtualPointSetType | VirtualPointSetType |
typedef TMetric::VirtualPointType | VirtualPointType |
typedef TMetric::VirtualRegionType | VirtualRegionType |
typedef TMetric::VirtualSizeType | VirtualSizeType |
typedef TMetric::VirtualSpacingType | VirtualSpacingType |
![]() | |
typedef SmartPointer< const Self > | ConstPointer |
typedef TMetric::ParametersValueType | FloatType |
typedef OptimizerParameters < TMetric::ParametersValueType > | ParametersType |
typedef SmartPointer< Self > | Pointer |
typedef OptimizerParameters < TMetric::ParametersValueType > | ScalesType |
typedef OptimizerParameterScalesEstimatorTemplate | Self |
typedef Object | Superclass |
![]() | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef Object | Self |
typedef LightObject | Superclass |
![]() | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef LightObject | Self |
Public Member Functions | |
virtual void | EstimateLocalStepScales (const ParametersType &step, ScalesType &localStepScales) override=0 |
virtual FloatType | EstimateMaximumStepSize () override |
virtual void | EstimateScales (ScalesType &scales) override=0 |
virtual FloatType | EstimateStepScale (const ParametersType &step) override=0 |
virtual const char * | GetNameOfClass () const |
virtual void | SetCentralRegionRadius (IndexValueType _arg) |
virtual void | SetMetric (MetricType *_arg) |
virtual void | SetScalesSamplingStrategy () |
virtual void | SetStepScaleSamplingStrategy () |
virtual void | SetTransformForward (bool _arg) |
virtual bool | GetTransformForward () const |
virtual void | SetVirtualDomainPointSet (VirtualPointSetType *_arg) |
virtual void | SetVirtualDomainPointSet (const VirtualPointSetType *_arg) |
virtual const VirtualPointSetType * | GetVirtualDomainPointSet () const |
![]() | |
virtual void | EstimateLocalStepScales (const ParametersType &step, ScalesType &localStepScales)=0 |
virtual void | EstimateScales (ScalesType &scales)=0 |
virtual FloatType | EstimateStepScale (const ParametersType &step)=0 |
![]() | |
unsigned long | AddObserver (const EventObject &event, Command *) |
unsigned long | AddObserver (const EventObject &event, Command *) const |
virtual LightObject::Pointer | CreateAnother () const override |
virtual void | DebugOff () const |
virtual void | DebugOn () const |
Command * | GetCommand (unsigned long tag) |
bool | GetDebug () const |
MetaDataDictionary & | GetMetaDataDictionary () |
const MetaDataDictionary & | GetMetaDataDictionary () const |
virtual ModifiedTimeType | GetMTime () const |
virtual const TimeStamp & | GetTimeStamp () const |
bool | HasObserver (const EventObject &event) const |
void | InvokeEvent (const EventObject &) |
void | InvokeEvent (const EventObject &) const |
virtual void | Modified () const |
virtual void | Register () const override |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) |
void | SetDebug (bool debugFlag) const |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
virtual void | SetReferenceCount (int) override |
virtual void | UnRegister () const noexceptoverride |
virtual void | SetObjectName (std::string _arg) |
virtual const std::string & | GetObjectName () const |
![]() | |
virtual void | Delete () |
virtual int | GetReferenceCount () const |
itkCloneMacro (Self) | |
void | Print (std::ostream &os, Indent indent=0) const |
Static Public Attributes | |
static const SizeValueType | FixedDimension = TMetric::FixedDimension |
static const SizeValueType | MovingDimension = TMetric::MovingDimension |
static const SizeValueType | VirtualDimension = TMetric::VirtualDimension |
Protected Attributes | |
IndexValueType | m_CentralRegionRadius |
MetricPointer | m_Metric |
SizeValueType | m_NumberOfRandomSamples |
SamplePointContainerType | m_SamplePoints |
TimeStamp | m_SamplingTime |
VirtualPointSetType::ConstPointer | m_VirtualDomainPointSet |
![]() | |
AtomicInt< int > | m_ReferenceCount |
Static Protected Attributes | |
static ITK_CONSTEXPR_VAR SizeValueType | SizeOfSmallDomain = 1000 |
Private Attributes | |
SamplingStrategyType | m_SamplingStrategy |
bool | m_TransformForward |
Additional Inherited Members | |
![]() | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool flag) |
![]() | |
static void | BreakOnError () |
static Pointer | New () |
typedef SmartPointer<const Self> itk::RegistrationParameterScalesEstimator< TMetric >::ConstPointer |
Definition at line 62 of file itkRegistrationParameterScalesEstimator.h.
typedef FixedTransformType::ConstPointer itk::RegistrationParameterScalesEstimator< TMetric >::FixedTransformConstPointer |
Definition at line 82 of file itkRegistrationParameterScalesEstimator.h.
typedef MetricType::FixedTransformType itk::RegistrationParameterScalesEstimator< TMetric >::FixedTransformType |
Type of the transform to initialize
Definition at line 81 of file itkRegistrationParameterScalesEstimator.h.
typedef Superclass::FloatType itk::RegistrationParameterScalesEstimator< TMetric >::FloatType |
Type of float
Definition at line 74 of file itkRegistrationParameterScalesEstimator.h.
typedef TMetric::JacobianType itk::RegistrationParameterScalesEstimator< TMetric >::JacobianType |
Type of Jacobian of transform.
Definition at line 115 of file itkRegistrationParameterScalesEstimator.h.
typedef MetricType::ConstPointer itk::RegistrationParameterScalesEstimator< TMetric >::MetricConstPointer |
Definition at line 78 of file itkRegistrationParameterScalesEstimator.h.
typedef MetricType::Pointer itk::RegistrationParameterScalesEstimator< TMetric >::MetricPointer |
Definition at line 77 of file itkRegistrationParameterScalesEstimator.h.
typedef TMetric itk::RegistrationParameterScalesEstimator< TMetric >::MetricType |
Definition at line 76 of file itkRegistrationParameterScalesEstimator.h.
typedef MovingTransformType::ConstPointer itk::RegistrationParameterScalesEstimator< TMetric >::MovingTransformConstPointer |
Definition at line 85 of file itkRegistrationParameterScalesEstimator.h.
typedef MetricType::MovingTransformType itk::RegistrationParameterScalesEstimator< TMetric >::MovingTransformType |
Definition at line 84 of file itkRegistrationParameterScalesEstimator.h.
typedef Superclass::ParametersType itk::RegistrationParameterScalesEstimator< TMetric >::ParametersType |
Type of parameters of the optimizer
Definition at line 71 of file itkRegistrationParameterScalesEstimator.h.
typedef SmartPointer<Self> itk::RegistrationParameterScalesEstimator< TMetric >::Pointer |
Definition at line 61 of file itkRegistrationParameterScalesEstimator.h.
typedef std::vector<VirtualPointType> itk::RegistrationParameterScalesEstimator< TMetric >::SamplePointContainerType |
Definition at line 112 of file itkRegistrationParameterScalesEstimator.h.
typedef Superclass::ScalesType itk::RegistrationParameterScalesEstimator< TMetric >::ScalesType |
Type of scales
Definition at line 65 of file itkRegistrationParameterScalesEstimator.h.
typedef RegistrationParameterScalesEstimator itk::RegistrationParameterScalesEstimator< TMetric >::Self |
Standard class typedefs.
Definition at line 59 of file itkRegistrationParameterScalesEstimator.h.
typedef OptimizerParameterScalesEstimatorTemplate<typename TMetric::ParametersValueType> itk::RegistrationParameterScalesEstimator< TMetric >::Superclass |
Definition at line 60 of file itkRegistrationParameterScalesEstimator.h.
typedef TMetric::VirtualImageConstPointer itk::RegistrationParameterScalesEstimator< TMetric >::VirtualImageConstPointer |
Definition at line 94 of file itkRegistrationParameterScalesEstimator.h.
typedef TMetric::VirtualImagePointer itk::RegistrationParameterScalesEstimator< TMetric >::VirtualImagePointer |
Definition at line 95 of file itkRegistrationParameterScalesEstimator.h.
typedef TMetric::VirtualImageType itk::RegistrationParameterScalesEstimator< TMetric >::VirtualImageType |
Definition at line 93 of file itkRegistrationParameterScalesEstimator.h.
typedef TMetric::VirtualIndexType itk::RegistrationParameterScalesEstimator< TMetric >::VirtualIndexType |
Definition at line 100 of file itkRegistrationParameterScalesEstimator.h.
typedef TMetric::VirtualPointSetPointer itk::RegistrationParameterScalesEstimator< TMetric >::VirtualPointSetPointer |
Definition at line 103 of file itkRegistrationParameterScalesEstimator.h.
typedef TMetric::VirtualPointSetType itk::RegistrationParameterScalesEstimator< TMetric >::VirtualPointSetType |
Definition at line 102 of file itkRegistrationParameterScalesEstimator.h.
typedef TMetric::VirtualPointType itk::RegistrationParameterScalesEstimator< TMetric >::VirtualPointType |
Definition at line 99 of file itkRegistrationParameterScalesEstimator.h.
typedef TMetric::VirtualRegionType itk::RegistrationParameterScalesEstimator< TMetric >::VirtualRegionType |
Definition at line 97 of file itkRegistrationParameterScalesEstimator.h.
typedef TMetric::VirtualSizeType itk::RegistrationParameterScalesEstimator< TMetric >::VirtualSizeType |
Definition at line 98 of file itkRegistrationParameterScalesEstimator.h.
typedef TMetric::VirtualSpacingType itk::RegistrationParameterScalesEstimator< TMetric >::VirtualSpacingType |
Definition at line 96 of file itkRegistrationParameterScalesEstimator.h.
enum itk::RegistrationParameterScalesEstimator::SamplingStrategyType |
The strategies to sample physical points in the virtual domain.
Enumerator | |
---|---|
FullDomainSampling | |
CornerSampling | |
RandomSampling | |
CentralRegionSampling | |
VirtualDomainPointSetSampling |
Definition at line 106 of file itkRegistrationParameterScalesEstimator.h.
|
protected |
|
inlineoverrideprotected |
Definition at line 160 of file itkRegistrationParameterScalesEstimator.h.
|
protected |
Check the metric and the transforms.
|
protected |
Check if the transform is a general affine transform that maps a line segment to a line segment.
|
protected |
The templated version of CheckGeneralAffineTransform to check if the transform is a general affine transform that maps a line segment to a line segment.
|
protected |
Compute the transform Jacobian at a physical point.
|
overridepure virtual |
Estimate the scales of local steps.
Implemented in itk::RegistrationParameterScalesFromJacobian< TMetric >, and itk::RegistrationParameterScalesFromShiftBase< TMetric >.
|
overridevirtual |
Estimate the trusted scale for steps. It returns the voxel spacing.
Implements itk::OptimizerParameterScalesEstimatorTemplate< TMetric::ParametersValueType >.
|
overridepure virtual |
Estimate parameter scales
Implemented in itk::RegistrationParameterScalesFromJacobian< TMetric >, and itk::RegistrationParameterScalesFromShiftBase< TMetric >.
|
overridepure virtual |
Estimate the step scale, the impact of a step on deformation.
Implemented in itk::RegistrationParameterScalesFromJacobian< TMetric >, and itk::RegistrationParameterScalesFromShiftBase< TMetric >.
|
protected |
Get the dimension of the target transformed to.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::OptimizerParameterScalesEstimatorTemplate< TMetric::ParametersValueType >.
Reimplemented in itk::RegistrationParameterScalesFromJacobian< TMetric >, itk::RegistrationParameterScalesFromShiftBase< TMetric >, itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.
|
protected |
Get the number of local parameters.
|
protectedvirtual |
Get the current sampling strategy. Note that this is changed internally as the class is used for scale or step estimation.
|
protected |
Get the transform in use.
|
virtual |
m_TransformForward specifies which transform scales to be estimated. m_TransformForward = true (default) for the moving transform parameters. m_TransformForward = false for the fixed transform parameters.
|
protected |
Get the central index of the virtual domain.
|
protected |
Get the central region of the virtual domain.
|
virtual |
Get/Set a point set for virtual domain sampling.
|
protected |
Check if the transform being optimized is a B-spline transform.
|
protected |
Check if the transform being optimized is a displacement field transform.
|
overrideprotectedvirtual |
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::OptimizerParameterScalesEstimatorTemplate< TMetric::ParametersValueType >.
Reimplemented in itk::RegistrationParameterScalesFromJacobian< TMetric >, itk::RegistrationParameterScalesFromShiftBase< TMetric >, itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.
|
protectedvirtual |
Sample the virtual domain and store the physical points in m_SamplePoints.
|
protected |
Sample the virtual domain with all pixels.
|
protected |
Sample the virtual domain randomly in a uniform distribution.
|
protected |
Sample the virtual domain with voxel in the central region.
|
protected |
Sample the virtual domain with corners.
|
protected |
Sample the virtual domain with a point set
|
protected |
Sample the virtual domain with all voxels inside a region.
|
virtual |
the radius of the central region for sampling.
|
virtual |
SetMetric sets the metric used in the estimation process. The transforms from the metric will be used for estimation, along with the images when appropriate.
|
protectedvirtual |
Set and get the number of samples.
|
protectedvirtual |
Set the sampling strategy. This is called from SetScalesSamplingStrategy() and SetStepScaleSamplingStrategy().
|
virtual |
Set the sampling strategy automatically for scales estimation.
|
virtual |
Set the sampling strategy automatically for step scale estimation.
|
virtual |
m_TransformForward specifies which transform scales to be estimated. m_TransformForward = true (default) for the moving transform parameters. m_TransformForward = false for the fixed transform parameters.
|
virtual |
Get/Set a point set for virtual domain sampling.
|
virtual |
Get/Set a point set for virtual domain sampling.
|
protected |
Check if the transform being optimized has local support.
|
protected |
Transform a physical point to a new physical point.
|
protected |
Transform a point to its continuous index.
|
protected |
Update the transform with a change in parameters.
|
static |
dimension accessors
Definition at line 88 of file itkRegistrationParameterScalesEstimator.h.
|
protected |
the radius of the central region for sampling
Definition at line 261 of file itkRegistrationParameterScalesEstimator.h.
|
protected |
the metric object
Definition at line 249 of file itkRegistrationParameterScalesEstimator.h.
|
protected |
the number of samples in the virtual domain
Definition at line 258 of file itkRegistrationParameterScalesEstimator.h.
|
protected |
the samples in the virtual domain
Definition at line 252 of file itkRegistrationParameterScalesEstimator.h.
|
private |
Definition at line 278 of file itkRegistrationParameterScalesEstimator.h.
|
mutableprotected |
Keep track of the last sampling time.
Definition at line 255 of file itkRegistrationParameterScalesEstimator.h.
|
private |
m_TransformForward specifies which transform scales to be estimated. m_TransformForward = true (default) for the moving transform parameters. m_TransformForward = false for the fixed transform parameters.
Definition at line 269 of file itkRegistrationParameterScalesEstimator.h.
|
protected |
Definition at line 263 of file itkRegistrationParameterScalesEstimator.h.
|
static |
dimension accessors
Definition at line 89 of file itkRegistrationParameterScalesEstimator.h.
|
staticprotected |
Definition at line 266 of file itkRegistrationParameterScalesEstimator.h.
|
static |
dimension accessors
Definition at line 90 of file itkRegistrationParameterScalesEstimator.h.