Class MaskedAssignImageFilter

java.lang.Object

org.itk.simple.ProcessObject

org.itk.simple.ImageFilter

org.itk.simple.MaskedAssignImageFilter

public class MaskedAssignImageFilter
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::MaskedAssign for the procedural interface itk::MaskedAssignImageFilter for the Doxygen on the original ITK class. C++ includes: sitkMaskedAssignImageFilter.h

Field Summary

Fields inherited from class ProcessObject

swigCMemOwn

Modifier and Type	Field	Description
protected boolean	swigCMemOwn

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	delete()	virtual itk::simple::MaskedAssignImageFilter::~MaskedAssignImageFilter() Destructor
Image	execute(Image image, Image maskImage)	Image itk::simple::MaskedAssignImageFilter::Execute(Image &&image, const Image &maskImage, const Image &assignImage) Execute the filter on the input image
Image	execute(Image image, Image maskImage, Image assignImage)	Image itk::simple::MaskedAssignImageFilter::Execute(Image &&image, const Image &maskImage, const Image &assignImage) Execute the filter on the input image
protected void	finalize()
double	getAssignConstant()	double itk::simple::MaskedAssignImageFilter::GetAssignConstant() const
protected static long	getCPtr(MaskedAssignImageFilter obj)
String	getName()	std::string itk::simple::MaskedAssignImageFilter::GetName() const Name of this class
void	setAssignConstant(double AssignConstant)	Self& itk::simple::MaskedAssignImageFilter::SetAssignConstant(double AssignConstant) Method to explicitly set the outside value of the mask when AssignImage is undefined.
protected static long	swigRelease(MaskedAssignImageFilter obj)
String	toString()	std::string itk::simple::MaskedAssignImageFilter::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

MaskedAssignImageFilter

protected MaskedAssignImageFilter(long cPtr,
 boolean cMemoryOwn)

MaskedAssignImageFilter

public MaskedAssignImageFilter()

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

Method Details

getCPtr

protected static long getCPtr(MaskedAssignImageFilter obj)

swigRelease

protected static long swigRelease(MaskedAssignImageFilter obj)

finalize

protected void finalize()

Overrides:

finalize in class ImageFilter

delete

public void delete()

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

Overrides:

delete in class ImageFilter

setAssignConstant

public void setAssignConstant(double AssignConstant)

Self& itk::simple::MaskedAssignImageFilter::SetAssignConstant(double AssignConstant) Method to explicitly set the outside value of the mask when AssignImage is undefined. Defaults to 0

getAssignConstant

public double getAssignConstant()

double itk::simple::MaskedAssignImageFilter::GetAssignConstant() const

getName

public String getName()

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

Overrides:

getName in class ProcessObject

toString

public String toString()

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

Overrides:

toString in class ProcessObject

execute

public Image execute(Image image,
 Image maskImage,
 Image assignImage)

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

execute

public Image execute(Image image,
 Image maskImage)

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