freSetupParameterTraits.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: freSetupParameterTraits.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 __freSetupParameterTraits_h
#define __freSetupParameterTraits_h

#include "freElementals.h"
#include "freParameter.h"

#include "itkNumericTraits.h"

namespace FREE
{

class SetupParameterTraits
{
public:
        typedef Parameter::ParameterValueType ParameterType;

        virtual const char* GetNameOfClass() const { return "SetupParameterTraits"; };

        double InitialValue(void) const { return m_dInitialValue;};

  double UpperBound(void) const { return m_dUpperBound;};

  double LowerBound(void) const { return m_dLowerBound;};

  double Quantisation(void) const { return m_dQuantisation;};

        bool IsBoundedBelow(void) const { return m_bBoundedBelow; };

        bool IsBoundedAbove(void) const { return m_bBoundedAbove; };

        bool IsBounded(void) const { return m_bBoundedAbove || m_bBoundedBelow; };

        bool ValueIsValid (double dValue) const;

        ParameterType GetParameterType(void) const { return m_ParameterType; };

        SetupParameterTraits(double dInitialValue = 0.0, ParameterType parameterType = Parameter::PVTDouble,
                                   double dLowerBound = itk::NumericTraits< double >::NonpositiveMin(), bool bBoundedBelow = false,
                                   double dUpperBound = itk::NumericTraits< double >::max(), bool bBoundedAbove = false,
                                                                                         double dQuantisation = 0.0);

protected:
        bool m_bBoundedBelow;
        bool m_bBoundedAbove;
        double m_dInitialValue;
        double m_dUpperBound;
        double m_dLowerBound;
        double m_dQuantisation;
        ParameterType m_ParameterType;
};

}//End of Namespace free

#endif

---