index :: spat

hoa.2d.recomposer~

aliases: [hoa.recomposer~]

recomposes a 2d plane wave decomposition into circular harmonics

available since version: 0.8

---

information

Recomposes a plane wave decomposition into circular harmonics. There's three modes, fixe (default), fisheye and free.

arguments:

• ORDER the order of decomposition.
  type: int
  

• N number of channels. '0' means auto-calculation.
  type: int
  

• MODE recomposition mode. There is three modes: fixe - simply recomposes a plane wave decomposition into circular harmonics. fisheye - allows you to perform an operation similar to the visual "fisheye" effect by distorsion of the sound field perspective to the front of the scene. free - allows you to change the angles and the widening value for each channels.
  type: symbol
  

methods:

• angles set the angles of channels. Angles are in radians, wrapped between 0 and 2π
  parameters:
  • VALS list of angles
    type: list
    units: rad
    required: True
    
• wide set the widening value of channels. Widening value is clipped between 0. (omnidirectional) and 1. (directional)
  parameters:
  • VALS list of values per channel
    type: list
    required: True
    

properties:

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

• @n (initonly) Get/set number of channels (planewaves). '0' means auto-calculation.
  type: int
  range: 0..128
  default: 0
  

• @mode (initonly) Get/set recomposition mode. There is three modes: fixe - simply recomposes a plane wave decomposition into circular harmonics. fisheye - allows you to perform an operation similar to the visual "fisheye" effect by distorsion of the sound field perspective to the front of the scene. free - allows you to change the angles and the widening value for each channels.
  type: symbol
  enum: fixe, fisheye, free
  default: free
  

• @fixe (initonly) Get/set alias for @mode fixe
  type: alias
  

• @fisheye (initonly) Get/set alias for @mode fisheye
  type: alias
  

• @free (initonly) Get/set alias for @mode free
  type: alias
  

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

inlets:

• input harmonic
  type: audio
• input harmonic
  type: audio
• input harmonic. If @fisheye mode is used: fisheye factor [0-1] in last inlet
  type: audio

outlets:

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

keywords:

hoa recomposer

See also: [hoa.2d.projector~]

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

License: GPL3 or later