itk::BinaryShapeKeepNObjectsImageFilter< TInputImage > Class Template Reference

#include <itkBinaryShapeKeepNObjectsImageFilter.h>

Inheritance diagram for itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >:

Collaboration diagram for itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >:

List of all members.

Public Types
typedef LabelObjectType::AttributeType	AttributeType
typedef LabelMapToBinaryImageFilter < LabelMapType, OutputImageType >	BinarizerType
typedef SmartPointer< const Self >	ConstPointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef ShapeKeepNObjectsLabelMapFilter < LabelMapType >	KeepNObjectsType
typedef BinaryImageToLabelMapFilter < InputImageType, LabelMapType >	LabelizerType
typedef LabelMap< LabelObjectType >	LabelMapType
typedef ShapeLabelObject < LabelType, itkGetStaticConstMacro(ImageDimension) >	LabelObjectType
typedef ShapeLabelMapFilter < LabelMapType, ShapeLabelFilterOutput >	LabelObjectValuatorType
typedef SizeValueType	LabelType
typedef OutputImageType::ConstPointer	OutputImageConstPointer
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TInputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef BinaryShapeKeepNObjectsImageFilter	Self
typedef Image< typename OutputImageType::PixelType, itkGetStaticConstMacro(OutputImageDimension) >	ShapeLabelFilterOutput
typedef ImageToImageFilter < TInputImage, TInputImage >	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
	typedef (Concept::EqualityComparable< InputImagePixelType >) InputEqualityComparableCheck
	typedef (Concept::Convertible< int, InputImagePixelType >) IntConvertibleToInputCheck
	typedef (Concept::OStreamWritable< InputImagePixelType >) InputOStreamWritableCheck
virtual void	SetFullyConnected (bool _arg)
virtual const bool &	GetFullyConnected ()
virtual void	FullyConnectedOn ()
virtual void	FullyConnectedOff ()
virtual void	SetBackgroundValue (OutputImagePixelType _arg)
virtual OutputImagePixelType	GetBackgroundValue () const
virtual void	SetForegroundValue (OutputImagePixelType _arg)
virtual OutputImagePixelType	GetForegroundValue () const
virtual SizeValueType	GetNumberOfObjects () const
virtual void	SetNumberOfObjects (SizeValueType _arg)
virtual bool	GetReverseOrdering () const
virtual void	SetReverseOrdering (bool _arg)
virtual void	ReverseOrderingOn ()
virtual void	ReverseOrderingOff ()
virtual AttributeType	GetAttribute () const
virtual void	SetAttribute (AttributeType _arg)
void	SetAttribute (const std::string &s)
Static Public Member Functions
static Pointer	New ()
Static Public Attributes
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TInputImage::ImageDimension
static const unsigned int	ImageDimension = TInputImage::ImageDimension
Protected Member Functions
	BinaryShapeKeepNObjectsImageFilter ()
void	EnlargeOutputRequestedRegion (DataObject *)
void	GenerateData ()
void	GenerateInputRequestedRegion ()
void	PrintSelf (std::ostream &os, Indent indent) const
	~BinaryShapeKeepNObjectsImageFilter ()
Private Member Functions
	BinaryShapeKeepNObjectsImageFilter (const Self &)
void	operator= (const Self &)
Private Attributes
AttributeType	m_Attribute
OutputImagePixelType	m_BackgroundValue
OutputImagePixelType	m_ForegroundValue
bool	m_FullyConnected
SizeValueType	m_NumberOfObjects
bool	m_ReverseOrdering

---

Detailed Description

template<class TInputImage>
class itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >

keep N objects according to their shape attributes

BinaryShapeKeepNObjectsImageFilter keep the N objects in a binary image with the highest (or lowest) attribute value. The attributes are the ones of the ShapeLabelObject.

Author:

Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

This implementation was taken from the Insight Journal paper: http://hdl.handle.net/1926/584 or http://www.insight-journal.org/browse/publication/176

See also:

ShapeLabelObject, LabelShapeKeepNObjectsImageFilter, BinaryStatisticsKeepNObjectsImageFilter

Definition at line 47 of file itkBinaryShapeKeepNObjectsImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage >

typedef LabelObjectType::AttributeType itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::AttributeType

Definition at line 86 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef LabelMapToBinaryImageFilter< LabelMapType, OutputImageType > itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::BinarizerType

Definition at line 88 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef SmartPointer< const Self > itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::ConstPointer

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

Definition at line 55 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef InputImageType::ConstPointer itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::InputImageConstPointer

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

Definition at line 61 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef InputImageType::PixelType itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::InputImagePixelType

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

Definition at line 63 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef InputImageType::Pointer itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::InputImagePointer

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

Definition at line 60 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef InputImageType::RegionType itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::InputImageRegionType

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

Definition at line 62 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef TInputImage itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::InputImageType

Some convenient typedefs.

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

Definition at line 58 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef ShapeKeepNObjectsLabelMapFilter< LabelMapType > itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::KeepNObjectsType

Definition at line 87 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef BinaryImageToLabelMapFilter< InputImageType, LabelMapType > itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::LabelizerType

Definition at line 82 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef LabelMap< LabelObjectType > itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::LabelMapType

Definition at line 81 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef ShapeLabelObject< LabelType, itkGetStaticConstMacro(ImageDimension) > itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::LabelObjectType

Definition at line 80 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef ShapeLabelMapFilter< LabelMapType, ShapeLabelFilterOutput > itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::LabelObjectValuatorType

Definition at line 85 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef SizeValueType itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::LabelType

Definition at line 78 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef OutputImageType::ConstPointer itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::OutputImageConstPointer

Definition at line 65 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef OutputImageType::PixelType itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::OutputImagePixelType

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

Definition at line 67 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef OutputImageType::Pointer itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TInputImage >.

Definition at line 64 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef OutputImageType::RegionType itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::OutputImageRegionType

Superclass typedefs.

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

Definition at line 66 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef TInputImage itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TInputImage >.

Definition at line 59 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef SmartPointer< Self > itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::Pointer

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

Definition at line 54 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef BinaryShapeKeepNObjectsImageFilter itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::Self

Standard class typedefs.

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

Definition at line 52 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef Image< typename OutputImageType::PixelType, itkGetStaticConstMacro(OutputImageDimension) > itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::ShapeLabelFilterOutput

Definition at line 84 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

typedef ImageToImageFilter< TInputImage, TInputImage > itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::Superclass

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

Definition at line 53 of file itkBinaryShapeKeepNObjectsImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage >

itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::BinaryShapeKeepNObjectsImageFilter

(

)

[protected]

template<class TInputImage >

itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::~BinaryShapeKeepNObjectsImageFilter

(

)

[inline, protected]

Definition at line 167 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::BinaryShapeKeepNObjectsImageFilter

(

const Self &

)

[private]

---

Member Function Documentation

template<class TInputImage >

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

void itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::EnlargeOutputRequestedRegion

(

DataObject *

)

[protected, virtual]

BinaryShapeKeepNObjectsImageFilter will produce the entire output.

Reimplemented from itk::ProcessObject.

template<class TInputImage >

virtual void itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::FullyConnectedOff

(

)

[virtual]

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

template<class TInputImage >

virtual void itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::FullyConnectedOn

(

)

[virtual]

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

template<class TInputImage >

void itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::GenerateData

(

)

[protected, virtual]

Single-threaded version of GenerateData. This filter delegates to GrayscaleGeodesicErodeImageFilter.

Reimplemented from itk::ImageSource< TInputImage >.

template<class TInputImage >

void itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::GenerateInputRequestedRegion

(

)

[protected, virtual]

BinaryShapeKeepNObjectsImageFilter needs the entire input be available. Thus, it needs to provide an implementation of GenerateInputRequestedRegion().

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

template<class TInputImage >

virtual AttributeType itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::GetAttribute

(

)

const [virtual]

Set/Get the attribute to use to select the object to keep. The default is "NumberOfPixels".

template<class TInputImage >

virtual OutputImagePixelType itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::GetBackgroundValue

(

)

const [virtual]

End concept checking Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::NonpositiveMin().

template<class TInputImage >

virtual OutputImagePixelType itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::GetForegroundValue

(

)

const [virtual]

Set/Get the value used as "foreground" in the output image. Defaults to NumericTraits<PixelType>::max().

template<class TInputImage >

virtual const bool& itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::GetFullyConnected

(

)

[virtual]

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

template<class TInputImage >

virtual const char* itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::GetNameOfClass

(

)

const [virtual]

Runtime information support.

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

template<class TInputImage >

virtual SizeValueType itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::GetNumberOfObjects

(

)

const [virtual]

Set/Get the number of objects to keep

template<class TInputImage >

virtual bool itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::GetReverseOrdering

(

)

const [virtual]

Set/Get the ordering of the objects. By default, the ones with the highest value are kept. Turming ReverseOrdering to true make this filter keep the objects with the smallest values

template<class TInputImage >

static Pointer itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::New

(

)

[static]

Standard New method.

Reimplemented from itk::Object.

template<class TInputImage >

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

template<class TInputImage >

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

template<class TInputImage >

virtual void itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::ReverseOrderingOff

(

)

[virtual]

Set/Get the ordering of the objects. By default, the ones with the highest value are kept. Turming ReverseOrdering to true make this filter keep the objects with the smallest values

template<class TInputImage >

virtual void itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::ReverseOrderingOn

(

)

[virtual]

Set/Get the ordering of the objects. By default, the ones with the highest value are kept. Turming ReverseOrdering to true make this filter keep the objects with the smallest values

template<class TInputImage >

virtual void itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::SetAttribute

(

AttributeType

_arg

)

[virtual]

Set/Get the attribute to use to select the object to keep. The default is "NumberOfPixels".

template<class TInputImage >

void itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::SetAttribute

(

const std::string &

s

)

[inline]

Set/Get the attribute to use to select the object to keep. The default is "NumberOfPixels".

Definition at line 159 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

virtual void itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::SetBackgroundValue

(

OutputImagePixelType

_arg

)

[virtual]

End concept checking Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::NonpositiveMin().

template<class TInputImage >

virtual void itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::SetForegroundValue

(

OutputImagePixelType

_arg

)

[virtual]

Set/Get the value used as "foreground" in the output image. Defaults to NumericTraits<PixelType>::max().

template<class TInputImage >

virtual void itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::SetFullyConnected

(

bool

_arg

)

[virtual]

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

template<class TInputImage >

virtual void itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::SetNumberOfObjects

(

SizeValueType

_arg

)

[virtual]

Set/Get the number of objects to keep

template<class TInputImage >

virtual void itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::SetReverseOrdering

(

bool

_arg

)

[virtual]

Set/Get the ordering of the objects. By default, the ones with the highest value are kept. Turming ReverseOrdering to true make this filter keep the objects with the smallest values

template<class TInputImage >

itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::typedef

(

Concept::EqualityComparable< InputImagePixelType >

)

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

template<class TInputImage >

itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::typedef

(

Concept::Convertible< int, InputImagePixelType >

)

This class requires IntConvertibleToInputCheck in the form of ( Concept::Convertible< int, InputImagePixelType > )

template<class TInputImage >

itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::typedef

(

Concept::OStreamWritable< InputImagePixelType >

)

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

---

Member Data Documentation

template<class TInputImage >

const unsigned int itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::ImageDimension = TInputImage::ImageDimension [static]

ImageDimension constants

Definition at line 75 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

const unsigned int itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::InputImageDimension = TInputImage::ImageDimension [static]

ImageDimension constants

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

Definition at line 71 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

AttributeType itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::m_Attribute [private]

Definition at line 191 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

OutputImagePixelType itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::m_BackgroundValue [private]

Definition at line 187 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

OutputImagePixelType itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::m_ForegroundValue [private]

Definition at line 188 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

bool itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::m_FullyConnected [private]

Definition at line 186 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

SizeValueType itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::m_NumberOfObjects [private]

Definition at line 189 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

bool itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::m_ReverseOrdering [private]

Definition at line 190 of file itkBinaryShapeKeepNObjectsImageFilter.h.

template<class TInputImage >

const unsigned int itk::BinaryShapeKeepNObjectsImageFilter< TInputImage >::OutputImageDimension = TInputImage::ImageDimension [static]

ImageDimension constants

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

Definition at line 73 of file itkBinaryShapeKeepNObjectsImageFilter.h.

---

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

• itkBinaryShapeKeepNObjectsImageFilter.h