itkLimiterFunctionBase.h

Go to the documentation of this file.

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

  This file is part of the elastix software.

  Copyright (c) University Medical Center Utrecht. All rights reserved.
  See src/CopyrightElastix.txt or http://elastix.isi.uu.nl/legal.php 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 __itkLimiterFunctionBase_h
#define __itkLimiterFunctionBase_h

#include "itkFunctionBase.h"
#include "itkExceptionObject.h"

namespace itk
{

template< class TInput, unsigned int NDimension >
class LimiterFunctionBase :
  public FunctionBase< TInput, typename NumericTraits< TInput >::RealType >
{
public:

  typedef LimiterFunctionBase                                                Self;
  typedef FunctionBase< TInput, typename NumericTraits< TInput >::RealType > Superclass;
  typedef SmartPointer< Self >                                               Pointer;
  typedef SmartPointer< const Self >                                         ConstPointer;

  itkTypeMacro( LimiterFunctionBase, FunctionBase );

  itkStaticConstMacro( Dimension, unsigned int, NDimension );

  typedef typename Superclass::InputType  InputType;
  typedef typename Superclass::OutputType OutputType;

  typedef OutputType DerivativeValueType;
  typedef CovariantVector<
    DerivativeValueType,
    itkGetStaticConstMacro( Dimension ) >            DerivativeType;

  virtual OutputType Evaluate( const InputType & input ) const = 0;

  virtual OutputType Evaluate( const InputType & input, DerivativeType & derivative ) const = 0;

  itkSetMacro( UpperBound, OutputType );
  itkGetConstMacro( UpperBound, OutputType );

  itkSetMacro( LowerBound, OutputType );
  itkGetConstMacro( LowerBound, OutputType );

  itkSetMacro( UpperThreshold, InputType );
  itkGetConstMacro( UpperThreshold, InputType );

  itkSetMacro( LowerThreshold, InputType );
  itkGetConstMacro( LowerThreshold, InputType );

  virtual void Initialize( void ) throw ( ExceptionObject ) {}

protected:

  LimiterFunctionBase()
  {
    this->m_UpperBound
      = itk::NumericTraits< OutputType >::One
      + itk::NumericTraits< OutputType >::One;
    this->m_LowerBound     = itk::NumericTraits< OutputType >::Zero;
    this->m_UpperThreshold = itk::NumericTraits< InputType >::One;
    this->m_LowerThreshold = itk::NumericTraits< InputType >::One;
  }


  ~LimiterFunctionBase(){}

  OutputType m_UpperBound;
  OutputType m_LowerBound;
  InputType  m_UpperThreshold;
  InputType  m_LowerThreshold;

private:

  LimiterFunctionBase( const Self & ); // purposely not implemented
  void operator=( const Self & );      // purposely not implemented

};

} // end namespace itk

#endif