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.in to make changes.
 */
 
#include <memory>
 
#include "sitkBasicFilters.h"
#include "sitkImageFilter.h"
 
namespace itk::simple {
 
    class SITKBasicFilters_EXPORT N4BiasFieldCorrectionImageFilter : public ImageFilter {
    public:
      using Self = N4BiasFieldCorrectionImageFilter;
 
      virtual ~N4BiasFieldCorrectionImageFilter();
 
      N4BiasFieldCorrectionImageFilter();
 
      using PixelIDTypeList = RealPixelIDTypeList;
\
 
      SITK_RETURN_SELF_TYPE_HEADER SetConvergenceThreshold ( double ConvergenceThreshold ) { this->m_ConvergenceThreshold = ConvergenceThreshold; return *this; }
 
      double GetConvergenceThreshold() const { return this->m_ConvergenceThreshold; }\
 
      SITK_RETURN_SELF_TYPE_HEADER SetMaximumNumberOfIterations ( std::vector<uint32_t> MaximumNumberOfIterations ) { this->m_MaximumNumberOfIterations = MaximumNumberOfIterations; return *this; }
 
      std::vector<uint32_t> GetMaximumNumberOfIterations() const { return this->m_MaximumNumberOfIterations; }\
 
      SITK_RETURN_SELF_TYPE_HEADER SetBiasFieldFullWidthAtHalfMaximum ( double BiasFieldFullWidthAtHalfMaximum ) { this->m_BiasFieldFullWidthAtHalfMaximum = BiasFieldFullWidthAtHalfMaximum; return *this; }
 
      double GetBiasFieldFullWidthAtHalfMaximum() const { return this->m_BiasFieldFullWidthAtHalfMaximum; }\
 
      SITK_RETURN_SELF_TYPE_HEADER SetWienerFilterNoise ( double WienerFilterNoise ) { this->m_WienerFilterNoise = WienerFilterNoise; return *this; }
 
      double GetWienerFilterNoise() const { return this->m_WienerFilterNoise; }\
 
      SITK_RETURN_SELF_TYPE_HEADER SetNumberOfHistogramBins ( uint32_t NumberOfHistogramBins ) { this->m_NumberOfHistogramBins = NumberOfHistogramBins; return *this; }
 
      uint32_t GetNumberOfHistogramBins() const { return this->m_NumberOfHistogramBins; }\
 
      SITK_RETURN_SELF_TYPE_HEADER SetNumberOfControlPoints ( std::vector<uint32_t> NumberOfControlPoints ) { this->m_NumberOfControlPoints = std::move(NumberOfControlPoints); return *this; }
 
      SITK_RETURN_SELF_TYPE_HEADER SetNumberOfControlPoints( uint32_t value ) { this->m_NumberOfControlPoints = std::vector<uint32_t>(3, value); return *this; }
 
      std::vector<uint32_t> GetNumberOfControlPoints() const { return this->m_NumberOfControlPoints; }\
 
      SITK_RETURN_SELF_TYPE_HEADER SetSplineOrder ( uint32_t SplineOrder ) { this->m_SplineOrder = SplineOrder; return *this; }
 
      uint32_t GetSplineOrder() const { return this->m_SplineOrder; }\
 
      SITK_RETURN_SELF_TYPE_HEADER SetUseMaskLabel ( bool UseMaskLabel ) { this->m_UseMaskLabel = UseMaskLabel; return *this; }
 
      SITK_RETURN_SELF_TYPE_HEADER UseMaskLabelOn() { return this->SetUseMaskLabel(true); }
      SITK_RETURN_SELF_TYPE_HEADER UseMaskLabelOff() { return this->SetUseMaskLabel(false); }
 
      bool GetUseMaskLabel() const { return this->m_UseMaskLabel; }\
 
      SITK_RETURN_SELF_TYPE_HEADER SetMaskLabel ( uint8_t MaskLabel ) { this->m_MaskLabel = MaskLabel; return *this; }
 
      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>;
 
      std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
 
 
      /*  */
      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};
 
      /* Some global documentation */
      std::function<uint32_t()> m_pfGetCurrentLevel;
      /* Some global documentation */
      std::function<uint32_t()> m_pfGetElapsedIterations;
      /* Some global documentation */
      std::function<double()> m_pfGetCurrentConvergenceMeasurement;
      /* Some global documentation */
      std::function<Image(Image)> m_pfGetLogBiasFieldAsImage;
 
      // Holder of process object for active measurements
      itk::ProcessObject *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