FoaMatrix
Extension
ExtensionDescription
An FoaMatrix is not typically instantiated directly, but rather through one of its subclasses: FoaEncoderMatrix, FoaDecoderMatrix, and FoaXformerMatrix.
Class Methods
.new
*new should not be called directly from AtkMatrix but rather is called from the various creation methods of its subclasses: FoaEncoderMatrix, FoaDecoderMatrix, or FoaXformerMatrix.
.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.,
|
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.
Answers, \FOA, aka traditional B-format:
| Ambisonic Order | Component Ordering | Component Normalisation |
| 1st | Furse-Malham (FuMa) | Gerzon / Furse-Malham (MaxN) |
.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.
.dirChannels
Get or set the directions of input or output channels, depending on -type.
.directions
A synonym for -dirChannels
.dirInputs
A convenience method providing polymorphism with -dirChannels, depending on -type.
.dirOutputs
A convenience method providing polymorphism with -dirChannels, depending on -type.