dyad_roughness_seth: Dyad roughness (Sethares)

Description Usage Arguments Value References

View source: R/sethares.R

Description

Gets the roughness of a dyad according to the model of Sethares (1993).

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
dyad_roughness_seth(
  f1,
  f2,
  a1,
  a2,
  ensure_f1_is_less_than_f2 = TRUE,
  min_amplitude = TRUE,
  a = 3.5,
  b = 5.75,
  s1 = 0.021,
  s2 = 19,
  d_star = 0.24
)

Arguments

f1

Frequency of tone 1 (Hz) (numeric vector).

f2

Frequency of tone 2 (Hz) (numeric vector). Must be greater than f1.

a1

amplitude of tone 1 (numeric vector).

a2

amplitude of tone 2 (numeric vector).

ensure_f1_is_less_than_f2

If FALSE, assumes that f1 < f2.

min_amplitude

If TRUE, roughness is considered to be proportional to the minimum amplitude of each pair of partials, rather than the product of their amplitudes. The default (TRUE) corresponds to the algorithm as updated by \insertCiteSethares2005;textualdycon and \insertCiteWeisser2013;textualdycon. Set to FALSE to recover the original algorithm from \insertCiteSethares1993;textualdycon.

a

Numeric scalar parameter, optimised to 3.5 (default) in Sethares (1993).

b

Numeric scalar parameter, optimised to 5.75 (default) in Sethares (1993).

s1

Numeric scalar parameter from Sethares (1993).

s2

Numeric scalar parameter from Sethares (1993).

d_star

Numeric scalar parameter from Sethares (1993).

Value

Numeric vector of roughnesses.

References

\insertAllCited
pmcharrison/dycon documentation built on June 28, 2021, 4:46 p.m.