Class MaskImageFilter

java.lang.Object

org.itk.simple.ProcessObject

org.itk.simple.ImageFilter

org.itk.simple.MaskImageFilter

public class MaskImageFilter
extends ImageFilter

Mask an image with a mask. This class is templated over the types of the input image type, the mask image type and the type of the output image. Numeric conversions (castings) are done by the C++ defaults. The pixel type of the input 2 image must have a valid definition of the operator != with zero. This condition is required because internally this filter will perform the operation The pixel from the input 1 is cast to the pixel type of the output image. Note that the input and the mask images must be of the same size. WARNING: Any pixel value other than masking value (0 by default) will not be masked out. See: MaskNegatedImageFilter itk::simple::Mask for the procedural interface itk::MaskImageFilter for the Doxygen on the original ITK class. C++ includes: sitkMaskImageFilter.h

Field Summary

Fields inherited from class ProcessObject

swigCMemOwn

Modifier and Type	Field	Description
protected boolean	swigCMemOwn

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	delete()	virtual itk::simple::MaskImageFilter::~MaskImageFilter() Destructor
Image	execute(Image image, Image maskImage)	Image itk::simple::MaskImageFilter::Execute(Image &&image, const Image &maskImage) Execute the filter on the input image
protected void	finalize()
protected static long	getCPtr(MaskImageFilter obj)
double	getMaskingValue()	double itk::simple::MaskImageFilter::GetMaskingValue() const Method to get the masking value of the mask.
String	getName()	std::string itk::simple::MaskImageFilter::GetName() const Name of this class
double	getOutsideValue()	double itk::simple::MaskImageFilter::GetOutsideValue() const
void	setMaskingValue(double MaskingValue)	Self& itk::simple::MaskImageFilter::SetMaskingValue(double MaskingValue) Method to explicitly set the masking value of the mask.
void	setOutsideValue(double OutsideValue)	Self& itk::simple::MaskImageFilter::SetOutsideValue(double OutsideValue) Method to explicitly set the outside value of the mask.
protected static long	swigRelease(MaskImageFilter obj)
String	toString()	std::string itk::simple::MaskImageFilter::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

MaskImageFilter

protected MaskImageFilter(long cPtr,
 boolean cMemoryOwn)

MaskImageFilter

public MaskImageFilter()

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

Method Details

getCPtr

protected static long getCPtr(MaskImageFilter obj)

swigRelease

protected static long swigRelease(MaskImageFilter obj)

finalize

protected void finalize()

Overrides:

finalize in class ImageFilter

delete

public void delete()

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

Overrides:

delete in class ImageFilter

setOutsideValue

public void setOutsideValue(double OutsideValue)

Self& itk::simple::MaskImageFilter::SetOutsideValue(double OutsideValue) Method to explicitly set the outside value of the mask. Defaults to 0

getOutsideValue

public double getOutsideValue()

double itk::simple::MaskImageFilter::GetOutsideValue() const

setMaskingValue

public void setMaskingValue(double MaskingValue)

Self& itk::simple::MaskImageFilter::SetMaskingValue(double MaskingValue) Method to explicitly set the masking value of the mask. Defaults to 0

getMaskingValue

public double getMaskingValue()

double itk::simple::MaskImageFilter::GetMaskingValue() const Method to get the masking value of the mask.

getName

public String getName()

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

Overrides:

getName in class ProcessObject

toString

public String toString()

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

Overrides:

toString in class ProcessObject

execute

public Image execute(Image image,
 Image maskImage)

Image itk::simple::MaskImageFilter::Execute(Image &&image, const Image &maskImage) Execute the filter on the input image