1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
/*=========================================================================
*
* Copyright UMC Utrecht and contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkComputeJacobianTerms_h
#define itkComputeJacobianTerms_h
#include "itkImageGridSampler.h"
#include "itkImageRandomSamplerBase.h"
#include "itkImageRandomCoordinateSampler.h"
#include "itkScaledSingleValuedNonLinearOptimizer.h"
namespace itk
{
/**\class ComputeJacobianTerms
* \brief This is a helper class for the automatic parameter estimation of the ASGD optimizer.
*
* More specifically this class computes the Jacobian terms related to the automatic
* parameter estimation for the adaptive stochastic gradient descent optimizer.
* Details can be found in the paper.
*/
template <typename TFixedImage, typename TTransform>
class ITK_TEMPLATE_EXPORT ComputeJacobianTerms : public Object
{
public:
ITK_DISALLOW_COPY_AND_MOVE(ComputeJacobianTerms);
/** Standard ITK.*/
using Self = ComputeJacobianTerms;
using Superclass = Object;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Run-time type information (and related methods). */
itkOverrideGetNameOfClassMacro(ComputeJacobianTerms);
/** typedef */
using TransformPointer = typename TTransform::Pointer;
using FixedImageRegionType = typename TFixedImage::RegionType;
/** Type for the mask of the fixed image. Only pixels that are "inside"
* this mask will be considered for the computation of the Jacobian terms.
*/
itkStaticConstMacro(FixedImageDimension, unsigned int, TFixedImage::ImageDimension);
using FixedImageMaskType = ImageMaskSpatialObject<Self::FixedImageDimension>;
using FixedImageMaskPointer = typename FixedImageMaskType::Pointer;
using FixedImageMaskConstPointer = typename FixedImageMaskType::ConstPointer;
using ScalesType = ScaledSingleValuedNonLinearOptimizer::ScalesType;
/** Set the fixed image. */
itkSetConstObjectMacro(FixedImage, TFixedImage);
/** Set the transform. */
itkSetObjectMacro(Transform, TTransform);
/** Set/Get the fixed image mask. */
itkSetObjectMacro(FixedImageMask, FixedImageMaskType);
itkSetConstObjectMacro(FixedImageMask, FixedImageMaskType);
itkGetConstObjectMacro(FixedImageMask, FixedImageMaskType);
/** Set some parameters. */
itkSetMacro(Scales, ScalesType);
itkSetMacro(UseScales, bool);
itkSetMacro(MaxBandCovSize, unsigned int);
itkSetMacro(NumberOfBandStructureSamples, unsigned int);
itkSetMacro(NumberOfJacobianMeasurements, SizeValueType);
/** Set the region over which the metric will be computed. */
void
SetFixedImageRegion(const FixedImageRegionType & region)
{
m_FixedImageRegion = region;
}
/** Get the region over which the metric will be computed. */
itkGetConstReferenceMacro(FixedImageRegion, FixedImageRegionType);
/** The terms returned by `Compute()`. */
struct Terms
{
double TrC;
double TrCC;
double maxJJ;
double maxJCJ;
};
/** The main functions that performs the computation. */
Terms
Compute() const;
protected:
ComputeJacobianTerms() = default;
~ComputeJacobianTerms() override = default;
using ImageSampleType = ImageSample<TFixedImage>;
/** Sample the fixed image to compute the Jacobian terms. */
// \todo: note that this is an exact copy of itk::ComputeDisplacementDistribution
// in the future it would be better to refactoring this part of the code.
std::vector<ImageSampleType>
SampleFixedImageForJacobianTerms() const;
private:
typename TFixedImage::ConstPointer m_FixedImage{ nullptr };
FixedImageRegionType m_FixedImageRegion{};
FixedImageMaskConstPointer m_FixedImageMask{ nullptr };
TransformPointer m_Transform{ nullptr };
ScalesType m_Scales{};
bool m_UseScales{ false };
unsigned int m_MaxBandCovSize{ 0 };
unsigned int m_NumberOfBandStructureSamples{ 0 };
SizeValueType m_NumberOfJacobianMeasurements{ 0 };
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkComputeJacobianTerms.hxx"
#endif
#endif // end #ifndef itkComputeJacobianTerms_h
|
