HoaLm:
Filter:
atk-sc3/Classes (extension) | Libraries > Ambisonic Toolkit > Coefficients & Theory

HoaLm
ExtensionExtension

Higher Order Ambisonic (HOA) indexing & coefficients

Description

Higher Order Ambisonic (HOA) component indexing & coefficients, by Associated Legendre degree (ℓ) and Associated Legendre index (m).

See Associated Legendre degree and Associated Legendre index in ATK-Glossary.

Class Methods

.new

Create a new instance by Associated Legendre degree (ℓ) and Associated Legendre index (m).

Arguments:

lm

An two slot Array of integers: [l, m]

.newIndex

Create a new instance by Higher Order Ambisonic (HOA) index.

Arguments:

index

An integer.

ordering

Component ordering scheme:

\acnAmbisonic Channel Number (ACN)
\sidSingle Index Designation (SID)
\fumaFurse-Malham (FuMa)

Instance Methods

(ℓ, m) & HOA index

.lm

Return Associated Legendre degree (ℓ) and index (m).

.l

Return Associated Legendre degree (ℓ).

.m

Return Associated Legendre index (m).

.index

Return Higher Order Ambisonic (HOA) index.

Arguments:

ordering

Component ordering scheme:

\acnAmbisonic Channel Number (ACN)
\sidSingle Index Designation (SID)
\fumaFurse-Malham (FuMa)

.isInSubset

Test sub-group membership.

Arguments:

subset
\zonalZonal
\sectoralSectoral
\tesseralTesseral
\rotateRotation around z-axis, aka yaw

Discussion:

See also Visualization of the spherical harmonics.

Coefficients

.size

Return number of ambisonic components.

Offers polymorphism with HoaDegree: -size and HoaOrder: -size.

.sph

Return N3D normalized angular encoding coefficient.

Arguments:

theta

Azimuth, in radians.

phi

Elevation, in radians.

.normalisation

Return component normalisation coefficient.

Arguments:

scheme

Component normalisation schemes:

\n3dOrthonormal basis for 3D decomposition (N3D)
\sn3dSemi-normalised basis for 3D decomposition (SN3D)
\n2dOrthonormal basis for 2D decomposition (N2D)
\sn2dSemi-normalised basis for 2D decomposition (SN2D)
\maxNMaximum normalisation (maxN)
\MaxNGerzon / Furse-Malham (MaxN)
\fumaSynonym for MaxN (FuMa)

.reflection

Return component reflection coefficient.

Arguments:

mirror
\reflectMirror across the origin. Equivalent to: \flip * \flop * \flap.
\flipMirror in the y-axis.
\flopMirror in the x-axis.
\flapMirror in the z-axis.
\CondonShortleyPhaseCondon-Shortley Phase. Equivalent to: \flip * \flop.
\originSynonym for \reflect.
\xSynonym for \flop.
\ySynonym for \flip.
\zSynonym for \flap.

Examples

TBD

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