A class that stores the binned energy decay histogram of an impulse response. More...

#include <omSoundEnergyIR.h>

Public Member Functions
Float *	getSamples ()
	Return a pointer to the start of the internal energy sample buffer. More...

const Float *	getSamples () const
	Return a pointer to the start of the internal energy sample buffer. More...

Size	getBandCount () const
	Return the number of frequency bands there are in this energy IR. More...

void	setBandCount (Size newBandCount)
	Set the number of frequency bands there are in this energy IR. More...

Float	getSampleRate () const
	Return the sample rate of this energy IR. More...

void	setSampleRate (Float newSampleRate)
	Set the sample rate of this energy IR. More...

Public Attributes
PODArray< Float, 1, Size, AlignedAllocator< 16 > >	samples
	An array of interleaved frequency band samples of this energy IR. More...

Size	numBands
	The number of frequency bands there are in this energy IR. More...

Float	sampleRate
	The sampling rate for this energy IR, e.g. how many IR samples per second. More...

Detailed Description

A class that stores the binned energy decay histogram of an impulse response.

The energy IR is normalized so that the total sound energy radiated from the source is 1.

The energy IR cannot be directly used for sound rendering. It must be converted into a pressure IR first.

Member Function Documentation

Float* om::sound::acoustics::base::EnergyIR::getSamples ( )

inline

Return a pointer to the start of the internal energy sample buffer.

const Float* om::sound::acoustics::base::EnergyIR::getSamples ( ) const

inline

Return a pointer to the start of the internal energy sample buffer.

Size om::sound::acoustics::base::EnergyIR::getBandCount ( ) const

inline

Return the number of frequency bands there are in this energy IR.

void om::sound::acoustics::base::EnergyIR::setBandCount ( Size newBandCount )

Set the number of frequency bands there are in this energy IR.

Float om::sound::acoustics::base::EnergyIR::getSampleRate ( ) const

inline

Return the sample rate of this energy IR.

void om::sound::acoustics::base::EnergyIR::setSampleRate ( Float newSampleRate )

inline

Set the sample rate of this energy IR.

This method does not alter the contents of the IR.

PODArray< Float, 1, Size, AlignedAllocator<16> > om::sound::acoustics::base::EnergyIR::samples

An array of interleaved frequency band samples of this energy IR.

The first sample's interleaved values indicate the frequencies of the bands in this IR.

Size om::sound::acoustics::base::EnergyIR::numBands

The number of frequency bands there are in this energy IR.

Float om::sound::acoustics::base::EnergyIR::sampleRate

The sampling rate for this energy IR, e.g. how many IR samples per second.

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