sitkGeodesicActiveContourLevelSetImageFilter.h

Go to the documentation of this file.

/*=========================================================================
*
*  Copyright Insight Software Consortium
*
*  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 sitkGeodesicActiveContourLevelSetImageFilter_h
#define sitkGeodesicActiveContourLevelSetImageFilter_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 {
  namespace simple {

    class SITKBasicFilters_EXPORT GeodesicActiveContourLevelSetImageFilter : public ImageFilter<2> {
    public:
      typedef GeodesicActiveContourLevelSetImageFilter Self;

      virtual ~GeodesicActiveContourLevelSetImageFilter();

      GeodesicActiveContourLevelSetImageFilter();

      typedef RealPixelIDTypeList  PixelIDTypeList;



      SITK_RETURN_SELF_TYPE_HEADER SetMaximumRMSError ( double MaximumRMSError ) { this->m_MaximumRMSError = MaximumRMSError; return *this; }

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

      SITK_RETURN_SELF_TYPE_HEADER SetPropagationScaling ( double PropagationScaling ) { this->m_PropagationScaling = PropagationScaling; return *this; }

        double GetPropagationScaling() const { return this->m_PropagationScaling; }

      SITK_RETURN_SELF_TYPE_HEADER SetCurvatureScaling ( double CurvatureScaling ) { this->m_CurvatureScaling = CurvatureScaling; return *this; }

        double GetCurvatureScaling() const { return this->m_CurvatureScaling; }

      SITK_RETURN_SELF_TYPE_HEADER SetAdvectionScaling ( double AdvectionScaling ) { this->m_AdvectionScaling = AdvectionScaling; return *this; }

        double GetAdvectionScaling() const { return this->m_AdvectionScaling; }

      SITK_RETURN_SELF_TYPE_HEADER SetNumberOfIterations ( uint32_t NumberOfIterations ) { this->m_NumberOfIterations = NumberOfIterations; return *this; }

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

      SITK_RETURN_SELF_TYPE_HEADER SetReverseExpansionDirection ( bool ReverseExpansionDirection ) { this->m_ReverseExpansionDirection = ReverseExpansionDirection; return *this; }

      SITK_RETURN_SELF_TYPE_HEADER ReverseExpansionDirectionOn() { return this->SetReverseExpansionDirection(true); }
      SITK_RETURN_SELF_TYPE_HEADER ReverseExpansionDirectionOff() { return this->SetReverseExpansionDirection(false); }

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

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

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

      std::string ToString() const;


      Image Execute ( const Image& image1, const Image& image2 );


      Image Execute ( const Image& image1, const Image& image2, double maximumRMSError, double propagationScaling, double curvatureScaling, double advectionScaling, uint32_t numberOfIterations, bool reverseExpansionDirection );

    private:

      typedef Image (Self::*MemberFunctionType)( const Image& image1, const Image& image2 );
      template <class TImageType> Image ExecuteInternal ( const Image& image1, const Image& image2 );


      friend struct detail::MemberFunctionAddressor<MemberFunctionType>;

      nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;


      /* Value of RMS change below which the filter should stop. This is a convergence criterion. */
      double  m_MaximumRMSError;
      /* Weight of direct propagation contribution to the speed term */
      double  m_PropagationScaling;
      /* Weight of the curvature contribution to the speed term */
      double  m_CurvatureScaling;
      /* Weight of the advection contribution to the speed term */
      double  m_AdvectionScaling;
      /* Number of iterations to run */
      uint32_t  m_NumberOfIterations;
      /* Turn On/Off the flag which determines whether Positive or Negative speed terms will cause surface expansion.  If set to TRUE then negative speed terms will cause the surface to expand and positive speed terms will cause the surface to contract.  If set to FALSE (default) then positive speed terms will cause the surface to expand and negative speed terms will cause the surface to contract.  This method can be safely used to reverse the expansion/contraction as appropriate to a particular application or data set. */
      bool  m_ReverseExpansionDirection;
      /* Level Set filter that uses propagation, curvature and advection terms. */
      uint32_t m_ElapsedIterations;
      /* Level Set filter that uses propagation, curvature and advection terms. */
      double m_RMSChange;

    };


     SITKBasicFilters_EXPORT Image GeodesicActiveContourLevelSet ( const Image& image1, const Image& image2, double maximumRMSError = 0.01, double propagationScaling = 1.0, double curvatureScaling = 1.0, double advectionScaling = 1.0, uint32_t numberOfIterations = 1000u, bool reverseExpansionDirection = false );

  }
}
#endif