FoaMatrix : AtkMatrix : Object
Extension
ExtensionDescription
An FoaMatrix is not typically instantiated directly, but rather through one of its subclasses: FoaEncoderMatrix, FoaDecoderMatrix, and FoaXformerMatrix.
Class Methods
FoaMatrix.new(kind)
*new should not be called directly from AtkMatrix but rather is called from the various creation methods of its subclasses: FoaEncoderMatrix, FoaDecoderMatrix, or FoaXformerMatrix.
FoaMatrix.newFromMatrix(matrix, directions)
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.,
|
Inherited class methods
Instance Methods
Information
.info
A convenience method to post the properties of the matrix, including metadata if the matrix was loaded from a .yml file.
.order
Ambisonic order.
.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.
.op
Answers 'matrix', i.e. the type of operation used to compute the resulting signals.
.kind
Answers the kind.
.dim
Answers the number of encoder dimensions: 2D or 3D.
.numChannels
Answers the number of input or output channels, depending on -type.
.dirChannels
.dirChannels = value
Get or set the directions of input or output channels, depending on -type.
.directions
A synonym for -dirChannels
.numInputs
Number of inputs.
.dirInputs
A convenience method providing polymorphism with -dirChannels, depending on -type.
.numOutputs
Number of outputs.
.dirOutputs
A convenience method providing polymorphism with -dirChannels, depending on -type.
Matrix
.matrix
Returns the raw coefficient Matrix.
.asArray
Returns the matrix as a new Array of rows.
File handling
.fileName
Answers the name of the file used to create the instance, or nil if not created by loading a matrix from a file.
.filePath
Answers the path of the file used to create the instance, or nil if not created by loading a matrix from a file.
.fileParse
If the instance was created by loading a .yml file, this method returns the IdentityDictionary containing the parsed metadata. This can be useful if anything was stored in the metadata that can be subsequently used once reloaded, such as encoding directions, rotations, etc.
.writeToFile(fileNameOrPath, note, attributeDictionary, overwrite: false)
Write the matrix to a file
Arguments:
| fileNameOrPath |
A String of the file name. The file extension determines the format:
You may provide a full path if you would like to save the file somewhere other than the default location in the Atk |
| note |
A String that is a short description or bit of info about the matrix to store for future reference. |
| attributeDictionary |
A Dictionary containing any information that's useful to store in key:value pairs. Keys that match getters in the AtkMatrix will take precedence over the defaults. See the Discussion for more details. |
| overwrite |
A boolean specifying whether you'd like to force overwriting an existing file of the same name and extension. |
Discussion:
The Guide to ATK Matrix Files offers examples and more discussion regarding writing and reading matrices and metadata, including how to generate matrices for use in Reaper.
Inherited instance methods
Examples
link::Classes/FoaMatrix::