itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage > Class Template Reference

Label pixels that are connected to a seed and lie within a neighborhood. More...

#include <itkNeighborhoodConnectedImageFilter.h>

Inheritance diagram for itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef InputImageType::IndexType	IndexType
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef InputImageType::SizeType	InputImageSizeType
typedef TInputImage	InputImageType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef NeighborhoodConnectedImageFilter	Self
typedef ImageToImageFilter < TInputImage, TOutputImage >	Superclass
Public Member Functions
void	AddSeed (const IndexType &seed)
void	ClearSeeds ()
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
virtual const InputImageSizeType &	GetRadius ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	SetRadius (InputImageSizeType _arg)
void	SetSeed (const IndexType &seed)
	typedef (Concept::OStreamWritable< OutputImagePixelType >) OutputOStreamWritableCheck
	typedef (Concept::EqualityComparable< OutputImagePixelType >) OutputEqualityComparableCheck
	typedef (Concept::SameDimension< InputImageDimension, OutputImageDimension >) SameDimensionCheck
	typedef (Concept::OStreamWritable< InputImagePixelType >) InputOStreamWritableCheck
	typedef (Concept::EqualityComparable< InputImagePixelType >) InputEqualityComparableCheck
virtual void	SetLower (InputImagePixelType _arg)
virtual InputImagePixelType	GetLower () const
virtual void	SetUpper (InputImagePixelType _arg)
virtual InputImagePixelType	GetUpper () const
virtual void	SetReplaceValue (OutputImagePixelType _arg)
virtual OutputImagePixelType	GetReplaceValue () const
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 *output)
void	GenerateData ()
void	GenerateInputRequestedRegion ()
Protected Attributes
InputImagePixelType	m_Lower
InputImageSizeType	m_Radius
OutputImagePixelType	m_ReplaceValue
InputImagePixelType	m_Upper
Private Member Functions
	NeighborhoodConnectedImageFilter (const Self &)
void	operator= (const Self &)
std::vector< IndexType >	m_Seeds
	NeighborhoodConnectedImageFilter ()
	~NeighborhoodConnectedImageFilter ()

---

Detailed Description

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

Label pixels that are connected to a seed and lie within a neighborhood.

NeighborhoodConnectedImageFilter labels pixels with ReplaceValue that are connected to an initial Seed AND whose neighbors all lie within a Lower and Upper threshold range.

Definition at line 36 of file itkNeighborhoodConnectedImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage , class TOutputImage >

typedef SmartPointer< const Self > itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::ConstPointer

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

Definition at line 44 of file itkNeighborhoodConnectedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InputImageType::IndexType itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::IndexType

Definition at line 57 of file itkNeighborhoodConnectedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InputImageType::PixelType itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::InputImagePixelType

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

Definition at line 56 of file itkNeighborhoodConnectedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InputImageType::Pointer itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::InputImagePointer

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

Definition at line 54 of file itkNeighborhoodConnectedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InputImageType::RegionType itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::InputImageRegionType

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

Definition at line 55 of file itkNeighborhoodConnectedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InputImageType::SizeType itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::InputImageSizeType

Definition at line 58 of file itkNeighborhoodConnectedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TInputImage itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::InputImageType

Some convenient typedefs.

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

Definition at line 51 of file itkNeighborhoodConnectedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef OutputImageType::PixelType itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

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

Definition at line 63 of file itkNeighborhoodConnectedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef OutputImageType::Pointer itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 61 of file itkNeighborhoodConnectedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef OutputImageType::RegionType itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Superclass typedefs.

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

Definition at line 62 of file itkNeighborhoodConnectedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TOutputImage itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 60 of file itkNeighborhoodConnectedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef SmartPointer< Self > itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::Pointer

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

Definition at line 43 of file itkNeighborhoodConnectedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef NeighborhoodConnectedImageFilter itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

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

Definition at line 41 of file itkNeighborhoodConnectedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef ImageToImageFilter< TInputImage, TOutputImage > itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::Superclass

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

Definition at line 42 of file itkNeighborhoodConnectedImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >

itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::NeighborhoodConnectedImageFilter

(

)

[protected]

End concept checking

template<class TInputImage , class TOutputImage >

itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::~NeighborhoodConnectedImageFilter

(

)

[inline, protected]

End concept checking

Definition at line 124 of file itkNeighborhoodConnectedImageFilter.h.

template<class TInputImage , class TOutputImage >

itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::NeighborhoodConnectedImageFilter

(

const Self &

)

[private]

---

Member Function Documentation

template<class TInputImage , class TOutputImage >

void itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::AddSeed

(

const IndexType &

seed

)

Add a seed point

template<class TInputImage , class TOutputImage >

void itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::ClearSeeds

(

)

Clear the seeds

template<class TInputImage , class TOutputImage >

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

void itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::EnlargeOutputRequestedRegion

(

DataObject *

)

[protected, virtual]

Give the process object a chance to indictate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Reimplemented from itk::ProcessObject.

template<class TInputImage , class TOutputImage >

void itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::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 >

void itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion

(

)

[protected, virtual]

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierachy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.

See also:

ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

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

template<class TInputImage , class TOutputImage >

virtual InputImagePixelType itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::GetLower

(

)

const [virtual]

Set/Get the lower threshold. The default is 0.

template<class TInputImage , class TOutputImage >

virtual const char* itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::GetNameOfClass

(

)

const [virtual]

Run-time type information (and related methods).

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

template<class TInputImage , class TOutputImage >

virtual const InputImageSizeType& itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::GetRadius

(

)

[virtual]

Get the radius of the neighborhood used to compute the median

template<class TInputImage , class TOutputImage >

virtual OutputImagePixelType itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::GetReplaceValue

(

)

const [virtual]

Set/Get value to replace thresholded pixels. Pixels that lie * within Lower and Upper (inclusive) will be replaced with this value. The default is 1.

template<class TInputImage , class TOutputImage >

virtual InputImagePixelType itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::GetUpper

(

)

const [virtual]

Set/Get the upper threshold. The default is the largest possible value for the InputPixelType.

template<class TInputImage , class TOutputImage >

static Pointer itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::New

(

)

[static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputImage , class TOutputImage >

void itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::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 >.

template<class TInputImage , class TOutputImage >

void itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const [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::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::SetLower

(

InputImagePixelType

_arg

)

[virtual]

Set/Get the lower threshold. The default is 0.

template<class TInputImage , class TOutputImage >

virtual void itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::SetRadius

(

InputImageSizeType

_arg

)

[virtual]

Set the radius of the neighborhood used for a mask.

template<class TInputImage , class TOutputImage >

virtual void itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::SetReplaceValue

(

OutputImagePixelType

_arg

)

[virtual]

Set/Get value to replace thresholded pixels. Pixels that lie * within Lower and Upper (inclusive) will be replaced with this value. The default is 1.

template<class TInputImage , class TOutputImage >

void itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::SetSeed

(

const IndexType &

seed

)

Set seed point.

template<class TInputImage , class TOutputImage >

virtual void itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::SetUpper

(

InputImagePixelType

_arg

)

[virtual]

Set/Get the upper threshold. The default is the largest possible value for the InputPixelType.

template<class TInputImage , class TOutputImage >

itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::typedef

(

Concept::OStreamWritable< InputImagePixelType >

)

This class requires InputOStreamWritableCheck in the form of ( Concept::OStreamWritable< InputImagePixelType > )

template<class TInputImage , class TOutputImage >

itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::typedef

(

Concept::SameDimension< InputImageDimension, OutputImageDimension >

)

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

template<class TInputImage , class TOutputImage >

itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::typedef

(

Concept::EqualityComparable< OutputImagePixelType >

)

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

template<class TInputImage , class TOutputImage >

itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::typedef

(

Concept::OStreamWritable< OutputImagePixelType >

)

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

template<class TInputImage , class TOutputImage >

itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::typedef

(

Concept::EqualityComparable< InputImagePixelType >

)

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

---

Member Data Documentation

template<class TInputImage , class TOutputImage >

const unsigned int itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension [static]

ImageDimension constants

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

Definition at line 102 of file itkNeighborhoodConnectedImageFilter.h.

template<class TInputImage , class TOutputImage >

InputImagePixelType itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::m_Lower [protected]

Definition at line 128 of file itkNeighborhoodConnectedImageFilter.h.

template<class TInputImage , class TOutputImage >

InputImageSizeType itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::m_Radius [protected]

Definition at line 133 of file itkNeighborhoodConnectedImageFilter.h.

template<class TInputImage , class TOutputImage >

OutputImagePixelType itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::m_ReplaceValue [protected]

Definition at line 131 of file itkNeighborhoodConnectedImageFilter.h.

template<class TInputImage , class TOutputImage >

std::vector< IndexType > itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::m_Seeds [protected]

End concept checking

Definition at line 125 of file itkNeighborhoodConnectedImageFilter.h.

template<class TInputImage , class TOutputImage >

InputImagePixelType itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >::m_Upper [protected]

Definition at line 129 of file itkNeighborhoodConnectedImageFilter.h.

template<class TInputImage , class TOutputImage >

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

ImageDimension constants

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

Definition at line 104 of file itkNeighborhoodConnectedImageFilter.h.

---

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

• itkNeighborhoodConnectedImageFilter.h