plot_filters: Plots filters properties

In palatej/rjdfilters: Trend-Cycle Extraction with Linear Filters

Plots filters properties

Description

Functions to plot the coefficients, the gain and the phase functions.

Usage

plot_coef(x, nxlab = 7, add = FALSE, ...)

## Default S3 method:
plot_coef(
  x,
  nxlab = 7,
  add = FALSE,
  zero_as_na = TRUE,
  q = 0,
  legend = FALSE,
  legend.pos = "topright",
  ...
)

## S3 method for class 'moving_average'
plot_coef(x, nxlab = 7, add = FALSE, ...)

## S3 method for class 'finite_filters'
plot_coef(
  x,
  nxlab = 7,
  add = FALSE,
  zero_as_na = TRUE,
  q = 0,
  legend = length(q) > 1,
  legend.pos = "topright",
  ...
)

plot_gain(x, nxlab = 7, add = FALSE, xlim = c(0, pi), ...)

## S3 method for class 'moving_average'
plot_gain(x, nxlab = 7, add = FALSE, xlim = c(0, pi), ...)

## S3 method for class 'finite_filters'
plot_gain(
  x,
  nxlab = 7,
  add = FALSE,
  xlim = c(0, pi),
  q = 0,
  legend = length(q) > 1,
  legend.pos = "topright",
  n = 101,
  ...
)

plot_phase(x, nxlab = 7, add = FALSE, xlim = c(0, pi), normalized = FALSE, ...)

## S3 method for class 'moving_average'
plot_phase(x, nxlab = 7, add = FALSE, xlim = c(0, pi), normalized = FALSE, ...)

## S3 method for class 'finite_filters'
plot_phase(
  x,
  nxlab = 7,
  add = FALSE,
  xlim = c(0, pi),
  normalized = FALSE,
  q = 0,
  legend = length(q) > 1,
  legend.pos = "topright",
  n = 101,
  ...
)

Arguments

x	coefficients, gain or phase.
nxlab	number of xlab.
add	boolean indicating if the new plot is added to the previous one.
...	other arguments to matplot.
zero_as_na	boolean indicating if the trailing zero of the coefficients should be plotted (FALSE) or removed (TRUE).
q	q.
legend	boolean indicating if the legend is printed.
legend.pos	position of the legend.
xlim	vector containing x limits.
n	number of points used to plot the functions.
normalized	boolean indicatif if the phase function is normalized by the frequency.

Examples

filter <- lp_filter(6, endpoints = "DAF", kernel = "Henderson")
plot_coef(filter, q = c(0,3), legend = TRUE)
plot_gain(filter, q = c(0,3), legend = TRUE)
plot_phase(filter, q = c(0,3), legend = TRUE)

palatej/rjdfilters documentation built on May 8, 2023, 6:28 a.m.