itk::TwoOutputExampleImageFilter< TImage > Class Template Reference
[Intensity Image Filters]

Example of a filter that produce two outputs. More...

#include <itkTwoOutputExampleImageFilter.h>

Inheritance diagram for itk::TwoOutputExampleImageFilter< TImage >:

[legend]Collaboration diagram for itk::TwoOutputExampleImageFilter< TImage >:

[legend]List of all members.

Public Types
typedef TwoOutputExampleImageFilter	Self
typedef ImageToImageFilter< TImage, TImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TImage::PixelType	PixelType
typedef Superclass::InputImageConstPointer	InputImageConstPointer
typedef TImage	OutputImageType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef OutputImageType::PixelType	OutputImagePixelType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual void	SetOutsideValue (PixelType _arg)
virtual PixelType	GetOutsideValue ()
void	ThresholdAbove (PixelType &thresh)
void	ThresholdBelow (PixelType &thresh)
void	ThresholdOutside (PixelType &lower, PixelType &upper)
OutputImagePointer	GetInverseOutput ()
void	SetInverseOutput (OutputImageType *output)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	TwoOutputExampleImageFilter ()
	~TwoOutputExampleImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)

---

Detailed Description

template<class TImage>
class itk::TwoOutputExampleImageFilter< TImage >

Example of a filter that produce two outputs.

TwoOutputExampleImageFilter sets image values to a user-specified "outside" value (by default, "black") if the image values are below, above, or between simple threshold values. The filter can produce two outputs, one the inverse of the other. (GetOutput() returns an image whose pixels satisfy the threshold values and are passed to the output unchanged (and those that don't are marked with the outside user-value); GetInverseOutput() returns an image in which pixels satisfying the threshold are marked "outside", and the other pixel values are passed through.)

The pixels must support the operators >= and <=.

Definition at line 43 of file itkTwoOutputExampleImageFilter.h.

---

Member Typedef Documentation

template<class TImage> typedef SmartPointer<const Self> itk::TwoOutputExampleImageFilter< TImage >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TImage, TImage >. Definition at line 50 of file itkTwoOutputExampleImageFilter.h.

template<class TImage> typedef Superclass::InputImageConstPointer itk::TwoOutputExampleImageFilter< TImage >::InputImageConstPointer

Reimplemented from itk::ImageToImageFilter< TImage, TImage >. Definition at line 77 of file itkTwoOutputExampleImageFilter.h.

template<class TImage> typedef OutputImageType::PixelType itk::TwoOutputExampleImageFilter< TImage >::OutputImagePixelType

Reimplemented from itk::ImageSource< TImage >. Definition at line 83 of file itkTwoOutputExampleImageFilter.h.

template<class TImage> typedef OutputImageType::Pointer itk::TwoOutputExampleImageFilter< TImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TImage >. Definition at line 81 of file itkTwoOutputExampleImageFilter.h.

template<class TImage> typedef OutputImageType::RegionType itk::TwoOutputExampleImageFilter< TImage >::OutputImageRegionType

Superclass typedefs. Reimplemented from itk::ImageToImageFilter< TImage, TImage >. Definition at line 82 of file itkTwoOutputExampleImageFilter.h.

template<class TImage> typedef TImage itk::TwoOutputExampleImageFilter< TImage >::OutputImageType

Some typedefs to handle the second output. Reimplemented from itk::ImageSource< TImage >. Definition at line 80 of file itkTwoOutputExampleImageFilter.h. Referenced by itk::TwoOutputExampleImageFilter< TImage >::SetInverseOutput().

template<class TImage> typedef TImage::PixelType itk::TwoOutputExampleImageFilter< TImage >::PixelType

Typedef to describe the type of pixel. Definition at line 56 of file itkTwoOutputExampleImageFilter.h.

template<class TImage> typedef SmartPointer<Self> itk::TwoOutputExampleImageFilter< TImage >::Pointer

Reimplemented from itk::ImageToImageFilter< TImage, TImage >. Definition at line 49 of file itkTwoOutputExampleImageFilter.h.

template<class TImage> typedef TwoOutputExampleImageFilter itk::TwoOutputExampleImageFilter< TImage >::Self

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TImage, TImage >. Definition at line 47 of file itkTwoOutputExampleImageFilter.h.

template<class TImage> typedef ImageToImageFilter<TImage,TImage> itk::TwoOutputExampleImageFilter< TImage >::Superclass

Reimplemented from itk::ImageToImageFilter< TImage, TImage >. Definition at line 48 of file itkTwoOutputExampleImageFilter.h.

---

Constructor & Destructor Documentation

template<class TImage> itk::TwoOutputExampleImageFilter< TImage >::TwoOutputExampleImageFilter (   )  [protected]

template<class TImage> itk::TwoOutputExampleImageFilter< TImage >::~TwoOutputExampleImageFilter (   )  [inline, protected]

Definition at line 94 of file itkTwoOutputExampleImageFilter.h.

---

Member Function Documentation

template<class TImage> OutputImagePointer itk::TwoOutputExampleImageFilter< TImage >::GetInverseOutput (   )

Get the image output of this process object.

template<class TImage> virtual const char* itk::TwoOutputExampleImageFilter< TImage >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

template<class TImage> virtual PixelType itk::TwoOutputExampleImageFilter< TImage >::GetOutsideValue (   )  [virtual]

Get the "outside" pixel value.

template<class TImage> Pointer itk::TwoOutputExampleImageFilter< TImage >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TImage> void itk::TwoOutputExampleImageFilter< TImage >::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< TImage, TImage >.

template<class TImage> void itk::TwoOutputExampleImageFilter< TImage >::SetInverseOutput (  OutputImageType *  output  )  [inline]

Set the image output of this process object. Definition at line 89 of file itkTwoOutputExampleImageFilter.h. References itk::TwoOutputExampleImageFilter< TImage >::OutputImageType.

template<class TImage> virtual void itk::TwoOutputExampleImageFilter< TImage >::SetOutsideValue (  PixelType  _arg  )  [virtual]

Set the "outside" pixel value. The default value NumericTraits<PixelType>::Zero.

template<class TImage> void itk::TwoOutputExampleImageFilter< TImage >::ThreadedGenerateData (  const OutputImageRegionType &  outputRegionForThread, int  threadId )  [protected, virtual]

TwoOutputExampleImageFilter 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< TImage >.

template<class TImage> void itk::TwoOutputExampleImageFilter< TImage >::ThresholdAbove (  PixelType &  thresh  )

The values greater than or equal to the value are set to OutsideValue.

template<class TImage> void itk::TwoOutputExampleImageFilter< TImage >::ThresholdBelow (  PixelType &  thresh  )

The values less than or equal to the value are set to OutsideValue.

template<class TImage> void itk::TwoOutputExampleImageFilter< TImage >::ThresholdOutside (  PixelType &  lower, PixelType &  upper )

The values outside the range are set to OutsideValue.

---

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

• itkTwoOutputExampleImageFilter.h

---