itkOtsuMultipleThresholdsCalculator.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 itkOtsuMultipleThresholdsCalculator_h
#define itkOtsuMultipleThresholdsCalculator_h
 
#include "itkHistogramAlgorithmBase.h"
#include "itkHistogram.h"
 
namespace itk
{
 
template <typename TInputHistogram>
class ITK_TEMPLATE_EXPORT OtsuMultipleThresholdsCalculator : public HistogramAlgorithmBase<TInputHistogram>
{
public:
  using Self = OtsuMultipleThresholdsCalculator;
  using Superclass = HistogramAlgorithmBase<TInputHistogram>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using MeasurementType = typename TInputHistogram::MeasurementType;
  using FrequencyType = typename TInputHistogram::AbsoluteFrequencyType;
 
  using MeanType = typename NumericTraits<MeasurementType>::RealType;
  using VarianceType = typename NumericTraits<MeasurementType>::RealType;
  using WeightType = typename NumericTraits<MeasurementType>::RealType;
 
  using MeanVectorType = std::vector<MeanType>;
  using FrequencyVectorType = std::vector<FrequencyType>;
  using WeightVectorType = std::vector<WeightType>;
 
  using InstanceIdentifierType = typename TInputHistogram::InstanceIdentifier;
  using InstanceIdentifierVectorType = std::vector<InstanceIdentifierType>;

  itkOverrideGetNameOfClassMacro(OtsuMultipleThresholdsCalculator);
  itkNewMacro(Self);
  using OutputType = std::vector<MeasurementType>;

  const OutputType &
  GetOutput();

  itkSetClampMacro(NumberOfThresholds, SizeValueType, 1, NumericTraits<SizeValueType>::max());
  itkGetConstMacro(NumberOfThresholds, SizeValueType);
  void
  Compute() override;

  itkSetMacro(ValleyEmphasis, bool);
  itkGetConstReferenceMacro(ValleyEmphasis, bool);
  itkBooleanMacro(ValleyEmphasis);
  itkSetMacro(ReturnBinMidpoint, bool);
  itkGetConstReferenceMacro(ReturnBinMidpoint, bool);
  itkBooleanMacro(ReturnBinMidpoint);
 
protected:
  OtsuMultipleThresholdsCalculator();
  ~OtsuMultipleThresholdsCalculator() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  bool
  IncrementThresholds(InstanceIdentifierVectorType & thresholdIndexes,
                      MeanType                       globalMean,
                      MeanVectorType &               classMean,
                      FrequencyVectorType &          classFrequency);
 
private:
  SizeValueType m_NumberOfThresholds{ 1 };
  OutputType    m_Output{};
  bool          m_ValleyEmphasis{ false };
  bool          m_ReturnBinMidpoint{ false };
};
} // end of namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkOtsuMultipleThresholdsCalculator.hxx"
#endif
 
#endif