itkConstraint.h

Go to the documentation of this file.

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

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

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

#ifndef itkConstraint_h
#define itkConstraint_h

#include <itkObject.h>
#include <itkObjectFactory.h>

#include <itkSingleValuedCostFunction.h>

namespace itk
{
  
class ITK_EXPORT Constraint : 
    public Object
{
public:
  typedef Constraint                               Self;
  typedef Object                                   Superclass;
  typedef SmartPointer<Self>                       Pointer;
  typedef SmartPointer<const Self>                 ConstPointer;
  typedef SingleValuedCostFunction::MeasureType    MeasureType;
  typedef SingleValuedCostFunction::DerivativeType DerivativeType;
  typedef SingleValuedCostFunction::ParametersType ParametersType;
  
  itkTypeMacro( Constraint, Object );

  virtual MeasureType EvaluateConstraint(const ParametersType & parameters) = 0;
  
  virtual void EvaluateDerivative(const ParametersType & parameters, DerivativeType & derivative ) const = 0;
  
protected:
  
  Constraint() {};
  virtual ~Constraint() {};

private:  
  
  Constraint(const Self&);          // purposely not implemented
  void operator=(const Self&);      // purposely not implemented
};

} // end namespace itk

#endif