itkBinaryThresholdProjectionImageFilter.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 itkBinaryThresholdProjectionImageFilter_h
#define itkBinaryThresholdProjectionImageFilter_h
 
#include "itkProjectionImageFilter.h"
#include "itkConceptChecking.h"
 
namespace itk
{
 
namespace Function
{
template <typename TInputPixel, typename TOutputPixel>
class BinaryThresholdAccumulator
{
public:
  BinaryThresholdAccumulator(SizeValueType) {}
  ~BinaryThresholdAccumulator() = default;
 
  inline void
  Initialize()
  {
    m_IsForeground = false;
  }
 
  inline void
  operator()(const TInputPixel & input)
  {
    if (input >= m_ThresholdValue)
    {
      m_IsForeground = true;
    }
  }
 
  inline TOutputPixel
  GetValue()
  {
    if (m_IsForeground)
    {
      return m_ForegroundValue;
    }
 
    return m_BackgroundValue;
  }
 
  bool m_IsForeground;
 
  TInputPixel  m_ThresholdValue;
  TOutputPixel m_ForegroundValue;
  TOutputPixel m_BackgroundValue;
};
} // end namespace Function
 
template <typename TInputImage, typename TOutputImage>
class BinaryThresholdProjectionImageFilter
  : public ProjectionImageFilter<
      TInputImage,
      TOutputImage,
      Function::BinaryThresholdAccumulator<typename TInputImage::PixelType, typename TOutputImage::PixelType>>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(BinaryThresholdProjectionImageFilter);
 
  using Self = BinaryThresholdProjectionImageFilter;
  using Superclass = ProjectionImageFilter<
    TInputImage,
    TOutputImage,
    Function::BinaryThresholdAccumulator<typename TInputImage::PixelType, typename TOutputImage::PixelType>>;
 
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(BinaryThresholdProjectionImageFilter);

  itkNewMacro(Self);

  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;

  using InputPixelType = typename InputImageType::PixelType;
  using OutputPixelType = typename OutputImageType::PixelType;
 
  using typename Superclass::AccumulatorType;

  itkSetMacro(ForegroundValue, OutputPixelType);
  itkGetConstMacro(ForegroundValue, OutputPixelType);

  itkSetMacro(BackgroundValue, OutputPixelType);
  itkGetConstMacro(BackgroundValue, OutputPixelType);

  itkSetMacro(ThresholdValue, InputPixelType);
  itkGetConstMacro(ThresholdValue, InputPixelType);
 
  itkConceptMacro(InputPixelTypeGreaterThanComparable, (Concept::GreaterThanComparable<InputPixelType>));
  itkConceptMacro(InputHasNumericTraitsCheck, (Concept::HasNumericTraits<InputPixelType>));
 
protected:
  BinaryThresholdProjectionImageFilter()
  {
    m_ForegroundValue = NumericTraits<OutputPixelType>::max();
    m_BackgroundValue = NumericTraits<OutputPixelType>::NonpositiveMin();
    m_ThresholdValue = InputPixelType{};
  }
 
  ~BinaryThresholdProjectionImageFilter() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override
  {
    Superclass::PrintSelf(os, indent);
 
    using InputPixelPrintType = typename NumericTraits<InputPixelType>::PrintType;
 
    os << indent << "ForegroundValue: " << static_cast<InputPixelPrintType>(m_ForegroundValue) << std::endl;
 
    using OutputPixelPrintType = typename NumericTraits<OutputPixelType>::PrintType;
 
    os << indent << "BackgroundValue: " << static_cast<OutputPixelPrintType>(m_BackgroundValue) << std::endl;
 
    os << indent << "ThresholdValue: " << static_cast<InputPixelPrintType>(m_ThresholdValue) << std::endl;
  }
 
  AccumulatorType
  NewAccumulator(SizeValueType size) const override
  {
    AccumulatorType accumulator(size);
 
    accumulator.m_ForegroundValue = m_ForegroundValue;
    accumulator.m_BackgroundValue = m_BackgroundValue;
    accumulator.m_ThresholdValue = m_ThresholdValue;
    return accumulator;
  }

  OutputPixelType m_ForegroundValue{};

  OutputPixelType m_BackgroundValue{};

  InputPixelType m_ThresholdValue{};
}; // end BinaryThresholdProjectionImageFilter
} // end namespace itk
 
#endif