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

A SignalType refinement for describing 1-D spectral data. More...

#include <spectrum.h>

Inheritance diagram for SignalTypes::Spectrum:

[legend]Collaboration diagram for SignalTypes::Spectrum:

[legend]List of all members.

Public Member Functions
const float	bandFrequency (uint band) const
const float	nyquist () const
const uint	size () const
	Spectrum (const uint size=1, const float frequency=0, const float step=1)
const float	step () const
Protected Attributes
float	theStep
	Step between spectral bands of represented Spectrum.

---

Detailed Description

A SignalType refinement for describing 1-D spectral data.

Author:

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

This class can be used to describe a signal type that is a vector of elements. The vector can be any size (dimensionality), and has two significant attributes, the frequency by which each individual spectrum arrives from the source, and the stepping between spectral bands.

---

Constructor & Destructor Documentation

SignalTypes::Spectrum::Spectrum	(	const uint	size = 1,
		const float	frequency = 0,
		const float	step = 1
	)			[inline]

Create a new SignalType to represent a spectrum.

Parameters:

	size	The number of bands in each spectrum.
	frequency	The number of times the source will emit a spectrum per second of signal time (in Hz).
	step	The increase in audio frequency (in Hz) per band. It is currently assumed that the signal is a monotonically stepped spectrum.

---

Member Function Documentation

const float SignalTypes::Spectrum::bandFrequency

(

uint

band

)

const [inline]

Determines the frequency represented by a specific band.

Parameters:

band

The band index.

Returns:

The midpoint frequency of band band.

const uint SignalTypes::Spectrum::size

(

)

const [inline]

Gets the number of bands in the spectra of the signal to which this type refers.

Returns:

The number of bands.

const float SignalTypes::Spectrum::step

(

)

const [inline]

Gets the difference in audio frequency between each band in the spectra.

Returns:

The frequency stepping between bands.

const float SignalTypes::Spectrum::nyquist

(

)

const [inline]

Gets the Nyquist frequency (the highest frequency that can be represented by this spectrum.

Returns:

The Nyquist frequency.

---

The documentation for this class was generated from the following files:

• spectrum.h
• spectrum.cpp

---