PeriodicCubicalComplex: R6 Class for Periodic Cubical Complex

In rgudhi: An Interface to the GUDHI Library for Topological Data Analysis

R6 Class for Periodic Cubical Complex

Description

The PeriodicCubicalComplex class is an example of a structured complex useful in computational mathematics (specially rigorous numerics) and image analysis.

Super classes

rgudhi::PythonClass -> rgudhi::CubicalComplex -> PeriodicCubicalComplex

Methods

Public methods

• PeriodicCubicalComplex$new()

• PeriodicCubicalComplex$clone()

Inherited methods

• rgudhi::PythonClass$get_python_class()
• rgudhi::PythonClass$set_python_class()
• rgudhi::CubicalComplex$betti_numbers()
• rgudhi::CubicalComplex$cofaces_of_persistence_pairs()
• rgudhi::CubicalComplex$compute_persistence()
• rgudhi::CubicalComplex$dimension()
• rgudhi::CubicalComplex$num_simplices()
• rgudhi::CubicalComplex$persistence()
• rgudhi::CubicalComplex$persistence_intervals_in_dimension()
• rgudhi::CubicalComplex$persistent_betti_numbers()

---

Method new()

Constructor from either top_dimensional_cells (and possibly dimensions) or from a Perseus-style file name.

Usage

PeriodicCubicalComplex$new(
  perseus_file,
  top_dimensional_cells,
  periodic_dimensions,
  dimensions = NULL,
  py_class = NULL
)

Arguments

perseus_file

A character string specifying the path to a Perseus-style file name.

top_dimensional_cells

Either a numeric vector (in which case, dimensions should be provided as well) or a multidimensional array specifying cell filtration values.

periodic_dimensions

A logical vector specifying the periodicity value of the top dimensional cells.

dimensions

An integer vector specifying the number of top dimensional cells. Defaults to NULL.

py_class

An existing PeriodicCubicalComplex Python class. Defaults to NULL which uses the Python class constructor instead.

Returns

A new PeriodicCubicalComplex object.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

PeriodicCubicalComplex$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Author(s)

Pawel Dlotko

See Also

Other data structures for cell complexes: CubicalComplex, SimplexTree

Examples

n <- 10
X <- cbind(seq(0, 1, len = n), seq(0, 1, len = n))
pcc <- PeriodicCubicalComplex$new(
  top_dimensional_cells = X,
  periodic_dimensions = c(TRUE, FALSE)
)
pcc

rgudhi documentation built on March 31, 2023, 11:38 p.m.