index :: spat

hoa.2d.map~

aliases: [hoa.map~]

a 2d ambisonic multisource spatializer

available since version: 0.8

---

information

Encodes several sources in the circular harmonics domain with distance compensation and muting system If nsrc==1 radius and angle controlled with signal values Note: source indexes are 1-based.

arguments:

• ORDER the order of decomposition
  type: int
  

• NSRC number of sources
  type: int
  

• MODE mode in signal control mode (with nsrc=1)
  type: symbol
  

methods:

• mute mute/unmute specified source
  parameters:

  • IDX source index. 1-based
    type: int
    required: True
    

  • STATE mute value
    type: int
    required: True
    

• polar set source mapping in polar coordinates
  parameters:

  • IDX source index. 1-based
    type: int
    required: True
    

  • RAD radius
    type: float
    required: True
    

  • ANG rotation angle
    type: float
    units: rad
    required: True
    

• pol alias to 'polar' method
  

• cartesian set source mapping in cartesian coordinates
  parameters:

  • IDX source index. 1-based
    type: int
    required: True
    

  • X x-coord
    type: float
    required: True
    

  • X y-coord
    type: float
    required: True
    

• car alias to 'cartesian' method
  

properties:

• @order (initonly) Get/set the order of decomposition
  type: int
  range: 1..63
  default: 1
  

• @nsrc (initonly) Get/set number of input sources
  type: int
  min value: 1
  default: 1
  

• @ramp Get/set ramp time
  type: float
  min value: 0
  default: 100
  

• @mode Get/set signal control mode (with nsrc=1). If 'pol': second and third signal inlets are treated as radius and angle values, if 'car': as X and Y coordinates
  type: symbol
  enum: pol, car
  default: pol
  

inlets:

• first source input
  type: audio
• … source input
  type: audio
• n-th source input
  type: audio

outlets:

• first harmonic output
  type: audio
• … harmonic output
  type: audio
• n-th harmonic output
  type: audio

keywords:

hoa map

Authors: Serge Poltavsky, Pierre Guillot, Eliott Paris, Thomas Le Meur

License: GPL3 or later