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

#include <itkZeroCrossingImageFilter.h>

+ Inheritance diagram for itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >:

List of all members.

Public Types

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

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual void GenerateInputRequestedRegion () throw ( InvalidRequestedRegionError )
virtual const char * GetNameOfClass () const
 typedef (Concept::EqualityComparable< OutputImagePixelType >) OutputEqualityComparableCheck
 typedef (Concept::SameDimension< ImageDimension, OutputImageDimension >) SameDimensionCheck
 typedef (Concept::Comparable< InputImagePixelType >) InputComparableCheck
 typedef (Concept::OStreamWritable< OutputImagePixelType >) OutputOStreamWritableCheck
virtual void SetForegroundValue (OutputImagePixelType _arg)
virtual OutputImagePixelType GetForegroundValue () const
virtual void SetBackgroundValue (OutputImagePixelType _arg)
virtual OutputImagePixelType GetBackgroundValue () const

Static Public Member Functions

static Pointer New ()

Static Public Attributes

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

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const
 ZeroCrossingImageFilter ()
 ~ZeroCrossingImageFilter ()

Protected Attributes

OutputImagePixelType m_BackgroundValue
OutputImagePixelType m_ForegroundValue
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 ZeroCrossingImageFilter (const Self &)
void operator= (const Self &)

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
Wiki Examples:

Definition at line 63 of file itkZeroCrossingImageFilter.h.


Member Typedef Documentation

template<class TInputImage , class TOutputImage >
typedef SmartPointer< const Self > itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::ConstPointer
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 80 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 72 of file itkZeroCrossingImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TOutputImage::PixelType itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::OutputImagePixelType
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 84 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 73 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 76 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 68 of file itkZeroCrossingImageFilter.h.

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

Constructor & Destructor Documentation

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

End concept checking

Definition at line 134 of file itkZeroCrossingImageFilter.h.

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

Definition at line 140 of file itkZeroCrossingImageFilter.h.

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

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()

Member Function Documentation

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::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.

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 ( ) const [virtual]

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

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

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

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

Run-time type information (and related methods).

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

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

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputImage , class TOutputImage >
void itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::operator= ( const Self ) [private]

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::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,
ThreadIdType  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 >.

template<class TInputImage , class TOutputImage >
itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::typedef ( Concept::EqualityComparable< OutputImagePixelType )

Begin concept checking This class requires OutputEqualityComparableCheck in the form of ( Concept::EqualityComparable< OutputImagePixelType > )

template<class TInputImage , class TOutputImage >
itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::typedef ( Concept::SameDimension< ImageDimension, OutputImageDimension )

This class requires SameDimensionCheck in the form of ( Concept::SameDimension< ImageDimension, OutputImageDimension > )

template<class TInputImage , class TOutputImage >
itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::typedef ( Concept::Comparable< InputImagePixelType )

This class requires InputComparableCheck in the form of ( Concept::Comparable< InputImagePixelType > )

template<class TInputImage , class TOutputImage >
itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::typedef ( Concept::OStreamWritable< OutputImagePixelType )

This class requires OutputOStreamWritableCheck in the form of ( Concept::OStreamWritable< OutputImagePixelType > )


Member Data Documentation

template<class TInputImage , class TOutputImage >
const unsigned int itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension [static]

ImageDimension enumeration

Definition at line 94 of file itkZeroCrossingImageFilter.h.

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

Definition at line 143 of file itkZeroCrossingImageFilter.h.

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

Definition at line 144 of file itkZeroCrossingImageFilter.h.

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

ImageDimension enumeration

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

Definition at line 96 of file itkZeroCrossingImageFilter.h.


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