itkLimiterFunctionBase.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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 applicable 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 __itkLimiterFunctionBase_h
#define __itkLimiterFunctionBase_h
 
#include "itkFunctionBase.h"
#include "itkMacro.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;
 
  OutputType Evaluate( const InputType & input ) const override = 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 ) {}
 
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() override{}
 
  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