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 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
|
/*=========================================================================
*
* 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 elxFiniteDifferenceGradientDescent_hxx
#define elxFiniteDifferenceGradientDescent_hxx
#include "elxFiniteDifferenceGradientDescent.h"
#include <itkDeref.h>
#include <iomanip>
#include <string>
#include "math.h"
namespace elastix
{
/**
* ********************* Constructor ****************************
*/
template <class TElastix>
FiniteDifferenceGradientDescent<TElastix>::FiniteDifferenceGradientDescent()
{
this->m_ShowMetricValues = false;
} // end Constructor
/**
* ***************** BeforeRegistration ***********************
*/
template <class TElastix>
void
FiniteDifferenceGradientDescent<TElastix>::BeforeRegistration()
{
const Configuration & configuration = itk::Deref(Superclass2::GetConfiguration());
std::string showMetricValues("false");
configuration.ReadParameter(showMetricValues, "ShowMetricValues", 0);
if (showMetricValues == "false")
{
this->m_ShowMetricValues = false;
this->SetComputeCurrentValue(this->m_ShowMetricValues);
}
else
{
this->m_ShowMetricValues = true;
this->SetComputeCurrentValue(this->m_ShowMetricValues);
}
/** Add some target cells to IterationInfo.*/
this->AddTargetCellToIterationInfo("2:Metric");
this->AddTargetCellToIterationInfo("3:Gain a_k");
this->AddTargetCellToIterationInfo("4:||Gradient||");
/** Format them as floats */
this->GetIterationInfoAt("2:Metric") << std::showpoint << std::fixed;
this->GetIterationInfoAt("3:Gain a_k") << std::showpoint << std::fixed;
this->GetIterationInfoAt("4:||Gradient||") << std::showpoint << std::fixed;
} // end BeforeRegistration
/**
* ***************** BeforeEachResolution ***********************
*/
template <class TElastix>
void
FiniteDifferenceGradientDescent<TElastix>::BeforeEachResolution()
{
/** Get the current resolution level.*/
unsigned int level = static_cast<unsigned int>(this->m_Registration->GetAsITKBaseType()->GetCurrentLevel());
const Configuration & configuration = itk::Deref(Superclass2::GetConfiguration());
/** Set the maximumNumberOfIterations.*/
unsigned int maximumNumberOfIterations = 500;
configuration.ReadParameter(
maximumNumberOfIterations, "MaximumNumberOfIterations", this->GetComponentLabel(), level, 0);
this->SetNumberOfIterations(maximumNumberOfIterations);
/** \todo GuessParameters function */
double a = 400.0;
double c = 1.0;
double A = 50.0;
double alpha = 0.602;
double gamma = 0.101;
configuration.ReadParameter(a, "SP_a", this->GetComponentLabel(), level, 0);
configuration.ReadParameter(c, "SP_c", this->GetComponentLabel(), level, 0);
configuration.ReadParameter(A, "SP_A", this->GetComponentLabel(), level, 0);
configuration.ReadParameter(alpha, "SP_alpha", this->GetComponentLabel(), level, 0);
configuration.ReadParameter(gamma, "SP_gamma", this->GetComponentLabel(), level, 0);
this->SetParam_a(a);
this->SetParam_c(c);
this->SetParam_A(A);
this->SetParam_alpha(alpha);
this->SetParam_gamma(gamma);
} // end BeforeEachResolution
/**
* ***************** AfterEachIteration *************************
*/
template <class TElastix>
void
FiniteDifferenceGradientDescent<TElastix>::AfterEachIteration()
{
/** Print some information */
if (this->m_ShowMetricValues)
{
this->GetIterationInfoAt("2:Metric") << this->GetValue();
}
else
{
this->GetIterationInfoAt("2:Metric") << "---";
}
this->GetIterationInfoAt("3:Gain a_k") << this->GetLearningRate();
this->GetIterationInfoAt("4:||Gradient||") << this->GetGradientMagnitude();
/** Select new spatial samples for the computation of the metric
* \todo You may also choose to select new samples after evaluation
* of the metric value */
if (this->GetNewSamplesEveryIteration())
{
this->SelectNewSamples();
}
} // end AfterEachIteration
/**
* ***************** AfterEachResolution *************************
*/
template <class TElastix>
void
FiniteDifferenceGradientDescent<TElastix>::AfterEachResolution()
{
/**
* enum StopConditionType { MaximumNumberOfIterations, MetricError }
*/
std::string stopcondition;
switch (this->GetStopCondition())
{
case MaximumNumberOfIterations:
stopcondition = "Maximum number of iterations has been reached";
break;
case MetricError:
stopcondition = "Error in metric";
break;
default:
stopcondition = "Unknown";
break;
}
/** Print the stopping condition */
log::info(std::ostringstream{} << "Stopping condition: " << stopcondition << ".");
} // end AfterEachResolution
/**
* ******************* AfterRegistration ************************
*/
template <class TElastix>
void
FiniteDifferenceGradientDescent<TElastix>::AfterRegistration()
{
/** Print the best metric value */
double bestValue;
if (this->m_ShowMetricValues)
{
bestValue = this->GetValue();
log::info(std::ostringstream{} << '\n' << "Final metric value = " << bestValue);
}
else
{
log::info(std::ostringstream{}
<< '\n'
<< "Run Elastix again with the option \"ShowMetricValues\" set to \"true\", to see information about the "
"metric values. ");
}
} // end AfterRegistration
/**
* ******************* StartOptimization ***********************
*/
template <class TElastix>
void
FiniteDifferenceGradientDescent<TElastix>::StartOptimization()
{
/** Check if the entered scales are correct and != [ 1 1 1 ...] */
this->SetUseScales(false);
const ScalesType & scales = this->GetScales();
if (scales.GetSize() == this->GetInitialPosition().GetSize())
{
ScalesType unit_scales(scales.GetSize(), 1.0);
if (scales != unit_scales)
{
/** only then: */
this->SetUseScales(true);
}
}
this->Superclass1::StartOptimization();
} // end StartOptimization
} // end namespace elastix
#endif // end #ifndef elxFiniteDifferenceGradientDescent_hxx
|