Class ValuedRegionalMinimaImageFilter

java.lang.Object

org.itk.simple.ProcessObject

org.itk.simple.ImageFilter

org.itk.simple.ValuedRegionalMinimaImageFilter

public class ValuedRegionalMinimaImageFilter
extends ImageFilter

Transforms the image so that any pixel that is not a regional minima is set to the maximum value for the pixel type. Pixels that are regional minima retain their value. Regional minima are flat zones surrounded by pixels of higher value. A completely flat image will be marked as a regional minima by this filter. This code was contributed in the Insight Journal paper: "Finding regional extrema - methods and performance" by Beare R., Lehmann G. https://doi.org/10.54294/hva3gz Richard Beare. Department of Medicine, Monash University, Melbourne, Australia. See: ValuedRegionalMaximaImageFilter , ValuedRegionalExtremaImageFilter , HMinimaImageFilter itk::simple::ValuedRegionalMinima for the procedural interface itk::ValuedRegionalMinimaImageFilter for the Doxygen on the original ITK class. C++ includes: sitkValuedRegionalMinimaImageFilter.h

Field Summary

Fields inherited from class ProcessObject

swigCMemOwn

Modifier and Type	Field	Description
protected boolean	swigCMemOwn

Constructor Summary

Constructors

Modifier	Constructor	Description
	ValuedRegionalMinimaImageFilter()	itk::simple::ValuedRegionalMinimaImageFilter::ValuedRegionalMinimaImageFilter() Default Constructor that takes no arguments and initializes default parameters
protected	ValuedRegionalMinimaImageFilter(long cPtr, boolean cMemoryOwn)

Method Summary

Modifier and Type	Method	Description
void	delete()	virtual itk::simple::ValuedRegionalMinimaImageFilter::~ValuedRegionalMinimaImageFilter() Destructor
Image	execute(Image image1)	Image itk::simple::ValuedRegionalMinimaImageFilter::Execute(const Image &image1) Execute the filter on the input image
protected void	finalize()
void	fullyConnectedOff()	Self& itk::simple::ValuedRegionalMinimaImageFilter::FullyConnectedOff()
void	fullyConnectedOn()	Self& itk::simple::ValuedRegionalMinimaImageFilter::FullyConnectedOn() Set the value of FullyConnected to true or false respectfully.
protected static long	getCPtr(ValuedRegionalMinimaImageFilter obj)
boolean	getFlat()	bool itk::simple::ValuedRegionalMinimaImageFilter::GetFlat() const This is a measurement.
boolean	getFullyConnected()	bool itk::simple::ValuedRegionalMinimaImageFilter::GetFullyConnected() const
String	getName()	std::string itk::simple::ValuedRegionalMinimaImageFilter::GetName() const Name of this class
void	setFullyConnected(boolean FullyConnected)	Self& itk::simple::ValuedRegionalMinimaImageFilter::SetFullyConnected(bool FullyConnected)
protected static long	swigRelease(ValuedRegionalMinimaImageFilter obj)
String	toString()	std::string itk::simple::ValuedRegionalMinimaImageFilter::ToString() const Print ourselves out

Methods inherited from class ImageFilter

getCPtr, swigRelease

Modifier and Type	Method	Description
protected static long	getCPtr(ImageFilter obj)
protected static long	swigRelease(ImageFilter obj)

Methods inherited from class 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

Modifier and Type	Method	Description
void	abort()	virtual void itk::simple::ProcessObject::Abort() Sets an abort flag on the active process.
int	addCommand(EventEnum event, Command cmd)	virtual int itk::simple::ProcessObject::AddCommand(itk::simple::EventEnum event, itk::simple::Command &cmd) Add a Command Object to observer the event.
void	debugOff()
void	debugOn()
protected static long	getCPtr(ProcessObject obj)
boolean	getDebug()
static double	getGlobalDefaultCoordinateTolerance()
static boolean	getGlobalDefaultDebug()
static double	getGlobalDefaultDirectionTolerance()
static long	getGlobalDefaultNumberOfThreads()
static String	getGlobalDefaultThreader()
static boolean	getGlobalWarningDisplay()
long	getNumberOfThreads()
long	getNumberOfWorkUnits()
float	getProgress()	virtual float itk::simple::ProcessObject::GetProgress() const An Active Measurement of the progress of execution.
static void	globalDefaultDebugOff()
static void	globalDefaultDebugOn()
static void	globalWarningDisplayOff()
static void	globalWarningDisplayOn()
boolean	hasCommand(EventEnum event)	virtual bool itk::simple::ProcessObject::HasCommand(itk::simple::EventEnum event) const Query of this object has any registered commands for event.
void	removeAllCommands()	virtual void itk::simple::ProcessObject::RemoveAllCommands() Remove all registered commands.
void	setDebug(boolean debugFlag)
static void	setGlobalDefaultCoordinateTolerance(double arg0)
static void	setGlobalDefaultDebug(boolean debugFlag)
static void	setGlobalDefaultDirectionTolerance(double arg0)
static void	setGlobalDefaultNumberOfThreads(long n)
static boolean	setGlobalDefaultThreader(String threader)
static void	setGlobalWarningDisplay(boolean flag)
void	setNumberOfThreads(long n)
void	setNumberOfWorkUnits(long n)
protected static long	swigRelease(ProcessObject obj)

Methods inherited from class Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ValuedRegionalMinimaImageFilter

protected ValuedRegionalMinimaImageFilter(long cPtr,
 boolean cMemoryOwn)

ValuedRegionalMinimaImageFilter

public ValuedRegionalMinimaImageFilter()

itk::simple::ValuedRegionalMinimaImageFilter::ValuedRegionalMinimaImageFilter() Default Constructor that takes no arguments and initializes default parameters

Method Details

getCPtr

protected static long getCPtr(ValuedRegionalMinimaImageFilter obj)

swigRelease

protected static long swigRelease(ValuedRegionalMinimaImageFilter obj)

finalize

protected void finalize()

Overrides:

finalize in class ImageFilter

delete

public void delete()

virtual itk::simple::ValuedRegionalMinimaImageFilter::~ValuedRegionalMinimaImageFilter() Destructor

Overrides:

delete in class ImageFilter

setFullyConnected

public void setFullyConnected(boolean FullyConnected)

Self& itk::simple::ValuedRegionalMinimaImageFilter::SetFullyConnected(bool FullyConnected)

fullyConnectedOn

public void fullyConnectedOn()

Self& itk::simple::ValuedRegionalMinimaImageFilter::FullyConnectedOn() Set the value of FullyConnected to true or false respectfully.

fullyConnectedOff

public void fullyConnectedOff()

Self& itk::simple::ValuedRegionalMinimaImageFilter::FullyConnectedOff()

getFullyConnected

public boolean getFullyConnected()

bool itk::simple::ValuedRegionalMinimaImageFilter::GetFullyConnected() const

getFlat

public boolean getFlat()

bool itk::simple::ValuedRegionalMinimaImageFilter::GetFlat() const This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.

getName

public String getName()

std::string itk::simple::ValuedRegionalMinimaImageFilter::GetName() const Name of this class

Overrides:

getName in class ProcessObject

toString

public String toString()

std::string itk::simple::ValuedRegionalMinimaImageFilter::ToString() const Print ourselves out

Overrides:

toString in class ProcessObject

execute

public Image execute(Image image1)

Image itk::simple::ValuedRegionalMinimaImageFilter::Execute(const Image &image1) Execute the filter on the input image