Array2dSqr311Iter3C<class Data1T,class Data2T,class Data3T> - Iterate through an array accessing 3x3 area.

Developer Documentation

RAVL, Recognition And Vision Library

USER

Ravl - Core - Arrays - 2D - Array2dSqr311Iter3C<class Data1T,class Data2T,class Data3T>

Array2dSqr311Iter3C<class Data1T,class Data2T,class Data3T>

Iterate through an array accessing 3x3 area.

include	"Ravl/Array2dSqr311Iter3.hh"
Source file:	Ravl/Core/Container/Array/Array2dSqr311Iter3.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
for the first array.

Parent Classes:

BufferAccess2dIter3C

Variables:

Array2dC array1;
Array2dC array2;
Array2dC array3;
Data1T * up;
Data1T * dn;

Methods:

Array2dSqr311Iter3C(): Default constructor.
Array2dSqr311Iter3C(const Array2dC<Data1T> & narray1,const Array2dC<Data2T> & narray2,const Array2dC<Data3T> & narray3): 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.
Data1T & DataBL1(): Access bottom left data element
const Data1T & DataBL1() const: Access bottom left data element
Data1T & DataBM1(): Access bottom mid data element
const Data1T & DataBM1() const: Access bottom mid data element
Data1T & DataBR1(): Access bottom right data element
const Data1T & DataBR1() const: Access bottom right data element
Data1T & DataML1(): Access middle left data element
const Data1T & DataML1() const: Access middle left data element
Data1T & DataMM1(): Access middle data element
const Data1T & DataMM1() const: Access middle data element
Data1T & DataMR1(): Access middle right data element
const Data1T & DataMR1() const: Access middle right data element
Data1T & DataTL1(): Access top left data element.
const Data1T & DataTL1() const: Access top left data element
Data1T & DataTM1(): Access top middle element
const Data1T & DataTM1() const: Access top middle element
Data1T & DataTR1(): Access top right data element
const Data1T & DataTR1() const: Access top right data element
Data2T & Data2(): Access middle data element of second array.
const Data2T & Data2() const: Access middle data element of second array.
Data3T & Data3(): Access middle data element of 3rd array.
const Data3T & Data3() const: Access middle data element of 3rd array.

#include "Ravl/BfAcc2Iter3.hh"

bool First(const BufferAccessC<BufferAccessC<Data1T>> & pbufa,const IndexRangeC & nrng1a,const IndexRangeC & nrng2a,const BufferAccessC<BufferAccessC<Data2T>> & pbufb,const IndexRangeC & nrng1b,const IndexRangeC & nrng2b,const BufferAccessC<BufferAccessC<Data3T>> & pbufc,const IndexRangeC & nrng1c,const IndexRangeC & nrng2c): Goto first element.
returns true if there is one.
bool First(const RangeBufferAccessC<BufferAccessC<Data1T>> & pbuf1,const IndexRangeC & nrng1,const RangeBufferAccessC<BufferAccessC<Data2T>> & pbuf2,const IndexRangeC & nrng2,const RangeBufferAccessC<BufferAccessC<Data3T>> & pbuf3,const IndexRangeC & nrng3): Goto first element.
returns true if there is one.
bool First(const SizeBufferAccessC<BufferAccessC<Data1T>> & pbuf1,SizeT size1,const SizeBufferAccessC<BufferAccessC<Data2T>> & pbuf2,SizeT size2,const SizeBufferAccessC<BufferAccessC<Data3T>> & pbuf3,SizeT size3): Goto first element.
returns true if there is one.
bool Next(): Goto next element.
returns true if on the same 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(int skip): Go forward 'skip' columns, without checking for row change.
Use with care.
bool IsElm() const: At a valid element ?
operator bool() const: At a valid element ?
void operator ++(): Goto next element.
void operator ++(int): Goto next element.
Data1T & Data1(): Access data.
const Data1T & Data1() const: Access data.
Data2T & Data2(): Access data.
const Data2T & Data2() const: Access data.
Data3T & Data3(): Access data.
const Data3T & Data3() const: Access data.
IntT RowIndex(const BufferAccessC<Data1T> * row1Begin) const: Work out the current row number
IntT ColIndex() const: Work out the current column number
Index2dC Index(const BufferAccessC<Data1T> * row1Begin) 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