itk::TwoOutputExampleImageFilter< TImage > Class Template Reference

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

#include <itkTwoOutputExampleImageFilter.h>

Inheritance diagram for itk::TwoOutputExampleImageFilter< TImage >:

Collaboration diagram for itk::TwoOutputExampleImageFilter< TImage >:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputImageConstPointer	InputImageConstPointer
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TImage	OutputImageType
typedef TImage::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef TwoOutputExampleImageFilter	Self
typedef ImageToImageFilter < TImage, TImage >	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
OutputImagePointer	GetInverseOutput ()
virtual const char *	GetNameOfClass () const
virtual PixelType	GetOutsideValue () const
void	SetInverseOutput (OutputImageType *output)
virtual void	SetOutsideValue (PixelType _arg)
void	ThresholdAbove (PixelType &thresh)
void	ThresholdBelow (PixelType &thresh)
void	ThresholdOutside (PixelType &lower, PixelType &upper)
	typedef (Concept::OStreamWritable< PixelType >) OStreamWritableCheck
	typedef (Concept::Comparable< PixelType >) ComparableCheck
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
	TwoOutputExampleImageFilter ()
	~TwoOutputExampleImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
Private Member Functions
void	operator= (const Self &)
	TwoOutputExampleImageFilter (const Self &)
Private Attributes
PixelType	m_Lower
PixelType	m_OutsideValue
PixelType	m_Upper

---

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 44 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 52 of file itkTwoOutputExampleImageFilter.h.

template<class TImage >

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

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 79 of file itkTwoOutputExampleImageFilter.h.

template<class TImage >

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

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 85 of file itkTwoOutputExampleImageFilter.h.

template<class TImage >

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

Reimplemented from itk::ImageSource< TImage >.

Definition at line 83 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 84 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 82 of file itkTwoOutputExampleImageFilter.h.

template<class TImage >

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

Typedef to describe the type of pixel.

Definition at line 55 of file itkTwoOutputExampleImageFilter.h.

template<class TImage >

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

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 51 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 49 of file itkTwoOutputExampleImageFilter.h.

template<class TImage >

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

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 50 of file itkTwoOutputExampleImageFilter.h.

---

Constructor & Destructor Documentation

template<class TImage >

itk::TwoOutputExampleImageFilter< TImage >::TwoOutputExampleImageFilter

(

)

[protected]

Begin concept checking

template<class TImage >

itk::TwoOutputExampleImageFilter< TImage >::~TwoOutputExampleImageFilter

(

)

[inline, protected]

Begin concept checking

Definition at line 106 of file itkTwoOutputExampleImageFilter.h.

template<class TImage >

itk::TwoOutputExampleImageFilter< TImage >::TwoOutputExampleImageFilter

(

const Self &

)

[private]

---

Member Function Documentation

template<class TImage >

virtual::itk::LightObject::Pointer itk::TwoOutputExampleImageFilter< TImage >::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 TImage >

OutputImagePointer itk::TwoOutputExampleImageFilter< TImage >::GetInverseOutput

(

)

[inline]

Get the image output of this process object.

Definition at line 88 of file itkTwoOutputExampleImageFilter.h.

References itk::ProcessObject::GetOutput().

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

(

)

const [virtual]

Get the "outside" pixel value.

template<class TImage >

static Pointer itk::TwoOutputExampleImageFilter< TImage >::New

(

)

[static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TImage >

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

template<class TImage >

void itk::TwoOutputExampleImageFilter< TImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const [protected, virtual]

Begin concept checking

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 92 of file itkTwoOutputExampleImageFilter.h.

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

template<class TImage >

itk::TwoOutputExampleImageFilter< TImage >::typedef

(

Concept::OStreamWritable< PixelType >

)

This class requires OStreamWritableCheck in the form of ( Concept::OStreamWritable< PixelType > )

template<class TImage >

itk::TwoOutputExampleImageFilter< TImage >::typedef

(

Concept::Comparable< PixelType >

)

Begin concept checking This class requires ComparableCheck in the form of ( Concept::Comparable< PixelType > )

---

Member Data Documentation

template<class TImage >

PixelType itk::TwoOutputExampleImageFilter< TImage >::m_Lower [private]

Definition at line 128 of file itkTwoOutputExampleImageFilter.h.

template<class TImage >

PixelType itk::TwoOutputExampleImageFilter< TImage >::m_OutsideValue [private]

Definition at line 127 of file itkTwoOutputExampleImageFilter.h.

template<class TImage >

PixelType itk::TwoOutputExampleImageFilter< TImage >::m_Upper [private]

Definition at line 129 of file itkTwoOutputExampleImageFilter.h.

---

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

• itkTwoOutputExampleImageFilter.h