sitkOtsuThresholdImageFilter.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
*
*         http://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 sitkOtsuThresholdImageFilter_h
#define sitkOtsuThresholdImageFilter_h
 
/*
 * WARNING: DO NOT EDIT THIS FILE!
 * THIS FILE IS AUTOMATICALLY GENERATED BY THE SIMPLEITK BUILD PROCESS.
 * Please look at sitkImageFilterTemplate.h.jinja to make changes.
 */
 
#include <memory>
 
#include "sitkBasicFilters.h"
#include "sitkImageFilter.h"
#include "sitkProcessObjectDeleter.h"
 
namespace itk::simple {

class SITKBasicFilters_EXPORT OtsuThresholdImageFilter : public ImageFilter {
public:
  using Self = OtsuThresholdImageFilter;

  virtual ~OtsuThresholdImageFilter();

  OtsuThresholdImageFilter();

  using PixelIDTypeList = BasicPixelIDTypeList;
 
 
 

  void
  SetInsideValue(uint8_t InsideValue )
    { this->m_InsideValue = InsideValue; }

  uint8_t
  GetInsideValue() const { return this->m_InsideValue; }
 

  void
  SetOutsideValue(uint8_t OutsideValue )
    { this->m_OutsideValue = OutsideValue; }

  uint8_t
  GetOutsideValue() const { return this->m_OutsideValue; }
 

  void
  SetNumberOfHistogramBins(uint32_t NumberOfHistogramBins )
    { this->m_NumberOfHistogramBins = NumberOfHistogramBins; }

  uint32_t
  GetNumberOfHistogramBins() const { return this->m_NumberOfHistogramBins; }
 

  void
  SetMaskOutput(bool MaskOutput )
    { this->m_MaskOutput = MaskOutput; }

  void
  MaskOutputOn() { return this->SetMaskOutput(true); }
  void
  MaskOutputOff() { return this->SetMaskOutput(false); }
  bool
  GetMaskOutput() const { return this->m_MaskOutput; }
 

  void
  SetMaskValue(uint8_t MaskValue )
    { this->m_MaskValue = MaskValue; }

  uint8_t
  GetMaskValue() const { return this->m_MaskValue; }
 

  void
  SetReturnBinMidpoint(bool ReturnBinMidpoint )
    { this->m_ReturnBinMidpoint = ReturnBinMidpoint; }

  void
  ReturnBinMidpointOn() { return this->SetReturnBinMidpoint(true); }
  void
  ReturnBinMidpointOff() { return this->SetReturnBinMidpoint(false); }
  bool
  GetReturnBinMidpoint() const { return this->m_ReturnBinMidpoint; }
 

  double GetThreshold() const { return this->m_Threshold; }

  std::string GetName() const { return std::string("OtsuThresholdImageFilter"); }

  std::string ToString() const;
 

  Image Execute(const Image &image, const Image &maskImage);
  Image Execute(const Image &image);
 
 
private:
  using MemberFunctionType = Image (Self::*)(const Image *
    image, const Image *
    maskImage);
  template <class TImageType> Image ExecuteInternal(const Image *
    image, const Image *
    maskImage);
    friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
    static const detail::MemberFunctionFactory<MemberFunctionType> &GetMemberFunctionFactory();
 
 
    uint8_t m_InsideValue{ 1u };
 
    uint8_t m_OutsideValue{ 0u };
 
    uint32_t m_NumberOfHistogramBins{ 128u };
 
    bool m_MaskOutput{ true };
 
    uint8_t m_MaskValue{ 255u };
 
    bool m_ReturnBinMidpoint{ false };
 
 
 
    double m_Threshold{ 0.0 };
 
 
 
 
};
 

SITKBasicFilters_EXPORT Image OtsuThreshold(
    const Image &image, const Image &maskImage, uint8_t insideValue = 1u, uint8_t outsideValue = 0u, uint32_t numberOfHistogramBins = 128u, bool maskOutput = true, uint8_t maskValue = 255u, bool returnBinMidpoint = false
);
 
SITKBasicFilters_EXPORT Image OtsuThreshold(
    const Image &image, uint8_t insideValue = 1u, uint8_t outsideValue = 0u, uint32_t numberOfHistogramBins = 128u, bool maskOutput = true, uint8_t maskValue = 255u, bool returnBinMidpoint = false
);

 
}
#endif