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

Computes the square root of the sum of squares of corresponding input pixels. More...

#include <sitkBinaryMagnitudeImageFilter.h>

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

Public Types

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

Public Member Functions

 BinaryMagnitudeImageFilter ()
Image Execute (const Image &image1, const Image &image2)
std::string GetName () const
std::string ToString () const
 ~BinaryMagnitudeImageFilter ()
- Public Member Functions inherited from itk::simple::ImageFilter< 2 >
 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, const Image &image2)

Private Member Functions

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

Private Attributes

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


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) throw ()
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< 2 >
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 square root of the sum of squares of corresponding input pixels.

This filter is templated over the types of the two input images and the type of the output image.

Numeric conversions (castings) are done by the C++ defaults.

The filter walks over all of the pixels in the two input images, and for each pixel does the following:

The filter expects all images to have the same dimension (e.g. all 2D, or all 3D, or all ND)

See also
itk::simple::BinaryMagnitude for the procedural interface
itk::BinaryMagnitudeImageFilter for the Doxygen on the original ITK class.

Definition at line 62 of file sitkBinaryMagnitudeImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::BinaryMagnitudeImageFilter::MemberFunctionType) (const Image &image1, const Image &image2)

Setup for member function dispatching

Definition at line 93 of file sitkBinaryMagnitudeImageFilter.h.

Define the pixels types supported by this filter

Definition at line 74 of file sitkBinaryMagnitudeImageFilter.h.

Definition at line 64 of file sitkBinaryMagnitudeImageFilter.h.

Constructor & Destructor Documentation

itk::simple::BinaryMagnitudeImageFilter::BinaryMagnitudeImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

itk::simple::BinaryMagnitudeImageFilter::~BinaryMagnitudeImageFilter ( )


Member Function Documentation

Image itk::simple::BinaryMagnitudeImageFilter::Execute ( const Image image1,
const Image image2 

Execute the filter on the input images

template<class TImageType >
Image itk::simple::BinaryMagnitudeImageFilter::ExecuteInternal ( const Image image1,
const Image image2 
std::string itk::simple::BinaryMagnitudeImageFilter::GetName ( ) const

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 78 of file sitkBinaryMagnitudeImageFilter.h.

std::string itk::simple::BinaryMagnitudeImageFilter::ToString ( ) const

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 98 of file sitkBinaryMagnitudeImageFilter.h.

Member Data Documentation

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::BinaryMagnitudeImageFilter::m_MemberFactory

Definition at line 100 of file sitkBinaryMagnitudeImageFilter.h.

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