SimpleITK  1.3.0.dev466
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::PowImageFilter Class Reference

Computes the powers of 2 images. More...

#include <sitkPowImageFilter.h>

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

Public Types

typedef typelist::Append< BasicPixelIDTypeList, ComplexPixelIDTypeList >::Type PixelIDTypeList
 
typedef PowImageFilter 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

Image Execute (const Image &image1, const Image &image2)
 
Image Execute (const Image &image1, double constant)
 
Image Execute (double constant, const Image &image2)
 
std::string GetName () const
 
 PowImageFilter ()
 
std::string ToString () const
 
virtual ~PowImageFilter ()
 
- 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::* MemberFunction1Type) (double constant, const Image &image2)
 
typedef Image(Self::* MemberFunction2Type) (const Image &image1, double constant)
 
typedef Image(Self::* MemberFunctionType) (const Image &image1, const Image &image2)
 

Private Member Functions

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

Private Attributes

nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunction1Type > > m_MemberFactory1
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunction2Type > > m_MemberFactory2
 

Friends

struct detail::MemberFunctionAddressor< MemberFunction1Type >
 
struct detail::MemberFunctionAddressor< MemberFunction2Type >
 
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< 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 powers of 2 images.

This class 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 output of the pow function will be cast to the pixel type of the output image.

The total operation over one pixel will be

output_pixel = static_cast< TOutput >( std::pow(static_cast<RealType>(A),static_cast<RealType>(B)) );

The pow function can be applied to two images with the following:

SetInput1( image1 );
SetInput2( image2 );

Additionally, this filter can be used to raise every pixel of an image to a power of a constant by using

SetInput1( image1 );
SetConstant2( constant );
See also
itk::simple::Pow for the procedural interface
itk::PowImageFilter for the Doxygen on the original ITK class.

Definition at line 63 of file sitkPowImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::PowImageFilter::MemberFunction1Type) (double constant, const Image &image2)
private

Definition at line 105 of file sitkPowImageFilter.h.

typedef Image(Self::* itk::simple::PowImageFilter::MemberFunction2Type) (const Image &image1, double constant)
private

Definition at line 110 of file sitkPowImageFilter.h.

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

Setup for member function dispatching

Definition at line 98 of file sitkPowImageFilter.h.

Define the pixels types supported by this filter

Definition at line 75 of file sitkPowImageFilter.h.

Definition at line 65 of file sitkPowImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::PowImageFilter::~PowImageFilter ( )
virtual

Destructor

itk::simple::PowImageFilter::PowImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::PowImageFilter::Execute ( const Image image1,
const Image image2 
)

Execute the filter on the input images

Image itk::simple::PowImageFilter::Execute ( const Image image1,
double  constant 
)

Execute the filter with an image and a constant

Image itk::simple::PowImageFilter::Execute ( double  constant,
const Image image2 
)
template<class TImageType >
Image itk::simple::PowImageFilter::ExecuteInternal ( const Image image1,
const Image image2 
)
private
template<class TImageType >
Image itk::simple::PowImageFilter::ExecuteInternal ( double  constant,
const Image image2 
)
private
template<class TImageType >
Image itk::simple::PowImageFilter::ExecuteInternal ( const Image image1,
double  constant 
)
private
std::string itk::simple::PowImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 79 of file sitkPowImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 107 of file sitkPowImageFilter.h.

Definition at line 112 of file sitkPowImageFilter.h.

Definition at line 102 of file sitkPowImageFilter.h.

Member Data Documentation

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

Definition at line 104 of file sitkPowImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunction1Type> > itk::simple::PowImageFilter::m_MemberFactory1
private

Definition at line 108 of file sitkPowImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunction2Type> > itk::simple::PowImageFilter::m_MemberFactory2
private

Definition at line 113 of file sitkPowImageFilter.h.


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