ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage > Class Template Reference
Data Processing Objects » Filters » Image Filters » Intensity Image Filters » Mathematical Morphology Image Filters | Group Filtering » Module ITKLabelMap

#include <itkLabelImageToLabelMapFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
class itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >

convert a labeled image to a label collection image

LabelImageToLabelMapFilter converts a label image to a label collection image. The labels are the same in the input and the output image.

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: https://doi.org/10.54294/q6auw4

See also
BinaryImageToLabelMapFilter, LabelMapToLabelImageFilter
ITK Sphinx Examples:
  • <a href=
  • <a href=

Definition at line 49 of file itkLabelImageToLabelMapFilter.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using IndexType = typename InputImageType::IndexType
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using LabelObjectType = typename OutputImageType::LabelObjectType
 
using LengthType = typename LabelObjectType::LengthType
 
using OutputImageConstPointer = typename OutputImageType::ConstPointer
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = LabelImageToLabelMapFilter
 
using Superclass = ImageToImageFilter< TInputImage, TOutputImage >
 

Public Member Functions

const char * GetNameOfClass () const override
 
virtual void SetBackgroundValue (OutputImagePixelType _arg)
 
virtual OutputImagePixelType GetBackgroundValue () const
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 

Protected Member Functions

void AfterThreadedGenerateData () override
 
void BeforeThreadedGenerateData () override
 
void DynamicThreadedGenerateData (const OutputImageRegionType &) override
 
void EnlargeOutputRequestedRegion (DataObject *) override
 
void GenerateInputRequestedRegion () override
 
 LabelImageToLabelMapFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void ThreadedGenerateData (const OutputImageRegionType &regionForThread, ThreadIdType threadId) override
 
 ~LabelImageToLabelMapFilter () override=default
 

Private Attributes

OutputImagePixelType m_BackgroundValue {}
 
std::vector< OutputImagePointer > m_TemporaryImages {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
using itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 58 of file itkLabelImageToLabelMapFilter.h.

◆ IndexType

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
using itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::IndexType = typename InputImageType::IndexType

Definition at line 67 of file itkLabelImageToLabelMapFilter.h.

◆ InputImageConstPointer

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
using itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 64 of file itkLabelImageToLabelMapFilter.h.

◆ InputImagePixelType

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
using itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 66 of file itkLabelImageToLabelMapFilter.h.

◆ InputImagePointer

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
using itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 63 of file itkLabelImageToLabelMapFilter.h.

◆ InputImageRegionType

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
using itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 65 of file itkLabelImageToLabelMapFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
using itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Some convenient type alias.

Definition at line 61 of file itkLabelImageToLabelMapFilter.h.

◆ LabelObjectType

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
using itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::LabelObjectType = typename OutputImageType::LabelObjectType

Definition at line 73 of file itkLabelImageToLabelMapFilter.h.

◆ LengthType

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
using itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::LengthType = typename LabelObjectType::LengthType

Definition at line 74 of file itkLabelImageToLabelMapFilter.h.

◆ OutputImageConstPointer

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
using itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::OutputImageConstPointer = typename OutputImageType::ConstPointer

Definition at line 70 of file itkLabelImageToLabelMapFilter.h.

◆ OutputImagePixelType

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
using itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::OutputImagePixelType = typename OutputImageType::PixelType

Definition at line 72 of file itkLabelImageToLabelMapFilter.h.

◆ OutputImagePointer

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
using itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 69 of file itkLabelImageToLabelMapFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
using itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 71 of file itkLabelImageToLabelMapFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
using itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 62 of file itkLabelImageToLabelMapFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
using itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 57 of file itkLabelImageToLabelMapFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
using itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::Self = LabelImageToLabelMapFilter

Standard class type aliases.

Definition at line 55 of file itkLabelImageToLabelMapFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
using itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 56 of file itkLabelImageToLabelMapFilter.h.

Constructor & Destructor Documentation

◆ LabelImageToLabelMapFilter()

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::LabelImageToLabelMapFilter ( )
protected

◆ ~LabelImageToLabelMapFilter()

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::~LabelImageToLabelMapFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ AfterThreadedGenerateData()

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
void itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::AfterThreadedGenerateData ( )
overrideprotected

◆ BeforeThreadedGenerateData()

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
void itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( )
overrideprotected

◆ DynamicThreadedGenerateData()

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
void itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType &  )
inlineoverrideprotected

Definition at line 121 of file itkLabelImageToLabelMapFilter.h.

◆ EnlargeOutputRequestedRegion()

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
void itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::EnlargeOutputRequestedRegion ( DataObject *  )
overrideprotected

LabelImageToLabelMapFilter will produce the entire output.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
void itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )
overrideprotected

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

◆ GetBackgroundValue()

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
virtual OutputImagePixelType itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::GetBackgroundValue ( ) const
virtual

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

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
const char * itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
override
See also
LightObject::GetNameOfClass()

◆ New()

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
static Pointer itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::New ( )
static

Standard New method.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
void itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotected

◆ SetBackgroundValue()

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
virtual void itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::SetBackgroundValue ( OutputImagePixelType  _arg)
virtual

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

◆ ThreadedGenerateData()

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
void itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType &  regionForThread,
ThreadIdType  threadId 
)
overrideprotected

Member Data Documentation

◆ InputImageDimension

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
constexpr unsigned int itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension
staticconstexpr

ImageDimension constants

Definition at line 77 of file itkLabelImageToLabelMapFilter.h.

◆ m_BackgroundValue

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
OutputImagePixelType itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::m_BackgroundValue {}
private

Definition at line 130 of file itkLabelImageToLabelMapFilter.h.

◆ m_TemporaryImages

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
std::vector<OutputImagePointer> itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::m_TemporaryImages {}
private

Definition at line 132 of file itkLabelImageToLabelMapFilter.h.

◆ OutputImageDimension

template<typename TInputImage , typename TOutputImage = LabelMap<LabelObject<typename TInputImage::PixelType, TInputImage::ImageDimension>>>
constexpr unsigned int itk::LabelImageToLabelMapFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension
staticconstexpr

Definition at line 78 of file itkLabelImageToLabelMapFilter.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3