itkPSMGradientDescentOptimizer.h

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

#include <vector>
#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkWeakPointer.h"
#include "vnl/vnl_vector_fixed.h"
#include "itkPSMParticleSystem.h"
#include "itkPSMCostFunction.h"
#include "itkPSMImageDomainWithGradients.h"

namespace itk
{

template <class TGradientNumericType, unsigned int VDimension>
class PSMGradientDescentOptimizer : public Object
{
public:
  typedef PSMGradientDescentOptimizer Self;
  typedef Object Superclass;
  typedef SmartPointer<Self>  Pointer;
  typedef SmartPointer<const Self>  ConstPointer;
  typedef WeakPointer<const Self>  ConstWeakPointer;

  itkNewMacro(Self);

  typedef PSMImageDomainWithGradients<TGradientNumericType, VDimension> DomainType;
  
  itkTypeMacro(PSMGradientDescentOptimizer, Object);

  itkStaticConstMacro(Dimension, unsigned int, VDimension);

  typedef PSMParticleSystem<VDimension> ParticleSystemType;

  typedef PSMCostFunction<VDimension> CostFunctionType;
  
  typedef typename CostFunctionType::VectorType VectorType;

  typedef typename ParticleSystemType::PointType PointType;

  void StartOptimization()
  {
    if (m_OptimizationMode == 0) { this->StartJacobiOptimization(); }
    else { this->StartGaussSeidelOptimization(); }
  }
  void StartJacobiOptimization();
  void StartGaussSeidelOptimization();

  void SetModeToGaussSeidel() { this->m_OptimizationMode = 1; }
  void SetModeToJacobi() { this->m_OptimizationMode = 0; }
  
  inline void StopOptimization()
  {    this->m_StopOptimization = true;  }

  itkGetMacro(NumberOfIterations, unsigned int);
  itkSetMacro(NumberOfIterations, unsigned int);

  itkGetMacro(TimeStep, double);
  itkSetMacro(TimeStep, double);

  itkGetMacro(MaximumNumberOfIterations, unsigned int);
  itkSetMacro(MaximumNumberOfIterations, unsigned int);

  itkGetMacro(Tolerance, double);
  itkSetMacro(Tolerance, double);
  
  itkGetObjectMacro(ParticleSystem, ParticleSystemType);
  itkSetObjectMacro(ParticleSystem, ParticleSystemType);

  itkGetObjectMacro(CostFunction, CostFunctionType);
  itkSetObjectMacro(CostFunction, CostFunctionType);
  
protected:
  PSMGradientDescentOptimizer();
  PSMGradientDescentOptimizer(const PSMGradientDescentOptimizer &);
  const PSMGradientDescentOptimizer &operator=(const PSMGradientDescentOptimizer &);
  void PrintSelf(std::ostream& os, Indent indent) const
  {
    Superclass::PrintSelf(os, indent);
  }
  virtual ~PSMGradientDescentOptimizer() {};

private:
  typename ParticleSystemType::Pointer m_ParticleSystem;
  typename CostFunctionType::Pointer m_CostFunction;
  bool m_StopOptimization;
  unsigned int m_NumberOfIterations;
  unsigned int m_MaximumNumberOfIterations;
  double m_Tolerance;
  double m_TimeStep;
  int m_OptimizationMode;

  std::vector< std::vector<double> > m_TimeSteps;
};

} // end namespace

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

#endif