RealArray2dC - 2 dimensional real array

User Documentation

Centre for Vision, Speech & Signal Processing

Parent Classes:

NumArray2dC

Methods:

RealArray2dC(): An empty real array.
RealArray2dC(const SizeT rdim,const SizeT cdim): A real array with the range <0, 'rdim'-1> x <0, 'cdim'-1>
RealArray2dC(const IndexRangeC & rowRange,const IndexRangeC & colRange): A real array with the range <'range'.Min(), 'range'.Max()>
RealArray2dC(const IndexRange2dC & range): A real array with the range <'range'.Min(), 'range'.Max()>
RealArray2dC(const IndexRectangleC & rect): create 2D array with the range covering indexes in 'rect'
RealArray2dC(const RealArray2dC & vv): another access to the real array 'vv'
Index2dC MinIndex() const: Finds the index of the minimal item
Index2dC MaxIndex() const: Finds the index of the maximal item
Index2dC FirstGreaterIndex(const RealT value) const: Finds the index from the beginning of the array of the first items which value is greater than 'value'
Index2dC FirstGreaterAbsIndex(const RealT value) const: Finds the index from the beginning of the array of the first items which the absolute value is greater than 'value'.
RealT SetZeroMean(): Values of the array are shifted to have zero mean returns the mean value of the original values.
RealT SetUnitSum(): Values of the array are normalizes to have D.C = 1 returns the sum of the original values.
RealArray2dC & Convolution(const RealArray2dC & mask): Convolves array with the mask the result is stored in the same array.
RealArray2dC Copy() const: Creates a copy of the array.

#include "amma/NArray2d.hh"

NumArray2dC<RealT> Copy() const: Make a copy.
NumArray2dC<RealT> & SetZero(): Sets all value of the array to be zero.
NumArray2dC<RealT> & Set(const RealT & data): Sets all items of the array to be 'data'.
void SetRow(IndexT r,const RealT & data): Sets all items in the row 'r' to be 'data'.
void SetCol(IndexT c,const RealT & data): Sets all items in the column 'c' to be 'data'.
Index2dC RangeMin() const: Returns the minimum index of the array.
Index2dC RangeMax() const: Returns the maximum index of the array.
BooleanT Contains(const Index2dC & i) const: Returns TRUE, if there is an item of the 2D array.
void DebugAddresses() const: Prints addresses. friend istream & operator>>(istream & s, NumArray2dC & arr);

#include "amma/Array2d.hh"

Array2dC<RealT> Copy() const: Make a copy of the array.
Access to the stored data. --------------------------
RangeBufferAccessC<RealT> & operator[](const IndexT i): access to the array[i]
const RangeBufferAccessC<RealT> & operator[](const IndexT i) const: return array[i]
RealT & operator[](const Index2dC & i): access to the item array[(i)]
const RealT & operator[](const Index2dC & i) const: return the item array[(i)]
Array1dC<RealT> Slice(const IndexT i): Access row as 1d array.
const IndexRangeC & Range1() const: return number of rows
const IndexRangeC & Range2() const: return number of columns of the first row
const Array2dC<RealT> & Array2d() const: access to the constant object
Array2dC<RealT> & Array2d(): access to the object
IndexRectangleC Rectangle() const: Return ranges of indexes
void ShiftIndexes1(const IndexT offset): All indexes of Range1() will be changed by 'offset'.
The range will be shifted by -offset.
void ShiftIndexes2(const IndexT offset): All indexes of Range2() will be changed by 'offset'.
The range will be shifted by -offset. Logical conditions. -------------------
BooleanT Contains(const Index2dC & i) const: Returns TRUE if there is an item of the 2D array
void Fill(const RealT & d): Sets all elements of the array to be 'd'.
SizeT Size() const: Return the number of elements in the 2D array.

#include "amma/Array1d.hh"

Array1dC<RangeBufferAccessC<DataC>> Copy() const: Creates a new physical copy of the array.
Array1dC<RangeBufferAccessC<DataC>> & Copy(const Array1dC<RangeBufferAccessC<DataC>> & orig): Copies values from the 'orig' array into this array.
Only items from the overlapping part of the ranges are copied. The function returns this array.
Array1dC<RangeBufferAccessC<DataC>> & Copy(const IndexRangeC & r,const IndexT off): Copies values from the index range 'r' into the new position with the offset 'off'.
Only those items which original position and destination are inside of the index range of this array are copied.
Array1dC<RangeBufferAccessC<DataC>> & Copy(const IndexT off,const Array1dC<RangeBufferAccessC<DataC>> & a): Copies the maximum possible part of array 'a' into this array.
The first element of array 'a' is placed into the element of this array with index 'off'. The functio returns this array.
const Array1dC<RangeBufferAccessC<DataC>> & operator=(const Array1dC<RangeBufferAccessC<DataC>> & vv): Assigment, as for a BIG_OBJECT.
Access to the object elements. ------------------------------
const Array1dC<RangeBufferAccessC<DataC>> & Array1d() const: Access to the whole array.
Array1dC<RangeBufferAccessC<DataC>> & Array1d(): Access to the whole array.
SArray1dC<RangeBufferAccessC<DataC>> SArray1d(): Create an access as an sarray.
NB. This does NOT copy the data, it only make a new access to it. If the array does not have contain element '0' an error will occure in check mode, when optimised is enabled an empty array will be returned. In anycase only elements 0 and above will be accessable. Array representation modifications. -----------------------------------
Array1dC<RangeBufferAccessC<DataC>> Enlarge(const IntT factor = 2) const: Enlarges the array by item duplications.
Every item is duplicated 'factor' times. The return array is extended by adding of higher indexes.
Array1dC<RangeBufferAccessC<DataC>> Extend(const SizeT n) const: Returns the array whose range is extended by adding 'n' items with default value from both limits of the range.
This array value are copied into the same index positions in the returned array.
Array1dC<RangeBufferAccessC<DataC>> & Append(const Array1dC<RangeBufferAccessC<DataC>> & a): This array is extended by the length of the array 'a' and the contents of both arrays are copied to it.
The function supports empty arrays. Logical operations. -------------------
BooleanT IsSharing(const Array1dC<RangeBufferAccessC<DataC>> & arr) const: Returns TRUE if this array and the array 'arr' are subarrays of the the same array.
Special operations. -------------------
void DebugAddresses() const: Prints addresses into 'cerrAMMA'.
const BodyRefCounterC & RefCounter() const: Returns access to reference counter.

#include "amma/RBfAcc.hh"

const RangeBufferAccessC<RangeBufferAccessC<DataC>> & operator=(RangeBufferAccessC<DataC> * bp): Changes the reference element to the element pointed by 'bp'.
Access to the object --------------------
RangeBufferAccessC<DataC> * ReferenceElm(void) 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(void) 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.
const BufferAccessC<RangeBufferAccessC<DataC>> & Access(void) const: Returns this object.
RangeBufferAccessC<DataC> * DataStart(): Returns the address of the first element of the buffer..
const RangeBufferAccessC<DataC> * DataStart() const: Returns the address of the first element of the buffer..
SizeT N() const: Returns the number of elements of the array.
SizeT Size() const: Returns the number of elements of the array.
const IndexRangeC & Limits() const: Returns the usable range of indeces expressed by this object.
const IndexRangeC & Range() const: Returns the usable range of indeces expressed by this object.
IndexT IMin() const: Returns the minimum index of the range of this access.
IndexT IMax() const: Returns the maximum index of the range of this access.
const RangeBufferAccessC<DataC> & operator[](const IndexT i) const: Read-only access to the ('i'+1)-th element of the buffer.
RangeBufferAccessC<DataC> & operator[](const IndexT i): Read-write access to the ('i'+1)-th element of the buffer.
const RangeBufferAccessC<RangeBufferAccessC<DataC>> & RAccess(void) const: Returns this object. Logical functions -----------------
BooleanT IsValid() const: Returns TRUE if this buffer access is not a default access object.
BooleanT IsEmpty() const: Returns TRUE if the size of the array is zero.
BooleanT Contains(const IndexT i) const: Returns TRUE if the array contains an item with the index 'i'.
BooleanT IsOverlapping(const RangeBufferAccessC<RangeBufferAccessC<DataC>> & 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<RangeBufferAccessC<DataC>> & operator+=(const SizeT i): Changes indeces of the access to be 'i' units higher.
RangeBufferAccessC<RangeBufferAccessC<DataC>> operator+(const SizeT i) const: Creates the new access object with the indeces 'i' units higher than those used in this access object.
const IndexRangeC & ShrinkHigh(const SizeT k): Changes the number of elements by subtracting the last 'k' elements.
void ShiftIndexes(const IndexT offset): All indexes of the items will be changed by 'offset'.
The range will be shifted by -offset.
void SetSubRange(const IndexT newMin,const IndexT newMax): The range of indexes of this array will be constrained to cover the index range at most.
const RangeBufferAccessC<RangeBufferAccessC<DataC>> & Swap(RangeBufferAccessC<RangeBufferAccessC<DataC>> & a): Exchanges the contents of this buffer with buffer 'a'.
void Swap(const IndexT i1,const IndexT i2): Exchanges the contents of elements with indeces 'i1' and 'i2'.
void Attach(const RangeBufferAccessC<RangeBufferAccessC<DataC>> & b): Changes this buffer access to have the same access rights as 'b'.
void Attach(const BufferAccessC<RangeBufferAccessC<DataC>> & b,const IndexRangeC & r): Changes this buffer access to have the access rights as 'b' limited by range 'r'. Modifications of the buffer contents ------------------------------------
void Fill(const RangeBufferAccessC<DataC> & d): 'd' value is assigned to all elements of the buffer.

Programmer:Radek Marik, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001

RealArray2dC

2 dimensional real array

include	"amma/ReArr2d.hh"
User Level:	Default
Library:	MstdArr
Example:	exComplx.cc
Section:	Containers.Arrays.2-D Arrays.Specialized Arrays
In Scope:	std