SimpleITK  1.2.4
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::GradientMagnitudeImageFilter Class Reference

Computes the gradient magnitude of an image region at each pixel. More...

#include <sitkGradientMagnitudeImageFilter.h>

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

Public Types

typedef BasicPixelIDTypeList PixelIDTypeList
 
typedef GradientMagnitudeImageFilter Self
 
- Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

Image Execute (const Image &image1)
 
Image Execute (const Image &image1, bool useImageSpacing)
 
std::string GetName () const
 
bool GetUseImageSpacing () const
 
 GradientMagnitudeImageFilter ()
 
SelfSetUseImageSpacing (bool UseImageSpacing)
 
std::string ToString () const
 
SelfUseImageSpacingOff ()
 
SelfUseImageSpacingOn ()
 
virtual ~GradientMagnitudeImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter< 1 >
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
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
 

Private Types

typedef Image(Self::* MemberFunctionType) (const Image &image1)
 

Private Member Functions

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

Private Attributes

nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
bool m_UseImageSpacing
 

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 void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 
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...
 
- 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) SITK_NOEXCEPT
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
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 TImageType >
static Image CastITKToImage (TImageType *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)
 
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 magnitude of an image region at each pixel.

See also
Image
Neighborhood
NeighborhoodOperator
NeighborhoodIterator
itk::simple::GradientMagnitude for the procedural interface
itk::GradientMagnitudeImageFilter for the Doxygen on the original ITK class.

Definition at line 48 of file sitkGradientMagnitudeImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::GradientMagnitudeImageFilter::MemberFunctionType) (const Image &image1)
private

Setup for member function dispatching

Definition at line 95 of file sitkGradientMagnitudeImageFilter.h.

Define the pixels types supported by this filter

Definition at line 60 of file sitkGradientMagnitudeImageFilter.h.

Definition at line 50 of file sitkGradientMagnitudeImageFilter.h.

Constructor & Destructor Documentation

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

Destructor

itk::simple::GradientMagnitudeImageFilter::GradientMagnitudeImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input image

Image itk::simple::GradientMagnitudeImageFilter::Execute ( const Image image1,
bool  useImageSpacing 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::GradientMagnitudeImageFilter::ExecuteInternal ( const Image image1)
private
std::string itk::simple::GradientMagnitudeImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 78 of file sitkGradientMagnitudeImageFilter.h.

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

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

Definition at line 76 of file sitkGradientMagnitudeImageFilter.h.

Self& itk::simple::GradientMagnitudeImageFilter::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 67 of file sitkGradientMagnitudeImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

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

Definition at line 71 of file sitkGradientMagnitudeImageFilter.h.

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

Set the value of UseImageSpacing to true or false respectfully.

Definition at line 70 of file sitkGradientMagnitudeImageFilter.h.

Friends And Related Function Documentation

Definition at line 99 of file sitkGradientMagnitudeImageFilter.h.

Member Data Documentation

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::GradientMagnitudeImageFilter::m_MemberFactory
private

Definition at line 101 of file sitkGradientMagnitudeImageFilter.h.

bool itk::simple::GradientMagnitudeImageFilter::m_UseImageSpacing
private

Definition at line 104 of file sitkGradientMagnitudeImageFilter.h.


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