itkThresholdImageFilter.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.
 *
 *=========================================================================*/
/*=========================================================================
 *
 *  Portions of this file are subject to the VTK Toolkit Version 3 copyright.
 *
 *  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
 *
 *  For complete copyright, license and disclaimer of warranty information
 *  please refer to the NOTICE file at the top of the ITK source tree.
 *
 *=========================================================================*/
#ifndef itkThresholdImageFilter_h
#define itkThresholdImageFilter_h
 
#include "itkInPlaceImageFilter.h"
 
#include "itkConceptChecking.h"
 
namespace itk
{
template <typename TImage>
class ITK_TEMPLATE_EXPORT ThresholdImageFilter : public InPlaceImageFilter<TImage, TImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ThresholdImageFilter);

  using Self = ThresholdImageFilter;
  using Superclass = InPlaceImageFilter<TImage, TImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ThresholdImageFilter);

  using PixelType = typename TImage::PixelType;

  itkConceptMacro(PixelTypeComparableCheck, (Concept::Comparable<PixelType>));
  itkConceptMacro(PixelTypeOStreamWritableCheck, (Concept::OStreamWritable<PixelType>));

  itkSetMacro(OutsideValue, PixelType);

  itkGetConstMacro(OutsideValue, PixelType);

  void
  ThresholdAbove(const PixelType & threshold);

  void
  ThresholdBelow(const PixelType & threshold);

  void
  ThresholdOutside(const PixelType & lower, const PixelType & upper);

  itkSetMacro(Lower, PixelType);
  itkGetConstMacro(Lower, PixelType);

  itkSetMacro(Upper, PixelType);
  itkGetConstMacro(Upper, PixelType);

  using InputImageType = TImage;
  using InputImagePointer = typename InputImageType::ConstPointer;
  using InputImageRegionType = typename InputImageType::RegionType;
  using InputImagePixelType = typename InputImageType::PixelType;

  using OutputImageType = TImage;
  using OutputImagePointer = typename OutputImageType::Pointer;
  using OutputImageRegionType = typename OutputImageType::RegionType;
  using OutputImagePixelType = typename OutputImageType::PixelType;
 
protected:
  ThresholdImageFilter();
  ~ThresholdImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;
 
private:
  PixelType m_OutsideValue{};
  PixelType m_Lower{};
  PixelType m_Upper{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkThresholdImageFilter.hxx"
#endif
 
#endif