index :: spat

hoa.scope~

aliases: [hoa.2d.scope~]

a 2d ambisonic harmonic scope

available since version: 0.8

---

information

displays the circular harmonics of an ambisonic sound field

arguments:

• ORDER the order of decomposition
  type: int
  

methods:

• dump dumps all object info to Pd console window.
  

• pos set UI element position
  parameters:

  • X top left x-coord
    type: float
    required: True
    

  • Y top right y-coord
    type: float
    required: True
    

properties:

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

• @view Get/set view rotation
  type: float
  default: 0
  

• @gain Get/set gain
  type: float
  min value: 0
  default: 1
  

• @refresh Get/set redraw time
  type: int
  units: ms
  range: 20..1000
  default: 100
  

• @ph_color Get/set positive harmonics color
  type: list
  default: 1 0 0 1
  

• @nh_color Get/set negative harmonics color
  type: list
  default: 0 0 1 1
  

• @size Get/set element size (width, height pair)
  type: list
  default: 120 120
  

• @pinned Get/set pin mode. if 1 - put element to the lowest level
  type: bool
  default: 0
  

• @background_color Get/set element background color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0.93 0.93 0.93 1
  

• @border_color Get/set border color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0.6 0.6 0.6 1
  

• @fontsize Get/set fontsize
  type: int
  range: 4..100
  default: 11
  

• @fontname Get/set fontname
  type: symbol
  enum: Courier, DejaVu, Helvetica, Monaco, Times
  default: Helvetica
  

• @fontweight Get/set font weight
  type: symbol
  enum: normal, bold
  default: normal
  

• @fontslant Get/set font slant
  type: symbol
  enum: roman, italic
  default: roman
  

• @label Get/set label text
  type: symbol
  default: (null)
  

• @label_color Get/set label color in RGB format within 0-1 range, for example: 0.2 0.4 0.1
  type: list
  default: 0 0 0 1
  

• @label_inner Get/set label position (1 - inner, 0 - outer).
  type: bool
  default: 0
  

• @label_align Get/set label horizontal align
  type: symbol
  enum: left, center, right
  default: left
  

• @label_valign Get/set label vertical align
  type: symbol
  enum: top, center, bottom
  default: top
  

• @label_side Get/set label snap side
  type: symbol
  enum: left, top, right, bottom
  default: top
  

• @label_margins Get/set label offset in pixels
  type: list
  default: 0 0
  

inlets:

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

keywords:

hoa scope

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

License: GPL3 or later