ITK  5.1.0
Insight Toolkit
itkOtsuThresholdImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 
19 #ifndef itkOtsuThresholdImageFilter_h
20 #define itkOtsuThresholdImageFilter_h
21 
24 
25 namespace itk
26 {
27 
55 template <typename TInputImage, typename TOutputImage, typename TMaskImage = TOutputImage>
56 class OtsuThresholdImageFilter : public HistogramThresholdImageFilter<TInputImage, TOutputImage, TMaskImage>
57 {
58 public:
59  ITK_DISALLOW_COPY_AND_ASSIGN(OtsuThresholdImageFilter);
60 
66 
68  itkNewMacro(Self);
69 
72 
73  using InputImageType = TInputImage;
74  using OutputImageType = TOutputImage;
75  using MaskImageType = TMaskImage;
76 
78  using InputPixelType = typename InputImageType::PixelType;
79  using OutputPixelType = typename OutputImageType::PixelType;
80  using MaskPixelType = typename MaskImageType::PixelType;
81 
83  using InputImagePointer = typename InputImageType::Pointer;
84  using OutputImagePointer = typename OutputImageType::Pointer;
85 
95 
98 
100  static constexpr unsigned int InputImageDimension = InputImageType::ImageDimension;
101  static constexpr unsigned int OutputImageDimension = OutputImageType::ImageDimension;
102 
105  itkSetMacro(ReturnBinMidpoint, bool);
106  itkGetConstReferenceMacro(ReturnBinMidpoint, bool);
107  itkBooleanMacro(ReturnBinMidpoint);
109 
110 protected:
112  ~OtsuThresholdImageFilter() override = default;
113 
114  void
115  GenerateData() override
116  {
117  auto calc = static_cast<CalculatorType *>(this->GetModifiableCalculator());
118  calc->SetReturnBinMidpoint(m_ReturnBinMidpoint);
119  this->Superclass::GenerateData();
120  }
121 
122 private:
123 #if defined(ITKV4_COMPATIBILITY)
124  bool m_ReturnBinMidpoint{ true };
125 #else
126  bool m_ReturnBinMidpoint{ false };
127 #endif
128 };
129 
130 } // end namespace itk
131 
132 #endif
itk::HistogramThresholdImageFilter::InputIndexType
typename InputImageType::IndexType InputIndexType
Definition: itkHistogramThresholdImageFilter.h:94
itk::ImageSource::OutputImagePointer
typename OutputImageType::Pointer OutputImagePointer
Definition: itkImageSource.h:91
itk::HistogramThresholdImageFilter::HistogramType
Statistics::Histogram< ValueRealType > HistogramType
Definition: itkHistogramThresholdImageFilter.h:105
itk::HistogramThresholdImageFilter::InputPixelType
typename InputImageType::PixelType InputPixelType
Definition: itkHistogramThresholdImageFilter.h:84
itk::OtsuThresholdImageFilter::OutputImageDimension
static constexpr unsigned int OutputImageDimension
Definition: itkOtsuThresholdImageFilter.h:101
itk::HistogramThresholdImageFilter::MaskImageRegionType
typename MaskImageType::RegionType MaskImageRegionType
Definition: itkHistogramThresholdImageFilter.h:101
itk::HistogramThresholdImageFilter::MaskSizeType
typename MaskImageType::SizeType MaskSizeType
Definition: itkHistogramThresholdImageFilter.h:99
itk::GTest::TypedefsAndConstructors::Dimension2::SizeType
ImageBaseType::SizeType SizeType
Definition: itkGTestTypedefsAndConstructors.h:49
itk::HistogramThresholdImageFilter::OutputSizeType
typename OutputImageType::SizeType OutputSizeType
Definition: itkHistogramThresholdImageFilter.h:96
itk::HistogramThresholdImageFilter
Threshold an image using a HistogramThresholdCalculator.
Definition: itkHistogramThresholdImageFilter.h:62
itk::HistogramThresholdImageFilter::OutputPixelType
typename OutputImageType::PixelType OutputPixelType
Definition: itkHistogramThresholdImageFilter.h:85
itk::SmartPointer< Self >
itk::OtsuThresholdImageFilter
Threshold an image using the Otsu Threshold.
Definition: itkOtsuThresholdImageFilter.h:56
itk::HistogramThresholdImageFilter::OutputIndexType
typename OutputImageType::IndexType OutputIndexType
Definition: itkHistogramThresholdImageFilter.h:97
itk::GTest::TypedefsAndConstructors::Dimension2::IndexType
ImageBaseType::IndexType IndexType
Definition: itkGTestTypedefsAndConstructors.h:50
itk::ImageSource
Base class for all process objects that output image data.
Definition: itkImageSource.h:67
itkOtsuThresholdCalculator.h
itk::Statistics::Histogram
This class stores measurement vectors in the context of n-dimensional histogram.
Definition: itkHistogram.h:77
itk::HistogramThresholdImageFilter::GetModifiableCalculator
virtual CalculatorType * GetModifiableCalculator()
itk::ImageToImageFilter::InputImagePointer
typename InputImageType::Pointer InputImagePointer
Definition: itkImageToImageFilter.h:130
itk::OtsuThresholdCalculator
Computes the Otsu's threshold for an image.
Definition: itkOtsuThresholdCalculator.h:45
itk::GTest::TypedefsAndConstructors::Dimension2::RegionType
ImageBaseType::RegionType RegionType
Definition: itkGTestTypedefsAndConstructors.h:54
itk::OtsuThresholdImageFilter::InputImageDimension
static constexpr unsigned int InputImageDimension
Definition: itkOtsuThresholdImageFilter.h:100
itk::HistogramThresholdImageFilter::MaskPixelType
typename MaskImageType::PixelType MaskPixelType
Definition: itkHistogramThresholdImageFilter.h:86
itk::ImageToImageFilter::InputImageType
TInputImage InputImageType
Definition: itkImageToImageFilter.h:129
itk::HistogramThresholdImageFilter::InputSizeType
typename InputImageType::SizeType InputSizeType
Definition: itkHistogramThresholdImageFilter.h:93
itk::HistogramThresholdImageFilter::MaskImageType
TMaskImage MaskImageType
Definition: itkHistogramThresholdImageFilter.h:81
itk::OtsuThresholdImageFilter::OtsuThresholdImageFilter
OtsuThresholdImageFilter()
Definition: itkOtsuThresholdImageFilter.h:111
itk::HistogramThresholdCalculator
Base class to compute a threshold value based on the histogram of an image.
Definition: itkHistogramThresholdCalculator.h:47
itk::ImageSource::OutputImageRegionType
typename OutputImageType::RegionType OutputImageRegionType
Definition: itkImageSource.h:92
itk::HistogramThresholdImageFilter::SetCalculator
virtual void SetCalculator(CalculatorType *_arg)
itk::HistogramThresholdImageFilter::GenerateData
void GenerateData() override
itk::HistogramThresholdImageFilter::MaskIndexType
typename MaskImageType::IndexType MaskIndexType
Definition: itkHistogramThresholdImageFilter.h:100
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkArray.h:26
itk::OtsuThresholdCalculator::New
static Pointer New()
itk::ProcessObject
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Definition: itkProcessObject.h:135
itkHistogramThresholdImageFilter.h
itk::OtsuThresholdImageFilter::GenerateData
void GenerateData() override
Definition: itkOtsuThresholdImageFilter.h:115
itk::OtsuThresholdImageFilter::~OtsuThresholdImageFilter
~OtsuThresholdImageFilter() override=default
itk::OtsuThresholdImageFilter::m_ReturnBinMidpoint
bool m_ReturnBinMidpoint
Definition: itkOtsuThresholdImageFilter.h:126
itk::ImageToImageFilter::InputImageRegionType
typename InputImageType::RegionType InputImageRegionType
Definition: itkImageToImageFilter.h:132
itk::ImageSource::OutputImageType
TOutputImage OutputImageType
Definition: itkImageSource.h:90