index :: ui

ui.filter~

UI filter object based on biquad filter

available since version: 0.9.3

---

methods:

• biquad set biquad coefficients (but not changes current filter properties)
  parameters:
  • b0 b1 b2 a1 a2 coefficients
    type: list
    required: True
    
• clear clears specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    

• dump dumps all object info to Pd console window
  

• interp for this object acts as load, no interpolation performed
  

• load loads specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    
• pos set UI element position
  parameters:

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

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

• store stores specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    

properties:

• @freq Get/set filter frequency
  type: float
  range: 0..20000
  default: 1000
  

• @scale Get/set frequency scale
  type: symbol
  enum: lin, log, rad
  default: lin
  

• @type Get/set frequency scale
  type: symbol
  enum: lpf, hpf, bpf, bpfq, lowshelf, highshelf, peak, notch
  default: lpf
  

• @gain Get/set gain (for low/highshelf/peak filters)
  type: float
  units: db
  range: -24..24
  default: 0
  

• @q Get/set quality factor
  type: float
  range: 0.0156..64
  default: 0.7071
  

• @presetname Get/set preset name for using with [ui.preset]
  type: symbol
  default: (null)
  

• @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: 300 100
  

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

• @mouse_events Get/set mouse events output mode. If on outputs @mouse_down, @mouse_up and @mouse_drag events
  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
  

• @knob_color Get/set knob color
  type: list
  default: 0 0.75 1 1
  

• @grid_color Get/set knob color
  type: list
  default: 0.6 0.6 0.6 1
  

• @plot_color Get/set knob color
  type: list
  default: 0 0 0 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.6 0.6 0.6 1
  

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

• input signal
  type: audio

outlets:

• filtered signal
  type: audio
• list: filter biquad coefficient
  type: control

keywords:

ui filter biquad

See also: [ui.filter]

Authors: Serge Poltavsky

License: GPL3 or later