![]() |
ITK
5.3.0
Insight Toolkit
|
#include <itkRegistrationParameterScalesEstimator.h>
Public Types | |
using | ConstPointer = SmartPointer< const Self > |
using | FixedTransformConstPointer = typename FixedTransformType::ConstPointer |
using | FixedTransformType = typename MetricType::FixedTransformType |
using | JacobianType = typename TMetric::JacobianType |
using | MetricConstPointer = typename MetricType::ConstPointer |
using | MetricPointer = typename MetricType::Pointer |
using | MetricType = TMetric |
using | MovingTransformConstPointer = typename MovingTransformType::ConstPointer |
using | MovingTransformType = typename MetricType::MovingTransformType |
using | Pointer = SmartPointer< Self > |
using | SamplePointContainerType = std::vector< VirtualPointType > |
using | SamplingStrategyType = SamplingStrategyEnum |
using | Self = RegistrationParameterScalesEstimator |
using | Superclass = OptimizerParameterScalesEstimatorTemplate< typename TMetric::ParametersValueType > |
using | VirtualImageConstPointer = typename TMetric::VirtualImageConstPointer |
using | VirtualImagePointer = typename TMetric::VirtualImagePointer |
using | VirtualImageType = typename TMetric::VirtualImageType |
using | VirtualIndexType = typename TMetric::VirtualIndexType |
using | VirtualPointSetPointer = typename TMetric::VirtualPointSetPointer |
using | VirtualPointSetType = typename TMetric::VirtualPointSetType |
using | VirtualPointType = typename TMetric::VirtualPointType |
using | VirtualRegionType = typename TMetric::VirtualRegionType |
using | VirtualSizeType = typename TMetric::VirtualSizeType |
using | VirtualSpacingType = typename TMetric::VirtualSpacingType |
![]() | |
using | ConstPointer = SmartPointer< const Self > |
using | FloatType = TMetric::ParametersValueType |
using | ParametersType = OptimizerParameters< TMetric::ParametersValueType > |
using | Pointer = SmartPointer< Self > |
using | ScalesType = OptimizerParameters< TMetric::ParametersValueType > |
using | Self = OptimizerParameterScalesEstimatorTemplate |
using | Superclass = Object |
![]() | |
using | ConstPointer = SmartPointer< const Self > |
using | Pointer = SmartPointer< Self > |
using | Self = Object |
using | Superclass = LightObject |
![]() | |
using | ConstPointer = SmartPointer< const Self > |
using | Pointer = SmartPointer< Self > |
using | Self = LightObject |
Public Member Functions | |
void | EstimateLocalStepScales (const ParametersType &step, ScalesType &localStepScales) override=0 |
FloatType | EstimateMaximumStepSize () override |
void | EstimateScales (ScalesType &scales) override=0 |
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 |
![]() | |
unsigned long | AddObserver (const EventObject &event, Command *) |
unsigned long | AddObserver (const EventObject &event, Command *) const |
unsigned long | AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const |
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 |
void | Register () const override |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) |
void | SetDebug (bool debugFlag) const |
void | SetReferenceCount (int) override |
void | UnRegister () const noexcept override |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
void | SetMetaDataDictionary (MetaDataDictionary &&rrhs) |
virtual void | SetObjectName (std::string _arg) |
virtual const std::string & | GetObjectName () const |
![]() | |
Pointer | Clone () const |
virtual void | Delete () |
virtual int | GetReferenceCount () const |
void | Print (std::ostream &os, Indent indent=0) const |
Static Public Attributes | |
static constexpr SizeValueType | FixedDimension = TMetric::FixedDimension |
static constexpr SizeValueType | MovingDimension = TMetric::MovingDimension |
static constexpr 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 |
![]() | |
std::atomic< int > | m_ReferenceCount |
Static Protected Attributes | |
static constexpr 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 val) |
![]() | |
static void | BreakOnError () |
static Pointer | New () |
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 80 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::ConstPointer = SmartPointer<const Self> |
Definition at line 90 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::FixedTransformConstPointer = typename FixedTransformType::ConstPointer |
Definition at line 110 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::FixedTransformType = typename MetricType::FixedTransformType |
Type of the transform to initialize
Definition at line 109 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::JacobianType = typename TMetric::JacobianType |
Type of Jacobian of transform.
Definition at line 148 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::MetricConstPointer = typename MetricType::ConstPointer |
Definition at line 106 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::MetricPointer = typename MetricType::Pointer |
Definition at line 105 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::MetricType = TMetric |
Definition at line 104 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::MovingTransformConstPointer = typename MovingTransformType::ConstPointer |
Definition at line 113 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::MovingTransformType = typename MetricType::MovingTransformType |
Definition at line 112 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::Pointer = SmartPointer<Self> |
Definition at line 89 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::SamplePointContainerType = std::vector<VirtualPointType> |
Definition at line 145 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::SamplingStrategyType = SamplingStrategyEnum |
Enables backwards compatibility for enum values
Definition at line 133 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::Self = RegistrationParameterScalesEstimator |
Standard class type aliases.
Definition at line 87 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::Superclass = OptimizerParameterScalesEstimatorTemplate<typename TMetric::ParametersValueType> |
Definition at line 88 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::VirtualImageConstPointer = typename TMetric::VirtualImageConstPointer |
Definition at line 121 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::VirtualImagePointer = typename TMetric::VirtualImagePointer |
Definition at line 122 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::VirtualImageType = typename TMetric::VirtualImageType |
Definition at line 120 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::VirtualIndexType = typename TMetric::VirtualIndexType |
Definition at line 127 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::VirtualPointSetPointer = typename TMetric::VirtualPointSetPointer |
Definition at line 130 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::VirtualPointSetType = typename TMetric::VirtualPointSetType |
Definition at line 129 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::VirtualPointType = typename TMetric::VirtualPointType |
Definition at line 126 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::VirtualRegionType = typename TMetric::VirtualRegionType |
Definition at line 124 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::VirtualSizeType = typename TMetric::VirtualSizeType |
Definition at line 125 of file itkRegistrationParameterScalesEstimator.h.
using itk::RegistrationParameterScalesEstimator< TMetric >::VirtualSpacingType = typename TMetric::VirtualSpacingType |
Definition at line 123 of file itkRegistrationParameterScalesEstimator.h.
|
protected |
|
overrideprotecteddefault |
|
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.
Implements itk::OptimizerParameterScalesEstimatorTemplate< TMetric::ParametersValueType >.
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
Implements itk::OptimizerParameterScalesEstimatorTemplate< TMetric::ParametersValueType >.
Implemented in itk::RegistrationParameterScalesFromJacobian< TMetric >, and itk::RegistrationParameterScalesFromShiftBase< TMetric >.
|
overridepure virtual |
Estimate the step scale, the impact of a step on deformation.
Implements itk::OptimizerParameterScalesEstimatorTemplate< TMetric::ParametersValueType >.
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::Object.
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.
|
staticconstexpr |
dimension accessors
Definition at line 116 of file itkRegistrationParameterScalesEstimator.h.
|
protected |
the radius of the central region for sampling
Definition at line 326 of file itkRegistrationParameterScalesEstimator.h.
|
protected |
the metric object
Definition at line 314 of file itkRegistrationParameterScalesEstimator.h.
|
protected |
the number of samples in the virtual domain
Definition at line 323 of file itkRegistrationParameterScalesEstimator.h.
|
protected |
the samples in the virtual domain
Definition at line 317 of file itkRegistrationParameterScalesEstimator.h.
|
private |
Definition at line 341 of file itkRegistrationParameterScalesEstimator.h.
|
mutableprotected |
Keep track of the last sampling time.
Definition at line 320 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 338 of file itkRegistrationParameterScalesEstimator.h.
|
protected |
Definition at line 328 of file itkRegistrationParameterScalesEstimator.h.
|
staticconstexpr |
Definition at line 117 of file itkRegistrationParameterScalesEstimator.h.
|
staticconstexprprotected |
Definition at line 331 of file itkRegistrationParameterScalesEstimator.h.
|
staticconstexpr |
Definition at line 118 of file itkRegistrationParameterScalesEstimator.h.