HoaMatrix
Extension
ExtensionDescription
An HoaMatrix is not typically instantiated directly, but rather through one of its subclasses: HoaMatrixEncoder, HoaMatrixDecoder, and HoaMatrixXformer.
Class Methods
.newFromMatrix
Create an instance from a raw 2D Matrix.
Arguments:
| matrix |
A Matrix in the form of |
| directions |
An array of directions. Specify in radians. Rank 1 arrays return pantophonic, while rank 2 arrays return periphonic. E.g.,
|
| order |
Ambisonic order. |
.newFromFile
Create an instance by loading a matrix from a file.
Arguments:
| filePathOrName |
Can be a path relative to your Otherwise a full path to your matrix file. |
| searchExtensions |
Search extension paths. |
| order |
Ambisonic order. |
Discussion:
See the Guide-to-ATK-Matrix-Files for more information.
Instance Methods
Information
.set
Describes both the signal set and the tool set, encompassing the Ambisonic order, as well as channel ordering and normalisation.
Ambisonic Toolkit designation indicating Ambisonic order and encoding format. E.g., \FOA, \HOA3.
For instance, \HOA3:
| Ambisonic Order | Component Ordering | Component Normalisation |
| 3rd | Ambisonic Channel Number (ACN) | Full 3-D normalisation (N3D) |
.type
Ambisonic Toolkit soundfield operation designation. E.g., \encode, \xform, \decode.
.dim
Answers the number of encoder dimensions: 2D or 3D.
.numChannels
Answers the number of input or output channels, depending on -type.
.directions
Answers the directions of input or output channels, depending on -type.
.dirInputs
A convenience method providing polymorphism with -directions, depending on -type.
.dirOutputs
A convenience method providing polymorphism with -directions, depending on -type.
Matrix
.thresh2
Bilateral thresholding in place.
Arguments:
| thresh |
When the |
File handling
Examples
TBD