vlNeighborhoodAxial Class Reference

This defines a neighborhood whose neighbors are only along the axis.

#include <vlneighborhood_axial.h>

Inheritance diagram for vlNeighborhoodAxial:

List of all members.

Public Member Functions
	vlNeighborhoodAxial (uint16 radius, uint16 dimension=3)
	Default constructor. Takes the radius and the dimension.
	~vlNeighborhoodAxial ()
bool	setAxis (uint16 axis)
	Set the axis along which to create neighborhood.
bool	setAxis (std::vector< uint16 > axis)
	Same as the previous function but this one takes a list of axis along which should be part of the neighborhood.
Protected Member Functions
bool	create ()
	Creates the offset.
Protected Attributes
uint16	m_radius
	Stores the radius of the neighborhood.
std::vector< uint16 >	m_axis
	Stores the axis along which to create the neighborhood.

---

Constructor & Destructor Documentation

vlNeighborhoodAxial::vlNeighborhoodAxial (  uint16  radius, uint16  dimension = 3 )

Definition at line 29 of file vlneighborhood_axial.cpp. References create().

vlNeighborhoodAxial::~vlNeighborhoodAxial (   )

Definition at line 36 of file vlneighborhood_axial.cpp.

---

Member Function Documentation

bool vlNeighborhoodAxial::create (   )  [protected]

Definition at line 71 of file vlneighborhood_axial.cpp. References vlNeighborhood::clear(), vlNeighborhood::m_dimension, vlNeighborhood::m_offsets, m_radius, and uint16. Referenced by vlNeighborhoodAxial().

bool vlNeighborhoodAxial::setAxis (  std::vector< uint16 >  axis  )

Definition at line 54 of file vlneighborhood_axial.cpp. References m_axis, and vlNeighborhood::m_dimension.

bool vlNeighborhoodAxial::setAxis (  uint16  axis  )

By default, the neighborhood will contain offsets along all axis as defined by the dimension. Call this function to set neighborhood only along one perticular axis Definition at line 41 of file vlneighborhood_axial.cpp. References m_axis, and vlNeighborhood::m_dimension.

---

Member Data Documentation

std::vector<uint16> vlNeighborhoodAxial::m_axis [protected]

Definition at line 65 of file vlneighborhood_axial.h. Referenced by setAxis().

uint16 vlNeighborhoodAxial::m_radius [protected]

Definition at line 62 of file vlneighborhood_axial.h. Referenced by create().

---

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

• vlneighborhood_axial.h
• vlneighborhood_axial.cpp

---