itk::SparseFieldCityBlockNeighborList< TNeighborhoodType > Class Template Reference

A convenience class for storing indicies which reference neighbor pixels within a neighborhood. More...

#include <itkSparseFieldLevelSetImageFilter.h>

Inheritance diagram for itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >:

Collaboration diagram for itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >:

List of all members.

Public Types
typedef TNeighborhoodType	NeighborhoodType
typedef NeighborhoodType::OffsetType	OffsetType
typedef NeighborhoodType::RadiusType	RadiusType
Public Member Functions
const unsigned int &	GetArrayIndex (unsigned int i) const
const OffsetType &	GetNeighborhoodOffset (unsigned int i) const
const RadiusType &	GetRadius () const
const unsigned int &	GetSize () const
int	GetStride (unsigned int i)
void	Print (std::ostream &os) const
	SparseFieldCityBlockNeighborList ()
	~SparseFieldCityBlockNeighborList ()
Static Public Attributes
static const unsigned int	Dimension = NeighborhoodType::Dimension
Private Attributes
std::vector< unsigned int >	m_ArrayIndex
std::vector< OffsetType >	m_NeighborhoodOffset
RadiusType	m_Radius
unsigned int	m_Size
unsigned	m_StrideTable [Dimension]

---

Detailed Description

template<class TNeighborhoodType>
class itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >

A convenience class for storing indicies which reference neighbor pixels within a neighborhood.

This class creates and stores indicies for use in finding neighbors within an itk::NeighborhoodIterator object. Both an array of unsigned integer indicies and an array of N dimensional offsets (from the center of the neighborhood) are created and stored. The indicies and offsets correspond to the "city-block" neighbors, that is, 4-neighbors in 2d, 6-neighbors in 3d, etc.

Order of reference is lowest index to highest index in the neighborhood. For example, for 4 connectivity, the indicies refer to the following neighbors:

  * 1 *
  2 * 3
  * 4 *

Definition at line 73 of file itkSparseFieldLevelSetImageFilter.h.

---

Member Typedef Documentation

template<class TNeighborhoodType>

typedef TNeighborhoodType itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::NeighborhoodType

Definition at line 76 of file itkSparseFieldLevelSetImageFilter.h.

template<class TNeighborhoodType>

typedef NeighborhoodType::OffsetType itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::OffsetType

Definition at line 77 of file itkSparseFieldLevelSetImageFilter.h.

template<class TNeighborhoodType>

typedef NeighborhoodType::RadiusType itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::RadiusType

Definition at line 78 of file itkSparseFieldLevelSetImageFilter.h.

---

Constructor & Destructor Documentation

template<class TNeighborhoodType>

itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::SparseFieldCityBlockNeighborList

(

)

template<class TNeighborhoodType>

itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::~SparseFieldCityBlockNeighborList

(

)

[inline]

Definition at line 99 of file itkSparseFieldLevelSetImageFilter.h.

---

Member Function Documentation

template<class TNeighborhoodType>

const unsigned int& itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::GetArrayIndex

(

unsigned int

i

)

const [inline]

Definition at line 86 of file itkSparseFieldLevelSetImageFilter.h.

template<class TNeighborhoodType>

const OffsetType& itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::GetNeighborhoodOffset

(

unsigned int

i

)

const [inline]

Definition at line 89 of file itkSparseFieldLevelSetImageFilter.h.

template<class TNeighborhoodType>

const RadiusType& itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::GetRadius

(

void

)

const [inline]

Definition at line 83 of file itkSparseFieldLevelSetImageFilter.h.

template<class TNeighborhoodType>

const unsigned int& itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::GetSize

(

void

)

const [inline]

Definition at line 92 of file itkSparseFieldLevelSetImageFilter.h.

template<class TNeighborhoodType>

int itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::GetStride

(

unsigned int

i

)

[inline]

Definition at line 95 of file itkSparseFieldLevelSetImageFilter.h.

template<class TNeighborhoodType>

void itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::Print

(

std::ostream &

os

)

const

---

Member Data Documentation

template<class TNeighborhoodType>

const unsigned int itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::Dimension = NeighborhoodType::Dimension [static]

Definition at line 80 of file itkSparseFieldLevelSetImageFilter.h.

template<class TNeighborhoodType>

std::vector< unsigned int > itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::m_ArrayIndex [private]

Definition at line 106 of file itkSparseFieldLevelSetImageFilter.h.

Referenced by itk::SparseFieldCityBlockNeighborList< NeighborhoodIterator< OutputImageType > >::GetArrayIndex().

template<class TNeighborhoodType>

std::vector< OffsetType > itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::m_NeighborhoodOffset [private]

Definition at line 107 of file itkSparseFieldLevelSetImageFilter.h.

Referenced by itk::SparseFieldCityBlockNeighborList< NeighborhoodIterator< OutputImageType > >::GetNeighborhoodOffset().

template<class TNeighborhoodType>

RadiusType itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::m_Radius [private]

Definition at line 105 of file itkSparseFieldLevelSetImageFilter.h.

Referenced by itk::SparseFieldCityBlockNeighborList< NeighborhoodIterator< OutputImageType > >::GetRadius().

template<class TNeighborhoodType>

unsigned int itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::m_Size [private]

Definition at line 104 of file itkSparseFieldLevelSetImageFilter.h.

Referenced by itk::SparseFieldCityBlockNeighborList< NeighborhoodIterator< OutputImageType > >::GetSize().

template<class TNeighborhoodType>

unsigned itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::m_StrideTable[Dimension] [private]

An internal table for keeping track of stride lengths in a neighborhood, i.e. the memory offsets between pixels along each dimensional axis.

Definition at line 111 of file itkSparseFieldLevelSetImageFilter.h.

Referenced by itk::SparseFieldCityBlockNeighborList< NeighborhoodIterator< OutputImageType > >::GetStride().

---

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

• itkSparseFieldLevelSetImageFilter.h