itkBinaryThresholdImageFilter.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 itkBinaryThresholdImageFilter_h
#define itkBinaryThresholdImageFilter_h
 
#include "itkUnaryFunctorImageFilter.h"
#include "itkConceptChecking.h"
#include "itkSimpleDataObjectDecorator.h"
 
namespace itk
{
namespace Functor
{
template <typename TInput, typename TOutput>
class ITK_TEMPLATE_EXPORT BinaryThreshold
{
public:
  BinaryThreshold()
    : m_LowerThreshold(NumericTraits<TInput>::NonpositiveMin())
    , m_UpperThreshold(NumericTraits<TInput>::max())
    , m_InsideValue(NumericTraits<TOutput>::max())
    , m_OutsideValue(TOutput{})
  {}
 
  ~BinaryThreshold() = default;
 
  void
  SetLowerThreshold(const TInput & thresh)
  {
    m_LowerThreshold = thresh;
  }
  void
  SetUpperThreshold(const TInput & thresh)
  {
    m_UpperThreshold = thresh;
  }
  void
  SetInsideValue(const TOutput & value)
  {
    m_InsideValue = value;
  }
  void
  SetOutsideValue(const TOutput & value)
  {
    m_OutsideValue = value;
  }
 
 
  bool
  operator==(const BinaryThreshold & other) const
  {
    return m_LowerThreshold == other.m_LowerThreshold && m_UpperThreshold == other.m_UpperThreshold &&
           Math::ExactlyEquals(m_InsideValue, other.m_InsideValue) &&
           Math::ExactlyEquals(m_OutsideValue, other.m_OutsideValue);
  }
 
  ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(BinaryThreshold);
 
  inline TOutput
  operator()(const TInput & A) const
  {
    if (m_LowerThreshold <= A && A <= m_UpperThreshold)
    {
      return m_InsideValue;
    }
    return m_OutsideValue;
  }
 
private:
  TInput  m_LowerThreshold;
  TInput  m_UpperThreshold;
  TOutput m_InsideValue;
  TOutput m_OutsideValue;
};
} // namespace Functor
 
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT BinaryThresholdImageFilter
  : public UnaryFunctorImageFilter<
      TInputImage,
      TOutputImage,
      Functor::BinaryThreshold<typename TInputImage::PixelType, typename TOutputImage::PixelType>>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(BinaryThresholdImageFilter);

  using Self = BinaryThresholdImageFilter;
  using Superclass = UnaryFunctorImageFilter<
    TInputImage,
    TOutputImage,
    Functor::BinaryThreshold<typename TInputImage::PixelType, typename TOutputImage::PixelType>>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(BinaryThresholdImageFilter);

  using InputPixelType = typename TInputImage::PixelType;
  using OutputPixelType = typename TOutputImage::PixelType;

  using InputPixelObjectType = SimpleDataObjectDecorator<InputPixelType>;

  itkSetMacro(OutsideValue, OutputPixelType);

  itkGetConstReferenceMacro(OutsideValue, OutputPixelType);

  itkSetMacro(InsideValue, OutputPixelType);

  itkGetConstReferenceMacro(InsideValue, OutputPixelType);

  virtual void
  SetUpperThreshold(const InputPixelType threshold);
 
  virtual void
  SetUpperThresholdInput(const InputPixelObjectType *);
 
  virtual void
  SetLowerThreshold(const InputPixelType threshold);
 
  virtual void
  SetLowerThresholdInput(const InputPixelObjectType *);

  virtual InputPixelType
  GetUpperThreshold() const;
 
  virtual InputPixelObjectType *
  GetUpperThresholdInput();
 
  virtual const InputPixelObjectType *
  GetUpperThresholdInput() const;
 
  virtual InputPixelType
  GetLowerThreshold() const;
 
  virtual InputPixelObjectType *
  GetLowerThresholdInput();
 
  virtual const InputPixelObjectType *
  GetLowerThresholdInput() const;
 
  itkConceptMacro(OutputEqualityComparableCheck, (Concept::EqualityComparable<OutputPixelType>));
  itkConceptMacro(InputPixelTypeComparable, (Concept::Comparable<InputPixelType>));
  itkConceptMacro(InputOStreamWritableCheck, (Concept::OStreamWritable<InputPixelType>));
  itkConceptMacro(OutputOStreamWritableCheck, (Concept::OStreamWritable<OutputPixelType>));
 
protected:
  BinaryThresholdImageFilter();
  ~BinaryThresholdImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  BeforeThreadedGenerateData() override;
 
private:
  OutputPixelType m_InsideValue{};
  OutputPixelType m_OutsideValue{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkBinaryThresholdImageFilter.hxx"
#endif
 
#endif