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

Produce a binary image where foreground is the regional maxima of the input image. More...

#include <sitkRegionalMaximaImageFilter.h>

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

Public Types

typedef ScalarPixelIDTypeList PixelIDTypeList
 
typedef RegionalMaximaImageFilter 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, double backgroundValue, double foregroundValue, bool fullyConnected, bool flatIsMaxima)
 
SelfFlatIsMaximaOff ()
 
SelfFlatIsMaximaOn ()
 
SelfFullyConnectedOff ()
 
SelfFullyConnectedOn ()
 
double GetBackgroundValue () const
 
bool GetFlatIsMaxima () const
 
double GetForegroundValue () const
 
bool GetFullyConnected () const
 
std::string GetName () const
 
 RegionalMaximaImageFilter ()
 
SelfSetBackgroundValue (double BackgroundValue)
 
SelfSetFlatIsMaxima (bool FlatIsMaxima)
 
SelfSetForegroundValue (double ForegroundValue)
 
SelfSetFullyConnected (bool FullyConnected)
 
std::string ToString () const
 
virtual ~RegionalMaximaImageFilter ()
 
- 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

double m_BackgroundValue
 
bool m_FlatIsMaxima
 
double m_ForegroundValue
 
bool m_FullyConnected
 
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< 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

Produce a binary image where foreground is the regional maxima of the input image.

Regional maxima are flat zones surrounded by pixels of lower value.

If the input image is constant, the entire image can be considered as a maxima or not. The desired behavior can be selected with the SetFlatIsMaxima() method.

Author
Gaetan Lehmann

This class was contributed to the Insight Journal by author Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France. The paper can be found at https://hdl.handle.net/1926/153

See also
ValuedRegionalMaximaImageFilter
HConvexImageFilter
RegionalMinimaImageFilter
itk::simple::RegionalMaxima for the procedural interface
itk::RegionalMaximaImageFilter for the Doxygen on the original ITK class.

Definition at line 54 of file sitkRegionalMaximaImageFilter.h.

Member Typedef Documentation

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

Setup for member function dispatching

Definition at line 135 of file sitkRegionalMaximaImageFilter.h.

Define the pixels types supported by this filter

Definition at line 66 of file sitkRegionalMaximaImageFilter.h.

Definition at line 56 of file sitkRegionalMaximaImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::RegionalMaximaImageFilter::~RegionalMaximaImageFilter ( )
virtual

Destructor

itk::simple::RegionalMaximaImageFilter::RegionalMaximaImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input image

Image itk::simple::RegionalMaximaImageFilter::Execute ( const Image image1,
double  backgroundValue,
double  foregroundValue,
bool  fullyConnected,
bool  flatIsMaxima 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::RegionalMaximaImageFilter::ExecuteInternal ( const Image image1)
private
Self& itk::simple::RegionalMaximaImageFilter::FlatIsMaximaOff ( )
inline

Definition at line 111 of file sitkRegionalMaximaImageFilter.h.

Self& itk::simple::RegionalMaximaImageFilter::FlatIsMaximaOn ( )
inline

Set the value of FlatIsMaxima to true or false respectfully.

Definition at line 110 of file sitkRegionalMaximaImageFilter.h.

Self& itk::simple::RegionalMaximaImageFilter::FullyConnectedOff ( )
inline

Definition at line 97 of file sitkRegionalMaximaImageFilter.h.

Self& itk::simple::RegionalMaximaImageFilter::FullyConnectedOn ( )
inline

Set the value of FullyConnected to true or false respectfully.

Definition at line 96 of file sitkRegionalMaximaImageFilter.h.

double itk::simple::RegionalMaximaImageFilter::GetBackgroundValue ( ) const
inline

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::NonpositiveMin() .

Definition at line 78 of file sitkRegionalMaximaImageFilter.h.

bool itk::simple::RegionalMaximaImageFilter::GetFlatIsMaxima ( ) const
inline

Set/Get wether a flat image must be considered as a maxima or not. Defaults to true.

Definition at line 116 of file sitkRegionalMaximaImageFilter.h.

double itk::simple::RegionalMaximaImageFilter::GetForegroundValue ( ) const
inline

Set/Get the value in the output image to consider as "foreground". Defaults to maximum value of PixelType.

Definition at line 88 of file sitkRegionalMaximaImageFilter.h.

bool itk::simple::RegionalMaximaImageFilter::GetFullyConnected ( ) const
inline

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

Definition at line 102 of file sitkRegionalMaximaImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 118 of file sitkRegionalMaximaImageFilter.h.

Self& itk::simple::RegionalMaximaImageFilter::SetBackgroundValue ( double  BackgroundValue)
inline

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::NonpositiveMin() .

Definition at line 73 of file sitkRegionalMaximaImageFilter.h.

Self& itk::simple::RegionalMaximaImageFilter::SetFlatIsMaxima ( bool  FlatIsMaxima)
inline

Set/Get wether a flat image must be considered as a maxima or not. Defaults to true.

Definition at line 107 of file sitkRegionalMaximaImageFilter.h.

Self& itk::simple::RegionalMaximaImageFilter::SetForegroundValue ( double  ForegroundValue)
inline

Set/Get the value in the output image to consider as "foreground". Defaults to maximum value of PixelType.

Definition at line 83 of file sitkRegionalMaximaImageFilter.h.

Self& itk::simple::RegionalMaximaImageFilter::SetFullyConnected ( bool  FullyConnected)
inline

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

Definition at line 93 of file sitkRegionalMaximaImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 139 of file sitkRegionalMaximaImageFilter.h.

Member Data Documentation

double itk::simple::RegionalMaximaImageFilter::m_BackgroundValue
private

Definition at line 145 of file sitkRegionalMaximaImageFilter.h.

bool itk::simple::RegionalMaximaImageFilter::m_FlatIsMaxima
private

Definition at line 150 of file sitkRegionalMaximaImageFilter.h.

double itk::simple::RegionalMaximaImageFilter::m_ForegroundValue
private

Definition at line 147 of file sitkRegionalMaximaImageFilter.h.

bool itk::simple::RegionalMaximaImageFilter::m_FullyConnected
private

Definition at line 149 of file sitkRegionalMaximaImageFilter.h.

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

Definition at line 141 of file sitkRegionalMaximaImageFilter.h.


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