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

AtkFoa
ExtensionExtension

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

Description

The AtkFoa class defines variables that may be used to integrate FOA and HOA workflows within the ATK library.

Class Methods

Ambisonic order

.defaultOrder

Ambisonic order, FOA.

Component ordering & normalisation

.format

Designation indicating ambisonic component ordering and component normalisation. The Ambisonic Toolkit FOA convention is FuMa-FuMa, i.e., Furse-Malham (FuMa), Gerzon / Furse-Malham (MaxN).

.ordering

Ambisonic Toolkit FOA ambisonic component ordering convention: Furse-Malham (FuMa). See ordering.

.normalisation

Ambisonic Toolkit ambisonic component normalisation convention: Gerzon / Furse-Malham (MaxN). See normalisation.

Radial & NFE

.refRadius

Ambisonic Toolkit FOA reference radius, in meters.

.speedOfSound

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

.setSpeedOfSound

Setter for *speedOfSound.

Arguments:

mps

Speed of sound, in meters per second.

Examples

TBD

helpfile source: HelpSource/Classes/AtkFoa.schelp
link::atk-sc3/Classes/AtkFoa::