HoaRadius | SuperCollider 3.13.0 Help

Description

Higher Order Ambisonic (HOA) radial utilities. Useful for finding ambisonic decoder effective radius, effective order and effective frequency.

Class Methods

HoaRadius.new(radius)

Create a new instance, in terms of distance.

Arguments:

radius

Radius, in meters. Def. AtkHoa.refRadius

HoaRadius.newFreq(freq, order, speedOfSound)

Create a new instance, in terms of frequency by the relationship:

(order * speedOfSound) / (2 * pi * freq).

Arguments:

freq	Frequency, in Hz.
order	Ambisonic order. Def. `AtkHoa.defaultOrder`
speedOfSound	Speed of sound, in meters per second. Def. `AtkHoa.speedOfSound`

HoaRadius.newWn(wn, sampleRate, order, speedOfSound)

Create a new instance, in terms of normalized frequency wn by the relationship:

(order * speedOfSound) / (pi * wn * sampleRate).

Arguments:

wn	Normalized frequency. DC = 0.0, Nyquist = 1.0;
sampleRate	Sample rate, in Hz.
order	Ambisonic order. Def. `AtkHoa.defaultOrder`
speedOfSound	Speed of sound, in meters per second. Def. `AtkHoa.speedOfSound`

HoaRadius.newWaveNumber(waveNumber, order)

Create a new instance, in terms of a spatial frequency defined by the angular wavenumber, by the relationship:

order / waveNumber.

Arguments:

waveNumber	Angular wavenumber, in radians per meter.
order	Ambisonic order. Def. `AtkHoa.defaultOrder`

HoaRadius.newDelay(delay, speedOfSound)

Create a new instance, in terms of time by the relationship:

delay * speedOfSound.

Arguments:

delay	Radial delay, in seconds.
speedOfSound	Speed of sound, in meters per second. Def. `AtkHoa.speedOfSound`

Inherited class methods

Instance Methods

Radius & delay

.radius

Return radius, in meters.

.delay(speedOfSound)

Return reference delay, in seconds.

Arguments:

speedOfSound

Speed of sound, in meters per second. Def. AtkHoa.speedOfSound

Effective order

.orderAtFreq(freq, speedOfSound)

Return effective ambisonic order, given frequency.

Arguments:

freq	Frequency, in Hz.
speedOfSound	Speed of sound, in meters per second. Def. `AtkHoa.speedOfSound`

.orderAtWn(wn, sampleRate, speedOfSound)

Return effective ambisonic order, given normalized frequency.

Arguments:

wn	Normalized frequency. DC = 0.0, Nyquist = 1.0.
sampleRate	Sample rate, in Hz.
speedOfSound	Speed of sound, in meters per second. Def. `AtkHoa.speedOfSound`

.orderAtWaveNumber(waveNumber)

Return effective ambisonic order, given spatial frequency defined by the angular wavenumber.

Arguments:

waveNumber

Angular wavenumber, in radians per meter.

Effective frequency

.freq(order, speedOfSound)

Return effective frequency.

Arguments:

order	Ambisonic order. Def. `AtkHoa.defaultOrder`
speedOfSound	Speed of sound, in meters per second. Def. `AtkHoa.speedOfSound`

.wn(sampleRate, order, speedOfSound)

Return effective normalized frequency where DC = 0.0, Nyquist = 1.0.

Arguments:

sampleRate	Sample rate, in Hz.
order	Ambisonic order. Def. `AtkHoa.defaultOrder`
speedOfSound	Speed of sound, in meters per second. Def. `AtkHoa.speedOfSound`