NFECoeffs:
Filter:
atk-sc3/Classes (extension) | Libraries > Ambisonic Toolkit > Coefficients & Theory

NFECoeffs
ExtensionExtension

Higher Order Ambisonic (HOA) "by degree" radial filtering coefficients

Description

Higher Order Ambisonic (HOA) "by degree" radial filtering coefficients, returned for realization by FOS and SOS cascade.

NOTE: In most cases, users will use the high level near-field effect (NFE) pseudo-UGens: HoaNFProx, HoaNFDist, HoaNFCtrl.

Class Methods

.new

Create a new instance.

Arguments:

degree

Associated Legendre degree (ℓ).

Instance Methods

.degree

Return Associated Legendre degree (ℓ).

.numFOS

Return number of FOS required for cascade.

.numSOS

Return number of SOS required for cascade.

Coefficients

.prox

Return a dictionary of near-field effect proximity radial filtering coefficients. See Coefficient Dictionary below.

Arguments:

radius

Radius, in meters.

sampleRate

Sample rate, in Hz.

speedOfSound

Speed of sound, in meters per second.

.dist

Return a dictionary of near-field effect distance radial filtering coefficients. See Coefficient Dictionary below.

Arguments:

radius

Radius, in meters.

sampleRate

Sample rate, in Hz.

speedOfSound

Speed of sound, in meters per second.

.ctrl

Return a dictionary of near-field effect control radial filtering coefficients. See Coefficient Dictionary below.

Arguments:

encRadius

Encoding radius, in meters.

decRadius

Decoding radius, in meters.

sampleRate

Sample rate, in Hz.

speedOfSound

Speed of sound, in meters per second.

Coefficient Dictionary

FOS and SOS coefficients are returned as rank two arrays of coefficients, available via the IdentityDictionary \sos and \fos keys. Additionally, a a normalizing scalar is also returned via the \g key.

Examples

TBD