itk::SparseFieldCityBlockNeighborList< TNeighborhoodType > Class Template Reference

#include <itkSparseFieldLevelSetImageFilter.h>

Detailed Description

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

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

This class creates and stores indices for use in finding neighbors within an itk::NeighborhoodIterator object. Both an array of unsigned integer indices and an array of N dimensional offsets (from the center of the neighborhood) are created and stored. The indices 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 indices refer to the following neighbors:

  1 *
2 * 3
  4 *

Definition at line 73 of file itkSparseFieldLevelSetImageFilter.h.

Collaboration diagram for itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >:

Public Types
using	NeighborhoodType = TNeighborhoodType
using	OffsetType = typename NeighborhoodType::OffsetType
using	RadiusType = typename NeighborhoodType::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, Indent indent) const
	SparseFieldCityBlockNeighborList ()
	~SparseFieldCityBlockNeighborList ()=default

Static Public Attributes
static constexpr 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 int	m_StrideTable [Dimension]

Member Typedef Documentation

NeighborhoodType

template<typename TNeighborhoodType>

using itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::NeighborhoodType = TNeighborhoodType

Definition at line 76 of file itkSparseFieldLevelSetImageFilter.h.

OffsetType

template<typename TNeighborhoodType>

using itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::OffsetType = typename NeighborhoodType::OffsetType

Definition at line 77 of file itkSparseFieldLevelSetImageFilter.h.

RadiusType

template<typename TNeighborhoodType>

using itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::RadiusType = typename NeighborhoodType::RadiusType

Definition at line 78 of file itkSparseFieldLevelSetImageFilter.h.

Constructor & Destructor Documentation

SparseFieldCityBlockNeighborList()

template<typename TNeighborhoodType>

itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::SparseFieldCityBlockNeighborList

(

)

~SparseFieldCityBlockNeighborList()

template<typename TNeighborhoodType>

itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::~SparseFieldCityBlockNeighborList ( )

default

Member Function Documentation

GetArrayIndex()

template<typename TNeighborhoodType>

const unsigned int& itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::GetArrayIndex ( unsigned int  i ) const

inline

Definition at line 88 of file itkSparseFieldLevelSetImageFilter.h.

GetNeighborhoodOffset()

template<typename TNeighborhoodType>

const OffsetType& itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::GetNeighborhoodOffset ( unsigned int  i ) const

inline

Definition at line 94 of file itkSparseFieldLevelSetImageFilter.h.

GetRadius()

template<typename TNeighborhoodType>

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

inline

Definition at line 82 of file itkSparseFieldLevelSetImageFilter.h.

GetSize()

template<typename TNeighborhoodType>

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

inline

Definition at line 100 of file itkSparseFieldLevelSetImageFilter.h.

GetStride()

template<typename TNeighborhoodType>

int itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::GetStride ( unsigned int  i )

inline

Definition at line 106 of file itkSparseFieldLevelSetImageFilter.h.

Print()

template<typename TNeighborhoodType>

void itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::Print	(	std::ostream &	os,
		Indent	indent
	)		const

Member Data Documentation

Dimension

template<typename TNeighborhoodType>

constexpr unsigned int itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::Dimension = NeighborhoodType::Dimension

staticconstexpr

Definition at line 79 of file itkSparseFieldLevelSetImageFilter.h.

m_ArrayIndex

template<typename TNeighborhoodType>

std::vector<unsigned int> itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::m_ArrayIndex

private

Definition at line 120 of file itkSparseFieldLevelSetImageFilter.h.

m_NeighborhoodOffset

template<typename TNeighborhoodType>

std::vector<OffsetType> itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::m_NeighborhoodOffset

private

Definition at line 121 of file itkSparseFieldLevelSetImageFilter.h.

m_Radius

template<typename TNeighborhoodType>

RadiusType itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::m_Radius

private

Definition at line 119 of file itkSparseFieldLevelSetImageFilter.h.

m_Size

template<typename TNeighborhoodType>

unsigned int itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::m_Size

private

Definition at line 118 of file itkSparseFieldLevelSetImageFilter.h.

m_StrideTable

template<typename TNeighborhoodType>

unsigned int 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 125 of file itkSparseFieldLevelSetImageFilter.h.

---

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

• itkSparseFieldLevelSetImageFilter.h