ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | List of all members
itk::Function::WindowConvergenceMonitoringFunction< TScalar > Class Template Reference

#include <itkWindowConvergenceMonitoringFunction.h>

+ Inheritance diagram for itk::Function::WindowConvergenceMonitoringFunction< TScalar >:
+ Collaboration diagram for itk::Function::WindowConvergenceMonitoringFunction< TScalar >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using EnergyValueConstIterator = typename EnergyValueContainerType::const_iterator
 
using EnergyValueContainerSizeType = typename Superclass::EnergyValueContainerSizeType
 
using EnergyValueContainerType = typename Superclass::EnergyValueContainerType
 
using EnergyValueIterator = typename EnergyValueContainerType::iterator
 
using EnergyValueType = typename Superclass::EnergyValueType
 
using Pointer = SmartPointer< Self >
 
using RealType = typename NumericTraits< ScalarType >::RealType
 
using ScalarType = TScalar
 
using Self = WindowConvergenceMonitoringFunction
 
using Superclass = ConvergenceMonitoringFunction< TScalar, TScalar >
 
- Public Types inherited from itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >
using ConstPointer = SmartPointer< const Self >
 
using EnergyValueConstIterator = typename EnergyValueContainerType::const_iterator
 
using EnergyValueContainerSizeType = typename EnergyValueContainerType::size_type
 
using EnergyValueContainerType = std::deque< EnergyValueType >
 
using EnergyValueIterator = typename EnergyValueContainerType::iterator
 
using EnergyValueType = TScalar
 
using Pointer = SmartPointer< Self >
 
using RealType = typename NumericTraits< ScalarType >::RealType
 
using ScalarType = TScalar
 
using Self = ConvergenceMonitoringFunction
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

void AddEnergyValue (const EnergyValueType) override
 
void ClearEnergyValues () override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >
virtual void AddEnergyValue (const EnergyValueType value)
 
EnergyValueContainerSizeType GetNumberOfEnergyValues () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
EnergyValueContainerSizeType m_WindowSize
 
RealType m_TotalEnergy
 
virtual void SetWindowSize (EnergyValueContainerSizeType _arg)
 
virtual EnergyValueContainerSizeType GetWindowSize () const
 
RealType GetConvergenceValue () const override
 
 WindowConvergenceMonitoringFunction ()
 
 ~WindowConvergenceMonitoringFunction () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Protected Member Functions inherited from itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >
 ConvergenceMonitoringFunction ()
 
 ~ConvergenceMonitoringFunction () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 
- Protected Attributes inherited from itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >
EnergyValueContainerType m_EnergyValues
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TScalar = double>
class itk::Function::WindowConvergenceMonitoringFunction< TScalar >

Class which monitors convergence during the course of optimization.

Author
Nick Tustison
Brian Avants

Definition at line 39 of file itkWindowConvergenceMonitoringFunction.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TScalar = double>
using itk::Function::WindowConvergenceMonitoringFunction< TScalar >::ConstPointer = SmartPointer<const Self>

Definition at line 47 of file itkWindowConvergenceMonitoringFunction.h.

◆ EnergyValueConstIterator

template<typename TScalar = double>
using itk::Function::WindowConvergenceMonitoringFunction< TScalar >::EnergyValueConstIterator = typename EnergyValueContainerType::const_iterator

Definition at line 62 of file itkWindowConvergenceMonitoringFunction.h.

◆ EnergyValueContainerSizeType

template<typename TScalar = double>
using itk::Function::WindowConvergenceMonitoringFunction< TScalar >::EnergyValueContainerSizeType = typename Superclass::EnergyValueContainerSizeType

Definition at line 60 of file itkWindowConvergenceMonitoringFunction.h.

◆ EnergyValueContainerType

template<typename TScalar = double>
using itk::Function::WindowConvergenceMonitoringFunction< TScalar >::EnergyValueContainerType = typename Superclass::EnergyValueContainerType

Definition at line 59 of file itkWindowConvergenceMonitoringFunction.h.

◆ EnergyValueIterator

template<typename TScalar = double>
using itk::Function::WindowConvergenceMonitoringFunction< TScalar >::EnergyValueIterator = typename EnergyValueContainerType::iterator

Definition at line 61 of file itkWindowConvergenceMonitoringFunction.h.

◆ EnergyValueType

template<typename TScalar = double>
using itk::Function::WindowConvergenceMonitoringFunction< TScalar >::EnergyValueType = typename Superclass::EnergyValueType

Definition at line 58 of file itkWindowConvergenceMonitoringFunction.h.

◆ Pointer

template<typename TScalar = double>
using itk::Function::WindowConvergenceMonitoringFunction< TScalar >::Pointer = SmartPointer<Self>

Definition at line 46 of file itkWindowConvergenceMonitoringFunction.h.

◆ RealType

template<typename TScalar = double>
using itk::Function::WindowConvergenceMonitoringFunction< TScalar >::RealType = typename NumericTraits<ScalarType>::RealType

Definition at line 56 of file itkWindowConvergenceMonitoringFunction.h.

◆ ScalarType

template<typename TScalar = double>
using itk::Function::WindowConvergenceMonitoringFunction< TScalar >::ScalarType = TScalar

Definition at line 55 of file itkWindowConvergenceMonitoringFunction.h.

◆ Self

template<typename TScalar = double>
using itk::Function::WindowConvergenceMonitoringFunction< TScalar >::Self = WindowConvergenceMonitoringFunction

Definition at line 44 of file itkWindowConvergenceMonitoringFunction.h.

◆ Superclass

template<typename TScalar = double>
using itk::Function::WindowConvergenceMonitoringFunction< TScalar >::Superclass = ConvergenceMonitoringFunction<TScalar, TScalar>

Definition at line 45 of file itkWindowConvergenceMonitoringFunction.h.

Constructor & Destructor Documentation

◆ WindowConvergenceMonitoringFunction()

template<typename TScalar = double>
itk::Function::WindowConvergenceMonitoringFunction< TScalar >::WindowConvergenceMonitoringFunction ( )
protected

Set/Get window size over which the convergence value is calculated

◆ ~WindowConvergenceMonitoringFunction()

template<typename TScalar = double>
itk::Function::WindowConvergenceMonitoringFunction< TScalar >::~WindowConvergenceMonitoringFunction ( )
overrideprotecteddefault

Set/Get window size over which the convergence value is calculated

Member Function Documentation

◆ AddEnergyValue()

template<typename TScalar = double>
void itk::Function::WindowConvergenceMonitoringFunction< TScalar >::AddEnergyValue ( const  EnergyValueType)
override

Add energy value

◆ ClearEnergyValues()

template<typename TScalar = double>
void itk::Function::WindowConvergenceMonitoringFunction< TScalar >::ClearEnergyValues ( )
overridevirtual

Clear all the energy values.

Reimplemented from itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >.

◆ CreateAnother()

template<typename TScalar = double>
virtual::itk::LightObject::Pointer itk::Function::WindowConvergenceMonitoringFunction< TScalar >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

◆ GetConvergenceValue()

template<typename TScalar = double>
RealType itk::Function::WindowConvergenceMonitoringFunction< TScalar >::GetConvergenceValue ( ) const
overridevirtual

Calculate convergence value by fitting to a window of the enrgy profile

Implements itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >.

◆ GetNameOfClass()

template<typename TScalar = double>
virtual const char* itk::Function::WindowConvergenceMonitoringFunction< TScalar >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >.

◆ GetWindowSize()

template<typename TScalar = double>
virtual EnergyValueContainerSizeType itk::Function::WindowConvergenceMonitoringFunction< TScalar >::GetWindowSize ( ) const
virtual

Set/Get window size over which the convergence value is calculated

◆ New()

template<typename TScalar = double>
static Pointer itk::Function::WindowConvergenceMonitoringFunction< TScalar >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TScalar = double>
void itk::Function::WindowConvergenceMonitoringFunction< TScalar >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Set/Get window size over which the convergence value is calculated

Reimplemented from itk::Object.

◆ SetWindowSize()

template<typename TScalar = double>
virtual void itk::Function::WindowConvergenceMonitoringFunction< TScalar >::SetWindowSize ( EnergyValueContainerSizeType  _arg)
virtual

Set/Get window size over which the convergence value is calculated

Member Data Documentation

◆ m_TotalEnergy

template<typename TScalar = double>
RealType itk::Function::WindowConvergenceMonitoringFunction< TScalar >::m_TotalEnergy
private

Set/Get window size over which the convergence value is calculated

Definition at line 92 of file itkWindowConvergenceMonitoringFunction.h.

◆ m_WindowSize

template<typename TScalar = double>
EnergyValueContainerSizeType itk::Function::WindowConvergenceMonitoringFunction< TScalar >::m_WindowSize
private

Set/Get window size over which the convergence value is calculated

Definition at line 90 of file itkWindowConvergenceMonitoringFunction.h.


The documentation for this class was generated from the following file: