itkPSMCostFunction.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 applicabcle 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 __itkPSMCostFunction_h
#define __itkPSMCostFunction_h

#include "itkLightObject.h"
#include "itkObjectFactory.h"
#include "itkWeakPointer.h"
#include "itkPSMParticleSystem.h"
#include "vnl/vnl_vector_fixed.h"

namespace itk
{

template <unsigned int VDimension>
class PSMCostFunction : public LightObject
{
public:
  typedef PSMCostFunction Self;
  typedef SmartPointer<Self>  Pointer;
  typedef SmartPointer<const Self>  ConstPointer;
  typedef LightObject Superclass;
  itkTypeMacro( PSMCostFunction, LightObject);

  typedef PSMParticleSystem<VDimension> ParticleSystemType;

  typedef vnl_vector_fixed<double, VDimension> VectorType;

  //  itkNewMacro(Self);
  
  itkStaticConstMacro(Dimension, unsigned int, VDimension);

  virtual VectorType Evaluate(unsigned int , unsigned int, const ParticleSystemType *,
                              double &maxtimestep) const = 0;
  virtual VectorType Evaluate(unsigned int , unsigned int, const ParticleSystemType *,
                              double &maxtimestep, double &energy) const = 0;
  virtual double Energy(unsigned int, unsigned int, const ParticleSystemType *) const = 0;


  virtual void ResetBuffers() { }
  
  virtual void AfterIteration() { }

  virtual void BeforeIteration()  {}

  virtual void BeforeEvaluate(unsigned int , unsigned int, const ParticleSystemType *) {}
  
  virtual void SetParticleSystem( ParticleSystemType *p)
  {    m_ParticleSystem = p;  }
  virtual ParticleSystemType *GetParticleSystem() const
  { return m_ParticleSystem; }
  virtual void SetDomainNumber( unsigned int i)
  {    m_DomainNumber = i;  }
  virtual int GetDomainNumber() const
  { return m_DomainNumber; }

protected:
  PSMCostFunction() : m_ParticleSystem(0), m_DomainNumber(0) {}
  virtual ~PSMCostFunction() {}
  void operator=(const PSMCostFunction &);
  PSMCostFunction(const PSMCostFunction &);

  ParticleSystemType *m_ParticleSystem;
  unsigned int m_DomainNumber;  
};

} //end namespace

#endif