vlNeighborhood Class Reference

A class to define the neighborhood of a voxel. More...

#include <vlneighborhood.h>

Inheritance diagram for vlNeighborhood:

List of all members.

Public Member Functions
	vlNeighborhood (uint16 dimension=3)
virtual	~vlNeighborhood ()
uint16	dimension () const
	Returns the dimension of the neighborhood.
const std::vector< vlOffset > &	getOffsets () const
	Get the offsets.
bool	add (const vlOffset &offset)
	Add an offset to the neighborhood.
bool	clear ()
	Remove all offsets from the neighborhood.
Protected Attributes
std::vector< vlOffset >	m_offsets
	Stores the offsets to the neighborhood voxels from the central voxel.
uint16	m_dimension
	Stores the dimension of this neighborhood.
Friends
std::ostream &	operator<< (std::ostream &os, vlNeighborhood const *const n)
	overriding << to enable writing neighborhood to a stream
std::ostream &	operator<< (std::ostream &os, vlNeighborhood const &n)
	overriding << to enable writing neighborhood to a stream

---

Detailed Description

This is a collection of offsets which defines the neighborhood of a voxel.

Definition at line 40 of file vlneighborhood.h.

---

Constructor & Destructor Documentation

vlNeighborhood::vlNeighborhood (  uint16  dimension = 3  )  [inline]

Definition at line 43 of file vlneighborhood.h. References dimension(), and m_dimension.

virtual vlNeighborhood::~vlNeighborhood (   )  [inline, virtual]

Definition at line 49 of file vlneighborhood.h.

---

Member Function Documentation

bool vlNeighborhood::add (  const vlOffset &  offset  )  [inline]

Definition at line 58 of file vlneighborhood.h. References vlOffset::dim(), m_dimension, and m_offsets. Referenced by vlRegionGrowOffsetFinder::regionGrowOffsets().

bool vlNeighborhood::clear (   )  [inline]

Definition at line 69 of file vlneighborhood.h. References m_offsets. Referenced by vlNeighborhoodAxial::create().

uint16 vlNeighborhood::dimension (   )  const [inline]

Definition at line 52 of file vlneighborhood.h. References m_dimension, and uint16. Referenced by vlNeighborhood().

const std::vector<vlOffset>& vlNeighborhood::getOffsets (   )  const [inline]

Definition at line 55 of file vlneighborhood.h. References m_offsets. Referenced by vlVolIterConst< DataType, vlLayout::Generic >::setNeighborhood(), and vlVolIterConst< DataType, vlLayout::Linear >::setNeighborhood().

---

Friends And Related Function Documentation

std::ostream& operator<< (  std::ostream &  os, vlNeighborhood const &  n )  [friend]

Definition at line 81 of file vlneighborhood.h.

std::ostream& operator<< (  std::ostream &  os, vlNeighborhood const *const  n )  [friend]

Definition at line 76 of file vlneighborhood.h.

---

Member Data Documentation

uint16 vlNeighborhood::m_dimension [protected]

Definition at line 95 of file vlneighborhood.h. Referenced by add(), vlNeighborhoodAxial::create(), dimension(), vlNeighborhoodAxial::setAxis(), and vlNeighborhood().

std::vector<vlOffset> vlNeighborhood::m_offsets [protected]

Definition at line 92 of file vlneighborhood.h. Referenced by add(), clear(), vlNeighborhoodAxial::create(), getOffsets(), and vlNeighborhood3D::vlNeighborhood3D().

---

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

• vlneighborhood.h

---