freConstrainedMetricInterface.h

Go to the documentation of this file.

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

  Program:   F.R.E.E. - flexible registration evaluation engine
  Version:   v.1.0.0
  Date:      $Date: 2006/09/01 12:00:00 $
  Module:    $RCSfile: freConstrainedMetricInterface.h,v $
  Language:  C++



  Copyright (c) 2007 Ralf o Floca (Department of Medical Informatics,
  Institute for Medical Biometry and Informatics, University of Heidelberg,
  Germany). All rights reserved.
  See FREECopyright.txt or http://www.mi.med.uni-hd.de/free/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 __freConstrainedMetricInterface_h
#define __freConstrainedMetricInterface_h

#include "freSetupOptimizationMetric.h"
#include "freIDPath.h"

#include "freSetupParameterConstraints.h"
#include "freControllerBase.h"

namespace FREE
{

class ITK_EXPORT ConstrainedMetricInterface
{
public:
  virtual const char *GetNameOfClass() const
        {return "ConstrainedMetricInterface";};

        void ResetConstraints();

        void AddConstraint(const SetupParameterConstraint& constraint, double dBarrierSize);

  void SetMaxConstraintPenalty (double dPenalty) { m_MaxConstraintPenalty = dPenalty;};
  double GetMaxConstraintPenalty () {return m_MaxConstraintPenalty;};

        virtual unsigned int GetNumberOfConstrainedValues(void) const {return m_Constraints.Size();};

  void SetFailureThreshold (double dThreshold) { m_FailureThreshold = dThreshold;};
  double GetFailureThreshold () {return m_FailureThreshold;};

protected:
  typedef  SetupOptimizationMetric::ParametersType           CnstrParametersType;
  typedef  SetupOptimizationMetric::DecomposedMeasureType    CnstrDecomposedMeasureType;

  ConstrainedMetricInterface();

  bool ComputeConstraintPenalties( const CnstrParametersType & parameters, CnstrDecomposedMeasureType & penalties ) const;
        
        double ComputeConstraintPenalty( const unsigned int iConstraintID,
                                                                                                                                         const CnstrParametersType & parameters ) const;

        SetupParameterConstraints m_Constraints;
        std::vector<double> m_BarrierSizes;

        double m_MaxConstraintPenalty;
        double m_FailureThreshold;
};

freControllerIDMacro(ConstrainedSetupOptimizationMetricControllerBase, "ConstrainedSetupOptimizationMetricBase");

} // end namespace FREE

#endif

---