ITK  4.9.0
Insight Segmentation and Registration Toolkit
itkWindowConvergenceMonitoringFunction.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright Insight Software Consortium
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef itkWindowConvergenceMonitoringFunction_h
19 #define itkWindowConvergenceMonitoringFunction_h
20 
22 
23 namespace itk
24 {
25 namespace Function
26 {
38 template<typename TScalar = double>
40 : public ConvergenceMonitoringFunction<TScalar, TScalar>
41 {
42 public:
43 
48 
50  itkNewMacro( Self );
51 
54 
55  typedef TScalar ScalarType;
57 
61  typedef typename EnergyValueContainerType::iterator EnergyValueIterator;
62  typedef typename EnergyValueContainerType::const_iterator EnergyValueConstIterator;
63 
65  virtual void AddEnergyValue( const EnergyValueType ) ITK_OVERRIDE;
66 
67  /* Clear energy values and set total energy to 0 */
68  virtual void ClearEnergyValues() ITK_OVERRIDE;
69 
71  itkSetMacro( WindowSize, EnergyValueContainerSizeType );
72  itkGetConstMacro( WindowSize, EnergyValueContainerSizeType );
74 
76  virtual RealType GetConvergenceValue() const ITK_OVERRIDE;
77 
78 protected:
80 
81  ~WindowConvergenceMonitoringFunction();
82 
83  void PrintSelf( std::ostream & os, Indent indent ) const ITK_OVERRIDE;
84 
85 private:
86  WindowConvergenceMonitoringFunction( const Self & ) ITK_DELETE_FUNCTION;
87  void operator=( const Self & ) ITK_DELETE_FUNCTION;
88 
89  EnergyValueContainerSizeType m_WindowSize;
90 
92 
93 };
94 } // end namespace function
95 } // end namespace itk
96 
97 #ifndef ITK_MANUAL_INSTANTIATION
98 #include "itkWindowConvergenceMonitoringFunction.hxx"
99 #endif
100 
101 #endif
Light weight base class for most itk classes.
Abstract base class which monitors convergence during the course of optimization. ...
ConvergenceMonitoringFunction< TScalar, TScalar > Superclass
virtual void AddEnergyValue(const EnergyValueType) override
Class which monitors convergence during the course of optimization.
void PrintSelf(std::ostream &os, Indent indent) const override
virtual RealType GetConvergenceValue() const override
Control indentation during Print() invocation.
Definition: itkIndent.h:49
Define additional traits for native types such as int or float.