itk::SparseFieldCityBlockNeighborList< TNeighborhoodType > Class Template Reference

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

#include <itkSparseFieldLevelSetImageFilter.h>

List of all members.

Public Types
typedef TNeighborhoodType	NeighborhoodType
typedef NeighborhoodType::OffsetType	OffsetType
typedef NeighborhoodType::RadiusType	RadiusType
Public Member Functions
	itkStaticConstMacro (Dimension, unsigned int, NeighborhoodType::Dimension)
const RadiusType &	GetRadius () const
const unsigned int &	GetArrayIndex (unsigned int i) const
const OffsetType &	GetNeighborhoodOffset (unsigned int i) const
const unsigned int &	GetSize () const
int	GetStride (unsigned int i)
	SparseFieldCityBlockNeighborList ()
	~SparseFieldCityBlockNeighborList ()
void	Print (std::ostream &os) const

---

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 69 of file itkSparseFieldLevelSetImageFilter.h.

---

Member Typedef Documentation

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

Definition at line 72 of file itkSparseFieldLevelSetImageFilter.h.

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

Definition at line 73 of file itkSparseFieldLevelSetImageFilter.h.

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

Definition at line 74 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 95 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 82 of file itkSparseFieldLevelSetImageFilter.h.

template<class TNeighborhoodType> const OffsetType& itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::GetNeighborhoodOffset (  unsigned int  i  )  const [inline]

Definition at line 85 of file itkSparseFieldLevelSetImageFilter.h.

template<class TNeighborhoodType> const RadiusType& itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::GetRadius (   )  const [inline]

Definition at line 79 of file itkSparseFieldLevelSetImageFilter.h.

template<class TNeighborhoodType> const unsigned int& itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::GetSize (   )  const [inline]

Definition at line 88 of file itkSparseFieldLevelSetImageFilter.h.

template<class TNeighborhoodType> int itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::GetStride (  unsigned int  i  )  [inline]

Definition at line 91 of file itkSparseFieldLevelSetImageFilter.h.

template<class TNeighborhoodType> itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::itkStaticConstMacro (  Dimension  , unsigned  int, NeighborhoodType::Dimension  )

template<class TNeighborhoodType> void itk::SparseFieldCityBlockNeighborList< TNeighborhoodType >::Print (  std::ostream &  os  )  const

---

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

• itkSparseFieldLevelSetImageFilter.h

---