ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::LabelObjectLine< VImageDimension > Class Template Reference

#include <itkLabelObjectLine.h>

Detailed Description

template<unsigned int VImageDimension>
class itk::LabelObjectLine< VImageDimension >

LabelObjectLine is the line object used in the LabelObject class to store the line which are part of the object. A line is formed of and index and a length in the dimension 0. It is used in a run-length encoding

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

Definition at line 43 of file itkLabelObjectLine.h.

+ Collaboration diagram for itk::LabelObjectLine< VImageDimension >:

Public Types

using IndexType = Index< VImageDimension >
 
using LengthType = SizeValueType
 

Public Member Functions

const IndexTypeGetIndex () const
 
const LengthTypeGetLength () const
 
bool HasIndex (const IndexType idx) const
 
bool IsNextIndex (const IndexType &idx) const
 
 ITK_DEFAULT_COPY_AND_MOVE (LabelObjectLine)
 
 LabelObjectLine ()
 
 LabelObjectLine (const IndexType &idx, const LengthType &length)
 
void Print (std::ostream &os, Indent indent=0) const
 
void SetIndex (const IndexType &idx)
 
void SetLength (const LengthType length)
 
virtual ~LabelObjectLine ()=default
 

Static Public Attributes

static constexpr unsigned int ImageDimension = VImageDimension
 

Protected Member Functions

virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 

Private Attributes

IndexType m_Index {}
 
LengthType m_Length {}
 

Member Typedef Documentation

◆ IndexType

template<unsigned int VImageDimension>
using itk::LabelObjectLine< VImageDimension >::IndexType = Index<VImageDimension>

Definition at line 50 of file itkLabelObjectLine.h.

◆ LengthType

template<unsigned int VImageDimension>
using itk::LabelObjectLine< VImageDimension >::LengthType = SizeValueType

Definition at line 51 of file itkLabelObjectLine.h.

Constructor & Destructor Documentation

◆ LabelObjectLine() [1/2]

template<unsigned int VImageDimension>
itk::LabelObjectLine< VImageDimension >::LabelObjectLine ( )

◆ LabelObjectLine() [2/2]

template<unsigned int VImageDimension>
itk::LabelObjectLine< VImageDimension >::LabelObjectLine ( const IndexType idx,
const LengthType length 
)

◆ ~LabelObjectLine()

template<unsigned int VImageDimension>
virtual itk::LabelObjectLine< VImageDimension >::~LabelObjectLine ( )
virtualdefault

Member Function Documentation

◆ GetIndex()

template<unsigned int VImageDimension>
const IndexType & itk::LabelObjectLine< VImageDimension >::GetIndex ( ) const

◆ GetLength()

template<unsigned int VImageDimension>
const LengthType & itk::LabelObjectLine< VImageDimension >::GetLength ( ) const

◆ HasIndex()

template<unsigned int VImageDimension>
bool itk::LabelObjectLine< VImageDimension >::HasIndex ( const IndexType  idx) const

Check for index

◆ IsNextIndex()

template<unsigned int VImageDimension>
bool itk::LabelObjectLine< VImageDimension >::IsNextIndex ( const IndexType idx) const

◆ ITK_DEFAULT_COPY_AND_MOVE()

template<unsigned int VImageDimension>
itk::LabelObjectLine< VImageDimension >::ITK_DEFAULT_COPY_AND_MOVE ( LabelObjectLine< VImageDimension >  )

◆ Print()

template<unsigned int VImageDimension>
void itk::LabelObjectLine< VImageDimension >::Print ( std::ostream &  os,
Indent  indent = 0 
) const

Cause the object to print itself out.

◆ PrintHeader()

template<unsigned int VImageDimension>
virtual void itk::LabelObjectLine< VImageDimension >::PrintHeader ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

◆ PrintSelf()

template<unsigned int VImageDimension>
virtual void itk::LabelObjectLine< VImageDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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.

◆ PrintTrailer()

template<unsigned int VImageDimension>
virtual void itk::LabelObjectLine< VImageDimension >::PrintTrailer ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

◆ SetIndex()

template<unsigned int VImageDimension>
void itk::LabelObjectLine< VImageDimension >::SetIndex ( const IndexType idx)

Set/Get Index

◆ SetLength()

template<unsigned int VImageDimension>
void itk::LabelObjectLine< VImageDimension >::SetLength ( const LengthType  length)

SetGet Length

Member Data Documentation

◆ ImageDimension

template<unsigned int VImageDimension>
constexpr unsigned int itk::LabelObjectLine< VImageDimension >::ImageDimension = VImageDimension
staticconstexpr

Definition at line 48 of file itkLabelObjectLine.h.

◆ m_Index

template<unsigned int VImageDimension>
IndexType itk::LabelObjectLine< VImageDimension >::m_Index {}
private

Definition at line 103 of file itkLabelObjectLine.h.

◆ m_Length

template<unsigned int VImageDimension>
LengthType itk::LabelObjectLine< VImageDimension >::m_Length {}
private

Definition at line 104 of file itkLabelObjectLine.h.


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