Class GeodesicActiveContourLevelSetImageFilter

java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.GeodesicActiveContourLevelSetImageFilter

public class GeodesicActiveContourLevelSetImageFilter extends ImageFilter
Segments structures in images based on a user supplied edge potential map. IMPORTANT The SegmentationLevelSetImageFilter class and the GeodesicActiveContourLevelSetFunction class contain additional information necessary to gain full understanding of how to use this filter. OVERVIEW This class is a level set method segmentation filter. An initial contour is propagated outwards (or inwards) until it ''sticks'' to the shape boundaries. This is done by using a level set speed function based on a user supplied edge potential map. INPUTS This filter requires two inputs. The first input is a initial level set. The initial level set is a real image which contains the initial contour/surface as the zero level set. For example, a signed distance function from the initial contour/surface is typically used. Unlike the simpler ShapeDetectionLevelSetImageFilter the initial contour does not have to lie wholly within the shape to be segmented. The initial contour is allow to overlap the shape boundary. The extra advection term in the update equation behaves like a doublet and attracts the contour to the boundary. This approach for segmentation follows that of Caselles et al (1997). The second input is the feature image. For this filter, this is the edge potential map. General characteristics of an edge potential map is that it has values close to zero in regions near the edges and values close to one inside the shape itself. Typically, the edge potential map is compute from the image gradient, for example: \\[ g(I) = 1 / ( 1 + | (\\nabla * G)(I)| ) \\] \\[ g(I) = \\exp^{-|(\\nabla * G)(I)|} \\] where $ I $ is image intensity and $ (\\nabla * G) $ is the derivative of Gaussian operator. See SegmentationLevelSetImageFilter and SparseFieldLevelSetImageFilter for more information on Inputs. PARAMETERS The PropagationScaling parameter can be used to switch from propagation outwards (POSITIVE scaling parameter) versus propagating inwards (NEGATIVE scaling parameter). This implementation allows the user to set the weights between the propagation, advection and curvature term using methods SetPropagationScaling() , SetAdvectionScaling() , SetCurvatureScaling() . In general, the larger the CurvatureScaling, the smoother the resulting contour. To follow the implementation in Caselles et al paper, set the PropagationScaling to $ c $ (the inflation or balloon force) and AdvectionScaling and CurvatureScaling both to 1.0. OUTPUTS The filter outputs a single, scalar, real-valued image. Negative values in the output image represent the inside of the segmented region and positive values in the image represent the outside of the segmented region. The zero crossings of the image correspond to the position of the propagating front. See SparseFieldLevelSetImageFilter and SegmentationLevelSetImageFilter for more information. REFERENCES "Geodesic Active Contours", V. Caselles, R. Kimmel and G. Sapiro. International Journal on Computer Vision, Vol 22, No. 1, pp 61-97, 1997 See: SegmentationLevelSetImageFilter GeodesicActiveContourLevelSetFunction SparseFieldLevelSetImageFilter itk::simple::GeodesicActiveContourLevelSet for the procedural interface itk::GeodesicActiveContourLevelSetImageFilter for the Doxygen on the original ITK class. C++ includes: sitkGeodesicActiveContourLevelSetImageFilter.h
  • Constructor Details

    • GeodesicActiveContourLevelSetImageFilter

      protected GeodesicActiveContourLevelSetImageFilter(long cPtr, boolean cMemoryOwn)
    • GeodesicActiveContourLevelSetImageFilter

      public GeodesicActiveContourLevelSetImageFilter()
      itk::simple::GeodesicActiveContourLevelSetImageFilter::GeodesicActiveContourLevelSetImageFilter() Default Constructor that takes no arguments and initializes default parameters
  • Method Details

    • getCPtr

      protected static long getCPtr(GeodesicActiveContourLevelSetImageFilter obj)
    • swigRelease

      protected static long swigRelease(GeodesicActiveContourLevelSetImageFilter obj)
    • finalize

      protected void finalize()
      Overrides:
      finalize in class ImageFilter
    • delete

      public void delete()
      virtual itk::simple::GeodesicActiveContourLevelSetImageFilter::~GeodesicActiveContourLevelSetImageFilter() Destructor
      Overrides:
      delete in class ImageFilter
    • setMaximumRMSError

      public void setMaximumRMSError(double MaximumRMSError)
      Self& itk::simple::GeodesicActiveContourLevelSetImageFilter::SetMaximumRMSError(double MaximumRMSError)
    • getMaximumRMSError

      public double getMaximumRMSError()
      double itk::simple::GeodesicActiveContourLevelSetImageFilter::GetMaximumRMSError() const
    • setPropagationScaling

      public void setPropagationScaling(double PropagationScaling)
      Self& itk::simple::GeodesicActiveContourLevelSetImageFilter::SetPropagationScaling(double PropagationScaling)
    • getPropagationScaling

      public double getPropagationScaling()
      double itk::simple::GeodesicActiveContourLevelSetImageFilter::GetPropagationScaling() const
    • setCurvatureScaling

      public void setCurvatureScaling(double CurvatureScaling)
      Self& itk::simple::GeodesicActiveContourLevelSetImageFilter::SetCurvatureScaling(double CurvatureScaling)
    • getCurvatureScaling

      public double getCurvatureScaling()
      double itk::simple::GeodesicActiveContourLevelSetImageFilter::GetCurvatureScaling() const
    • setAdvectionScaling

      public void setAdvectionScaling(double AdvectionScaling)
      Self& itk::simple::GeodesicActiveContourLevelSetImageFilter::SetAdvectionScaling(double AdvectionScaling)
    • getAdvectionScaling

      public double getAdvectionScaling()
      double itk::simple::GeodesicActiveContourLevelSetImageFilter::GetAdvectionScaling() const
    • setNumberOfIterations

      public void setNumberOfIterations(long NumberOfIterations)
      Self& itk::simple::GeodesicActiveContourLevelSetImageFilter::SetNumberOfIterations(uint32_t NumberOfIterations)
    • getNumberOfIterations

      public long getNumberOfIterations()
      uint32_t itk::simple::GeodesicActiveContourLevelSetImageFilter::GetNumberOfIterations() const
    • setReverseExpansionDirection

      public void setReverseExpansionDirection(boolean ReverseExpansionDirection)
      Self& itk::simple::GeodesicActiveContourLevelSetImageFilter::SetReverseExpansionDirection(bool ReverseExpansionDirection)
    • reverseExpansionDirectionOn

      public void reverseExpansionDirectionOn()
      Self& itk::simple::GeodesicActiveContourLevelSetImageFilter::ReverseExpansionDirectionOn() Set the value of ReverseExpansionDirection to true or false respectfully.
    • reverseExpansionDirectionOff

      public void reverseExpansionDirectionOff()
      Self& itk::simple::GeodesicActiveContourLevelSetImageFilter::ReverseExpansionDirectionOff()
    • getReverseExpansionDirection

      public boolean getReverseExpansionDirection()
      bool itk::simple::GeodesicActiveContourLevelSetImageFilter::GetReverseExpansionDirection() const
    • getElapsedIterations

      public long getElapsedIterations()
      uint32_t itk::simple::GeodesicActiveContourLevelSetImageFilter::GetElapsedIterations() const Number of iterations run. This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.
    • getRMSChange

      public double getRMSChange()
      double itk::simple::GeodesicActiveContourLevelSetImageFilter::GetRMSChange() const The Root Mean Square of the levelset upon termination. This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.
    • getName

      public String getName()
      std::string itk::simple::GeodesicActiveContourLevelSetImageFilter::GetName() const Name of this class
      Overrides:
      getName in class ProcessObject
    • toString

      public String toString()
      std::string itk::simple::GeodesicActiveContourLevelSetImageFilter::ToString() const Print ourselves out
      Overrides:
      toString in class ProcessObject
    • execute

      public Image execute(Image initialImage, Image featureImage)
      Image itk::simple::GeodesicActiveContourLevelSetImageFilter::Execute(Image &&initialImage, const Image &featureImage) Execute the filter on the input image