Package org.itk.simple
Class SimilarityIndexImageFilter
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.SimilarityIndexImageFilter
Measures the similarity between the set of non-zero pixels of two
images.
SimilarityIndexImageFilter measures the similarity between the set non-zero pixels of two images
using the following formula: \\[ S = \\frac{2 | A \\cap B |}{|A| + |B|} \\] where $A$ and $B$ are respectively the set of non-zero pixels in the first and second
input images. Operator $|\\cdot|$ represents the size of a set and $\\cap$ represents the intersection of two sets.
The measure is derived from a reliability measure known as the kappa
statistic. $S$ is sensitive to both differences in size and in location and have
been in the literature for comparing two segmentation masks. For more
information see: "Morphometric Analysis of White Matter Lesions in MR
Images: Method and Validation", A. P. Zijdenbos, B. M. Dawant, R. A.
Margolin and A. C. Palmer, IEEE Trans. on Medical Imaging, 13(4) pp
716-724,1994
This filter requires the largest possible region of the first image
and the same corresponding region in the second image. It behaves as
filter with two input and one output. Thus it can be inserted in a
pipeline with other filters. The filter passes the first input through
unmodified.
This filter is templated over the two input image type. It assume both
image have the same number of dimensions.
See:
itk::SimilarityIndexImageFilter for the Doxygen on the original ITK class.
C++ includes: sitkSimilarityIndexImageFilter.h
-
Field Summary
Fields inherited from class org.itk.simple.ProcessObject
swigCMemOwn
-
Constructor Summary
ConstructorsModifierConstructorDescriptionitk::simple::SimilarityIndexImageFilter::SimilarityIndexImageFilter() Default Constructor that takes no arguments and initializes default parametersprotected
SimilarityIndexImageFilter
(long cPtr, boolean cMemoryOwn) -
Method Summary
Modifier and TypeMethodDescriptionvoid
delete()
virtual itk::simple::SimilarityIndexImageFilter::~SimilarityIndexImageFilter() Destructorvoid
void itk::simple::SimilarityIndexImageFilter::Execute(const Image &image1, const Image &image2) Execute the filter on the input imagesprotected void
finalize()
protected static long
getName()
std::string itk::simple::SimilarityIndexImageFilter::GetName() const Name of this classdouble
double itk::simple::SimilarityIndexImageFilter::GetSimilarityIndex() const Return the computed similarity index.protected static long
toString()
std::string itk::simple::SimilarityIndexImageFilter::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
-
SimilarityIndexImageFilter
protected SimilarityIndexImageFilter(long cPtr, boolean cMemoryOwn) -
SimilarityIndexImageFilter
public SimilarityIndexImageFilter()itk::simple::SimilarityIndexImageFilter::SimilarityIndexImageFilter() 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::SimilarityIndexImageFilter::~SimilarityIndexImageFilter() Destructor- Overrides:
delete
in classImageFilter
-
getSimilarityIndex
public double getSimilarityIndex()double itk::simple::SimilarityIndexImageFilter::GetSimilarityIndex() const Return the computed similarity index. 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::SimilarityIndexImageFilter::GetName() const Name of this class- Overrides:
getName
in classProcessObject
-
toString
std::string itk::simple::SimilarityIndexImageFilter::ToString() const Print ourselves out- Overrides:
toString
in classProcessObject
-
execute
void itk::simple::SimilarityIndexImageFilter::Execute(const Image &image1, const Image &image2) Execute the filter on the input images
-