SignalTypes::SquareMatrix Class Reference
[Classes derived from SignalType.]

A SignalType refinement for describing 2-D square matrix data. More...

#include <matrix.h>

Inheritance diagram for SignalTypes::SquareMatrix:

Inheritance graph
[legend]
Collaboration diagram for SignalTypes::SquareMatrix:

Collaboration graph
[legend]
List of all members.

Public Member Functions

const float pitch () const
const uint size () const
 SquareMatrix (const uint size=1, const float frequency=0., const float pitch=0.)

Detailed Description

A SignalType refinement for describing 2-D square matrix data.

Author:
Gav Wood <gav@cs.york.ac.uk>
This is very similar to the Matrix class except that it describes only data representing *square* martixes; that is the width and the height are equal.


Constructor & Destructor Documentation

SignalTypes::SquareMatrix::SquareMatrix ( const uint  size = 1,
const float  frequency = 0.,
const float  pitch = 0. 
) [inline]

Constrictor for a new matrix whose row size is equal to column size.

Parameters:
size The number of rows (or columns).
frequency The number of matrices that are required to represent a second of signal time.
pitch The theoretical number of elements in a row that would represent a second in signal time. Of course this property may be left as its default (0) if it makes no sense for the data.


Member Function Documentation

const uint SignalTypes::SquareMatrix::size (  )  const [inline]

Get the size of the matrix this SignalType represents.

The sample size is therefore equal to size() * size().

Returns:
The number of elements in every row and column of the matrix.

const float SignalTypes::SquareMatrix::pitch (  )  const [inline]

Get the frequency represented by the progression of elements in either the row or column.

Returns:
The pitch of the matrix elements.


The documentation for this class was generated from the following file:
Generated on Thu Jul 13 06:56:55 2006 for Exscalibar by  doxygen 1.4.7