Class RegionalMinimaImageFilter
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.RegionalMinimaImageFilter
Produce a binary image where foreground is the regional minima of the
input image.
Regional minima are flat zones surrounded by pixels of greater value.
If the input image is constant, the entire image can be considered as
a minima or not. The SetFlatIsMinima() method let the user choose which behavior to use.
This class was contributed to the Insight Journal by
Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA
de Jouy-en-Josas, France. https://doi.org/10.54294/hva3gz
See:
 RegionalMaximaImageFilter
 ValuedRegionalMinimaImageFilter
 HConcaveImageFilter
 itk::simple::RegionalMinima for the procedural interface
 itk::RegionalMinimaImageFilter for the Doxygen on the original ITK class.
C++ includes: sitkRegionalMinimaImageFilter.h
- 
Field SummaryFields inherited from class org.itk.simple.ProcessObjectswigCMemOwn
- 
Constructor SummaryConstructorsModifierConstructorDescriptionitk::simple::RegionalMinimaImageFilter::RegionalMinimaImageFilter() Default Constructor that takes no arguments and initializes default parametersprotectedRegionalMinimaImageFilter(long cPtr, boolean cMemoryOwn) 
- 
Method SummaryModifier and TypeMethodDescriptionvoiddelete()virtual itk::simple::RegionalMinimaImageFilter::~RegionalMinimaImageFilter() DestructorImage itk::simple::RegionalMinimaImageFilter::Execute(const Image &image1) Execute the filter on the input imageprotected voidfinalize()voidSelf& itk::simple::RegionalMinimaImageFilter::FlatIsMinimaOff()voidSelf& itk::simple::RegionalMinimaImageFilter::FlatIsMinimaOn() Set the value of FlatIsMinima to true or false respectfully.voidSelf& itk::simple::RegionalMinimaImageFilter::FullyConnectedOff()voidSelf& itk::simple::RegionalMinimaImageFilter::FullyConnectedOn() Set the value of FullyConnected to true or false respectfully.doubledouble itk::simple::RegionalMinimaImageFilter::GetBackgroundValue() const Set/Get the value used as "background" in the output image.protected static longbooleanbool itk::simple::RegionalMinimaImageFilter::GetFlatIsMinima() const Set/Get whether a flat image must be considered as a minima or not.doubledouble itk::simple::RegionalMinimaImageFilter::GetForegroundValue() const Set/Get the value in the output image to consider as "foreground".booleanbool itk::simple::RegionalMinimaImageFilter::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::RegionalMinimaImageFilter::GetName() const Name of this classvoidsetBackgroundValue(double BackgroundValue) Self& itk::simple::RegionalMinimaImageFilter::SetBackgroundValue(double BackgroundValue) Set/Get the value used as "background" in the output image.voidsetFlatIsMinima(boolean FlatIsMinima) Self& itk::simple::RegionalMinimaImageFilter::SetFlatIsMinima(bool FlatIsMinima) Set/Get whether a flat image must be considered as a minima or not.voidsetForegroundValue(double ForegroundValue) Self& itk::simple::RegionalMinimaImageFilter::SetForegroundValue(double ForegroundValue) Set/Get the value in the output image to consider as "foreground".voidsetFullyConnected(boolean FullyConnected) Self& itk::simple::RegionalMinimaImageFilter::SetFullyConnected(bool FullyConnected) Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity.protected static longtoString()std::string itk::simple::RegionalMinimaImageFilter::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- 
RegionalMinimaImageFilterprotected RegionalMinimaImageFilter(long cPtr, boolean cMemoryOwn) 
- 
RegionalMinimaImageFilterpublic RegionalMinimaImageFilter()itk::simple::RegionalMinimaImageFilter::RegionalMinimaImageFilter() 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::RegionalMinimaImageFilter::~RegionalMinimaImageFilter() Destructor- Overrides:
- deletein class- ImageFilter
 
- 
setBackgroundValuepublic void setBackgroundValue(double BackgroundValue) Self& itk::simple::RegionalMinimaImageFilter::SetBackgroundValue(double BackgroundValue) Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::NonpositiveMin() .
- 
getBackgroundValuepublic double getBackgroundValue()double itk::simple::RegionalMinimaImageFilter::GetBackgroundValue() const Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::NonpositiveMin() .
- 
setForegroundValuepublic void setForegroundValue(double ForegroundValue) Self& itk::simple::RegionalMinimaImageFilter::SetForegroundValue(double ForegroundValue) Set/Get the value in the output image to consider as "foreground". Defaults to maximum value of PixelType.
- 
getForegroundValuepublic double getForegroundValue()double itk::simple::RegionalMinimaImageFilter::GetForegroundValue() const Set/Get the value in the output image to consider as "foreground". Defaults to maximum value of PixelType.
- 
setFullyConnectedpublic void setFullyConnected(boolean FullyConnected) Self& itk::simple::RegionalMinimaImageFilter::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.
- 
fullyConnectedOnpublic void fullyConnectedOn()Self& itk::simple::RegionalMinimaImageFilter::FullyConnectedOn() Set the value of FullyConnected to true or false respectfully.
- 
fullyConnectedOffpublic void fullyConnectedOff()Self& itk::simple::RegionalMinimaImageFilter::FullyConnectedOff()
- 
getFullyConnectedpublic boolean getFullyConnected()bool itk::simple::RegionalMinimaImageFilter::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.
- 
setFlatIsMinimapublic void setFlatIsMinima(boolean FlatIsMinima) Self& itk::simple::RegionalMinimaImageFilter::SetFlatIsMinima(bool FlatIsMinima) Set/Get whether a flat image must be considered as a minima or not. Defaults to true.
- 
flatIsMinimaOnpublic void flatIsMinimaOn()Self& itk::simple::RegionalMinimaImageFilter::FlatIsMinimaOn() Set the value of FlatIsMinima to true or false respectfully.
- 
flatIsMinimaOffpublic void flatIsMinimaOff()Self& itk::simple::RegionalMinimaImageFilter::FlatIsMinimaOff()
- 
getFlatIsMinimapublic boolean getFlatIsMinima()bool itk::simple::RegionalMinimaImageFilter::GetFlatIsMinima() const Set/Get whether a flat image must be considered as a minima or not. Defaults to true.
- 
getNamestd::string itk::simple::RegionalMinimaImageFilter::GetName() const Name of this class- Overrides:
- getNamein class- ProcessObject
 
- 
toStringstd::string itk::simple::RegionalMinimaImageFilter::ToString() const Print ourselves out- Overrides:
- toStringin class- ProcessObject
 
- 
execute
 
-