Plot Method for Persistence Landscapes.

A base::plot() method for persistence landscape objects.

# S4 method for class 'Rcpp_PersistenceLandscape'
plot(
  x,
  replace_inf = NULL,
  n_levels = NULL,
  palette = "default",
  alpha = NULL,
  rev = FALSE,
  ...,
  silent = TRUE
)

Arguments

x

A persistence landscape object of class 'Rcpp_PersistenceLandscape'.

replace_inf

When using an exact representation of a persistence landscape, infinite values can appear. If not NULL, this value will replace Inf (and its negative will replace -Inf) in the plot.

n_levels

Integer; number of levels to plot. If NULL (the default), determined to be the number of levels in pl or x.

palette

Character; either the name of a qualitative palette from grDevices::palette.pals() (passed to grDevices::palette.colors()) or a sequential/diverging palette from grDevices::hcl.pals() (passed to grDevices::hcl.colors()), the name of a palette function in grDevices (e.g. 'rainbow' or 'terrain.colors'), a single color, or a vector of colors for grDevices::colorRampPalette() to interpolate. The default palette = "default" uses grDevices::palette.colors() with palette = "Okabe-Ito" (the colorblind-friendly default introduced in R 4.0.0), falling back to the current grDevices::palette().

alpha, rev

Parameters passed to grDevices::palette.colors(), grDevices::hcl.colors(), or grDevices::colorRampPalette(). For qualitative palettes returned by grDevices::palette.colors(), rev reverses the order. Note that recycle = TRUE is set internally when calling grDevices::palette.colors().

...

Additional parameters passed to base::plot(). Values passed to type or col will be ignored with a message.

silent

Logical; whether to silence messages.

Value

None (invisible NULL).

See also

Rcpp_PersistenceLandscape for the exported C++ class and pl_new() for the R wrapper.

Examples

# sample points
set.seed(650637L)
rpp <- tdaunif::sample_projective_plane(48L)

# compute persistence data, retaining parameters
pd <- ripserr::vietoris_rips(rpp, dim = 2L, threshold = 4)
#> Warning: `dim` parameter has been deprecated; use `max_dim` instead.

par(mfrow = c(3L, 1L), mar = c(0, 2, 0, 2))

# palette name
plot(pl_new(pd, degree = 0L, xmin = 0, xmax = 1.5, xby = 0.01),
     palette = "Cork", lwd = 1)
# palette function name
plot(pl_new(pd, degree = 1L, xmin = 0, xmax = 1.5, xby = 0.01),
     palette = "topo.colors", lwd = 1, rev = TRUE)
# custom color ramp
plot(pl_new(pd, degree = 2L, xmin = 0, xmax = 1.5, xby = 0.01),
     palette = c("red", "green", "blue"), lwd = 1)


# example with many colors
rpp2 <- tdaunif::sample_projective_plane(120L)
pd2 <- ripserr::vietoris_rips(rpp2, dim = 2L, threshold = 4)
#> Warning: `dim` parameter has been deprecated; use `max_dim` instead.
plot(pl_new(pd2, degree = 0L, xmin = 0, xmax = 1.5, xby = 0.01),
     palette = "Polychrome 36", lwd = 1)
plot(pl_new(pd2, degree = 1L, xmin = 0, xmax = 1.5, xby = 0.01),
     palette = "Alphabet", lwd = 1)
plot(pl_new(pd2, degree = 2L, xmin = 0, xmax = 1.5, xby = 0.01),
     palette = "Tableau 10", lwd = 1)


par(mfrow = c(1L, 1L), mar = c(5.1, 4.1, 4.1, 2.1))