index :: spat

hoa.3d.meter~

multi spherical meter with sound field descriptor

available since version: 0.9.7

---

information

displays the peak levels for a spherical array of loudspeakers. It computes and displays the energy and velocity vectors.

methods:

• 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:

• @channels Get/set number of input channels
  type: int
  range: 1..64
  default: 4
  

• @send Get/set send destination
  type: symbol
  default: (null)
  

• @receive Get/set receive source
  type: symbol
  default: (null)
  

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

• @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
  

• @over_color Get/set peak overload color
  type: list
  default: 1 0 0 0.8
  

• @hot_color Get/set color for >=-12db.
  type: list
  default: 1 0.6 0 0.8
  

• @warm_color Get/set color for >=-21db.
  type: list
  default: 0.85 0.85 0 0.8
  

• @tepid_color Get/set color for >=-30db.
  type: list
  default: 0.6 0.73 0 0.8
  

• @cold_color Get/set color for >=-39db.
  type: list
  default: 0 0.6 0 0.8
  

• @energy_color Get/set energy vector color
  type: list
  default: 0 0 1 0.8
  

• @velocity_color Get/set velocity vector
  type: list
  default: 1 0 0 0.8
  

• @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
  

• @interval Get/set refresh interval
  type: int
  units: ms
  range: 20..1000
  default: 50
  

• @clockwise Get/set clockwise channel numbering mode
  type: bool
  default: 0
  

• @offset Get/set channel numbering offset for each axes
  type: list
  default: 0 0 0
  

• @angles Get/set channel layout angles
  type: list
  default: 0 90 0 -19.5 120 -19.5 240 -19.5
  

• @vectors Get/set vector display mode
  type: symbol
  enum: both, energy, none, velocity
  default: energy
  

• @view Get/set view mode
  type: symbol
  enum: bottom, top, topnextbottom, toponbottom
  default: top
  

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 meter 3d

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

License: GPL3 or later