Class RankImageFilter
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.RankImageFilter
Rank filter of a greyscale image.
Nonlinear filter in which each output pixel is a user defined rank of
input pixels in a user defined neighborhood. The default rank is 0.5
(median). The boundary conditions are different to the standard
itkMedianImageFilter. In this filter the neighborhood is cropped at
the boundary, and is therefore smaller.
This filter uses a recursive implementation - essentially the one by
Huang 1979, I believe, to compute the rank, and is therefore usually a
lot faster than the direct implementation. The extensions to Huang are
support for arbitrary pixel types (using c++ maps) and arbitrary
neighborhoods. I presume that these are not new ideas.
This filter is based on the sliding window code from the
consolidatedMorphology package on InsightJournal.
The structuring element is assumed to be composed of binary values
(zero or one). Only elements of the structuring element having values
> 0 are candidates for affecting the center pixel.
This code was contributed in the Insight Journal paper: "Efficient
implementation of kernel filtering" by Beare R., Lehmann G https://doi.org/10.54294/igq8fn
See:
 MedianImageFilter
Richard Beare
See:
 itk::simple::Rank for the procedural interface
 itk::RankImageFilter for the Doxygen on the original ITK class.
C++ includes: sitkRankImageFilter.h
- 
Field SummaryFields inherited from class org.itk.simple.ProcessObjectswigCMemOwn
- 
Constructor SummaryConstructorsModifierConstructorDescriptionitk::simple::RankImageFilter::RankImageFilter() Default Constructor that takes no arguments and initializes default parametersprotectedRankImageFilter(long cPtr, boolean cMemoryOwn) 
- 
Method SummaryModifier and TypeMethodDescriptionvoiddelete()virtual itk::simple::RankImageFilter::~RankImageFilter() DestructorImage itk::simple::RankImageFilter::Execute(const Image &image1) Execute the filter on the input imageprotected voidfinalize()protected static longgetCPtr(RankImageFilter obj) KernelEnum itk::simple::RankImageFilter::GetKernelType() const Get the kernel or structuring element .getName()std::string itk::simple::RankImageFilter::GetName() const Name of this classstd::vector<unsigned int> itk::simple::RankImageFilter::GetRadius() constdoublegetRank()double itk::simple::RankImageFilter::GetRank() constvoidsetKernelType(KernelEnum KernelType) Self& itk::simple::RankImageFilter::SetKernelType(KernelEnum KernelType) Set the kernel or structuring element.voidsetRadius(VectorUInt32 Radius) Self& itk::simple::RankImageFilter::SetRadius(std::vector< unsigned int > Radius)voidsetRank(double Rank) Self& itk::simple::RankImageFilter::SetRank(double Rank)protected static longtoString()std::string itk::simple::RankImageFilter::ToString() const Print ourselves outMethods inherited from class org.itk.simple.ImageFiltergetCPtr, swigReleaseMethods inherited from class org.itk.simple.ProcessObjectabort, 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- 
RankImageFilterprotected RankImageFilter(long cPtr, boolean cMemoryOwn) 
- 
RankImageFilterpublic RankImageFilter()itk::simple::RankImageFilter::RankImageFilter() Default Constructor that takes no arguments and initializes default parameters
 
- 
- 
Method Details- 
getCPtr
- 
swigRelease
- 
finalizeprotected void finalize()- Overrides:
- finalizein class- ImageFilter
 
- 
deletepublic void delete()virtual itk::simple::RankImageFilter::~RankImageFilter() Destructor- Overrides:
- deletein class- ImageFilter
 
- 
setRankpublic void setRank(double Rank) Self& itk::simple::RankImageFilter::SetRank(double Rank)
- 
getRankpublic double getRank()double itk::simple::RankImageFilter::GetRank() const
- 
setRadiusSelf& itk::simple::RankImageFilter::SetRadius(std::vector< unsigned int > Radius)
- 
getRadiusstd::vector<unsigned int> itk::simple::RankImageFilter::GetRadius() const
- 
setKernelTypeSelf& itk::simple::RankImageFilter::SetKernelType(KernelEnum KernelType) Set the kernel or structuring element.
- 
getKernelTypeKernelEnum itk::simple::RankImageFilter::GetKernelType() const Get the kernel or structuring element .
- 
getNamestd::string itk::simple::RankImageFilter::GetName() const Name of this class- Overrides:
- getNamein class- ProcessObject
 
- 
toStringstd::string itk::simple::RankImageFilter::ToString() const Print ourselves out- Overrides:
- toStringin class- ProcessObject
 
- 
execute
 
-