ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes
itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 > Class Template Reference

#include <itkValuedRegionalExtremaImageFilter.h>

+ Inheritance diagram for itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >:
+ Collaboration diagram for itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef
InputImageType::ConstPointer 
InputImageConstPointer
typedef InputImageType::PixelType InputImagePixelType
typedef InputImageType::Pointer InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef TInputImage InputImageType
typedef InputImageType::SizeType ISizeType
typedef
OutputImageType::ConstPointer 
OutputImageConstPointer
typedef OutputImageType::PixelType OutputImagePixelType
typedef OutputImageType::Pointer OutputImagePointer
typedef OutputImageType::RegionType OutputImageRegionType
typedef TOutputImage OutputImageType
typedef SmartPointer< SelfPointer
typedef
ValuedRegionalExtremaImageFilter 
Self
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual bool GetFlat () const
virtual const char * GetNameOfClass () const
 typedef (Concept::HasPixelTraits< InputImagePixelType >) InputHasPixelTraitsCheck
 typedef (Concept::HasNumericTraits< InputImagePixelType >) InputHasNumericTraitsCheck
virtual void SetFullyConnected (bool _arg)
virtual const bool & GetFullyConnected ()
virtual void FullyConnectedOn ()
virtual void FullyConnectedOff ()
virtual void SetMarkerValue (typename TInputImage::PixelType _arg)
virtual const
TInputImage::PixelType & 
GetMarkerValue ()

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions

void EnlargeOutputRequestedRegion (DataObject *)
void GenerateData ()
void GenerateInputRequestedRegion ()
 ValuedRegionalExtremaImageFilter ()
 ~ValuedRegionalExtremaImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const

Private Types

typedef
ConstShapedNeighborhoodIterator
< InputImageType
ConstInputIterator
typedef std::stack< OutIndexTypeIndexStack
typedef InputImageType::IndexType InIndexType
typedef
ShapedNeighborhoodIterator
< OutputImageType
NOutputIterator
typedef OutputImageType::IndexType OutIndexType

Private Member Functions

void operator= (const Self &)
 ValuedRegionalExtremaImageFilter (const Self &)

Private Attributes

bool m_Flat
bool m_FullyConnected
TInputImage::PixelType m_MarkerValue

Detailed Description

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
class itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >

Uses a flooding algorithm to set all voxels that are not a regional extrema to the max or min of the pixel type.

This is the class used by ValuedRegionalMinimaImageFilter and ValuedRegionalMaximaImageFilter. There is no supression of regional minima based on dynamics, as available in HMinimaImageFilter. This flooding algorithm is a very simple one, but I'm not sure where it came from - I certainly didn't invent it.

Let's consider the case of regional minima. The basic algorithm is: Boundary conditions are such that the image is logically surrounded by a border that is either maximal or minimal for the pixel type. An optimized version could explicitly set the border to avoid the need for boundary checks. For regional minima the boundary is set to the maximal value for the pixel type.

Pixels are visited in raster order. The neighbors of each pixel are examined. If any neighbor is greater than the centre, then the centre pixel cannot be a regional minima. The centre pixel is part of a flat region (consisting of at least one pixel) that is therefore not a regional minima either. This region is set to the maximum value for the pixel type using a flooding algorithm.

There are some minor complications that prevent pixels being examined more than once -- basically check that the output value is less than the maximum for the pixel type.

The implementation uses the functor model from itkMaximumImageFilter.

This code was contributed in the Insight Journal paper: "Finding regional extrema - methods and performance" by Beare R., Lehmann G. http://hdl.handle.net/1926/153 http://www.insight-journal.org/browse/publication/65

Author:
Richard Beare. Department of Medicine, Monash University, Melbourne, Australia.
See also:
ValuedRegionalMinimaImageFilter, ValuedRegionalMaximaImageFilter,
HMinimaImageFilter

Definition at line 77 of file itkValuedRegionalExtremaImageFilter.h.


Member Typedef Documentation

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
typedef ConstShapedNeighborhoodIterator< InputImageType > itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::ConstInputIterator [private]

Definition at line 176 of file itkValuedRegionalExtremaImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
typedef SmartPointer< const Self > itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::ConstPointer
template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
typedef std::stack< OutIndexType > itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::IndexStack [private]

Definition at line 178 of file itkValuedRegionalExtremaImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
typedef InputImageType::IndexType itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::InIndexType [private]

Definition at line 175 of file itkValuedRegionalExtremaImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
typedef InputImageType::ConstPointer itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::InputImageConstPointer
template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
typedef InputImageType::PixelType itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::InputImagePixelType
template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
typedef InputImageType::Pointer itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::InputImagePointer
template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
typedef InputImageType::RegionType itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::InputImageRegionType
template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
typedef TInputImage itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::InputImageType
template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
typedef InputImageType::SizeType itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::ISizeType

Definition at line 97 of file itkValuedRegionalExtremaImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
typedef ShapedNeighborhoodIterator< OutputImageType > itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::NOutputIterator [private]

Definition at line 177 of file itkValuedRegionalExtremaImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
typedef OutputImageType::IndexType itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::OutIndexType [private]

Definition at line 174 of file itkValuedRegionalExtremaImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
typedef OutputImageType::ConstPointer itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::OutputImageConstPointer

Definition at line 99 of file itkValuedRegionalExtremaImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
typedef OutputImageType::PixelType itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::OutputImagePixelType
template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
typedef OutputImageType::Pointer itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 98 of file itkValuedRegionalExtremaImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
typedef OutputImageType::RegionType itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::OutputImageRegionType

Superclass typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 100 of file itkValuedRegionalExtremaImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
typedef TOutputImage itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 92 of file itkValuedRegionalExtremaImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
typedef SmartPointer< Self > itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::Pointer
template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
typedef ValuedRegionalExtremaImageFilter itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::Self
template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
typedef ImageToImageFilter< TInputImage, TOutputImage > itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::Superclass

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::ValuedRegionalExtremaImageFilter ( ) [protected]

End concept checking

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::~ValuedRegionalExtremaImageFilter ( ) [inline, protected]

End concept checking

Definition at line 151 of file itkValuedRegionalExtremaImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::ValuedRegionalExtremaImageFilter ( const Self ) [private]

Member Function Documentation

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
virtual::itk::LightObject::Pointer itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::CreateAnother ( void  ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

Reimplemented in itk::ValuedRegionalMaximaImageFilter< TInputImage, TOutputImage >, and itk::ValuedRegionalMinimaImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
void itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::EnlargeOutputRequestedRegion ( DataObject ) [protected, virtual]

ValuedRegionalExtremaImageFilter will produce the entire output.

Reimplemented from itk::ProcessObject.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
virtual void itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::FullyConnectedOff ( ) [virtual]

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.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
virtual void itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::FullyConnectedOn ( ) [virtual]

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.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
void itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::GenerateData ( ) [protected, virtual]

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See also:
ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
void itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::GenerateInputRequestedRegion ( ) [protected, virtual]

ValuedRegionalExtremaImageFilter needs the entire input be available. Thus, it needs to provide an implementation of GenerateInputRequestedRegion().

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
virtual bool itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::GetFlat ( ) const [virtual]

Get whether the image is flat or not.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
virtual const bool& itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::GetFullyConnected ( ) [virtual]

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.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
virtual const TInputImage::PixelType& itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::GetMarkerValue ( ) [virtual]

Set/Get the value used to mark all pixels which are not extrema.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
virtual const char* itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::GetNameOfClass ( ) const [virtual]
template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
static Pointer itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::New ( ) [static]
template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
void itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::operator= ( const Self ) [private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::ValuedRegionalMaximaImageFilter< TInputImage, TOutputImage >, and itk::ValuedRegionalMinimaImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
void itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

End concept checking

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
virtual void itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::SetFullyConnected ( bool  _arg) [virtual]

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.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
virtual void itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::SetMarkerValue ( typename TInputImage::PixelType  _arg) [virtual]

Set/Get the value used to mark all pixels which are not extrema.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::typedef ( Concept::HasPixelTraits< InputImagePixelType )

Begin concept checking This class requires InputHasPixelTraitsCheck in the form of ( Concept::HasPixelTraits< InputImagePixelType > )

Reimplemented in itk::ValuedRegionalMaximaImageFilter< TInputImage, TOutputImage >, and itk::ValuedRegionalMinimaImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::typedef ( Concept::HasNumericTraits< InputImagePixelType )

This class requires InputHasNumericTraitsCheck in the form of ( Concept::HasNumericTraits< InputImagePixelType > )

Reimplemented in itk::ValuedRegionalMaximaImageFilter< TInputImage, TOutputImage >, and itk::ValuedRegionalMinimaImageFilter< TInputImage, TOutputImage >.


Member Data Documentation

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
const unsigned int itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::InputImageDimension = TInputImage::ImageDimension [static]

ImageDimension constants

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 105 of file itkValuedRegionalExtremaImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
bool itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::m_Flat [private]

Definition at line 172 of file itkValuedRegionalExtremaImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
bool itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::m_FullyConnected [private]

Definition at line 171 of file itkValuedRegionalExtremaImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
TInputImage::PixelType itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::m_MarkerValue [private]

Definition at line 169 of file itkValuedRegionalExtremaImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction1, class TFunction2>
const unsigned int itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::OutputImageDimension = TOutputImage::ImageDimension [static]

ImageDimension constants

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 107 of file itkValuedRegionalExtremaImageFilter.h.


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