/usr/include/ITK-4.9/itkConvergenceMonitoringFunction.h is in libinsighttoolkit4-dev 4.9.0-4ubuntu1.
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 | /*=========================================================================
*
* 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 itkConvergenceMonitoringFunction_h
#define itkConvergenceMonitoringFunction_h
#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkNumericTraits.h"
#include <deque>
namespace itk
{
namespace Function
{
/**
* \class ConvergenceMonitoringFunction
* \brief Abstract base class which monitors convergence during the course of optimization.
*
*
* \author Nick Tustison
* \author Brian Avants
*
* \ingroup ITKOptimizersv4
*/
template<typename TScalar, typename TEnergyValue>
class ConvergenceMonitoringFunction
: public Object
{
public:
typedef ConvergenceMonitoringFunction Self;
typedef Object Superclass;
typedef SmartPointer<Self> Pointer;
typedef SmartPointer<const Self> ConstPointer;
/** Run-time type information (and related methods). */
itkTypeMacro( ConvergenceMonitoringFunction, Object );
typedef TScalar ScalarType;
typedef typename NumericTraits<ScalarType>::RealType RealType;
typedef TEnergyValue EnergyValueType;
typedef std::deque<EnergyValueType> EnergyValueContainerType;
typedef typename EnergyValueContainerType::size_type EnergyValueContainerSizeType;
typedef typename EnergyValueContainerType::iterator EnergyValueIterator;
typedef typename EnergyValueContainerType::const_iterator EnergyValueConstIterator;
/* Add energy value to the end of the profile. */
virtual void AddEnergyValue( const EnergyValueType value )
{
itkDebugMacro( "Adding energy value " << value );
this->m_EnergyValues.push_back( value );
this->Modified();
}
/* Get the current number of energy values. */
EnergyValueContainerSizeType GetNumberOfEnergyValues() const
{
return this->m_EnergyValues.size();
}
/** Clear all the energy values. */
virtual void ClearEnergyValues()
{
if( this->GetNumberOfEnergyValues() > 0 )
{
itkDebugMacro( "Clearing energy values." );
this->m_EnergyValues.clear();
this->Modified();
}
}
/** Derived classes are responsible for defining the convergence value calculation */
virtual RealType GetConvergenceValue() const = 0;
protected:
ConvergenceMonitoringFunction()
{
this->m_EnergyValues.clear();
}
~ConvergenceMonitoringFunction() {}
virtual void PrintSelf( std::ostream & os, Indent indent ) const ITK_OVERRIDE
{
Superclass::PrintSelf( os, indent );
os << std::endl << "Energy values: " << std::flush;
EnergyValueConstIterator it = this->m_EnergyValues.begin();
while( it != this->m_EnergyValues.end() )
{
os << "(" << it - this->m_EnergyValues.begin() << "): " << *it << " ";
++it;
}
os << std::endl;
}
EnergyValueContainerType m_EnergyValues;
private:
ConvergenceMonitoringFunction(const Self &) ITK_DELETE_FUNCTION;
void operator=(const Self &) ITK_DELETE_FUNCTION;
};
} // end namespace function
} // end namespace itk
#endif
|