itkWindowConvergenceMonitoringFunction.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  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 __itkWindowConvergenceMonitoringFunction_h
#define __itkWindowConvergenceMonitoringFunction_h

#include "itkConvergenceMonitoringFunction.h"

namespace itk
{
namespace Function
{
template<class TScalar = double>
class WindowConvergenceMonitoringFunction
: public ConvergenceMonitoringFunction<TScalar, TScalar>
{
public:

  typedef WindowConvergenceMonitoringFunction                     Self;
  typedef ConvergenceMonitoringFunction<TScalar, TScalar>         Superclass;
  typedef SmartPointer<Self>                                      Pointer;
  typedef SmartPointer<const Self>                                ConstPointer;

  itkNewMacro( Self );

  itkTypeMacro( WindowConvergenceMonitoringFunction, ConvergenceMonitoringFunction );

  typedef TScalar                                            ScalarType;
  typedef typename NumericTraits<ScalarType>::RealType       RealType;

  typedef typename Superclass::EnergyValueType               EnergyValueType;
  typedef typename Superclass::EnergyValueContainerType      EnergyValueContainerType;
  typedef typename Superclass::EnergyValueContainerSizeType  EnergyValueContainerSizeType;
  typedef typename EnergyValueContainerType::iterator        EnergyValueIterator;
  typedef typename EnergyValueContainerType::const_iterator  EnergyValueConstIterator;

  virtual void AddEnergyValue( const EnergyValueType );

  /* Clear energy values and set total energy to 0 */
  virtual void ClearEnergyValues();

  itkSetMacro( WindowSize, EnergyValueContainerSizeType );
  itkGetConstMacro( WindowSize, EnergyValueContainerSizeType );

  virtual RealType GetConvergenceValue() const;

protected:
  WindowConvergenceMonitoringFunction();

  ~WindowConvergenceMonitoringFunction();

  void PrintSelf( std::ostream & os, Indent indent ) const;

private:
  WindowConvergenceMonitoringFunction( const Self & ); //purposely not implemented
  void operator=( const Self & );  //purposely not implemented

  EnergyValueContainerSizeType                   m_WindowSize;

  RealType                                       m_TotalEnergy;

};
} // end namespace function
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkWindowConvergenceMonitoringFunction.hxx"
#endif

#endif