Package org.itk.simple
Class RegionalMaximaImageFilter
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.RegionalMaximaImageFilter
Produce a binary image where foreground is the regional maxima of the
input image.
Regional maxima are flat zones surrounded by pixels of lower value.
If the input image is constant, the entire image can be considered as
a maxima or not. The desired behavior can be selected with the SetFlatIsMaxima() method.
Gaetan Lehmann
This class was contributed to the Insight Journal by author Gaetan
Lehmann. Biologie du Developpement et de la Reproduction, INRA de
Jouy-en-Josas, France. The paper can be found at https://www.insight-journal.org/browse/publication/65
See:
ValuedRegionalMaximaImageFilter
HConvexImageFilter
RegionalMinimaImageFilter
itk::simple::RegionalMaxima for the procedural interface
itk::RegionalMaximaImageFilter for the Doxygen on the original ITK class.
C++ includes: sitkRegionalMaximaImageFilter.h
-
Field Summary
Fields inherited from class org.itk.simple.ProcessObject
swigCMemOwn
-
Constructor Summary
ConstructorsModifierConstructorDescriptionitk::simple::RegionalMaximaImageFilter::RegionalMaximaImageFilter() Default Constructor that takes no arguments and initializes default parametersprotected
RegionalMaximaImageFilter
(long cPtr, boolean cMemoryOwn) -
Method Summary
Modifier and TypeMethodDescriptionvoid
delete()
virtual itk::simple::RegionalMaximaImageFilter::~RegionalMaximaImageFilter() DestructorImage itk::simple::RegionalMaximaImageFilter::Execute(const Image &image1) Execute the filter on the input imageprotected void
finalize()
void
Self& itk::simple::RegionalMaximaImageFilter::FlatIsMaximaOff()void
Self& itk::simple::RegionalMaximaImageFilter::FlatIsMaximaOn() Set the value of FlatIsMaxima to true or false respectfully.void
Self& itk::simple::RegionalMaximaImageFilter::FullyConnectedOff()void
Self& itk::simple::RegionalMaximaImageFilter::FullyConnectedOn() Set the value of FullyConnected to true or false respectfully.double
double itk::simple::RegionalMaximaImageFilter::GetBackgroundValue() const Set/Get the value used as "background" in the output image.protected static long
boolean
bool itk::simple::RegionalMaximaImageFilter::GetFlatIsMaxima() const Set/Get whether a flat image must be considered as a maxima or not.double
double itk::simple::RegionalMaximaImageFilter::GetForegroundValue() const Set/Get the value in the output image to consider as "foreground".boolean
bool itk::simple::RegionalMaximaImageFilter::GetFullyConnected() const Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity.getName()
std::string itk::simple::RegionalMaximaImageFilter::GetName() const Name of this classvoid
setBackgroundValue
(double BackgroundValue) Self& itk::simple::RegionalMaximaImageFilter::SetBackgroundValue(double BackgroundValue) Set/Get the value used as "background" in the output image.void
setFlatIsMaxima
(boolean FlatIsMaxima) Self& itk::simple::RegionalMaximaImageFilter::SetFlatIsMaxima(bool FlatIsMaxima) Set/Get whether a flat image must be considered as a maxima or not.void
setForegroundValue
(double ForegroundValue) Self& itk::simple::RegionalMaximaImageFilter::SetForegroundValue(double ForegroundValue) Set/Get the value in the output image to consider as "foreground".void
setFullyConnected
(boolean FullyConnected) Self& itk::simple::RegionalMaximaImageFilter::SetFullyConnected(bool FullyConnected) Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity.protected static long
toString()
std::string itk::simple::RegionalMaximaImageFilter::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
-
RegionalMaximaImageFilter
protected RegionalMaximaImageFilter(long cPtr, boolean cMemoryOwn) -
RegionalMaximaImageFilter
public RegionalMaximaImageFilter()itk::simple::RegionalMaximaImageFilter::RegionalMaximaImageFilter() 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::RegionalMaximaImageFilter::~RegionalMaximaImageFilter() Destructor- Overrides:
delete
in classImageFilter
-
setBackgroundValue
public void setBackgroundValue(double BackgroundValue) Self& itk::simple::RegionalMaximaImageFilter::SetBackgroundValue(double BackgroundValue) Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::NonpositiveMin() . -
getBackgroundValue
public double getBackgroundValue()double itk::simple::RegionalMaximaImageFilter::GetBackgroundValue() const Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::NonpositiveMin() . -
setForegroundValue
public void setForegroundValue(double ForegroundValue) Self& itk::simple::RegionalMaximaImageFilter::SetForegroundValue(double ForegroundValue) Set/Get the value in the output image to consider as "foreground". Defaults to maximum value of PixelType. -
getForegroundValue
public double getForegroundValue()double itk::simple::RegionalMaximaImageFilter::GetForegroundValue() const Set/Get the value in the output image to consider as "foreground". Defaults to maximum value of PixelType. -
setFullyConnected
public void setFullyConnected(boolean FullyConnected) Self& itk::simple::RegionalMaximaImageFilter::SetFullyConnected(bool FullyConnected) Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn. -
fullyConnectedOn
public void fullyConnectedOn()Self& itk::simple::RegionalMaximaImageFilter::FullyConnectedOn() Set the value of FullyConnected to true or false respectfully. -
fullyConnectedOff
public void fullyConnectedOff()Self& itk::simple::RegionalMaximaImageFilter::FullyConnectedOff() -
getFullyConnected
public boolean getFullyConnected()bool itk::simple::RegionalMaximaImageFilter::GetFullyConnected() const Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn. -
setFlatIsMaxima
public void setFlatIsMaxima(boolean FlatIsMaxima) Self& itk::simple::RegionalMaximaImageFilter::SetFlatIsMaxima(bool FlatIsMaxima) Set/Get whether a flat image must be considered as a maxima or not. Defaults to true. -
flatIsMaximaOn
public void flatIsMaximaOn()Self& itk::simple::RegionalMaximaImageFilter::FlatIsMaximaOn() Set the value of FlatIsMaxima to true or false respectfully. -
flatIsMaximaOff
public void flatIsMaximaOff()Self& itk::simple::RegionalMaximaImageFilter::FlatIsMaximaOff() -
getFlatIsMaxima
public boolean getFlatIsMaxima()bool itk::simple::RegionalMaximaImageFilter::GetFlatIsMaxima() const Set/Get whether a flat image must be considered as a maxima or not. Defaults to true. -
getName
std::string itk::simple::RegionalMaximaImageFilter::GetName() const Name of this class- Overrides:
getName
in classProcessObject
-
toString
std::string itk::simple::RegionalMaximaImageFilter::ToString() const Print ourselves out- Overrides:
toString
in classProcessObject
-
execute
Image itk::simple::RegionalMaximaImageFilter::Execute(const Image &image1) Execute the filter on the input image
-