itkCommandIterationUpdate.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkCommandIterationUpdate_h
#define itkCommandIterationUpdate_h
 
#include "itkCommand.h"
#include "itkWeakPointer.h"
 
namespace itk
{

template <typename TOptimizer>
class CommandIterationUpdate : public Command
{
public:

  using Self = CommandIterationUpdate;
 

  using Superclass = itk::Command;
 

  using Pointer = itk::SmartPointer<Self>;

  using ConstPointer = itk::SmartPointer<const Self>;

  void
  Execute(itk::Object * caller, const itk::EventObject & event) override
  {
    Execute((const itk::Object *)caller, event);
  }
 
  void
  Execute(const itk::Object *, const itk::EventObject & event) override
  {
    if (typeid(event) == typeid(itk::StartEvent))
    {
      std::cout << std::endl << "Position              Value" << std::endl << std::endl;
    }
    else if (typeid(event) == typeid(itk::IterationEvent))
    {
      std::cout << m_Optimizer->GetCurrentIteration() << " = " << m_Optimizer->GetValue() << " : "
                << m_Optimizer->GetCurrentPosition() << std::endl;
    }
    else if (typeid(event) == typeid(itk::EndEvent))
    {
      std::cout << std::endl
                << std::endl
                << "After " << m_Optimizer->GetCurrentIteration() << "  iterations " << std::endl
                << "Solution is    = " << m_Optimizer->GetCurrentPosition() << std::endl
                << "With value     = " << m_Optimizer->GetValue() << std::endl
                << "Stop condition = " << m_Optimizer->GetStopCondition() << std::endl;
    }
  }
 

  itkOverrideGetNameOfClassMacro(CommandIterationUpdate);
 

  itkNewMacro(Self);
 

  using OptimizerType = TOptimizer;
 

  void
  SetOptimizer(OptimizerType * optimizer)
  {
    m_Optimizer = optimizer;
    m_Optimizer->AddObserver(itk::IterationEvent(), this);
  }

 
protected:
  CommandIterationUpdate() = default;
 
private:
  WeakPointer<OptimizerType> m_Optimizer{};
};
 
} // end namespace itk
 
#endif