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

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

#include <matrix.h>

Inheritance diagram for SignalTypes::Matrix:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

const uint height () const
 Matrix (const uint width=1, const uint height=1, const float frequency=0, const float pitchWidth=0, const float pitchHeight=0)
const float pitchHeight () const
const float pitchWidth () const
const uint width () const

Protected Attributes

uint theHeight
 Height of the represented matrix in elements.
float thePitchHeight
 Pitch height of the represented matrix.
float thePitchWidth
 Pitch width of the represented matrix.
uint theWidth
 Width of the represented matrix in elements.

Detailed Description

A SignalType refinement for describing 2-D matrix data.

Author:
Gav Wood <gav@cs.york.ac.uk>


Constructor & Destructor Documentation

SignalTypes::Matrix::Matrix ( const uint  width = 1,
const uint  height = 1,
const float  frequency = 0,
const float  pitchWidth = 0,
const float  pitchHeight = 0 
) [inline]

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

Parameters:
width The number of columns.
height The number of rows.
frequency The number of matrices that are required to represent a second of signal time.
pitchWidth 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.
pitchHeight The theoretical number of elements in a column 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::Matrix::height (  )  const [inline]

Get the number of rows in the matrix this object represents.

Returns:
The number of elements in a column (number of rows).

const float SignalTypes::Matrix::pitchHeight (  )  const [inline]

Get the frequency represented by the progression of elements in a column.

Returns:
The pitch height of the matrix elements.

const float SignalTypes::Matrix::pitchWidth (  )  const [inline]

Get the frequency represented by the progression of elements in a row.

Returns:
The pitch width of the matrix elements.

const uint SignalTypes::Matrix::width (  )  const [inline]

Get the number of columns in the matrix this object represents.

Returns:
The number of elements in a row (number of columns)


The documentation for this class was generated from the following files:
Generated on Fri Nov 10 21:58:44 2006 for Exscalibar by  doxygen 1.5.1