ADT | SuperCollider 3.13.0 Help

Description

Control the Ambisonic Decoder Toolbox (ADT) via the command line, using Octave. This quark allows you to generate run the toolbox with the allrad, pinv and ssf decoders, write .yml files suitable for the Ambisonic Toolkit and write all other outputs native to the ADT.

Class Methods

ADT.new(folderPath, directions, match: 'amp', order: 3, format, filename: 'ADT', ymlOnly: true)

Create a new instance of the ADT class.

Arguments:

folderPath	The path of the folder to which to write the .yml files. If nil AND the atk-sc3 quark is installed, this will default to Atk.userExtensionsDir ++ "matrices/HOA(orderNum)/decoders/" (e.g for 3rd order, Atk.userExtensionsDir ++ "matrices/HOA3/decoders/"). If nil and the atk-sc3 is NOT installed, it will default to ADT.userADTDir ++ "/decoders/".
directions	An Array of directions in polar form ([theta_radians, phi_radians, rho_meters]) in the form `[[0, 0, 1]]`. Meters can be omitted, will default to 1.5.
match	A symbol for the gain matching, can be 'amp', 'rms', or 'energy'. NOTE: Match gains only work with the energy beam shape decoders as of now. The other beams, basic and controlled, are matched with 'amp'.
order	The ambisonic order of the decoder. This can be a single value, or for mixed order, an array of `[horiz_order, vertical_order, mixed_order_scheme]`. See the ADT documentation for discussion of mixed order decoders.
format	The ambisonic format as an Array of the channel order and normalization. Defaults to `['ACN', 'N3D']`. See ADT for possiblities.
filename	An optional filename as the beginning of the written .yml files. Defaults to 'ADT'.
ymlOnly	A boolean which determines where the default output files from the ADT get written. `True` means the files will be written to the "pathToADT/decoders/" folder and `false` means they will be written with the .yml files to the user specified path, `folderPath`. Defaults to `true`.

ADT.userADTDir

ADT.userADTDir = value

The directory to the local copy of the Ambisonic Decoder Toolbox repository. Defaults to "/pathToThisQuark/ADT/". Otherwise you can set this path manually.ADT.userADTDir; // check where it currently points ADT.userADTDir_("pathToADT"); // change where it points

ADT.userOctaveCmd

ADT.userOctaveCmd = value

The path to the octave command. Defaults to the path returned from the command "which octave".ADT.userOctaveCmd // check for the command path "which octave".unixCmd; // should return the command path, if not, run this same command in the Terminal and manually set the path as below ADT.userOctaveCmd_("pathToCommand");

Inherited class methods

Undocumented class methods

ADT.scripts

ADT.scripts = value

ADT.userPyADTDir

ADT.userPyADTDir = value

Instance Methods

.allrad(imagSpeakers, type: 'python', verbose: false)

Generate the matrices for the allrad decoder method.

NOTE: Warning: The allrad takes a long time (several minutes)

Arguments:

imagSpeakers	An array of locations for imaginary speaker locations (used for irregular speaker arrays, such as a dome). If nil, a single imaginary speaker at [0, -0.5pi, 1] is created.
action	A function to be evaluated upon completion of the asynchronous matrix generation.

.pinv(alpha, verbose: false)

Generate the matrices for the psuedo-inverse decoder method.

Arguments:

alpha	A value between 0 and 1. 0 -> mode matching and 1 -> even energy. Values between 0 and 1 give a blend of the two.
action	A function to be evaluated upon completion of the asynchronous matrix generation.

.ssf(alpha, elevationRange, verbose: false)

Generate the matrices for the spherical slepian functions decoder method.

Arguments:

alpha	A value between 0 and 1. 0 -> mode matching and 1 -> even energy. Values between 0 and 1 give a blend of the two.
elevationRange	Elevation angle(s) in radians. If empty, assume a hemisphere. If a scalar, a min elevation. If an array: [minElevation, maxElevation].
action	A function to be evaluated upon completion of the asynchronous matrix generation.

Inherited instance methods

Undocumented instance methods

.allradPython(imagSpeakers: true, verbose: false)

.filePath(type: "allrad", beam: "energy")

.matrixNames

.matrixPaths

.run(type: "allrad", extraArgs, verbose: false)

Examples

(

///////// SET PATHS //////////
// path to ADT repository folder
// ADT.userADTDir_(ADT.filenameSymbol.asString.dirname ++ "/../ADT/");

// path to octave command (use "which octave" in terminal)
ADT.userOctaveCmd_("/usr/local/bin/octave");

/////// SET SPEAKER DIRECTIONS ////////

// load included example directions dictionary
~directions = (ADT.filenameSymbol.asString.dirname ++ "/../Example_Speaker_Arrays/DXARTS_205.scd").load;

// parse dictionary
~directions = [~directions.spkrAzimuthsRad, ~directions.spkrElevationsRad].flop;

////// INSTANTIATE THE ADT CLASS ////////

// create instance of ADT with folderPath on desktop with '205' as beginning of filename
~adt = ADT.new(
    folderPath: nil, // nil, write to default path
    directions: ~directions,
    match: 'amp',
    order: 3,
    format: ['ACN', 'N3D'],
    filename: '205',
    ymlOnly: true // write only yml to the folderPath, the rest get written to the ADT repo folder
)
)

///// CHOOSE A DECODER METHOD //////
// pinv decoder
(
~alpha = 0; // mode matching
// ~alpha = 1; // even energy
~adt.pinv(~alpha);
)

// slepian
(
~alpha = 0; // mode matching
// ~alpha = 1; // even energy
~elevationRange = nil; // use ADT default range
// ~elevationRange = -0.5pi; // -90 degrees as min elevation
// ~elevationRange = [-0.5pi, 0.5pi]; // min/max range
~adt.ssf(~alpha, ~elevationRange);
)

// allrad
(
~imagSpeakers = nil; // default ADT
// ~imagSpeakers = [0, -0.5pi, 1.5]; // use with ATK
~adt.allrad(~imagSpeakers)
)

// use with the ATK
Quarks.install("atk-sc3");

~matrixName = ~adt.matrixNames[0]; // choose the first matrix

~order = ~matrixName[10].asString.asInteger;

~decoder = HoaMatrixDecoder.newFromFile(~matrixName, order: ~order);

helpfile source: /Library/Application Support/SuperCollider/downloaded-quarks/adt.quark/HelpSource/Classes/ADT.schelp
link::Classes/ADT::

ADT : Object Extension

ADT.new(folderPath, directions, match: 'amp', order: 3, format, filename: 'ADT', ymlOnly: true)

Arguments:

ADT.userADTDir

ADT.userADTDir = value

ADT.userOctaveCmd

ADT.userOctaveCmd = value

ADT.scripts

ADT.scripts = value

ADT.userPyADTDir

ADT.userPyADTDir = value

.allrad(imagSpeakers, type: 'python', verbose: false)

Arguments:

.pinv(alpha, verbose: false)

Arguments:

.ssf(alpha, elevationRange, verbose: false)

Arguments:

.allradPython(imagSpeakers: true, verbose: false)

.filePath(type: "allrad", beam: "energy")

.matrixNames

.matrixPaths

.run(type: "allrad", extraArgs, verbose: false)

ADT : Object
Extension