SimpleITK  2.0.0rc2.post23
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::GradientRecursiveGaussianImageFilter Class Reference

Computes the gradient of an image by convolution with the first derivative of a Gaussian. More...

#include <sitkGradientRecursiveGaussianImageFilter.h>

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

Public Types

using PixelIDTypeList = typelist::Append< BasicPixelIDTypeList, VectorPixelIDTypeList >::Type
 
using Self = GradientRecursiveGaussianImageFilter
 
- 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 GetNormalizeAcrossScale () const
 
double GetSigma () const
 
bool GetUseImageDirection () const
 
 GradientRecursiveGaussianImageFilter ()
 
SelfNormalizeAcrossScaleOff ()
 
SelfNormalizeAcrossScaleOn ()
 
SelfSetNormalizeAcrossScale (bool NormalizeAcrossScale)
 
SelfSetSigma (double Sigma)
 
SelfSetUseImageDirection (bool UseImageDirection)
 
std::string ToString () const
 
SelfUseImageDirectionOff ()
 
SelfUseImageDirectionOn ()
 
virtual ~GradientRecursiveGaussianImageFilter ()
 
- 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_NormalizeAcrossScale {false}
 
double m_Sigma {1.0}
 
bool m_UseImageDirection {false}
 

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 by convolution with the first derivative of a Gaussian.

This filter is implemented using the recursive gaussian filters.

This filter supports both scalar and vector pixel types within the input image, including VectorImage type.

See also
itk::simple::GradientRecursiveGaussian for the procedural interface
itk::GradientRecursiveGaussianImageFilter for the Doxygen on the original ITK class.

Definition at line 44 of file sitkGradientRecursiveGaussianImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 111 of file sitkGradientRecursiveGaussianImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 56 of file sitkGradientRecursiveGaussianImageFilter.h.

◆ Self

Definition at line 46 of file sitkGradientRecursiveGaussianImageFilter.h.

Constructor & Destructor Documentation

◆ ~GradientRecursiveGaussianImageFilter()

virtual itk::simple::GradientRecursiveGaussianImageFilter::~GradientRecursiveGaussianImageFilter ( )
virtual

Destructor

◆ GradientRecursiveGaussianImageFilter()

itk::simple::GradientRecursiveGaussianImageFilter::GradientRecursiveGaussianImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 97 of file sitkGradientRecursiveGaussianImageFilter.h.

◆ GetNormalizeAcrossScale()

bool itk::simple::GradientRecursiveGaussianImageFilter::GetNormalizeAcrossScale ( ) const
inline

Define which normalization factor will be used for the Gaussian

See also
RecursiveGaussianImageFilter::SetNormalizeAcrossScale

Definition at line 80 of file sitkGradientRecursiveGaussianImageFilter.h.

◆ GetSigma()

double itk::simple::GradientRecursiveGaussianImageFilter::GetSigma ( ) const
inline

Definition at line 66 of file sitkGradientRecursiveGaussianImageFilter.h.

◆ GetUseImageDirection()

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

The UseImageDirection flag determines whether the gradients are computed with respect to the image grid or with respect to the physical space. When this flag is ON the gradients 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 94 of file sitkGradientRecursiveGaussianImageFilter.h.

◆ NormalizeAcrossScaleOff()

Self& itk::simple::GradientRecursiveGaussianImageFilter::NormalizeAcrossScaleOff ( )
inline

Definition at line 75 of file sitkGradientRecursiveGaussianImageFilter.h.

◆ NormalizeAcrossScaleOn()

Self& itk::simple::GradientRecursiveGaussianImageFilter::NormalizeAcrossScaleOn ( )
inline

Set the value of NormalizeAcrossScale to true or false respectfully.

Definition at line 74 of file sitkGradientRecursiveGaussianImageFilter.h.

◆ SetNormalizeAcrossScale()

Self& itk::simple::GradientRecursiveGaussianImageFilter::SetNormalizeAcrossScale ( bool  NormalizeAcrossScale)
inline

Define which normalization factor will be used for the Gaussian

See also
RecursiveGaussianImageFilter::SetNormalizeAcrossScale

Definition at line 71 of file sitkGradientRecursiveGaussianImageFilter.h.

◆ SetSigma()

Self& itk::simple::GradientRecursiveGaussianImageFilter::SetSigma ( double  Sigma)
inline

Set Sigma value. Sigma is measured in the units of image spacing.

Definition at line 62 of file sitkGradientRecursiveGaussianImageFilter.h.

◆ SetUseImageDirection()

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

The UseImageDirection flag determines whether the gradients are computed with respect to the image grid or with respect to the physical space. When this flag is ON the gradients 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 85 of file sitkGradientRecursiveGaussianImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

◆ UseImageDirectionOff()

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

Definition at line 89 of file sitkGradientRecursiveGaussianImageFilter.h.

◆ UseImageDirectionOn()

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

Set the value of UseImageDirection to true or false respectfully.

Definition at line 88 of file sitkGradientRecursiveGaussianImageFilter.h.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 115 of file sitkGradientRecursiveGaussianImageFilter.h.

Member Data Documentation

◆ m_MemberFactory

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

Definition at line 117 of file sitkGradientRecursiveGaussianImageFilter.h.

◆ m_NormalizeAcrossScale

bool itk::simple::GradientRecursiveGaussianImageFilter::m_NormalizeAcrossScale {false}
private

Definition at line 124 of file sitkGradientRecursiveGaussianImageFilter.h.

◆ m_Sigma

double itk::simple::GradientRecursiveGaussianImageFilter::m_Sigma {1.0}
private

Definition at line 121 of file sitkGradientRecursiveGaussianImageFilter.h.

◆ m_UseImageDirection

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

Definition at line 126 of file sitkGradientRecursiveGaussianImageFilter.h.


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