itkIterateNeighborhoodOptimizer.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkIterateNeighborhoodOptimizer.h,v $
  Language:  C++
  Date:      $Date$
  Version:   $Revision$

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef itkIterateNeighborhoodOptimizer_h
#define itkIterateNeighborhoodOptimizer_h

#include "MinimalPathExtractionExport.h"

#include "itkArray.h"
#include "itkSingleValuedNonLinearOptimizer.h"

namespace itk
{

class MinimalPathExtraction_EXPORT IterateNeighborhoodOptimizer :
    public SingleValuedNonLinearOptimizer
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(IterateNeighborhoodOptimizer);

  using Self = IterateNeighborhoodOptimizer;
  using Superclass = SingleValuedNonLinearOptimizer;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro( Self );

  itkTypeMacro( IterateNeighborhoodOptimizer, SingleValuedNonLinearOptimizer );

  itkGetConstReferenceMacro( Maximize, bool );
  itkSetMacro( Maximize, bool );
  itkBooleanMacro( Maximize );
  bool GetMinimize( ) const
    { return !m_Maximize; }
  void SetMinimize(bool v)
    { this->SetMaximize(!v); }
  void MinimizeOn()
    { this->MaximizeOff(); }
  void MinimizeOff()
    { this->MaximizeOn(); }

  virtual void AdvanceOneStep( void );

  void StartOptimization( void ) override;

  void ResumeOptimization( void );

  void StopOptimization( void );

  itkSetMacro(FullyConnected, bool);
  itkGetConstReferenceMacro(FullyConnected, bool);
  itkBooleanMacro(FullyConnected);

  using NeighborhoodSizeType = Array<double>;
  itkSetMacro( NeighborhoodSize, NeighborhoodSizeType );
  itkGetConstReferenceMacro( NeighborhoodSize, NeighborhoodSizeType );

  itkGetConstMacro( CurrentIteration, unsigned int );

  itkGetConstReferenceMacro( CurrentValue, double );

protected:
  IterateNeighborhoodOptimizer();
  ~IterateNeighborhoodOptimizer() override {};
  void PrintSelf(std::ostream& os, Indent indent) const override;

private:
  bool                 m_Stop;
  bool                 m_Maximize;
  bool                 m_FullyConnected;
  double               m_CurrentValue;
  unsigned long        m_CurrentIteration;
  NeighborhoodSizeType m_NeighborhoodSize;

};

} // end namespace itk

#endif