Package org.itk.simple
Class ShapeDetectionLevelSetImageFilter
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.ShapeDetectionLevelSetImageFilter
Segments structures in images based on a user supplied edge potential
map.
IMPORTANT
The SegmentationLevelSetImageFilter class and the ShapeDetectionLevelSetFunction 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. This approach for
segmentation follows that of Malladi et al (1995).
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. Note that
for this algorithm the initial contour has to be wholly within (or
wholly outside) the structure to be segmented.
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).
The smoothness of the resulting contour/surface can be adjusted using
a combination of PropagationScaling and CurvatureScaling parameters.
The larger the CurvatureScaling parameter, the smoother the resulting
contour. The CurvatureScaling parameter should be non-negative for
proper operation of this algorithm. To follow the implementation in
Malladi et al paper, set the PropagationScaling to $\\pm 1.0$ and CurvatureScaling to $ \\epsilon $ .
Note that there is no advection term for this filter. Setting the
advection scaling will have no effect.
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
"Shape Modeling with Front Propagation: A Level Set Approach", R.
Malladi, J. A. Sethian and B. C. Vermuri. IEEE Trans. on Pattern
Analysis and Machine Intelligence, Vol 17, No. 2, pp 158-174, February
1995
See:
SegmentationLevelSetImageFilter
ShapeDetectionLevelSetFunction
SparseFieldLevelSetImageFilter
itk::simple::ShapeDetectionLevelSet for the procedural interface
itk::ShapeDetectionLevelSetImageFilter for the Doxygen on the original ITK class.
C++ includes: sitkShapeDetectionLevelSetImageFilter.h
-
Field Summary
Fields inherited from class org.itk.simple.ProcessObject
swigCMemOwn
-
Constructor Summary
ConstructorsModifierConstructorDescriptionitk::simple::ShapeDetectionLevelSetImageFilter::ShapeDetectionLevelSetImageFilter() Default Constructor that takes no arguments and initializes default parametersprotected
ShapeDetectionLevelSetImageFilter
(long cPtr, boolean cMemoryOwn) -
Method Summary
Modifier and TypeMethodDescriptionvoid
delete()
virtual itk::simple::ShapeDetectionLevelSetImageFilter::~ShapeDetectionLevelSetImageFilter() DestructorImage itk::simple::ShapeDetectionLevelSetImageFilter::Execute(Image &&initialImage, const Image &featureImage) Execute the filter on the input imageprotected void
finalize()
protected static long
double
double itk::simple::ShapeDetectionLevelSetImageFilter::GetCurvatureScaling() constlong
uint32_t itk::simple::ShapeDetectionLevelSetImageFilter::GetElapsedIterations() const Number of iterations run.double
double itk::simple::ShapeDetectionLevelSetImageFilter::GetMaximumRMSError() constgetName()
std::string itk::simple::ShapeDetectionLevelSetImageFilter::GetName() const Name of this classlong
uint32_t itk::simple::ShapeDetectionLevelSetImageFilter::GetNumberOfIterations() constdouble
double itk::simple::ShapeDetectionLevelSetImageFilter::GetPropagationScaling() constboolean
bool itk::simple::ShapeDetectionLevelSetImageFilter::GetReverseExpansionDirection() constdouble
double itk::simple::ShapeDetectionLevelSetImageFilter::GetRMSChange() const The Root Mean Square of the levelset upon termination.void
Self& itk::simple::ShapeDetectionLevelSetImageFilter::ReverseExpansionDirectionOff()void
Self& itk::simple::ShapeDetectionLevelSetImageFilter::ReverseExpansionDirectionOn() Set the value of ReverseExpansionDirection to true or false respectfully.void
setCurvatureScaling
(double CurvatureScaling) Self& itk::simple::ShapeDetectionLevelSetImageFilter::SetCurvatureScaling(double CurvatureScaling)void
setMaximumRMSError
(double MaximumRMSError) Self& itk::simple::ShapeDetectionLevelSetImageFilter::SetMaximumRMSError(double MaximumRMSError)void
setNumberOfIterations
(long NumberOfIterations) Self& itk::simple::ShapeDetectionLevelSetImageFilter::SetNumberOfIterations(uint32_t NumberOfIterations)void
setPropagationScaling
(double PropagationScaling) Self& itk::simple::ShapeDetectionLevelSetImageFilter::SetPropagationScaling(double PropagationScaling)void
setReverseExpansionDirection
(boolean ReverseExpansionDirection) Self& itk::simple::ShapeDetectionLevelSetImageFilter::SetReverseExpansionDirection(bool ReverseExpansionDirection)protected static long
toString()
std::string itk::simple::ShapeDetectionLevelSetImageFilter::ToString() const Print ourselves outMethods inherited from class org.itk.simple.ImageFilter
getCPtr, swigRelease
Methods inherited from class org.itk.simple.ProcessObject
abort, addCommand, debugOff, debugOn, getCPtr, getDebug, getGlobalDefaultCoordinateTolerance, getGlobalDefaultDebug, getGlobalDefaultDirectionTolerance, getGlobalDefaultNumberOfThreads, getGlobalDefaultThreader, getGlobalWarningDisplay, getNumberOfThreads, getNumberOfWorkUnits, getProgress, globalDefaultDebugOff, globalDefaultDebugOn, globalWarningDisplayOff, globalWarningDisplayOn, hasCommand, removeAllCommands, setDebug, setGlobalDefaultCoordinateTolerance, setGlobalDefaultDebug, setGlobalDefaultDirectionTolerance, setGlobalDefaultNumberOfThreads, setGlobalDefaultThreader, setGlobalWarningDisplay, setNumberOfThreads, setNumberOfWorkUnits, swigRelease
-
Constructor Details
-
ShapeDetectionLevelSetImageFilter
protected ShapeDetectionLevelSetImageFilter(long cPtr, boolean cMemoryOwn) -
ShapeDetectionLevelSetImageFilter
public ShapeDetectionLevelSetImageFilter()itk::simple::ShapeDetectionLevelSetImageFilter::ShapeDetectionLevelSetImageFilter() Default Constructor that takes no arguments and initializes default parameters
-
-
Method Details
-
getCPtr
-
swigRelease
-
finalize
protected void finalize()- Overrides:
finalize
in classImageFilter
-
delete
public void delete()virtual itk::simple::ShapeDetectionLevelSetImageFilter::~ShapeDetectionLevelSetImageFilter() Destructor- Overrides:
delete
in classImageFilter
-
setMaximumRMSError
public void setMaximumRMSError(double MaximumRMSError) Self& itk::simple::ShapeDetectionLevelSetImageFilter::SetMaximumRMSError(double MaximumRMSError) -
getMaximumRMSError
public double getMaximumRMSError()double itk::simple::ShapeDetectionLevelSetImageFilter::GetMaximumRMSError() const -
setPropagationScaling
public void setPropagationScaling(double PropagationScaling) Self& itk::simple::ShapeDetectionLevelSetImageFilter::SetPropagationScaling(double PropagationScaling) -
getPropagationScaling
public double getPropagationScaling()double itk::simple::ShapeDetectionLevelSetImageFilter::GetPropagationScaling() const -
setCurvatureScaling
public void setCurvatureScaling(double CurvatureScaling) Self& itk::simple::ShapeDetectionLevelSetImageFilter::SetCurvatureScaling(double CurvatureScaling) -
getCurvatureScaling
public double getCurvatureScaling()double itk::simple::ShapeDetectionLevelSetImageFilter::GetCurvatureScaling() const -
setNumberOfIterations
public void setNumberOfIterations(long NumberOfIterations) Self& itk::simple::ShapeDetectionLevelSetImageFilter::SetNumberOfIterations(uint32_t NumberOfIterations) -
getNumberOfIterations
public long getNumberOfIterations()uint32_t itk::simple::ShapeDetectionLevelSetImageFilter::GetNumberOfIterations() const -
setReverseExpansionDirection
public void setReverseExpansionDirection(boolean ReverseExpansionDirection) Self& itk::simple::ShapeDetectionLevelSetImageFilter::SetReverseExpansionDirection(bool ReverseExpansionDirection) -
reverseExpansionDirectionOn
public void reverseExpansionDirectionOn()Self& itk::simple::ShapeDetectionLevelSetImageFilter::ReverseExpansionDirectionOn() Set the value of ReverseExpansionDirection to true or false respectfully. -
reverseExpansionDirectionOff
public void reverseExpansionDirectionOff()Self& itk::simple::ShapeDetectionLevelSetImageFilter::ReverseExpansionDirectionOff() -
getReverseExpansionDirection
public boolean getReverseExpansionDirection()bool itk::simple::ShapeDetectionLevelSetImageFilter::GetReverseExpansionDirection() const -
getElapsedIterations
public long getElapsedIterations()uint32_t itk::simple::ShapeDetectionLevelSetImageFilter::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::ShapeDetectionLevelSetImageFilter::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
std::string itk::simple::ShapeDetectionLevelSetImageFilter::GetName() const Name of this class- Overrides:
getName
in classProcessObject
-
toString
std::string itk::simple::ShapeDetectionLevelSetImageFilter::ToString() const Print ourselves out- Overrides:
toString
in classProcessObject
-
execute
Image itk::simple::ShapeDetectionLevelSetImageFilter::Execute(Image &&initialImage, const Image &featureImage) Execute the filter on the input image
-