ITK  5.2.0
Insight Toolkit
itkRegistrationParameterScalesFromJacobian.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
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 itkRegistrationParameterScalesFromJacobian_h
19 #define itkRegistrationParameterScalesFromJacobian_h
20 
22 
23 namespace itk
24 {
25 
41 template <typename TMetric>
43 {
44 public:
45  ITK_DISALLOW_COPY_AND_ASSIGN(RegistrationParameterScalesFromJacobian);
46 
52 
54  itkNewMacro(Self);
55 
58 
60  using ScalesType = typename Superclass::ScalesType;
61 
63  using ParametersType = typename Superclass::ParametersType;
64 
66  using FloatType = typename Superclass::FloatType;
67 
68  using VirtualPointType = typename Superclass::VirtualPointType;
69  using VirtualIndexType = typename Superclass::VirtualIndexType;
70  using MovingTransformType = typename Superclass::MovingTransformType;
71  using FixedTransformType = typename Superclass::FixedTransformType;
72  using JacobianType = typename Superclass::JacobianType;
73  using VirtualImageConstPointer = typename Superclass::VirtualImageConstPointer;
74 
76  void
77  EstimateScales(ScalesType & scales) override;
78 
96  FloatType
97  EstimateStepScale(const ParametersType & step) override;
98 
100  void
101  EstimateLocalStepScales(const ParametersType & step, ScalesType & localStepScales) override;
102 
103 protected:
105  ~RegistrationParameterScalesFromJacobian() override = default;
106 
107  void
108  PrintSelf(std::ostream & os, Indent indent) const override;
109 
114  void
115  ComputeSampleStepScales(const ParametersType & step, ScalesType & sampleScales);
116 }; // class RegistrationParameterScalesFromJacobian
117 
118 
119 } // namespace itk
120 
121 
122 #ifndef ITK_MANUAL_INSTANTIATION
123 # include "itkRegistrationParameterScalesFromJacobian.hxx"
124 #endif
125 
126 #endif /* itkRegistrationParameterScalesFromJacobian_h */
itk::RegistrationParameterScalesEstimator::ParametersType
typename Superclass::ParametersType ParametersType
Definition: itkRegistrationParameterScalesEstimator.h:99
itk::RegistrationParameterScalesEstimator::FloatType
typename Superclass::FloatType FloatType
Definition: itkRegistrationParameterScalesEstimator.h:102
itk::RegistrationParameterScalesEstimator
Implements a registration helper class for estimating scales of transform parameters and step sizes.
Definition: itkRegistrationParameterScalesEstimator.h:80
itk::RegistrationParameterScalesEstimator::ScalesType
typename Superclass::ScalesType ScalesType
Definition: itkRegistrationParameterScalesEstimator.h:96
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::RegistrationParameterScalesEstimator::JacobianType
typename TMetric::JacobianType JacobianType
Definition: itkRegistrationParameterScalesEstimator.h:148
itk::RegistrationParameterScalesEstimator::VirtualPointType
typename TMetric::VirtualPointType VirtualPointType
Definition: itkRegistrationParameterScalesEstimator.h:126
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itk::RegistrationParameterScalesEstimator::MovingTransformType
typename MetricType::MovingTransformType MovingTransformType
Definition: itkRegistrationParameterScalesEstimator.h:112
itk::RegistrationParameterScalesEstimator::FixedTransformType
typename MetricType::FixedTransformType FixedTransformType
Definition: itkRegistrationParameterScalesEstimator.h:109
itk::RegistrationParameterScalesFromJacobian
Implements a registration helper class for estimating scales of transform parameters from Jacobian no...
Definition: itkRegistrationParameterScalesFromJacobian.h:42
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::RegistrationParameterScalesEstimator::VirtualIndexType
typename TMetric::VirtualIndexType VirtualIndexType
Definition: itkRegistrationParameterScalesEstimator.h:127
itkRegistrationParameterScalesEstimator.h
itk::RegistrationParameterScalesEstimator::VirtualImageConstPointer
typename TMetric::VirtualImageConstPointer VirtualImageConstPointer
Definition: itkRegistrationParameterScalesEstimator.h:121