Developer Documentation
RAVL, Recognition And Vision Library
USER HOME PAGE CLASS LIST CONTENTS
Ravl - Core - Arrays - 2D - Array2dSqr3IterC<class DataT>
 

  PUBLIC
Array2dSqr3IterC::Array2dSqr3IterC(void)
Array2dSqr3IterC::Array2dSqr3IterC(const Array2dC &)
Array2dSqr3IterC::First(void)
Array2dSqr3IterC::Next(void)
Array2dSqr3IterC::IsElm(void) const
Array2dSqr3IterC::operator bool(void) const
Array2dSqr3IterC::operator ++(void)
Array2dSqr3IterC::operator ++(int)
Array2dSqr3IterC::DataBL(void)
Array2dSqr3IterC::DataBL(void) const
Array2dSqr3IterC::DataBM(void)
Array2dSqr3IterC::DataBM(void) const
Array2dSqr3IterC::DataBR(void)
Array2dSqr3IterC::DataBR(void) const
Array2dSqr3IterC::DataML(void)
Array2dSqr3IterC::DataML(void) const
Array2dSqr3IterC::DataMM(void)
Array2dSqr3IterC::DataMM(void) const
Array2dSqr3IterC::DataMR(void)
Array2dSqr3IterC::DataMR(void) const
Array2dSqr3IterC::DataTL(void)
Array2dSqr3IterC::DataTL(void) const
Array2dSqr3IterC::DataTM(void)
Array2dSqr3IterC::DataTM(void) const
Array2dSqr3IterC::DataTR(void)
Array2dSqr3IterC::DataTR(void) const
BufferAccess2dIterC::First(const BufferAccessC> &,SizeT,SizeT)
BufferAccess2dIterC::First(const SizeBufferAccessC> &,SizeT)
BufferAccess2dIterC::First(const BufferAccessC> &,const IndexRangeC &,const IndexRangeC &)
BufferAccess2dIterC::First(const RangeBufferAccessC> &,const IndexRangeC &)
BufferAccess2dIterC::RowStart(void)
BufferAccess2dIterC::NextRow(void)
BufferAccess2dIterC::NextRow(IndexC)
BufferAccess2dIterC::NextCol(void)
BufferAccess2dIterC::NextCol(int)
BufferAccess2dIterC::Next(void)
BufferAccess2dIterC::IsElm(void) const
BufferAccess2dIterC::operator bool(void) const
BufferAccess2dIterC::operator ++(void)
BufferAccess2dIterC::operator ++(int)
BufferAccess2dIterC::operator *(void)
BufferAccess2dIterC::operator *(void) const
BufferAccess2dIterC::operator ->(void)
BufferAccess2dIterC::operator ->(void) const
BufferAccess2dIterC::Data(void)
BufferAccess2dIterC::Data(void) const
BufferAccess2dIterC::Data1(void)
BufferAccess2dIterC::Data1(void) const
BufferAccess2dIterC::Row(void)
BufferAccess2dIterC::Row(void) const
BufferAccess2dIterC::RowIndex(const BufferAccessC *) const
BufferAccess2dIterC::ColIndex(void) const
BufferAccess2dIterC::Index(const BufferAccessC *) const
BufferAccess2dIterC::Invalidate(void)

   Array2dSqr3IterC<class DataT>   
 
Iterate through an array accessing 3x3 area.
 
include "Ravl/Array2dSqr3Iter.hh"
Source file:Ravl/Core/Container/Array/Array2dSqr3Iter.hh
User Level:Normal
Library:RavlCore
In Scope:RavlN

Comments:
The square can be accessed with DataBL,DataBR etc... which access the following array elements.

TL TM TR
ML MM MR
BL BM BR

Parent Classes: Variables:
Array2dC array;

DataT * up;

DataT * dn;

Methods:
Array2dSqr3IterC()
Default constructor.

Array2dSqr3IterC(const Array2dC<DataT> & narray)
Constructor.

bool First()
Goto first element in the array.

bool Next()
Goto next element.

bool IsElm() const
Test if iterator is at a valid element.

operator bool() const
Test if iterator is at a valid element.

void operator ++()
Goto next element.

void operator ++(int)
Goto next element.

DataT & DataBL()
Access bottom left data element

const DataT & DataBL() const
Access bottom left data element

DataT & DataBM()
Access bottom mid data element

const DataT & DataBM() const
Access bottom mid data element

DataT & DataBR()
Access bottom right data element

const DataT & DataBR() const
Access bottom right data element

DataT & DataML()
Access middle left data element

const DataT & DataML() const
Access middle left data element

DataT & DataMM()
Access middle data element

const DataT & DataMM() const
Access middle data element

DataT & DataMR()
Access middle right data element

const DataT & DataMR() const
Access middle right data element

DataT & DataTL()
Access top left data element.

const DataT & DataTL() const
Access top left data element

DataT & DataTM()
Access top middle element

const DataT & DataTM() const
Access top middle element

DataT & DataTR()
Access top right data element

const DataT & DataTR() const
Access top right data element

#include "Ravl/BfAcc2Iter.hh"
bool First(const BufferAccessC<BufferAccessC<DataT>> & pbuf,SizeT size1,SizeT size2)
Goto first element in the array.

bool First(const SizeBufferAccessC<BufferAccessC<DataT>> & pbuf,SizeT size)
Goto first element in the array.

bool First(const BufferAccessC<BufferAccessC<DataT>> & pbuf,const IndexRangeC & nrng1,const IndexRangeC & nrng2)
Goto first element in the array.

bool First(const RangeBufferAccessC<BufferAccessC<DataT>> & pbuf,const IndexRangeC & nrng)
Goto first element in the array

void RowStart()
Go back to the begining of this row.

bool NextRow()
Go to the begining of the next row.
Returns true if the iterator is begining of a valid row, and false if it is at the end of the array.

bool NextRow(IndexC off)
Go to the 'offset' from the first element in the next row.
Returns true if the iterator is in a valid row, and false if it is at the end of the array.

void NextCol()
Goto next column, without checking for row change.
Use with care.

void NextCol(int skip)
Go forward 'skip' columns, without checking for row change.
Use with care.

bool Next()
Goto next element.
Goto next element in the array. Returns true if the element is on the same row of the array. It returns false if the element is on the next row or at the end of the array.

bool IsElm() const
Test if iterator is at a valid element.

operator bool() const
Test if iterator is at a valid element.

void operator ++()
Goto next element.

void operator ++(int)
Goto next element.

DataT & operator *()
Access data of current element

const DataT & operator *() const
Access data of current element

DataT * operator ->()
Access data of current element

const DataT * operator ->() const
Access data of current element

DataT & Data()
Access data of current element

const DataT & Data() const
Access data of current element

DataT & Data1()
Access data of current element

const DataT & Data1() const
Access data of current element

RangeBufferAccessC<DataT> & Row()
Access row we're currently iterating.

const RangeBufferAccessC<DataT> & Row() const
Access row we're currently iterating.

IntT RowIndex(const BufferAccessC<DataT> * row1Begin) const
Work out the current row.

IntT ColIndex() const
Work out the current column.

Index2dC Index(const BufferAccessC<DataT> * rowBegin) const
Get index of current location.
Has to be calculate, and so is slightly slow.

void Invalidate()
Invalidate this iterator.


Maintainer:Charles Galambos, Documentation by CxxDoc: Tue Aug 13 09:59:30 2002