itkClampImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkClampImageFilter_h
#define itkClampImageFilter_h
 
#include "itkUnaryFunctorImageFilter.h"
 
namespace itk
{
 
namespace Functor
{

template <typename TInput, typename TOutput = TInput>
class ITK_TEMPLATE_EXPORT Clamp
{
public:
  using Self = Clamp;
 
  using InputType = TInput;
  using OutputType = TOutput;

  Clamp();
 
  ~Clamp() = default;
 
  OutputType
  GetLowerBound() const;
  OutputType
  GetUpperBound() const;

  void
  SetBounds(const OutputType lowerBound, const OutputType upperBound);
 
  bool
  operator==(const Self & other) const;
 
  ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(Self);
 
  OutputType
  operator()(const InputType & A) const;
 
  itkConceptMacro(InputConvertibleToOutputCheck, (Concept::Convertible<InputType, OutputType>));
  itkConceptMacro(InputConvertibleToDoubleCheck, (Concept::Convertible<InputType, double>));
  itkConceptMacro(DoubleLessThanComparableToOutputCheck, (Concept::LessThanComparable<double, OutputType>));
  itkConceptMacro(DoubleGreaterThanComparableToOutputCheck, (Concept::GreaterThanComparable<double, OutputType>));
 
private:
  OutputType m_LowerBound;
  OutputType m_UpperBound;
};
 
 
template <typename TInput, typename TOutput>
inline auto
Clamp<TInput, TOutput>::operator()(const InputType & A) const -> OutputType
{
  const auto dA = static_cast<double>(A);
 
  if (dA < m_LowerBound)
  {
    return m_LowerBound;
  }
 
  if (dA > m_UpperBound)
  {
    return m_UpperBound;
  }
 
  return static_cast<OutputType>(A);
}
 
} // end namespace Functor
 

template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT ClampImageFilter
  : public UnaryFunctorImageFilter<TInputImage,
                                   TOutputImage,
                                   Functor::Clamp<typename TInputImage::PixelType, typename TOutputImage::PixelType>>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ClampImageFilter);

  using Self = ClampImageFilter;
  using Superclass =
    UnaryFunctorImageFilter<TInputImage,
                            TOutputImage,
                            Functor::Clamp<typename TInputImage::PixelType, typename TOutputImage::PixelType>>;
 
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using InputPixelType = typename TInputImage::PixelType;
  using OutputPixelType = typename TOutputImage::PixelType;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ClampImageFilter);
 
  OutputPixelType
  GetLowerBound() const;
  OutputPixelType
  GetUpperBound() const;

  void
  SetBounds(const OutputPixelType lowerBound, const OutputPixelType upperBound);
 
protected:
  ClampImageFilter() = default;
  ~ClampImageFilter() override = default;
 
  void
  GenerateData() override;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkClampImageFilter.hxx"
#endif
 
#endif