AtkHoa:
Filter:
atk-sc3/Classes (extension) | Libraries > Ambisonic Toolkit > ATK Platform & Configuration

AtkHoa
ExtensionExtension

A class that stores some global HOA variables for the Ambisonic Toolkit

Description

The AtkHoa class defines variables specifying the HOA-NFE framework within the context of the ATK library.

Class Methods

Ambisonic order

.defaultOrder

Ambisonic Toolkit default ambisonic order.

.setDefaultOrder

Setter for *defaultOrder.

Arguments:

order

Ambisonic order.

Component ordering & normalisation

.format

Designation indicating ambisonic component ordering and component normalisation. The Ambisonic Toolkit convention is ACN-N3D, i.e., Ambisonic Channel Number (ACN), Orthonormal basis for 3D decomposition (N3D).

.ordering

Ambisonic Toolkit ambisonic component ordering convention: Ambisonic Channel Number (ACN). See ordering.

.normalisation

Ambisonic Toolkit ambisonic component normalisation convention: Orthonormal basis for 3D decomposition (N3D). See normalisation.

.formatDict

A number of common formats are indexed by a single keyword:

\atkAmbisonic Toolkit (ATK)
\ambixAmbisonics Exchangeable (AmbiX)
\fumaFurse-Malham (FuMa)

Radial & NFE

.refRadius

Ambisonic Toolkit reference radius, in meters.

.setRefRadius

Setter for *refRadius.

Arguments:

radius

Radius, in meters.

.speedOfSound

Ambisonic Toolkit (HOA) speed of sound, in meters per second.

.setSpeedOfSound

Setter for *speedOfSound.

Arguments:

mps

Speed of sound, in meters per second.

Thresholding

.thresh

Ambisonic Toolkit "near zero" precision value default for bilateral coefficient thresholding.

.setThresh

Setter for *thresh.

Testing & reporting

.detectOrder

Given a number of coefficients, return an ambisonic order.

.confirmOrder

Confirm the given number of coefficients matches that expected for an ambisonic order.

Examples

TBD