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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
/*=========================================================================
*
* Code adapted from itkCommandIterationUpdatev4.h
*
* Copyright NumFOCUS
*
* 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
*
* https://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 antsCommandIterationUpdate_h
#define antsCommandIterationUpdate_h
#include "itkCommand.h"
#include "itkWeakPointer.h"
namespace ants
{
/**
* \class CommandIterationUpdate
* \brief Implementation of the Command Pattern to be invoked every iteration
* \ingroup ITKOptimizersv4
*/
template <typename TOptimizer>
class antsCommandIterationUpdate : public itk::Command
{
public:
/**
* Standard "Self" typedef.
*/
using Self = antsCommandIterationUpdate;
/**
* Standard "Superclass" typedef.
*/
using Superclass = itk::Command;
/**
* Smart pointer type alias support
*/
using Pointer = itk::SmartPointer<Self>;
/**
* ConstSmart pointer type alias support
*/
using ConstPointer = itk::SmartPointer<const Self>;
/**
* Execute method will print data at each iteration
*/
void
Execute(itk::Object * caller, const itk::EventObject & event) override
{
Execute((const itk::Object *)caller, event);
}
void
Execute(const itk::Object *, const itk::EventObject & event) override
{
if (typeid(event) == typeid(itk::StartEvent))
{
this->SetTotalNumberOfIterations(static_cast<unsigned int>(m_Optimizer->GetNumberOfIterations()));
if (m_IterationUpdateInterval == 0)
{
if (m_TotalNumberOfIterations > 10)
{
m_IterationUpdateInterval = m_TotalNumberOfIterations / 10;
}
else
{
m_IterationUpdateInterval = 1;
}
}
std::cout << std::endl << "Iteration/Total,MetricValue";
if (m_PrintParameters)
{
std::cout << ",Parameters";
}
std::cout << std::endl;
}
else if (typeid(event) == typeid(itk::IterationEvent))
{
// Count iterations from 1
const unsigned int printIter = (m_Optimizer->GetCurrentIteration() + 1);
if (printIter % m_IterationUpdateInterval == 0)
{
std::cout << printIter << "/" << m_TotalNumberOfIterations << ",";
std::cout << m_Optimizer->GetValue();
if (m_PrintParameters)
{
std::cout << "," << m_Optimizer->GetCurrentPosition();
}
std::cout << std::endl;
}
}
else if (typeid(event) == typeid(itk::EndEvent))
{
using MetricValuesListType = typename OptimizerType::MetricValuesListType;
using ParameterListSizeType = typename OptimizerType::ParameterListSizeType;
ParameterListSizeType bestIndex = m_Optimizer->GetBestParametersIndex();
MetricValuesListType metricValues = m_Optimizer->GetMetricValuesList();
std::cout << std::endl << "Optimization complete. Best metric value: " << metricValues[bestIndex];
std::cout << std::endl;
}
}
/**
* Run-time type information (and related methods).
*/
itkTypeMacro(antsCommandIterationUpdate, itk::Command);
/**
* Method for creation through the object factory.
*/
itkNewMacro(Self);
/**
* Type defining the optimizer
*/
using OptimizerType = TOptimizer;
/**
* Set Optimizer
*/
void
SetOptimizer(OptimizerType * optimizer)
{
m_Optimizer = optimizer;
m_Optimizer->AddObserver(itk::IterationEvent(), this);
m_Optimizer->AddObserver(itk::StartEvent(), this);
m_Optimizer->AddObserver(itk::EndEvent(), this);
}
/**
* Print parameters at each iteration
*/
itkSetMacro(PrintParameters, bool);
itkGetMacro(PrintParameters, bool);
itkBooleanMacro(PrintParameters);
itkSetMacro(IterationUpdateInterval, unsigned int);
itkGetMacro(IterationUpdateInterval, unsigned int);
protected:
/**
* Constructor
*/
antsCommandIterationUpdate(){};
itkSetMacro(TotalNumberOfIterations, unsigned int);
itkGetMacro(TotalNumberOfIterations, unsigned int);
private:
/**
* WeakPointer to the Optimizer
*/
itk::WeakPointer<OptimizerType> m_Optimizer;
bool m_PrintParameters{ false };
unsigned int m_TotalNumberOfIterations{0};
unsigned int m_IterationUpdateInterval{0};
};
} // end namespace ants
#endif
|
