Class BoxMeanImageFilter

java.lang.Object

org.itk.simple.ProcessObject

org.itk.simple.ImageFilter

org.itk.simple.BoxMeanImageFilter

public class BoxMeanImageFilter
extends ImageFilter

Implements a fast rectangular mean filter using the accumulator approach. 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 Richard Beare See: itk::simple::BoxMean for the procedural interface itk::BoxMeanImageFilter for the Doxygen on the original ITK class. C++ includes: sitkBoxMeanImageFilter.h

Field Summary

Fields inherited from class ProcessObject

swigCMemOwn

Modifier and Type	Field	Description
protected boolean	swigCMemOwn

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	delete()	virtual itk::simple::BoxMeanImageFilter::~BoxMeanImageFilter() Destructor
Image	execute(Image image1)	Image itk::simple::BoxMeanImageFilter::Execute(const Image &image1) Execute the filter on the input image
protected void	finalize()
protected static long	getCPtr(BoxMeanImageFilter obj)
String	getName()	std::string itk::simple::BoxMeanImageFilter::GetName() const Name of this class
VectorUInt32	getRadius()	std::vector<unsigned int> itk::simple::BoxMeanImageFilter::GetRadius() const
void	setRadius(long value)	Self& itk::simple::BoxMeanImageFilter::SetRadius(unsigned int value) Set the values of the Radius vector all to value
void	setRadius(VectorUInt32 Radius)	Self& itk::simple::BoxMeanImageFilter::SetRadius(unsigned int value) Set the values of the Radius vector all to value
protected static long	swigRelease(BoxMeanImageFilter obj)
String	toString()	std::string itk::simple::BoxMeanImageFilter::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

BoxMeanImageFilter

protected BoxMeanImageFilter(long cPtr,
 boolean cMemoryOwn)

BoxMeanImageFilter

public BoxMeanImageFilter()

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

Method Details

getCPtr

protected static long getCPtr(BoxMeanImageFilter obj)

swigRelease

protected static long swigRelease(BoxMeanImageFilter obj)

finalize

protected void finalize()

Overrides:

finalize in class ImageFilter

delete

public void delete()

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

Overrides:

delete in class ImageFilter

setRadius

public void setRadius(VectorUInt32 Radius)

Self& itk::simple::BoxMeanImageFilter::SetRadius(unsigned int value) Set the values of the Radius vector all to value

setRadius

public void setRadius(long value)

Self& itk::simple::BoxMeanImageFilter::SetRadius(unsigned int value) Set the values of the Radius vector all to value

getRadius

public VectorUInt32 getRadius()

std::vector<unsigned int> itk::simple::BoxMeanImageFilter::GetRadius() const

getName

public String getName()

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

Overrides:

getName in class ProcessObject

toString

public String toString()

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

Overrides:

toString in class ProcessObject

execute

public Image execute(Image image1)

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