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

Computes the pixel-wise maximum of several images. More...

#include <sitkNaryMaximumImageFilter.h>

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

Public Types

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

Public Member Functions

Image Execute (const std::vector< Image > &images)
 
Image Execute (const Image &image1)
 
Image Execute (const Image &image1, const Image &image2)
 
Image Execute (const Image &image1, const Image &image2, const Image &image3)
 
Image Execute (const Image &image1, const Image &image2, const Image &image3, const Image &image4)
 
Image Execute (const Image &image1, const Image &image2, const Image &image3, const Image &image4, const Image &image5)
 
std::string GetName () const
 
 NaryMaximumImageFilter ()
 
std::string ToString () const
 
virtual ~NaryMaximumImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter< 3 >
 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 std::vector< Image > &)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const std::vector< Image > &images)
 

Private Attributes

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

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< 3 >
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 pixel-wise maximum of several images.

This class is templated over the types of the input images and the type of the output image. Numeric conversions (castings) are done by the C++ defaults.

The pixel type of the output images must have a valid definition of the operator<. This condition is required because internally this filter will perform an operation similar to:

const OutputPixelType query_value = static_cast<OutputPixelType>(pixel_from_input_n);
if(current_maximum < query_value)
{
current_maximum = query_value;
}

(where current_maximum is also of type OutputPixelType)

for each of the n input images.

For example, this filter could be used directly to find a "maximum projection" of a series of images, often used in preliminary analysis of time-series data.

Author
Zachary Pincus

This filter was contributed by Zachary Pincus from the Department of Biochemistry and Program in Biomedical Informatics at Stanford University School of Medicine

See also
itk::simple::NaryMaximum for the procedural interface

Definition at line 67 of file sitkNaryMaximumImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::NaryMaximumImageFilter::MemberFunctionType) (const std::vector< Image > &)
private

Setup for member function dispatching

Definition at line 109 of file sitkNaryMaximumImageFilter.h.

Define the pixels types supported by this filter

Definition at line 82 of file sitkNaryMaximumImageFilter.h.

Definition at line 71 of file sitkNaryMaximumImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::NaryMaximumImageFilter::~NaryMaximumImageFilter ( )
virtual

Destructor

itk::simple::NaryMaximumImageFilter::NaryMaximumImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::NaryMaximumImageFilter::Execute ( const std::vector< Image > &  images)

Execute the filter on the input images

Image itk::simple::NaryMaximumImageFilter::Execute ( const Image image1)
Image itk::simple::NaryMaximumImageFilter::Execute ( const Image image1,
const Image image2 
)
Image itk::simple::NaryMaximumImageFilter::Execute ( const Image image1,
const Image image2,
const Image image3 
)
Image itk::simple::NaryMaximumImageFilter::Execute ( const Image image1,
const Image image2,
const Image image3,
const Image image4 
)
Image itk::simple::NaryMaximumImageFilter::Execute ( const Image image1,
const Image image2,
const Image image3,
const Image image4,
const Image image5 
)
template<class TImageType >
Image itk::simple::NaryMaximumImageFilter::ExecuteInternal ( const std::vector< Image > &  images)
private
std::string itk::simple::NaryMaximumImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 87 of file sitkNaryMaximumImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 114 of file sitkNaryMaximumImageFilter.h.

Member Data Documentation

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

Definition at line 116 of file sitkNaryMaximumImageFilter.h.


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