Class GradientMagnitudeImageFilter

java.lang.Object

org.itk.simple.ProcessObject

org.itk.simple.ImageFilter

org.itk.simple.GradientMagnitudeImageFilter

public class GradientMagnitudeImageFilter
extends ImageFilter

Computes the gradient magnitude of an image region at each pixel. See: Image Neighborhood NeighborhoodOperator NeighborhoodIterator itk::simple::GradientMagnitude for the procedural interface itk::GradientMagnitudeImageFilter for the Doxygen on the original ITK class. C++ includes: sitkGradientMagnitudeImageFilter.h

Field Summary

Fields inherited from class ProcessObject

swigCMemOwn

Modifier and Type	Field	Description
protected boolean	swigCMemOwn

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	delete()	virtual itk::simple::GradientMagnitudeImageFilter::~GradientMagnitudeImageFilter() Destructor
Image	execute(Image image1)	Image itk::simple::GradientMagnitudeImageFilter::Execute(const Image &image1) Execute the filter on the input image
protected void	finalize()
protected static long	getCPtr(GradientMagnitudeImageFilter obj)
String	getName()	std::string itk::simple::GradientMagnitudeImageFilter::GetName() const Name of this class
boolean	getUseImageSpacing()	bool itk::simple::GradientMagnitudeImageFilter::GetUseImageSpacing() const Set/Get whether or not the filter will use the spacing of the input image in the computation of the derivatives.
void	setUseImageSpacing(boolean UseImageSpacing)	Self& itk::simple::GradientMagnitudeImageFilter::SetUseImageSpacing(bool UseImageSpacing) Set/Get whether or not the filter will use the spacing of the input image in the computation of the derivatives.
protected static long	swigRelease(GradientMagnitudeImageFilter obj)
String	toString()	std::string itk::simple::GradientMagnitudeImageFilter::ToString() const Print ourselves out
void	useImageSpacingOff()	Self& itk::simple::GradientMagnitudeImageFilter::UseImageSpacingOff()
void	useImageSpacingOn()	Self& itk::simple::GradientMagnitudeImageFilter::UseImageSpacingOn() Set the value of UseImageSpacing to true or false respectfully.

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

GradientMagnitudeImageFilter

protected GradientMagnitudeImageFilter(long cPtr,
 boolean cMemoryOwn)

GradientMagnitudeImageFilter

public GradientMagnitudeImageFilter()

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

Method Details

getCPtr

protected static long getCPtr(GradientMagnitudeImageFilter obj)

swigRelease

protected static long swigRelease(GradientMagnitudeImageFilter obj)

finalize

protected void finalize()

Overrides:

finalize in class ImageFilter

delete

public void delete()

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

Overrides:

delete in class ImageFilter

setUseImageSpacing

public void setUseImageSpacing(boolean UseImageSpacing)

Self& itk::simple::GradientMagnitudeImageFilter::SetUseImageSpacing(bool UseImageSpacing) Set/Get whether or not the filter will use the spacing of the input image in the computation of the derivatives. Use On to compute the gradient in physical space; use Off to ignore image spacing and to compute the gradient in isotropic voxel space. Default is On.

useImageSpacingOn

public void useImageSpacingOn()

Self& itk::simple::GradientMagnitudeImageFilter::UseImageSpacingOn() Set the value of UseImageSpacing to true or false respectfully.

useImageSpacingOff

public void useImageSpacingOff()

Self& itk::simple::GradientMagnitudeImageFilter::UseImageSpacingOff()

getUseImageSpacing

public boolean getUseImageSpacing()

bool itk::simple::GradientMagnitudeImageFilter::GetUseImageSpacing() const Set/Get whether or not the filter will use the spacing of the input image in the computation of the derivatives. Use On to compute the gradient in physical space; use Off to ignore image spacing and to compute the gradient in isotropic voxel space. Default is On.

getName

public String getName()

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

Overrides:

getName in class ProcessObject

toString

public String toString()

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

Overrides:

toString in class ProcessObject

execute

public Image execute(Image image1)

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