ITK  4.8.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::RelabelComponentImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkRelabelComponentImageFilter.h>

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

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::RelabelComponentImageFilter< TInputImage, TOutputImage >

Relabel the components in an image such that consecutive labels are used.

RelabelComponentImageFilter remaps the labels associated with the objects in an image (as from the output of ConnectedComponentImageFilter) such that the label numbers are consecutive with no gaps between the label numbers used. By default, the relabeling will also sort the labels based on the size of the object: the largest object will have label #1, the second largest will have label #2, etc. If two labels have the same size their initial order is kept. The sorting by size can be disabled using SetSortByObjectSize.

Label #0 is assumed to be the background and is left unaltered by the relabeling.

RelabelComponentImageFilter is typically used on the output of the ConnectedComponentImageFilter for those applications that want to extract the largest object or the "k" largest objects. Any particular object can be extracted from the relabeled output using a BinaryThresholdImageFilter. A group of objects can be extracted from the relabled output using a ThresholdImageFilter.

Once all the objects are relabeled, the application can query the number of objects and the size of each object. Object sizes are returned in a vector. The size of the background is not calculated. So the size of object #1 is GetSizeOfObjectsInPixels()[0], the size of object #2 is GetSizeOfObjectsInPixels()[1], etc.

If user sets a minimum object size, all objects with fewer pixels than the minimum will be discarded, so that the number of objects reported will be only those remaining. The GetOriginalNumberOfObjects method can be called to find out how many objects were present before the small ones were discarded.

RelabelComponentImageFilter can be run as an "in place" filter, where it will overwrite its output. The default is run out of place (or generate a separate output). "In place" operation can be controlled via methods in the superclass, InPlaceImageFilter::InPlaceOn() and InPlaceImageFilter::InPlaceOff().

See Also
ConnectedComponentImageFilter, BinaryThresholdImageFilter, ThresholdImageFilter
Wiki Examples:
Examples:
Examples/Segmentation/RelabelComponentImageFilter.cxx, WikiExamples/ImageProcessing/RelabelComponentImageFilter.cxx, WikiExamples/ImageProcessing/ScalarConnectedComponentImageFilter.cxx, and WikiExamples/Statistics/ScalarImageKmeansImageFilter.cxx.

Definition at line 81 of file itkRelabelComponentImageFilter.h.

Classes

struct  RelabelComponentObjectType
 
class  RelabelComponentSizeInPixelsComparator
 

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef TInputImage::IndexType IndexType
 
typedef
Superclass::InputImagePointer 
InputImagePointer
 
typedef TInputImage InputImageType
 
typedef IdentifierType LabelType
 
typedef std::vector< float > ObjectSizeInPhysicalUnitsContainerType
 
typedef std::vector
< ObjectSizeType
ObjectSizeInPixelsContainerType
 
typedef SizeValueType ObjectSizeType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef TOutputImage::RegionType RegionType
 
typedef RelabelComponentImageFilter Self
 
typedef TInputImage::SizeType SizeType
 
typedef InPlaceImageFilter
< TInputImage, TOutputImage > 
Superclass
 
- Public Types inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImagePointer 
OutputImagePointer
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef Superclass::OutputImageType OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef InPlaceImageFilter Self
 
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToImageFilter Self
 
typedef ImageSource< TOutputImage > Superclass
 
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual ObjectSizeType GetMinimumObjectSize () const
 
virtual const char * GetNameOfClass () const
 
virtual LabelType GetNumberOfObjects () const
 
virtual LabelType GetOriginalNumberOfObjects () const
 
const
ObjectSizeInPhysicalUnitsContainerType
GetSizeOfObjectsInPhysicalUnits () const
 
const
ObjectSizeInPixelsContainerType
GetSizeOfObjectsInPixels () const
 
virtual void SetMinimumObjectSize (ObjectSizeType _arg)
 
 typedef (Concept::EqualityComparable< InputPixelType >) InputEqualityComparableCheck
 
 typedef (Concept::Convertible< LabelType, InputPixelType >) UnsignedLongConvertibleToInputCheck
 
 typedef (Concept::Convertible< OutputPixelType, LabelType >) OutputLongConvertibleToUnsignedLongCheck
 
 typedef (Concept::Convertible< InputPixelType, OutputPixelType >) InputConvertibleToOutputCheck
 
 typedef (Concept::SameDimension< InputImageDimension, ImageDimension >) SameDimensionCheck
 
virtual void SetNumberOfObjectsToPrint (LabelType _arg)
 
virtual const LabelTypeGetNumberOfObjectsToPrint () const
 
virtual void SetSortByObjectSize (bool _arg)
 
virtual bool GetSortByObjectSize () const
 
virtual void SortByObjectSizeOn ()
 
virtual void SortByObjectSizeOff ()
 
ObjectSizeType GetSizeOfObjectInPixels (LabelType obj) const
 
float GetSizeOfObjectInPhysicalUnits (LabelType obj) const
 
- Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool CanRunInPlace () const
 
virtual void SetInPlace (bool _arg)
 
virtual bool GetInPlace () const
 
virtual void InPlaceOn ()
 
virtual void InPlaceOff ()
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
virtual void PopBackInput () override
 
virtual void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TInputImage *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *output)
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void GenerateData () override
 
void GenerateInputRequestedRegion () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 RelabelComponentImageFilter ()
 
virtual ~RelabelComponentImageFilter ()
 
- Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual void AllocateOutputs () override
 
virtual bool GetRunningInPlace () const
 
 InPlaceImageFilter ()
 
virtual void ReleaseInputs () override
 
 ~InPlaceImageFilter ()
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
 ImageToImageFilter ()
 
virtual void VerifyInputInformation () override
 
 ~ImageToImageFilter ()
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual ~ImageSource ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

void operator= (const Self &)
 
 RelabelComponentImageFilter (const Self &)
 

Private Attributes

ObjectSizeType m_MinimumObjectSize
 
LabelType m_NumberOfObjects
 
LabelType m_NumberOfObjectsToPrint
 
LabelType m_OriginalNumberOfObjects
 
ObjectSizeInPhysicalUnitsContainerType m_SizeOfObjectsInPhysicalUnits
 
ObjectSizeInPixelsContainerType m_SizeOfObjectsInPixels
 
bool m_SortByObjectSize
 
typedef TOutputImage::PixelType OutputPixelType
 
typedef
TOutputImage::InternalPixelType 
OutputInternalPixelType
 
typedef TInputImage::PixelType InputPixelType
 
typedef
TInputImage::InternalPixelType 
InputInternalPixelType
 
static const unsigned int ImageDimension = TOutputImage::ImageDimension
 
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 

Additional Inherited Members

- Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 
InputToOutputRegionCopierType
 
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 
OutputToInputRegionCopierType
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TInputImage , typename TOutputImage >
typedef SmartPointer< const Self > itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::ConstPointer

Definition at line 123 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef TInputImage::IndexType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::IndexType

Definition at line 115 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef Superclass::InputImagePointer itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::InputImagePointer

Types from the Superclass

Definition at line 94 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef TInputImage itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::InputImageType

Image typedef support

Definition at line 113 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef TInputImage::InternalPixelType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::InputInternalPixelType

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Definition at line 103 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef TInputImage::PixelType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::InputPixelType

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Definition at line 102 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef IdentifierType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::LabelType

Type used as identifier for the different component lables.

Definition at line 133 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef std::vector< float > itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::ObjectSizeInPhysicalUnitsContainerType

Definition at line 146 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef std::vector< ObjectSizeType > itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::ObjectSizeInPixelsContainerType

Definition at line 143 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef SizeValueType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::ObjectSizeType

Type used to count number of pixels in objects.

Definition at line 139 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef TOutputImage itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::OutputImageType

Definition at line 114 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef TOutputImage::InternalPixelType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::OutputInternalPixelType

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Definition at line 101 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef TOutputImage::PixelType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::OutputPixelType

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Definition at line 100 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef SmartPointer< Self > itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::Pointer

Smart pointer typedef support

Definition at line 122 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef TOutputImage::RegionType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::RegionType

Definition at line 117 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef RelabelComponentImageFilter itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::Self

Standard "Self" & Superclass typedef.

Definition at line 88 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef TInputImage::SizeType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::SizeType

Definition at line 116 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
typedef InPlaceImageFilter< TInputImage, TOutputImage > itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::Superclass

Definition at line 89 of file itkRelabelComponentImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TOutputImage >
itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::RelabelComponentImageFilter ( )
inlineprotected
template<typename TInputImage , typename TOutputImage >
virtual itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::~RelabelComponentImageFilter ( )
inlineprotectedvirtual

Definition at line 261 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::RelabelComponentImageFilter ( const Self )
private

Member Function Documentation

template<typename TInputImage , typename TOutputImage >
virtual::itk::LightObject::Pointer itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::CreateAnother ( ) 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<typename TInputImage , typename TOutputImage >
void itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GenerateData ( )
overrideprotectedvirtual

Standard pipeline method.

Reimplemented from itk::ImageSource< TOutputImage >.

template<typename TInputImage , typename TOutputImage >
void itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )
overrideprotectedvirtual

RelabelComponentImageFilter needs the entire input. Therefore it must provide an implementation GenerateInputRequestedRegion().

See Also
ProcessObject::GenerateInputRequestedRegion().

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

template<typename TInputImage , typename TOutputImage >
virtual ObjectSizeType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetMinimumObjectSize ( ) const
virtual

Get the caller-defined minimum size of an object in pixels. If the caller has not set the minimum, 0 will be returned, which is to be interpreted as meaning that no minimum exists, and all objects in the original label map will be passed through to the output.

template<typename TInputImage , typename TOutputImage >
virtual const char* itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods)

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

template<typename TInputImage , typename TOutputImage >
virtual LabelType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetNumberOfObjects ( ) const
virtual

Get the number of objects in the image. This information is only valid after the filter has executed.

template<typename TInputImage , typename TOutputImage >
virtual const LabelType& itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetNumberOfObjectsToPrint ( ) const
virtual

Get/Set the number of objects enumerated and described when the filter is printed.

template<typename TInputImage , typename TOutputImage >
virtual LabelType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetOriginalNumberOfObjects ( ) const
virtual

Get the original number of objects in the image before small objects were discarded. This information is only valid after the filter has executed. If the caller has not specified a minimum object size, OriginalNumberOfObjects is the same as NumberOfObjects.

template<typename TInputImage , typename TOutputImage >
float itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetSizeOfObjectInPhysicalUnits ( LabelType  obj) const
inline

Get the size of a particular object in physical space (in units of pixel size). This information is only valid after the filter has executed. Size of the background (object #0) is not calculated.

Definition at line 226 of file itkRelabelComponentImageFilter.h.

References itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_NumberOfObjects, and itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_SizeOfObjectsInPhysicalUnits.

template<typename TInputImage , typename TOutputImage >
ObjectSizeType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetSizeOfObjectInPixels ( LabelType  obj) const
inline

Get the size of a particular object in pixels. This information is only valid after the filter has executed. Size of the background (object #0) is not calculated.

Definition at line 210 of file itkRelabelComponentImageFilter.h.

References itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_NumberOfObjects, and itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_SizeOfObjectsInPixels.

template<typename TInputImage , typename TOutputImage >
const ObjectSizeInPhysicalUnitsContainerType& itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetSizeOfObjectsInPhysicalUnits ( ) const
inline

Get the size of each object in physical space (in units of pixel size). This information is only valid after the filter has executed. Size of the background is not calculated. Size of object #1 is GetSizeOfObjectsInPhysicalUnits()[0]. Size of object #2 is GetSizeOfObjectsInPhysicalUnits()[1]. Etc.

Definition at line 200 of file itkRelabelComponentImageFilter.h.

References itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_SizeOfObjectsInPhysicalUnits.

template<typename TInputImage , typename TOutputImage >
const ObjectSizeInPixelsContainerType& itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetSizeOfObjectsInPixels ( ) const
inline

Get the size of each object in pixels. This information is only valid after the filter has executed. Size of the background is not calculated. Size of object #1 is GetSizeOfObjectsInPixels()[0]. Size of object #2 is GetSizeOfObjectsInPixels()[1]. Etc.

Definition at line 188 of file itkRelabelComponentImageFilter.h.

References itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_SizeOfObjectsInPixels.

template<typename TInputImage , typename TOutputImage >
virtual bool itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetSortByObjectSize ( ) const
virtual

Controls whether the object labels are sorted by size. If false, initial order of labels is kept.

template<typename TInputImage , typename TOutputImage >
static Pointer itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

template<typename TInputImage , typename TOutputImage >
void itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::operator= ( const Self )
private
template<typename TInputImage , typename TOutputImage >
void itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Standard printself method

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

template<typename TInputImage , typename TOutputImage >
virtual void itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::SetMinimumObjectSize ( ObjectSizeType  _arg)
virtual

Set the minimum size in pixels for an object. All objects smaller than this size will be discarded and will not appear in the output label map. NumberOfObjects will count only the objects whose pixel counts are greater than or equal to the minimum size. Call GetOriginalNumberOfObjects to find out how many objects were present in the original label map.

template<typename TInputImage , typename TOutputImage >
virtual void itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::SetNumberOfObjectsToPrint ( LabelType  _arg)
virtual

Get/Set the number of objects enumerated and described when the filter is printed.

template<typename TInputImage , typename TOutputImage >
virtual void itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::SetSortByObjectSize ( bool  _arg)
virtual

Controls whether the object labels are sorted by size. If false, initial order of labels is kept.

template<typename TInputImage , typename TOutputImage >
virtual void itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::SortByObjectSizeOff ( )
virtual

Controls whether the object labels are sorted by size. If false, initial order of labels is kept.

template<typename TInputImage , typename TOutputImage >
virtual void itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::SortByObjectSizeOn ( )
virtual

Controls whether the object labels are sorted by size. If false, initial order of labels is kept.

template<typename TInputImage , typename TOutputImage >
itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::typedef ( Concept::EqualityComparable< InputPixelType )

This class requires InputEqualityComparableCheck in the form of ( Concept::EqualityComparable< InputPixelType > )

template<typename TInputImage , typename TOutputImage >
itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::typedef ( Concept::Convertible< LabelType, InputPixelType )

This class requires UnsignedLongConvertibleToInputCheck in the form of ( Concept::Convertible< LabelType, InputPixelType > )

template<typename TInputImage , typename TOutputImage >
itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::typedef ( Concept::Convertible< OutputPixelType, LabelType )

This class requires OutputLongConvertibleToUnsignedLongCheck in the form of ( Concept::Convertible< OutputPixelType, LabelType > )

template<typename TInputImage , typename TOutputImage >
itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::typedef ( Concept::Convertible< InputPixelType, OutputPixelType )

This class requires InputConvertibleToOutputCheck in the form of ( Concept::Convertible< InputPixelType, OutputPixelType > )

template<typename TInputImage , typename TOutputImage >
itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::typedef ( Concept::SameDimension< InputImageDimension, ImageDimension )

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

Member Data Documentation

template<typename TInputImage , typename TOutputImage >
const unsigned int itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::ImageDimension = TOutputImage::ImageDimension
static

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Definition at line 105 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
const unsigned int itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension
static

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Definition at line 107 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
ObjectSizeType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_MinimumObjectSize
private

Definition at line 317 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
LabelType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_NumberOfObjects
private
template<typename TInputImage , typename TOutputImage >
LabelType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_NumberOfObjectsToPrint
private

Definition at line 315 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
LabelType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_OriginalNumberOfObjects
private

Definition at line 316 of file itkRelabelComponentImageFilter.h.

template<typename TInputImage , typename TOutputImage >
ObjectSizeInPhysicalUnitsContainerType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_SizeOfObjectsInPhysicalUnits
private
template<typename TInputImage , typename TOutputImage >
ObjectSizeInPixelsContainerType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_SizeOfObjectsInPixels
private
template<typename TInputImage , typename TOutputImage >
bool itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_SortByObjectSize
private

Definition at line 318 of file itkRelabelComponentImageFilter.h.


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