/usr/include/ITK-4.5/itkGradientDescentOptimizerBasev4.h is in libinsighttoolkit4-dev 4.5.0-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*=========================================================================
*
* Copyright Insight Software Consortium
*
* 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 __itkGradientDescentOptimizerBasev4_h
#define __itkGradientDescentOptimizerBasev4_h
#include "itkObjectToObjectOptimizerBase.h"
#include "itkObjectToObjectOptimizerBase.h"
#include "itkThreadedIndexedContainerPartitioner.h"
#include "itkDomainThreader.h"
namespace itk
{
/** \class GradientDescentOptimizerBasev4
* \brief Abstract base class for gradient descent-style optimizers.
*
* Gradient modification is threaded in \c ModifyGradient.
*
* Derived classes must override \c ModifyGradientByScalesOverSubRange,
* \c ModifyGradientByLearningRateOverSubRange and \c ResumeOptimization.
*
* \ingroup ITKOptimizersv4
*/
template<typename TInternalComputationValueType>
class GradientDescentOptimizerBasev4Template
: public ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType>
{
public:
/** Standard class typedefs. */
typedef GradientDescentOptimizerBasev4Template Self;
typedef ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType> Superclass;
typedef SmartPointer< Self > Pointer;
typedef SmartPointer< const Self > ConstPointer;
/** Run-time type information (and related methods). */
itkTypeMacro(GradientDescentOptimizerBasev4Template, Superclass);
/** Codes of stopping conditions. */
typedef enum {
MAXIMUM_NUMBER_OF_ITERATIONS,
COSTFUNCTION_ERROR,
UPDATE_PARAMETERS_ERROR,
STEP_TOO_SMALL,
CONVERGENCE_CHECKER_PASSED,
OTHER_ERROR
} StopConditionType;
/** Stop condition return string type */
typedef std::string StopConditionReturnStringType;
/** Stop condition internal string type */
typedef std::ostringstream StopConditionDescriptionType;
/** It should be possible to derive the internal computation type from the class object. */
typedef TInternalComputationValueType InternalComputationValueType;
/** Metric type over which this class is templated */
typedef typename Superclass::MetricType MetricType;
typedef typename MetricType::Pointer MetricTypePointer;
/** Derivative type */
typedef typename MetricType::DerivativeType DerivativeType;
/** Measure type */
typedef typename Superclass::MeasureType MeasureType;
typedef typename Superclass::ScalesType ScalesType;
typedef typename Superclass::ParametersType ParametersType;
/** Get the most recent gradient values. */
itkGetConstReferenceMacro( Gradient, DerivativeType );
/** Get stop condition enum */
itkGetConstReferenceMacro(StopCondition, StopConditionType);
/** Set the number of iterations. */
itkSetMacro(NumberOfIterations, SizeValueType);
/** Get the number of iterations. */
itkGetConstReferenceMacro(NumberOfIterations, SizeValueType);
/** Get the current iteration number. */
itkGetConstMacro(CurrentIteration, SizeValueType);
/** Resume optimization.
* This runs the optimization loop, and allows continuation
* of stopped optimization */
virtual void ResumeOptimization() = 0;
/** Stop optimization. The object is left in a state so the
* optimization can be resumed by calling ResumeOptimization. */
virtual void StopOptimization(void);
/** Get the reason for termination */
virtual const StopConditionReturnStringType GetStopConditionDescription() const;
/** Modify the gradient in place, to advance the optimization.
* This call performs a threaded modification for transforms with
* local support (assumed to be dense). Otherwise the modification
* is performed w/out threading.
* See EstimateLearningRate() to perform optionaly learning rate
* estimation.
* At completion, m_Gradient can be used to update the transform
* parameters. Derived classes may hold additional results in
* other member variables.
*
* \sa EstimateLearningRate()
*/
virtual void ModifyGradientByScales();
virtual void ModifyGradientByLearningRate();
typedef ThreadedIndexedContainerPartitioner::IndexRangeType IndexRangeType;
/** Derived classes define this worker method to modify the gradient by scales.
* Modifications must be performed over the index range defined in
* \c subrange.
* Called from ModifyGradientByScales(), either directly or via threaded
* operation. */
virtual void ModifyGradientByScalesOverSubRange( const IndexRangeType& subrange ) = 0;
/** Derived classes define this worker method to modify the gradient by learning rates.
* Modifications must be performed over the index range defined in
* \c subrange.
* Called from ModifyGradientByLearningRate(), either directly or via threaded
* operation.
* This function is used in GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate
* and GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate classes.
*/
virtual void ModifyGradientByLearningRateOverSubRange( const IndexRangeType& subrange ) = 0;
protected:
/** Default constructor */
GradientDescentOptimizerBasev4Template();
virtual ~GradientDescentOptimizerBasev4Template();
typename DomainThreader<ThreadedIndexedContainerPartitioner, Self>::Pointer m_ModifyGradientByScalesThreader;
typename DomainThreader<ThreadedIndexedContainerPartitioner, Self>::Pointer m_ModifyGradientByLearningRateThreader;
/* Common variables for optimization control and reporting */
bool m_Stop;
StopConditionType m_StopCondition;
StopConditionDescriptionType m_StopConditionDescription;
SizeValueType m_NumberOfIterations;
SizeValueType m_CurrentIteration;
/** Current gradient */
DerivativeType m_Gradient;
virtual void PrintSelf(std::ostream & os, Indent indent) const;
private:
GradientDescentOptimizerBasev4Template( const Self & ); //purposely not implemented
void operator=( const Self& ); //purposely not implemented
};
/** This helps to meet backward compatibility */
typedef GradientDescentOptimizerBasev4Template<double> GradientDescentOptimizerBasev4;
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkGradientDescentOptimizerBasev4.hxx"
#endif
#endif
|