vpd-finalizers {tdarec} | R Documentation |
Finalizers for persistent homology vectorizations
Description
These functions take a persistent homology vectorization
parameter object and modify the dials::unknown()
parts of ranges
based
on a data set and heuristics used in inaugural studies.
Usage
get_pairs_max(object, x, hom_degrees = NULL, ...)
get_pers_max_frac(
object,
x,
hom_degree = NULL,
log_vals = TRUE,
frac = 1/100,
...
)
get_pers_min_mult(
object,
x,
hom_degree = NULL,
log_vals = TRUE,
mult = 100,
...
)
Arguments
object |
A |
x |
Persistence data in a recognizable format. |
... |
Other arguments to pass to the underlying parameter finalizer functions. |
hom_degree , hom_degrees |
Integer (vector) of homological degree(s). |
log_vals |
A logical: should the ranges be set on the log10 scale? |
frac |
A double for the fraction of the data to be used for the upper
bound. For |
mult |
A double for the multiple of the data to be used for the lower bound. |
Details
get_pairs_max()
sets the upper bound to the maximum number of persistent
pairs.
get_pers_max_frac()
sets both bounds to fractions of the maximum finite
persistence (lifespan). A single number is used as the lower bound fraction
and takes the upper bound fraction to be 1.
get_pers_min_mult()
sets both bounds to multiples of the minimum positive
persistence (lifespan). A single number is used as the upper bound multiple
and takes the lower bound multiple to be 1.
Value
An updated param
object or a list of updated param
objects depending
on what is provided in object
.