Package org.itk.simple
Class GradientImageFilter
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.GradientImageFilter
Computes the gradient of an image using directional derivatives.
Computes the gradient of an image using directional derivatives. The
directional derivative at each pixel location is computed by
convolution with a first-order derivative operator.
The second template parameter defines the value type used in the
derivative operator (defaults to float). The third template parameter
defines the value type used for output image (defaults to float). The
output image is defined as a covariant vector image whose value type
is specified as this third template parameter.
See:
Image
Neighborhood
NeighborhoodOperator
NeighborhoodIterator
itk::simple::Gradient for the procedural interface
itk::GradientImageFilter for the Doxygen on the original ITK class.
C++ includes: sitkGradientImageFilter.h
-
Field Summary
Fields inherited from class org.itk.simple.ProcessObject
swigCMemOwn
-
Constructor Summary
ConstructorsModifierConstructorDescriptionitk::simple::GradientImageFilter::GradientImageFilter() Default Constructor that takes no arguments and initializes default parametersprotected
GradientImageFilter
(long cPtr, boolean cMemoryOwn) -
Method Summary
Modifier and TypeMethodDescriptionvoid
delete()
virtual itk::simple::GradientImageFilter::~GradientImageFilter() DestructorImage itk::simple::GradientImageFilter::Execute(const Image &image1) Execute the filter on the input imageprotected void
finalize()
protected static long
getName()
std::string itk::simple::GradientImageFilter::GetName() const Name of this classboolean
bool itk::simple::GradientImageFilter::GetUseImageDirection() const The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space.boolean
bool itk::simple::GradientImageFilter::GetUseImageSpacing() const Set/Get whether or not the filter will use the spacing of the input image in its calculations.void
setUseImageDirection
(boolean UseImageDirection) Self& itk::simple::GradientImageFilter::SetUseImageDirection(bool UseImageDirection) The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space.void
setUseImageSpacing
(boolean UseImageSpacing) Self& itk::simple::GradientImageFilter::SetUseImageSpacing(bool UseImageSpacing) Set/Get whether or not the filter will use the spacing of the input image in its calculations.protected static long
toString()
std::string itk::simple::GradientImageFilter::ToString() const Print ourselves outvoid
Self& itk::simple::GradientImageFilter::UseImageDirectionOff()void
Self& itk::simple::GradientImageFilter::UseImageDirectionOn() Set the value of UseImageDirection to true or false respectfully.void
Self& itk::simple::GradientImageFilter::UseImageSpacingOff()void
Self& itk::simple::GradientImageFilter::UseImageSpacingOn() Set the value of UseImageSpacing to true or false respectfully.Methods inherited from class org.itk.simple.ImageFilter
getCPtr, swigRelease
Methods inherited from class org.itk.simple.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
-
Constructor Details
-
GradientImageFilter
protected GradientImageFilter(long cPtr, boolean cMemoryOwn) -
GradientImageFilter
public GradientImageFilter()itk::simple::GradientImageFilter::GradientImageFilter() Default Constructor that takes no arguments and initializes default parameters
-
-
Method Details
-
getCPtr
-
swigRelease
-
finalize
protected void finalize()- Overrides:
finalize
in classImageFilter
-
delete
public void delete()virtual itk::simple::GradientImageFilter::~GradientImageFilter() Destructor- Overrides:
delete
in classImageFilter
-
setUseImageSpacing
public void setUseImageSpacing(boolean UseImageSpacing) Self& itk::simple::GradientImageFilter::SetUseImageSpacing(bool UseImageSpacing) Set/Get whether or not the filter will use the spacing of the input image in its calculations. Use On to take the image spacing information into account and to compute the derivatives in physical space; use Off to ignore the image spacing and to compute the derivatives in isotropic voxel space. Default is On. -
useImageSpacingOn
public void useImageSpacingOn()Self& itk::simple::GradientImageFilter::UseImageSpacingOn() Set the value of UseImageSpacing to true or false respectfully. -
useImageSpacingOff
public void useImageSpacingOff()Self& itk::simple::GradientImageFilter::UseImageSpacingOff() -
getUseImageSpacing
public boolean getUseImageSpacing()bool itk::simple::GradientImageFilter::GetUseImageSpacing() const Set/Get whether or not the filter will use the spacing of the input image in its calculations. Use On to take the image spacing information into account and to compute the derivatives in physical space; use Off to ignore the image spacing and to compute the derivatives in isotropic voxel space. Default is On. -
setUseImageDirection
public void setUseImageDirection(boolean UseImageDirection) Self& itk::simple::GradientImageFilter::SetUseImageDirection(bool UseImageDirection) The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On. -
useImageDirectionOn
public void useImageDirectionOn()Self& itk::simple::GradientImageFilter::UseImageDirectionOn() Set the value of UseImageDirection to true or false respectfully. -
useImageDirectionOff
public void useImageDirectionOff()Self& itk::simple::GradientImageFilter::UseImageDirectionOff() -
getUseImageDirection
public boolean getUseImageDirection()bool itk::simple::GradientImageFilter::GetUseImageDirection() const The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On. -
getName
std::string itk::simple::GradientImageFilter::GetName() const Name of this class- Overrides:
getName
in classProcessObject
-
toString
std::string itk::simple::GradientImageFilter::ToString() const Print ourselves out- Overrides:
toString
in classProcessObject
-
execute
Image itk::simple::GradientImageFilter::Execute(const Image &image1) Execute the filter on the input image
-