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 ITK_TEMPLATE_EXPORT LimiterFunctionBase : public FunctionBase<TInput, typename NumericTraits<TInput>::RealType>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(LimiterFunctionBase);
 
  using Self = LimiterFunctionBase;
  using Superclass = FunctionBase<TInput, typename NumericTraits<TInput>::RealType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkTypeMacro(LimiterFunctionBase, FunctionBase);
 
  itkStaticConstMacro(Dimension, unsigned int, NDimension);
 
  using typename Superclass::InputType;
  using typename Superclass::OutputType;
 
  using DerivativeValueType = OutputType;
  using DerivativeType = CovariantVector<DerivativeValueType, Self::Dimension>;
 
  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()
  {}
 
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 = default;
 
  OutputType m_UpperBound;
  OutputType m_LowerBound;
  InputType  m_UpperThreshold;
  InputType  m_LowerThreshold;
};
 
} // end namespace itk
 
#endif