index :: list

list.correlate

list cross-correlation

available since version: 0.9.4

---

information

Note: may perform slowly in large lists because it does not use the FFT to compute the convolution

arguments:

• B second argument values
  type: list
  

properties:

• @a Get/set first argument
  type: list
  

• @b Get/set second argument
  type: list
  

• @mode Get/set output mode. 'full' - output the cross-correlation at each point of overlap, with an output length of (M+N-1). At the end-points of the cross-correlation, the signals do not overlap completely, and boundary effects may be seen. 'valid' - output of length (max(M,N)-min(M,N)+1). The cross-correlation product is only given for points where the signals overlap completely. Values outside the signal boundary have no effect. 'same' - output of length max(M,N). Boundary effects are still visible
  type: symbol
  enum: valid, same, full
  default: valid
  

• @valid Get/set alias to @mode valid
  type: alias
  

• @same Get/set alias to @mode same
  type: alias
  

• @full Get/set alias to @mode full
  type: alias
  

inlets:

• calculate cross-correlation and output
  type: control
• set second argument (@b property)
  type: control

outlets:

• list: output result
  type: control

keywords:

list correlation cross

Authors: Serge Poltavsky

License: GPL3 or later