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

HoaDegree
ExtensionExtension

Higher Order Ambisonic (HOA) indexing & coefficients

Description

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

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

Class Methods

.new

Create a new instance.

Arguments:

degree

Associated Legendre degree (ℓ).

Instance Methods

.degree

Return Associated Legendre degree (ℓ).

(ℓ, m) & HOA indices

.lm

Return an array of Associated Legendre degrees (ℓ) and indices (m).

.l

Return an array of Associated Legendre degrees (ℓ).

.m

Return an array of Associated Legendre indices (m).

.indices

Return Higher Order Ambisonic (HOA) indices.

Arguments:

ordering

Component ordering scheme:

\acnAmbisonic Channel Number (ACN)
\sidSingle Index Designation (SID)
\fumaFurse-Malham (FuMa)
subset
\allAll indices
\zonalZonal
\sectoralSectoral
\tesseralTesseral
\rotateRotation around z-axis, aka yaw

.startIndex

Return the starting index of this degree.

Coefficients

.size

Return number of ambisonic components.

.sph

Return N3D normalized angular encoding coefficients.

Arguments:

theta

Azimuth, in radians.

phi

Elevation, in radians.

.normalisation

Return component normalisation coefficients.

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 coefficients.

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/HoaDegree.schelp
link::atk-sc3/Classes/HoaDegree::