vlSliceInfo Class Reference

Class to store slice information.

#include <vlsliceinfo.h>

Inheritance diagram for vlSliceInfo:

List of all members.

Public Member Functions
	vlSliceInfo ()
	Default constructor.
virtual	~vlSliceInfo ()
	Default destructor.
vlNormal< float >	normal () const
	Get the normal.
uint16	count () const
	Get the number of slices along the current normal.
uint16	xDim () const
	Get the x dimension of the slice.
uint16	yDim () const
	Get the y dimension of the slice.
float	pos () const
	Get the slice position.
vlAxis	axis () const
	Get the axis of the slice.
vlDataType	dataType () const
	Get the data type of the slice.
Protected Attributes
vlNormal< float >	m_normal
	Normal to the slice.
uint16	m_sliceCount
	Number of slices in the given slice direction (m_normal).
uint16	m_xDim
	Slice dimension along X.
uint16	m_yDim
	Slice dimension along Y.
float	m_slicePos
	Slice position of the current slice in memory (always in the range [0,m_sliceCount-1]).
vlAxis	m_axis
	The axis along which the normal is oriented.
vlDataType	m_dataType
	The datatype of the voxel.
Friends
class	vlSlice
std::ostream &	operator<< (std::ostream &os, vlSliceInfo const *const si)
	overriding << to enable writing slice info to a stream
std::ostream &	operator<< (std::ostream &os, vlSliceInfo const &si)
	overriding << to enable writing slice info to a stream

---

Constructor & Destructor Documentation

vlSliceInfo::vlSliceInfo (   )

Definition at line 29 of file vlsliceinfo.cpp. References VL_Z_AXIS.

vlSliceInfo::~vlSliceInfo (   )  [virtual]

Definition at line 40 of file vlsliceinfo.cpp.

---

Member Function Documentation

vlAxis vlSliceInfo::axis (   )  const [inline]

Definition at line 67 of file vlsliceinfo.h. References m_axis, and vlAxis.

uint16 vlSliceInfo::count (   )  const [inline]

Definition at line 55 of file vlsliceinfo.h. References m_sliceCount, and uint16.

vlDataType vlSliceInfo::dataType (   )  const [inline]

Definition at line 70 of file vlsliceinfo.h. References m_dataType, and vlDataType.

vlNormal<float> vlSliceInfo::normal (   )  const [inline]

Definition at line 52 of file vlsliceinfo.h. References m_normal.

float vlSliceInfo::pos (   )  const [inline]

Definition at line 64 of file vlsliceinfo.h. References m_slicePos.

uint16 vlSliceInfo::xDim (   )  const [inline]

Definition at line 58 of file vlsliceinfo.h. References m_xDim, and uint16.

uint16 vlSliceInfo::yDim (   )  const [inline]

Definition at line 61 of file vlsliceinfo.h. References m_yDim, and uint16.

---

Friends And Related Function Documentation

std::ostream& operator<< (  std::ostream &  os, vlSliceInfo const &  si )  [friend]

Definition at line 78 of file vlsliceinfo.h.

std::ostream& operator<< (  std::ostream &  os, vlSliceInfo const *const  si )  [friend]

Definition at line 73 of file vlsliceinfo.h.

friend class vlSlice [friend]

Definition at line 42 of file vlsliceinfo.h.

---

Member Data Documentation

vlAxis vlSliceInfo::m_axis [protected]

Definition at line 103 of file vlsliceinfo.h. Referenced by axis(), vlSlice::extractSliceT(), vlSlice::getSlicePos(), vlSlice::getVoxelPos(), vlSlice::setDefaultParams(), and vlSlice::updateNormal().

vlDataType vlSliceInfo::m_dataType [protected]

Definition at line 106 of file vlsliceinfo.h. Referenced by dataType(), and vlSlice::setDefaultParams().

vlNormal<float> vlSliceInfo::m_normal [protected]

Definition at line 88 of file vlsliceinfo.h. Referenced by normal(), vlSlice::setDefaultParams(), vlSlice::setNormal(), and vlSlice::updateNormal().

uint16 vlSliceInfo::m_sliceCount [protected]

Definition at line 91 of file vlsliceinfo.h. Referenced by count(), vlSlice::isValid(), vlSlice::moveSlicePos(), vlSlice::setDefaultParams(), vlSlice::setSlicePos(), and vlSlice::updateNormal().

float vlSliceInfo::m_slicePos [protected]

Definition at line 100 of file vlsliceinfo.h. Referenced by vlSlice::extractSliceT(), vlSlice::getVoxelPos(), vlSlice::moveSlicePos(), pos(), vlSlice::setDefaultParams(), vlSlice::setSlicePos(), and vlSlice::updateNormal().

uint16 vlSliceInfo::m_xDim [protected]

Definition at line 94 of file vlsliceinfo.h. Referenced by vlSlice::getVoxelInfo(), vlSlice::isValid(), vlSlice::setDefaultParams(), vlSlice::updateNormal(), and xDim().

uint16 vlSliceInfo::m_yDim [protected]

Definition at line 97 of file vlsliceinfo.h. Referenced by vlSlice::getVoxelInfo(), vlSlice::isValid(), vlSlice::setDefaultParams(), vlSlice::updateNormal(), and yDim().

---

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

• vlsliceinfo.h
• vlsliceinfo.cpp

---