Array2dC<class DataT> - 2 Dimensional array

User Documentation

RAVL, Recognition And Vision Library

Ravl - Core - Arrays - 2D - Array2dC<class DataT>

Array2dC<class DataT>

2 Dimensional array

include	"Ravl/Array2d.hh"
Created:	2/5/1993
User Level:	Basic
Library:	RavlCore
Example:	exArray2d.cc
In Scope:	RavlN

Comments:
The class Array2dC is a container of items which can be indexed by 2-dimensional index.

Parent Classes:

RangeBufferAccess2dC

Derived Classes:

ImageC

SummedAreaTableC

Variables:

Methods:

Array2dC(): Creates an empty 2D array.
Array2dC(SizeT dim1,SizeT dim2): Creates 2D array with the range < <0,dim1-1>, <0,dim2-1> >
Array2dC(IntT minRow,IntT maxRow,IntT minCol,IntT maxCol): Creates 2D array with the range minRow to maxRow by minCol to maxCol.
Array2dC(IndexC minRow,IndexC maxRow,IndexC minCol,IndexC maxCol): Creates 2D array with the range minRow to maxRow by minCol to maxCol.
Array2dC(const Index2dC & min,const Index2dC & max): Creates 2D array with the range < , >.
Array2dC(const IndexRangeC & rng1,const IndexRangeC & rng2): Creates 2D array with the range
Array2dC(const IndexRange2dC & rect): Create 2D array with the range covering indexes in 'rect'
Array2dC(const IndexRange2dC & rect,const BufferC<DataT> & data): Create 2D array with the range covering indexes in 'rect' from data.
Note: It is the users responsability to ensure that 'data' is large enought to contain 'rect'.
Array2dC(const Array2dC<DataT> & arr,const IndexRange2dC & rect): Create a sub array of 'arr' covering indexes 'rect'.
Array2dC(const Array2dC<DataT> & arr,const IndexRange2dC & rect,const Index2dC & newOrigin): Create a sub array of 'arr' covering indexes 'rect', with origin 'newOrigin'.
This copies the access.
Array2dC(const SArray2dC<DataT> & sarr): Construct 2d array from sarray.
Note: This does NOT make a copy, it just creates another access to the buffer.
Array2dC(const RangeBufferAccess2dC<DataT> & rbf,Buffer2dC<DataT> & buf): Construct an array with buffer access 'rbf' and data area 'buf'
Expert users only! This allows the creation of arrays that have unusual access structures. e.g. deinterlacing an image without copying any data.
Array2dC<DataT> Copy() const: Make a copy of the array.
SArray2dC<DataT> SArray2d(bool doShift = false): Create an access as an SArray.
Note: This does NOT copy the data, it only make a new access to it. If doShift is true element Range1().Min(),Range2().Min() will become 0,0 of the sarray. Otherwise if the array does not contain element '0,0' an error will occure in check mode, when optimised is enabled an empty array will be returned.
SArray1dC<DataT> AsVector(bool alwaysCopy = false): Access 2d array as 1d vector.
This will only copy the data if the data isn't continuous or alwaysCopy is true, this can make it much more effecient than a straigh copy.
Array1dC<DataT> SliceRow(IndexC i): Access row as 1d array.
Note: Changes made to the slice will also affect this array!
Slice1dC<DataT> SliceColumn(IndexC i): Access columb as 1d slice.
NB. Changes made to the slice will also affect this array!
Slice1dC<DataT> Diagonal(): Take a slice along the diagonal of the array.
NB. Changes made to the slice will also affect this array!
const Array2dC<DataT> & Array2d() const: access to the constant object
Array2dC<DataT> & Array2d(): access to the object
void ShiftIndexes1(IndexC offset): All indexes of Range1() will be changed by 'offset'.
The range will be shifted by -offset. Note: this affects the access for all arrays accessing this data, use with care.
void ShiftIndexes2(IndexC offset): All indexes of Range2() will be changed by 'offset'.
The range will be shifted by -offset. Note: this affects the access for all arrays accessing this data, use with care.
Array2dC<DataT> CopyAccess(IndexC shift1 = 0,IndexC shift2 = 0): This will create a copy of the access structure without copying the data itself.
The access is shifted by shift1 in dimention 1 and shift2 in dimention 2.
Array2dC<DataT> operator +(const Array2dC<DataT> & arr) const: Sums 2 numerical arrays.
The operator returns the result as a new array.
Array2dC<DataT> operator -(const Array2dC<DataT> & arr) const: Subtracts 2 numerical arrays.
The operator returns the result as a new array.
Array2dC<DataT> operator *(const Array2dC<DataT> & arr) const: Mutliplies 2 numerical arrays.
The operator returns the result as a new array.
Array2dC<DataT> operator /(const Array2dC<DataT> & arr) const: Divides 2 numerical arrays.
The operator returns the result as a new array.
Array2dC<DataT> operator *(const DataT & number) const: Multiplys the array by the 'number'.
The operator returns the result as a new array.
Array2dC<DataT> operator /(const DataT & number) const: Divides all array items by the 'number'.
The operator returns the result as a new array.
Array2dC<DataT> operator +(const DataT & number) const: Adds 'number' to the array.
The operator returns the result as a new array.
Array2dC<DataT> operator -(const DataT & number) const: Subtracts 'number' from all array items.
The operator returns the result as a new array.
const Array2dC<DataT> & operator +=(const Array2dC<DataT> & arr): Adds the 2nd array to this array.
const Array2dC<DataT> & operator -=(const Array2dC<DataT> & arr): Subtracts the 2nd array from this array.
const Array2dC<DataT> & operator *=(const Array2dC<DataT> & arr): Multiplies the 2nd array to this array.
const Array2dC<DataT> & operator /=(const Array2dC<DataT> & arr): Divides the 2nd array from this array.
const Array2dC<DataT> & operator +=(const DataT & number): Adds 'number' to all array items.
const Array2dC<DataT> & operator -=(const DataT & number): Subtracts 'number' from all array items.
const Array2dC<DataT> & operator *=(const DataT & number): Multiplies the array by the 'number'.
const Array2dC<DataT> & operator /=(const DataT & number): Divides the array elements by the 'number'.
DataT SumSqr() const: Calculate the sum of the squares of all elements in the array
Buffer2dC<DataT> & Buffer2d(): Access raw 2d buffer.

#include "Ravl/RBfAcc2d.hh"

DataT & operator [](const Index2dC & i): access to the item array[(i)]
const DataT & operator [](const Index2dC & i) const: return the item array[(i)]
RangeBufferAccessC<DataT> operator [](IndexC i): access to the item array[(i)]
const RangeBufferAccessC<DataT> operator [](IndexC i) const: return the item array[(i)]
const IndexRangeC & Range1() const: Range of first index.
const IndexRangeC & Range2() const: Range of second index.
UIntT Size() const: Get the total number of elements in the array.
void Fill(const DataT & d): Fill array with value.
IndexRange2dC Rectangle() const: Return ranges of indexes
IndexRange2dC Frame() const: Return ranges of indexes
bool Contains(const Index2dC & i) const: Returns TRUE if there is an item of the 2D array
IntT Stride() const: Get the stide of the 2d array.
bool IsContinuous() const: Test if the array is allocated in a continous area of memory.
Note: this only checks the first two rows follow each other in memory, this may miss other discontunities.
bool IsEmpty() const: Is rectangle empty ?
BufferAccess2dIterC<DataT> Iter(): Creat an iterator for this buffer.
BufferAccessC<DataT> & RowPtr(IndexC i): Access element 0 of row i.
Note: The element may not actually exist.
Advanced uses only!
void SetRowPtr(IndexC i,BufferAccessC<DataT> & rowPtr): Set element 0 of row i to 'rowPtr'.
Advanced uses only!
This directly manipulates the row pointer table. It can be used to change the way the array is stored. NOTE: Many of the numerical operations in RAVL assume the data is stored in linearly in a contiguous chunk of memory. Manipulating the layout with this method will break this method will break this assumption. This method is provided to allow operations like deinterlacing image to be done without copying large amounts of memory.

#include "Ravl/RBfAcc.hh"

const RangeBufferAccessC<BufferAccessC<DataT>> & operator =(BufferAccessC<DataT> * bp): Changes the reference element to the element pointed by 'bp'.
Access to the object -------------------- inline const BufferAccessC & Access(void) const; Returns this object.
BufferAccessC<DataT> * DataStart(): Returns the address of the first element of the buffer.
const BufferAccessC<DataT> * DataStart() const: Returns the address of the first element of the buffer.
SizeT Size() const: Returns the number of elements of the array.
const IndexRangeC & Range() const: Returns the usable range of indeces expressed by this object.
IndexC IMin() const: Returns the minimum index of the range of this access.
IndexC IMax() const: Returns the maximum index of the range of this access.
const BufferAccessC<DataT> & operator [](IndexC i) const: Read-only access to the ('i'+1)-th element of the buffer.
BufferAccessC<DataT> & operator [](IndexC i): Read-write access to the ('i'+1)-th element of the buffer.
const RangeBufferAccessC<BufferAccessC<DataT>> & RAccess(void) const: Returns this object. Logical functions -----------------
bool IsEmpty() const: Returns TRUE if the size of the array is zero.
bool Contains(IndexC i) const: Returns TRUE if the array contains an item with the index 'i'.
bool IsOverlapping(const RangeBufferAccessC<BufferAccessC<DataT>> & acc) const: Returns TRUE if this access has an item with the same index as an item of the access 'acc'. Modifications of the access ---------------------------
const RangeBufferAccessC<BufferAccessC<DataT>> & operator +=(SizeT i): Changes indeces of the access to be 'i' units higher.
RangeBufferAccessC<BufferAccessC<DataT>> operator +(SizeT i) const: Creates the new access object with the indeces 'i' units higher than those used in this access object.
const IndexRangeC & ShrinkHigh(SizeT k): Changes the number of elements by subtracting the last 'k' elements.
void ShiftIndexes(IndexC offset): All indexes of the items will be changed by 'offset'.
The range will be shifted by -offset.
void SetSubRange(IndexC newMin,IndexC newMax): Constrain the indexs that can be accessed from the array.
The range of indexes of this array will be constrained to cover the index range at most.
const RangeBufferAccessC<BufferAccessC<DataT>> & Swap(RangeBufferAccessC<BufferAccessC<DataT>> & a): Exchanges the contents of this buffer with buffer 'a'.
void Swap(IndexC i1,IndexC i2): Exchanges the contents of elements with indeces 'i1' and 'i2'.
void Attach(const RangeBufferAccessC<BufferAccessC<DataT>> & b): Changes this buffer access to have the same access rights as 'b'.
void Attach(const BufferAccessC<BufferAccessC<DataT>> & b,const IndexRangeC & r): Changes this buffer access to have the access rights as 'b' limited by range 'r'. so the first element in 'b' is accessed at 'r.Min()'.
RangeBufferAccessC<BufferAccessC<DataT>> BufferFrom(IndexC first): Get an access for this buffer starting from the 'first' element to the end of the buffer.
RangeBufferAccessC<BufferAccessC<DataT>> BufferFrom(IndexC first,UIntT len): Get an access for this buffer starting from the 'first' element for 'len' elements.
An error will be generated if the requested buffer isn't contains within this one. Modifications of the buffer contents ------------------------------------
void Fill(const BufferAccessC<DataT> & d): Fill the buffer with the value 'd'.
void Reverse(): Reverse the order of elements in this array in place.
bool operator ==(const RangeBufferAccessC<BufferAccessC<DataT>> & ba) const: Are two accesses the same ?

#include "Ravl/BufferAccess.hh"

BufferAccessC<DataT> * ReferenceElm() const: Returns the pointer to the reference element of the attached buffer. The reference element need not to be the valid element of the buffer.
void * ReferenceVoid() const: Returns the pointer to the reference element of the attached buffer. The reference element need not to be the valid element of the buffer. The function is intended to be used in printing.
bool IsValid() const: Returns TRUE if this buffer access is not a default access object.
const BufferAccessC<DataT> & operator [](const IndexC i) const: Read-only access to the ('i'+1)-th element of the buffer.
BufferAccessC<DataT> & operator [](const IndexC i): Read-write access to the ('i'+1)-th element of the buffer.
const BufferAccessC<BufferAccessC<DataT>> & operator +=(IndexC ind): Inplace Add index to start position.
const BufferAccessC<BufferAccessC<DataT>> & operator -=(IndexC ind): Inplace Subtract index from start position.
BufferAccessC<BufferAccessC<DataT>> operator -(IndexC ind) const: Substract value from position, and return it as a new value.
BufferAccessC<BufferAccessC<DataT>> operator +(IndexC ind) const: Substract value from position, and return it as a new value.
bool operator ==(const BufferAccessC<BufferAccessC<DataT>> & ba) const: Are two accesses the same ?
bool operator !=(const BufferAccessC<BufferAccessC<DataT>> & ba) const: Are two accesses the same ?

Maintainer:Radek Marik, Created: 2/5/1993, Documentation by CxxDoc: Tue Aug 13 09:59:02 2002