ITK  4.13.0
Insight Segmentation and Registration Toolkit
itkRegistrationParameterScalesFromShiftBase.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright Insight Software Consortium
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef itkRegistrationParameterScalesFromShiftBase_h
19 #define itkRegistrationParameterScalesFromShiftBase_h
20 
22 
23 namespace itk
24 {
25 
42 template < typename TMetric >
43 class ITK_TEMPLATE_EXPORT RegistrationParameterScalesFromShiftBase :
44  public RegistrationParameterScalesEstimator< TMetric >
45 {
46 public:
52 
55 
57  typedef typename Superclass::ScalesType ScalesType;
58 
60  typedef typename Superclass::ParametersType ParametersType;
62 
64  typedef typename Superclass::FloatType FloatType;
65 
66  typedef typename Superclass::VirtualPointType VirtualPointType;
67  typedef typename Superclass::VirtualIndexType VirtualIndexType;
68  typedef typename Superclass::MovingTransformType MovingTransformType;
69  typedef typename Superclass::FixedTransformType FixedTransformType;
70  typedef typename Superclass::JacobianType JacobianType;
71  typedef typename Superclass::VirtualImageConstPointer VirtualImageConstPointer;
72 
74  virtual void EstimateScales(ScalesType &scales) ITK_OVERRIDE;
75 
77  virtual FloatType EstimateStepScale(const ParametersType &step) ITK_OVERRIDE;
78 
80  virtual void EstimateLocalStepScales(const ParametersType &step,
81  ScalesType &localStepScales) ITK_OVERRIDE;
82 
84  itkSetMacro( SmallParameterVariation, ParametersValueType );
85  itkGetConstMacro( SmallParameterVariation, ParametersValueType );
87 
88 protected:
91 
92  virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
93 
96  virtual FloatType ComputeMaximumVoxelShift(const ParametersType &deltaParameters);
97 
100  virtual void ComputeSampleShifts(const ParametersType &deltaParameters, ScalesType &localShifts) = 0;
101 
102 private:
103  ITK_DISALLOW_COPY_AND_ASSIGN(RegistrationParameterScalesFromShiftBase);
104 
105  //A small variation of parameters
107 
108 }; //class RegistrationParameterScalesFromShiftBase
109 
110 
111 } // namespace itk
112 
113 
114 #ifndef ITK_MANUAL_INSTANTIATION
115 #include "itkRegistrationParameterScalesFromShiftBase.hxx"
116 #endif
117 
118 #endif /* itkRegistrationParameterScalesFromShiftBase_h */
Registration helper base class for estimating scales of transform parameters from the maximum voxel s...
RegistrationParameterScalesEstimator< TMetric > Superclass
Implements a registration helper class for estimating scales of transform parameters and step sizes...
TParametersValueType ValueType
Control indentation during Print() invocation.
Definition: itkIndent.h:49