Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::ZeroCrossingImageFilter< TInputImage, TOutputImage > Class Template Reference
[Image Feature Extraction Filters]

#include <itkZeroCrossingImageFilter.h>

Inheritance diagram for itk::ZeroCrossingImageFilter:

Inheritance graph
[legend]
Collaboration diagram for itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef ZeroCrossingImageFilter Self
typedef ImageToImageFilter<
TInputImage, TOutputImage > 
Superclass
typedef TInputImage InputImageType
typedef TOutputImage OutputImageType
typedef SmartPointer< SelfPointer
typedef SmartPointer< const
Self
ConstPointer
typedef TInputImage::PixelType InputImagePixelType
typedef TOutputImage::PixelType OutputImagePixelType
typedef TOutputImage::RegionType OutputImageRegionType

Public Methods

virtual const char * GetClassName () const
 itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)
virtual void GenerateInputRequestedRegion () throw (InvalidRequestedRegionError)
virtual void SetForegroundValue (OutputImagePixelType _arg)
virtual OutputImagePixelType GetForegroundValue ()
virtual void SetBackgroundValue (OutputImagePixelType _arg)
virtual OutputImagePixelType GetBackgroundValue ()

Static Public Methods

Pointer New ()

Protected Methods

 ZeroCrossingImageFilter ()
 ~ZeroCrossingImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const
 ZeroCrossingImageFilter (const Self &)
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)

Protected Attributes

OutputImagePixelType m_BackgroundValue
OutputImagePixelType m_ForegroundValue

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >

This filter finds the closest pixel to the zero-crossings (sign changes) in a signed itk::Image. Pixels closest to zero-crossings are labeled with a foreground value. All other pixels are marked with a background value. The algorithm works by detecting differences in sign among neighbors using city-block style connectivity (4-neighbors in 2d, 6-neighbors in 3d, etc.).
Inputs and Outputs
The input to this filter is an itk::Image of arbitrary dimension. The algorithm assumes a signed data type (zero-crossings are not defined for unsigned data types), and requires that operator>, operator<, operator==, and operator!= are defined.

The output of the filter is a binary, labeled image of user-specified type. By default, zero-crossing pixels are labeled with a default ``foreground'' value of itk::NumericTraits<OutputDataType>One, where OutputDataType is the data type of the output image. All other pixels are labeled with a default ``background'' value of itk::NumericTraits<OutputDataType>Zero.

Parameters
There are two parameters for this filter. ForegroundValue is the value that marks zero-crossing pixels. The BackgroundValue is the value given to all other pixels.
See also:
Image , Neighborhood , NeighborhoodOperator , NeighborhoodIterator

Definition at line 56 of file itkZeroCrossingImageFilter.h.


Member Typedef Documentation

template<class TInputImage, class TOutputImage>
typedef SmartPointer<const Self> itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::ConstPointer
 

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

Definition at line 70 of file itkZeroCrossingImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TInputImage::PixelType itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::InputImagePixelType
 

Define pixel types

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

Definition at line 73 of file itkZeroCrossingImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TInputImage itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::InputImageType
 

Image typedef support

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

Definition at line 65 of file itkZeroCrossingImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TOutputImage::PixelType itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::OutputImagePixelType
 

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 74 of file itkZeroCrossingImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TOutputImage::RegionType itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::OutputImageRegionType
 

Typedef to describe the output image region type.

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

Definition at line 80 of file itkZeroCrossingImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef TOutputImage itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::OutputImageType
 

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 66 of file itkZeroCrossingImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef SmartPointer<Self> itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::Pointer
 

SmartPointer typedef support

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

Definition at line 69 of file itkZeroCrossingImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef ZeroCrossingImageFilter itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::Self
 

Standard "Self" & Superclass typedef.

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

Definition at line 61 of file itkZeroCrossingImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef ImageToImageFilter<TInputImage, TOutputImage> itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::Superclass
 

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

Definition at line 62 of file itkZeroCrossingImageFilter.h.


Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage>
itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::ZeroCrossingImageFilter   [inline, protected]
 

Definition at line 110 of file itkZeroCrossingImageFilter.h.

template<class TInputImage, class TOutputImage>
itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::~ZeroCrossingImageFilter   [inline, protected]
 

Definition at line 115 of file itkZeroCrossingImageFilter.h.

template<class TInputImage, class TOutputImage>
itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::ZeroCrossingImageFilter const Self   [inline, protected]
 

Definition at line 118 of file itkZeroCrossingImageFilter.h.


Member Function Documentation

template<class TInputImage, class TOutputImage>
virtual void itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion   throw (InvalidRequestedRegionError) [virtual]
 

ZeroCrossingImageFilter needs a larger input requested region than the output requested region (larger by the kernel size to do comparisons between the central pixel and ite neighbors). Thus ZeroCrossingImageFilter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

See also:
ImageToImageFilter::GenerateInputRequestedRegion()

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

template<class TInputImage, class TOutputImage>
virtual OutputImagePixelType itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::GetBackgroundValue   [virtual]
 

Set/Get the label value for non-zero-crossing pixels.

template<class TInputImage, class TOutputImage>
virtual const char* itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::GetClassName   const [virtual]
 

Run-time type information (and related methods).

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

template<class TInputImage, class TOutputImage>
virtual OutputImagePixelType itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::GetForegroundValue   [virtual]
 

Set/Get the label value for zero-crossing pixels.

template<class TInputImage, class TOutputImage>
itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro ImageDimension   ,
unsigned    int,
TInputImage::ImageDimension   
 

ImageDimension enumeration

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

template<class TInputImage, class TOutputImage>
Pointer itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::New   [static]
 

Method for creation through the object factory.

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

template<class TInputImage, class TOutputImage>
void itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::PrintSelf std::ostream &    os,
Indent    indent
const [protected, virtual]
 

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

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

template<class TInputImage, class TOutputImage>
virtual void itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::SetBackgroundValue OutputImagePixelType    _arg [virtual]
 

Set/Get the label value for non-zero-crossing pixels.

template<class TInputImage, class TOutputImage>
virtual void itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::SetForegroundValue OutputImagePixelType    _arg [virtual]
 

Set/Get the label value for zero-crossing pixels.

template<class TInputImage, class TOutputImage>
void itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData const OutputImageRegionType   outputRegionForThread,
int    threadId
[protected, virtual]
 

ZeroCrossingImageFilter can be implemented as a multithreaded filter. Therefore,this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See also:
ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.


Member Data Documentation

template<class TInputImage, class TOutputImage>
OutputImagePixelType itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::m_BackgroundValue [protected]
 

Definition at line 119 of file itkZeroCrossingImageFilter.h.

template<class TInputImage, class TOutputImage>
OutputImagePixelType itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::m_ForegroundValue [protected]
 

Definition at line 120 of file itkZeroCrossingImageFilter.h.


The documentation for this class was generated from the following file:
Generated at Wed Mar 12 01:22:01 2003 for ITK by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2000