PUBLIC

RealHistogram2dC::RealHistogram2dC(void) RealHistogram2dC::RealHistogram2dC(const Point2dC &,const Point2dC &,const Index2dC &) RealHistogram2dC::RealHistogram2dC(const Vector2dC &,const Point2dC &,const SArray2dC &) RealHistogram2dC::Scale(void) const RealHistogram2dC::Offset(void) const RealHistogram2dC::Bin(const Point2dC &) const RealHistogram2dC::MidBin(const Index2dC &) const RealHistogram2dC::Reset(void) RealHistogram2dC::Vote(const Point2dC &) RealHistogram2dC::CheckVote(const Point2dC &) RealHistogram2dC::TotalVotes(void) const RealHistogram2dC::Information(void) const RealHistogram2dC::Energy(void) const RealHistogram2dC::MeanVariance(void) const SArray2dC::Copy(void) const SArray2dC::Buffer(void) SArray2dC::Buffer(void) const SArray2dC::AsVector(bool) SArray2dC::operator +(const SArray2dC &) const SArray2dC::operator -(const SArray2dC &) const SArray2dC::operator *(const SArray2dC &) const SArray2dC::operator /(const SArray2dC &) const SArray2dC::operator *(const DataT &) const SArray2dC::operator /(const DataT &) const SArray2dC::operator +(const DataT &) const SArray2dC::operator -(const DataT &) const SArray2dC::operator +=(const SArray2dC &) SArray2dC::operator -=(const SArray2dC &) SArray2dC::operator *=(const SArray2dC &) SArray2dC::operator /=(const SArray2dC &) SArray2dC::operator +=(const DataT &) SArray2dC::operator -=(const DataT &) SArray2dC::operator *=(const DataT &) SArray2dC::operator /=(const DataT &) SArray2dC::SumSqr(void) const SArray2dC::Sum(void) const SArray2dC::Diagonal(void) SArray2dC::SliceRow(IndexC) SArray2dC::SliceColumn(IndexC) SArray2dC::SetColumn(IndexC,const SArray1dC &) SArray2dC::SetRow(IndexC,const SArray1dC &) SArray2dC::BuildAccess(UIntT,UIntT) SizeBufferAccess2dC::Contains(const Index2dC &) const SizeBufferAccess2dC::operator [](const Index2dC &) SizeBufferAccess2dC::operator [](const Index2dC &) const SizeBufferAccess2dC::operator [](IndexC) SizeBufferAccess2dC::operator [](IndexC) const SizeBufferAccess2dC::Size1(void) const SizeBufferAccess2dC::Size2(void) const SizeBufferAccess2dC::Size(void) const SizeBufferAccess2dC::Fill(const DataT &) SizeBufferAccess2dC::Stride(void) const SizeBufferAccess2dC::IsContinuous(void) const SizeBufferAccessC::operator =(DataT *) SizeBufferAccessC::DataStart(void) const SizeBufferAccessC::Size(void) const SizeBufferAccessC::Limits(void) const SizeBufferAccessC::Range(void) const SizeBufferAccessC::IMin(void) const SizeBufferAccessC::IMax(void) const SizeBufferAccessC::operator [](const IndexC) const SizeBufferAccessC::operator [](const IndexC) SizeBufferAccessC::SAccess(void) const SizeBufferAccessC::IsEmpty(void) const SizeBufferAccessC::Contains(IndexC) const SizeBufferAccessC::ShrinkHigh(SizeT) SizeBufferAccessC::Swap(SizeBufferAccessC &) SizeBufferAccessC::Attach(const SizeBufferAccessC &) SizeBufferAccessC::Attach(const BufferAccessC &,SizeT) SizeBufferAccessC::operator +(SizeT) const SizeBufferAccessC::Fill(const DataT &) SizeBufferAccessC::CopyFrom(const SizeBufferAccessC &) SizeBufferAccessC::Reverse(void) SizeBufferAccessC::BufferFrom(UIntT) SizeBufferAccessC::BufferFrom(UIntT,UIntT) SizeBufferAccessC::operator ==(const SizeBufferAccessC &) const SizeBufferAccessC::Copy(void) const BufferAccessC::ReferenceElm(void) const BufferAccessC::ReferenceVoid(void) const BufferAccessC::IsValid(void) const BufferAccessC::operator [](const IndexC) const BufferAccessC::operator [](const IndexC) BufferAccessC::operator +=(IndexC) BufferAccessC::operator -=(IndexC) BufferAccessC::operator -(IndexC) const BufferAccessC::operator +(IndexC) const BufferAccessC::operator ==(const BufferAccessC &) const BufferAccessC::operator !=(const BufferAccessC &) const

public SArray2dC<UIntC>

Vector2dC scale;

Scale factor.

Point2dC offset;

Offset of 0,0 index.

RealHistogram2dC()

Default construct

RealHistogram2dC(const Point2dC & min,const Point2dC & max,const Index2dC & steps)

Create a histogram.

RealHistogram2dC(const Vector2dC & nscale,const Point2dC & noffset,const SArray2dC<UIntC> & array)

Create a histogram from an offset, scale and a SArray1d.

Vector2dC Scale() const

Scaling.

Point2dC Offset() const

Offset used in hash table.

Index2dC Bin(const Point2dC & v) const

Get the bin which value 'v' falls into.

Point2dC MidBin(const Index2dC & bin) const

Get the middle of given bin.

void Reset()

Reset counters in histogram to zero.

void Vote(const Point2dC & v)

Vote for value.
Note, this will not check that the value is within the histogram. In check mode this will cause an error, in optimised it will corrupt memory.

bool CheckVote(const Point2dC & v)

Vote for value.
Returns false if value is out of range.

UIntT TotalVotes() const

Find the total number of votes cast.
This is computed not stored, and so is relatively slow.

RealT Information() const

Calculate the amount of information represented by the histogram.
This is also known as the entropy of the histogram.

RealT Energy() const

Calculate the energy represented by the original signal.

MeanCovariance2dC MeanVariance() const

Calculate the mean and variance for the signal.

SArray2dC<UIntC> Copy() const

Copy array.

Buffer2dC<UIntC> & Buffer()

Access base data buffer.
Experts only!

const Buffer2dC<UIntC> & Buffer() const

Constant access base data buffer.
Experts only!

SArray1dC<UIntC> 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.

SArray2dC<UIntC> operator +(const SArray2dC<UIntC> & arr) const

Sums 2 numerical arrays. The operator returns the result as a new array.

SArray2dC<UIntC> operator -(const SArray2dC<UIntC> & arr) const

Subtracts 2 numerical arrays. The operator returns the result as a new array.

SArray2dC<UIntC> operator *(const SArray2dC<UIntC> & arr) const

Mutliplies 2 numerical arrays. The operator returns the result as a new array.

SArray2dC<UIntC> operator /(const SArray2dC<UIntC> & arr) const

Devides 2 numerical arrays. The operator returns the result as a new array.

SArray2dC<UIntC> operator *(const UIntC & number) const

Multiplys the array by the 'number'. The operator returns the result as a new array.

SArray2dC<UIntC> operator /(const UIntC & number) const

Divides all array items by the 'number'. The operator returns the result as a new array.

SArray2dC<UIntC> operator +(const UIntC & number) const

Adds 'number' to the array. The operator returns the result as a new array.

SArray2dC<UIntC> operator -(const UIntC & number) const

Subtracts 'number' from all array items. The operator returns the result as a new array.

const SArray2dC<UIntC> & operator +=(const SArray2dC<UIntC> & arr)

Adds the 2nd array to this array.

const SArray2dC<UIntC> & operator -=(const SArray2dC<UIntC> & arr)

Subtracts the 2nd array from this array.

const SArray2dC<UIntC> & operator *=(const SArray2dC<UIntC> & arr)

Multiplies the 2nd array to this array.

const SArray2dC<UIntC> & operator /=(const SArray2dC<UIntC> & arr)

Divides the 2nd array from this array.

const SArray2dC<UIntC> & operator +=(const UIntC & number)

Adds 'number' to all array items.

const SArray2dC<UIntC> & operator -=(const UIntC & number)

Subtracts 'number' from all array items.

const SArray2dC<UIntC> & operator *=(const UIntC & number)

Multiplies the array by the 'number'.

const SArray2dC<UIntC> & operator /=(const UIntC & number)

Divides the array elements by the 'number'.

UIntC SumSqr() const

Calculate the sum of the squares of all the elements in the array

UIntC Sum() const

Returns the sum all elements of the array.

Slice1dC<UIntC> Diagonal()

Take a slice along the diagonal of the array.

SArray1dC<UIntC> SliceRow(IndexC i)

Access row as 1d array.
NB. Changes made to the slice will also affect this array!

Slice1dC<UIntC> SliceColumn(IndexC i)

Access columb as 1d slice.
NB. Changes made to the slice will also affect this array!

void SetColumn(IndexC i,const SArray1dC<UIntC> & val)

Set the values in the column i to those in 'val'.
'val' must have a size equal to the number of rows.

void SetRow(IndexC i,const SArray1dC<UIntC> & val)

Set the values in the row i to those in 'val'.
'val' must have a size equal to the number of columns

void BuildAccess(UIntT offset = 0,UIntT stride = 0)

bool Contains(const Index2dC & i) const

Does this buffer contain the index i ?
Returns true if yes.

UIntC & operator [](const Index2dC & i)

access to the item array[(i)]

const UIntC & operator [](const Index2dC & i) const

return the item array[(i)]

SizeBufferAccessC<UIntC> operator [](IndexC i)

access to the item array[(i)]

const SizeBufferAccessC<UIntC> operator [](IndexC i) const

return the item array[(i)]

SizeT Size1() const

Size.

SizeT Size2() const

Size.

UIntT Size() const

Get the total number of elements in the array.

void Fill(const UIntC & d)

Fill array with value.

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.

const SizeBufferAccessC<BufferAccessC<DataT>> & operator =(BufferAccessC<DataT> * bp)

Changes the reference element to the element pointed by 'bp'. Access to the object --------------------

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.

IndexRangeC Limits() const

Returns the usable range of indeces expressed by this object.

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 [](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 SizeBufferAccessC<BufferAccessC<DataT>> & SAccess(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'. Modifications of the access ---------------------------

SizeT ShrinkHigh(SizeT k)

Changes the number of elements by subtracting the last 'k' elements.

const SizeBufferAccessC<BufferAccessC<DataT>> & Swap(SizeBufferAccessC<BufferAccessC<DataT>> & a)

Exchanges the contents of this buffer with buffer 'a'.

void Attach(const SizeBufferAccessC<BufferAccessC<DataT>> & b)

Changes this buffer access to have the same access rights as 'b'.

void Attach(const BufferAccessC<BufferAccessC<DataT>> & b,SizeT size)

Changes this buffer access to have the access rights as 'b' limited for 'size' elements.

SizeBufferAccessC<BufferAccessC<DataT>> operator +(SizeT i) const

Creates the new access object shifted 'i' elements to the right (towards next elements). The size is descreased to fit the the original range of this access. Modifications of the buffer contents ------------------------------------

void Fill(const BufferAccessC<DataT> & d)

'd' value is assigned to all elements of the buffer.

void CopyFrom(const SizeBufferAccessC<BufferAccessC<DataT>> & oth)

Copy contents of another buffer into this one.
NB. Buffers MUST be the same length.

void Reverse()

Reverse the order of elements in this array in place.

SizeBufferAccessC<BufferAccessC<DataT>> BufferFrom(UIntT first)

Get an access for this buffer starting from the 'first' element to the end of the buffer.

SizeBufferAccessC<BufferAccessC<DataT>> BufferFrom(UIntT 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.

bool operator ==(const SizeBufferAccessC<BufferAccessC<DataT>> & ba) const

Are two accesses the same ?

SizeBufferAccessC<BufferAccessC<DataT>> Copy(void) const

Returns a physical copy of this access pointing to the physical copy of the accessed buffer in the range accessible by this access. The new copy is necessary to attach to reference counted buffer or to delete at the end of the life of this object.

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 ?