AtkHoa : Object
Extension
ExtensionDescription
The AtkHoa class defines variables specifying the HOA-NFE framework within the context of the ATK library.
Class Methods
Ambisonic order
AtkHoa.defaultOrder
Ambisonic Toolkit default ambisonic order.
AtkHoa.setDefaultOrder(order)
Component ordering & normalisation
AtkHoa.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).
AtkHoa.ordering
Ambisonic Toolkit ambisonic component ordering convention: Ambisonic Channel Number (ACN). See ordering.
AtkHoa.normalisation
Ambisonic Toolkit ambisonic component normalisation convention: Orthonormal basis for 3D decomposition (N3D). See normalisation.
AtkHoa.formatDict
A number of common formats are indexed by a single keyword:
\atk | Ambisonic Toolkit (ATK) |
\ambix | Ambisonics Exchangeable (AmbiX) |
\fuma | Furse-Malham (FuMa) |
Radial & NFE
AtkHoa.refRadius
Ambisonic Toolkit reference radius, in meters.
AtkHoa.setRefRadius(radius)
AtkHoa.speedOfSound
Ambisonic Toolkit speed of sound, in meters per second.
AtkHoa.setSpeedOfSound(mps)
Thresholding
AtkHoa.thresh
Ambisonic Toolkit "near zero" precision value default for bilateral coefficient thresholding.
AtkHoa.setThresh(threshold)
Setter for *thresh.
Testing & reporting
AtkHoa.detectOrder(size)
Given a number of coefficients, return an ambisonic order.
AtkHoa.confirmOrder(size, order)
Confirm the given number of coefficients matches that expected for an ambisonic order.
Inherited class methods
Instance Methods
Inherited instance methods
Examples
TBD
link::Classes/AtkHoa::