R/sparse-fr-spectrum.R

In pmcharrison/hrep: Harmony Representations

#' @keywords internal
.sparse_fr_spectrum <- function(frequency, amplitude, labels = NULL) {
  checkmate::qassert(frequency, "N")
  checkmate::qassert(amplitude, "N")
  stopifnot(length(frequency) == length(amplitude))

  res <- sparse_spectrum(x = frequency,
                         y = amplitude,
                         x_unit = "Hz",
                         y_unit = "amplitude",
                         label = "sparse frequency spectrum",
                         x_lab = "Frequency (Hz)",
                         y_lab = "Amplitude",
                         labels = labels)
  class(res) <- c("sparse_fr_spectrum", "chord", class(res))
  res
}

#' Is sparse pitch-class spectrum
#'
#' Checks whether an object belongs to the class \code{sparse_fr_spectrum}.
#'
#' @param x Object to check.
#'
#' @return Logical scalar.
#'
#' @export
is.sparse_fr_spectrum <- function(x) {
  is(x, "sparse_fr_spectrum")
}

#' Sparse frequency spectrum
#'
#' This function represents an input object as a
#' sparse frequency spectrum.
#'
#' @details
#' A sparse frequency spectrum comprises a finite set of spectral components,
#' each defined by a frequency (in Hz)
#' and an amplitude (expressed in arbitrary units, but with the
#' fundamental frequencies of chord pitches typically taking the value 1).
#'
#' @param x Input sonority.
#' * Numeric vectors will be treated as vectors of MIDI note numbers,
#' and expanded into their implied harmonics.
#' * Two-element lists will be treated as finalised spectra.
#' The first element should be labelled "frequency",
#' and correspond to a numeric vector of frequencies;
#' the second element should be labelled "amplitude",
#' and correspond to a numeric vector of amplitudes.
#'
#' @inheritDotParams expand_harmonics
#'
#' @return An object of class \code{sparse_fr_spectrum}.
#'
#' @rdname sparse_fr_spectrum
#'
#' @md
#'
#' @export
sparse_fr_spectrum <- function(x, ...) {
  UseMethod("sparse_fr_spectrum")
}

#' @rdname sparse_fr_spectrum
#' @export
sparse_fr_spectrum.sparse_fr_spectrum <- function(x, ...) {
  x
}

#' @rdname sparse_fr_spectrum
#' @export
sparse_fr_spectrum.sparse_pi_spectrum <- function(x, ...) {
  .sparse_fr_spectrum(
    frequency = midi_to_freq(pitch(x)),
    amplitude = amp(x),
    labels = x$labels
  )
}

#' @rdname sparse_fr_spectrum
#' @export
sparse_fr_spectrum.pi_chord <- function(x, ...) {
  sparse_fr_spectrum(sparse_pi_spectrum(x, ...))
}

#' @rdname sparse_fr_spectrum
#' @export
sparse_fr_spectrum.default <- function(x, ...) {
  sparse_fr_spectrum(pi_chord(x), ...)
}

#' @rdname sparse_fr_spectrum
#' @export
sparse_fr_spectrum.list <- function(x, ...) {
  stopifnot(length(x) == 2L,
            is.numeric(x[[1]]),
            is.numeric(x[[2]]),
            length(x[[1]]) == length(x[[2]]))
  stopifnot(is.null(names(x)) || identical(names(x), c("frequency", "amplitude")))
  .sparse_fr_spectrum(frequency = x[[1]],
                      amplitude = x[[2]])
}

#' @export
freq.sparse_fr_spectrum <- function(x) {
  x$x
}

#' @export
`freq<-.sparse_fr_spectrum` <- function(x, value) {
  stopifnot(is.numeric(value),
            length(value) == length(freq(x)))
  x$x <- value
  x
}

#' @export
amp.sparse_fr_spectrum <- function(x) {
  x$y
}

#' @export
`amp<-.sparse_fr_spectrum` <- function(x, value) {
  stopifnot(is.numeric(value),
            length(value) == length(amp(x)))
  x$y <- value
  x
}