SimpleITK  2.1.0.dev86
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::GradientImageFilter Class Reference

Computes the gradient of an image using directional derivatives. More...

#include <sitkGradientImageFilter.h>

+ Inheritance diagram for itk::simple::GradientImageFilter:
+ Collaboration diagram for itk::simple::GradientImageFilter:

Public Types

using PixelIDTypeList = BasicPixelIDTypeList
 
using Self = GradientImageFilter
 
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

Image Execute (const Image &image1)
 
std::string GetName () const
 
bool GetUseImageDirection () const
 
bool GetUseImageSpacing () const
 
 GradientImageFilter ()
 
SelfSetUseImageDirection (bool UseImageDirection)
 
SelfSetUseImageSpacing (bool UseImageSpacing)
 
std::string ToString () const
 
SelfUseImageDirectionOff ()
 
SelfUseImageDirectionOn ()
 
SelfUseImageSpacingOff ()
 
SelfUseImageSpacingOn ()
 
virtual ~GradientImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
 Directly add a callback to observe an event. More...
 
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
 
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
 
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 
 ProcessObject ()
 
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
 
virtual ~ProcessObject ()
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
virtual bool GetDebug () const
 
virtual void SetDebug (bool debugFlag)
 
virtual void SetNumberOfThreads (unsigned int n)
 
virtual unsigned int GetNumberOfThreads () const
 
virtual void SetNumberOfWorkUnits (unsigned int n)
 
virtual unsigned int GetNumberOfWorkUnits () const
 

Private Types

using MemberFunctionType = Image(Self::*)(const Image &image1)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image &image1)
 

Private Attributes

std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
bool m_UseImageDirection {false}
 
bool m_UseImageSpacing {true}
 

Friends

struct detail::MemberFunctionAddressor< MemberFunctionType >
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::simple::ProcessObject
static bool GetGlobalDefaultDebug ()
 
static void GlobalDefaultDebugOff ()
 
static void GlobalDefaultDebugOn ()
 
static void SetGlobalDefaultDebug (bool debugFlag)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static void SetGlobalWarningDisplay (bool flag)
 
static bool GetGlobalWarningDisplay ()
 
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
 
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
 
- Protected Member Functions inherited from itk::simple::ImageFilter
void CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
 
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
 
virtual itk::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) noexcept
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()=default
 
 NonCopyable (const NonCopyable &)=delete
 
NonCopyableoperator= (const NonCopyable &)=delete
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
static void FixNonZeroIndex (TImageType *img)
 
- Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer CastImageToITK (const Image &img)
 
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
 
template<class TImageType >
static Image CastITKToImage (TImageType *img)
 
static const itk::EventObjectGetITKEventObject (EventEnum e)
 
template<typename T >
static std::ostream & ToStringHelper (std::ostream &os, const T &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const signed char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const unsigned char &v)
 

Detailed Description

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 also
Image
Neighborhood
NeighborhoodOperator
NeighborhoodIterator
itk::simple::Gradient for the procedural interface
itk::GradientImageFilter for the Doxygen on the original ITK class.

Definition at line 55 of file sitkGradientImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::GradientImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )
private

Setup for member function dispatching

Definition at line 112 of file sitkGradientImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 67 of file sitkGradientImageFilter.h.

◆ Self

Definition at line 57 of file sitkGradientImageFilter.h.

Constructor & Destructor Documentation

◆ ~GradientImageFilter()

virtual itk::simple::GradientImageFilter::~GradientImageFilter ( )
virtual

Destructor

◆ GradientImageFilter()

itk::simple::GradientImageFilter::GradientImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

Image itk::simple::GradientImageFilter::Execute ( const Image image1)

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::GradientImageFilter::ExecuteInternal ( const Image image1)
private

◆ GetName()

std::string itk::simple::GradientImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 98 of file sitkGradientImageFilter.h.

◆ GetUseImageDirection()

bool itk::simple::GradientImageFilter::GetUseImageDirection ( ) const
inline

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.

Definition at line 95 of file sitkGradientImageFilter.h.

◆ GetUseImageSpacing()

bool itk::simple::GradientImageFilter::GetUseImageSpacing ( ) const
inline

Definition at line 81 of file sitkGradientImageFilter.h.

◆ SetUseImageDirection()

Self& itk::simple::GradientImageFilter::SetUseImageDirection ( bool  UseImageDirection)
inline

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.

Definition at line 86 of file sitkGradientImageFilter.h.

◆ SetUseImageSpacing()

Self& itk::simple::GradientImageFilter::SetUseImageSpacing ( bool  UseImageSpacing)
inline

Set/Get whether or not the filter will use the spacing of the input image in its calculations

Definition at line 73 of file sitkGradientImageFilter.h.

◆ ToString()

std::string itk::simple::GradientImageFilter::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

◆ UseImageDirectionOff()

Self& itk::simple::GradientImageFilter::UseImageDirectionOff ( )
inline

Definition at line 90 of file sitkGradientImageFilter.h.

◆ UseImageDirectionOn()

Self& itk::simple::GradientImageFilter::UseImageDirectionOn ( )
inline

Set the value of UseImageDirection to true or false respectfully.

Definition at line 89 of file sitkGradientImageFilter.h.

◆ UseImageSpacingOff()

Self& itk::simple::GradientImageFilter::UseImageSpacingOff ( )
inline

Definition at line 77 of file sitkGradientImageFilter.h.

◆ UseImageSpacingOn()

Self& itk::simple::GradientImageFilter::UseImageSpacingOn ( )
inline

Set the value of UseImageSpacing to true or false respectfully.

Definition at line 76 of file sitkGradientImageFilter.h.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 116 of file sitkGradientImageFilter.h.

Member Data Documentation

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::GradientImageFilter::m_MemberFactory
private

Definition at line 118 of file sitkGradientImageFilter.h.

◆ m_UseImageDirection

bool itk::simple::GradientImageFilter::m_UseImageDirection {false}
private

Definition at line 123 of file sitkGradientImageFilter.h.

◆ m_UseImageSpacing

bool itk::simple::GradientImageFilter::m_UseImageSpacing {true}
private

Definition at line 121 of file sitkGradientImageFilter.h.


The documentation for this class was generated from the following file: