sitkScalarChanAndVeseDenseLevelSetImageFilter.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 sitkScalarChanAndVeseDenseLevelSetImageFilter_h
#define sitkScalarChanAndVeseDenseLevelSetImageFilter_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 ScalarChanAndVeseDenseLevelSetImageFilter : public ImageFilter {
public:
  using Self = ScalarChanAndVeseDenseLevelSetImageFilter;

  virtual ~ScalarChanAndVeseDenseLevelSetImageFilter();

  ScalarChanAndVeseDenseLevelSetImageFilter();

  using PixelIDTypeList = RealPixelIDTypeList;
 
 
 

  void
  SetMaximumRMSError(double MaximumRMSError )
    { this->m_MaximumRMSError = MaximumRMSError; }

  double
  GetMaximumRMSError() const { return this->m_MaximumRMSError; }
 

  void
  SetNumberOfIterations(uint32_t NumberOfIterations )
    { this->m_NumberOfIterations = NumberOfIterations; }

  uint32_t
  GetNumberOfIterations() const { return this->m_NumberOfIterations; }
 

  void
  SetLambda1(double Lambda1 )
    { this->m_Lambda1 = Lambda1; }

  double
  GetLambda1() const { return this->m_Lambda1; }
 

  void
  SetLambda2(double Lambda2 )
    { this->m_Lambda2 = Lambda2; }

  double
  GetLambda2() const { return this->m_Lambda2; }
 

  void
  SetEpsilon(double Epsilon )
    { this->m_Epsilon = Epsilon; }

  double
  GetEpsilon() const { return this->m_Epsilon; }
 

  void
  SetCurvatureWeight(double CurvatureWeight )
    { this->m_CurvatureWeight = CurvatureWeight; }

  double
  GetCurvatureWeight() const { return this->m_CurvatureWeight; }
 

  void
  SetAreaWeight(double AreaWeight )
    { this->m_AreaWeight = AreaWeight; }

  double
  GetAreaWeight() const { return this->m_AreaWeight; }
 

  void
  SetReinitializationSmoothingWeight(double ReinitializationSmoothingWeight )
    { this->m_ReinitializationSmoothingWeight = ReinitializationSmoothingWeight; }

  double
  GetReinitializationSmoothingWeight() const { return this->m_ReinitializationSmoothingWeight; }
 

  void
  SetVolume(double Volume )
    { this->m_Volume = Volume; }

  double
  GetVolume() const { return this->m_Volume; }
 

  void
  SetVolumeMatchingWeight(double VolumeMatchingWeight )
    { this->m_VolumeMatchingWeight = VolumeMatchingWeight; }

  double
  GetVolumeMatchingWeight() const { return this->m_VolumeMatchingWeight; }
 
    typedef enum { AtanRegularizedHeaviside, SinRegularizedHeaviside, Heaviside } HeavisideStepFunctionType;

  void
  SetHeavisideStepFunction(HeavisideStepFunctionType HeavisideStepFunction )
    { this->m_HeavisideStepFunction = HeavisideStepFunction; }

  HeavisideStepFunctionType
  GetHeavisideStepFunction() const { return this->m_HeavisideStepFunction; }
 

  void
  SetUseImageSpacing(bool UseImageSpacing )
    { this->m_UseImageSpacing = UseImageSpacing; }

  void
  UseImageSpacingOn() { return this->SetUseImageSpacing(true); }
  void
  UseImageSpacingOff() { return this->SetUseImageSpacing(false); }
  bool
  GetUseImageSpacing() const { return this->m_UseImageSpacing; }
 

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

  double GetRMSChange() const { return this->m_RMSChange; }

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

  std::string ToString() const;
 

  Image Execute(const Image &initialImage, const Image &featureImage);
 
 
private:
  using MemberFunctionType = Image (Self::*)(const Image *
    initialImage, const Image *
    featureImage);
  template <class TImageType> Image ExecuteInternal(const Image *
    initialImage, const Image *
    featureImage);
    friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
    static const detail::MemberFunctionFactory<MemberFunctionType> &GetMemberFunctionFactory();
 
 
  /* Value of RMS change below which the filter should stop. This is a convergence criterion. */
    double m_MaximumRMSError{ 0.02 };
 
  /* Number of iterations to run */
    uint32_t m_NumberOfIterations{ 1000u };
 
  /* Lambda1. Internal intensity difference weight */
    double m_Lambda1{ 1.0 };
 
  /* Lambda2. External intensity difference weight */
    double m_Lambda2{ 1.0 };
 
  /* Width of regularization of Heaviside function. */
    double m_Epsilon{ 1.0 };
 
  /* Gamma. Scales all curvature weight values  */
    double m_CurvatureWeight{ 1.0 };
 
  /* Nu. Area regularization values */
    double m_AreaWeight{ 0.0 };
 
  /* Weight of the laplacian smoothing term */
    double m_ReinitializationSmoothingWeight{ 0.0 };
 
  /*  Pixel Volume = Number of pixels inside the level-set */
    double m_Volume{ 0.0 };
 
  /* Volume matching weight. */
    double m_VolumeMatchingWeight{ 0.0 };
 
  /* Step functions */
    HeavisideStepFunctionType m_HeavisideStepFunction{ itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::AtanRegularizedHeaviside };
 
    bool m_UseImageSpacing{ true };
 
 
 
    uint32_t m_ElapsedIterations{ 0 };
    double m_RMSChange{ 0.0 };
 
 
 
 
};
 

SITKBasicFilters_EXPORT Image ScalarChanAndVeseDenseLevelSet(
    const Image &initialImage, const Image &featureImage, double maximumRMSError = 0.02, uint32_t numberOfIterations = 1000u, double lambda1 = 1.0, double lambda2 = 1.0, double epsilon = 1.0, double curvatureWeight = 1.0, double areaWeight = 0.0, double reinitializationSmoothingWeight = 0.0, double volume = 0.0, double volumeMatchingWeight = 0.0, ScalarChanAndVeseDenseLevelSetImageFilter::HeavisideStepFunctionType heavisideStepFunction = itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::AtanRegularizedHeaviside, bool useImageSpacing = true
);

 
}
#endif