sitkN4BiasFieldCorrectionImageFilter.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 sitkN4BiasFieldCorrectionImageFilter_h
#define sitkN4BiasFieldCorrectionImageFilter_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 N4BiasFieldCorrectionImageFilter : public ImageFilter {
public:
  using Self = N4BiasFieldCorrectionImageFilter;

  virtual ~N4BiasFieldCorrectionImageFilter();

  N4BiasFieldCorrectionImageFilter();

  using PixelIDTypeList = RealPixelIDTypeList;
 
 
 

  void
  SetConvergenceThreshold(double ConvergenceThreshold )
    { this->m_ConvergenceThreshold = ConvergenceThreshold; }

  double
  GetConvergenceThreshold() const { return this->m_ConvergenceThreshold; }
 

  void
  SetMaximumNumberOfIterations(std::vector<uint32_t> MaximumNumberOfIterations )
    { this->m_MaximumNumberOfIterations = MaximumNumberOfIterations; }

  std::vector<uint32_t>
  GetMaximumNumberOfIterations() const { return this->m_MaximumNumberOfIterations; }
 

  void
  SetBiasFieldFullWidthAtHalfMaximum(double BiasFieldFullWidthAtHalfMaximum )
    { this->m_BiasFieldFullWidthAtHalfMaximum = BiasFieldFullWidthAtHalfMaximum; }

  double
  GetBiasFieldFullWidthAtHalfMaximum() const { return this->m_BiasFieldFullWidthAtHalfMaximum; }
 

  void
  SetWienerFilterNoise(double WienerFilterNoise )
    { this->m_WienerFilterNoise = WienerFilterNoise; }

  double
  GetWienerFilterNoise() const { return this->m_WienerFilterNoise; }
 

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

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

  void
  SetNumberOfControlPoints(std::vector<uint32_t> NumberOfControlPoints )
    { this->m_NumberOfControlPoints = std::move(NumberOfControlPoints); }

  void
  SetNumberOfControlPoints( uint32_t value ) { this->m_NumberOfControlPoints = std::vector<uint32_t>(3, value); }
  std::vector<uint32_t>
  GetNumberOfControlPoints() const { return this->m_NumberOfControlPoints; }
 

  void
  SetSplineOrder(uint32_t SplineOrder )
    { this->m_SplineOrder = SplineOrder; }

  uint32_t
  GetSplineOrder() const { return this->m_SplineOrder; }
 

  void
  SetUseMaskLabel(bool UseMaskLabel )
    { this->m_UseMaskLabel = UseMaskLabel; }

  void
  UseMaskLabelOn() { return this->SetUseMaskLabel(true); }
  void
  UseMaskLabelOff() { return this->SetUseMaskLabel(false); }
  bool
  GetUseMaskLabel() const { return this->m_UseMaskLabel; }
 

  void
  SetMaskLabel(uint8_t MaskLabel )
    { this->m_MaskLabel = MaskLabel; }

  uint8_t
  GetMaskLabel() const { return this->m_MaskLabel; }
 

  uint32_t GetCurrentLevel()const { return this->m_pfGetCurrentLevel(); }

  uint32_t GetElapsedIterations()const { return this->m_pfGetElapsedIterations(); }

  double GetCurrentConvergenceMeasurement()const { return this->m_pfGetCurrentConvergenceMeasurement(); }

  Image GetLogBiasFieldAsImage(Image referenceImage)const { return this->m_pfGetLogBiasFieldAsImage(referenceImage); }

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

  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();
 
 
    double m_ConvergenceThreshold{ 0.001 };
 
  /*  odo this variable needs to be printed */
    std::vector<uint32_t> m_MaximumNumberOfIterations{ std::vector<uint32_t>(4,50) };
 
    double m_BiasFieldFullWidthAtHalfMaximum{ 0.15 };
 
    double m_WienerFilterNoise{ 0.01 };
 
    uint32_t m_NumberOfHistogramBins{ 200u };
 
    std::vector<uint32_t> m_NumberOfControlPoints{ std::vector<uint32_t>(3, 4) };
 
    uint32_t m_SplineOrder{ 3u };
 
    bool m_UseMaskLabel{ true };
 
    uint8_t m_MaskLabel{ 1 };
 
 
 
    std::function<uint32_t()> m_pfGetCurrentLevel;
    std::function<uint32_t()> m_pfGetElapsedIterations;
    std::function<double()> m_pfGetCurrentConvergenceMeasurement;
    std::function<Image(Image)> m_pfGetLogBiasFieldAsImage;
 
 
    // Holder of process object for active measurements
    std::unique_ptr<itk::ProcessObject, ProcessObjectDeleter> m_Filter{nullptr};
 
 
 
};
 

SITKBasicFilters_EXPORT Image N4BiasFieldCorrection(
    const Image &image, const Image &maskImage, double convergenceThreshold = 0.001, std::vector<uint32_t> maximumNumberOfIterations = std::vector<uint32_t>(4,50), double biasFieldFullWidthAtHalfMaximum = 0.15, double wienerFilterNoise = 0.01, uint32_t numberOfHistogramBins = 200u, std::vector<uint32_t> numberOfControlPoints = std::vector<uint32_t>(3, 4), uint32_t splineOrder = 3u, bool useMaskLabel = true, uint8_t maskLabel = 1
);
 
SITKBasicFilters_EXPORT Image N4BiasFieldCorrection(
    const Image &image, double convergenceThreshold = 0.001, std::vector<uint32_t> maximumNumberOfIterations = std::vector<uint32_t>(4,50), double biasFieldFullWidthAtHalfMaximum = 0.15, double wienerFilterNoise = 0.01, uint32_t numberOfHistogramBins = 200u, std::vector<uint32_t> numberOfControlPoints = std::vector<uint32_t>(3, 4), uint32_t splineOrder = 3u, bool useMaskLabel = true, uint8_t maskLabel = 1
);

 
}
#endif