Function reference

Core

Core classes for time series analysis and recurrence quantification.

core.series.Series	Ammonyte series object, launching point for most ammonyte analysis.
core.geoseries.GeoSeries	Ammonyte GeoSeries object for geographically referenced time series.
core.time_embedded_series.TimeEmbeddedSeries	Time embedded time series object. Precursor to recurrence matrix and recurrence network.
core.recurrence_matrix.RecurrenceMatrix	Recurrence matrix object. Used for Recurrence Quantification Analysis (RQA).
core.recurrence_network.RecurrenceNetwork	Recurrence network object. Used for Recurrence Network Analysis (RNA).
core.rqa_res.RQARes	Class for storing the result of various RQA techniques
core.transitions.DeterministicTransitions	Container for deterministic transition detection results

Utilities

Functions for transition detection, parameter selection, metrics, and plotting.

utils.ks.KS_test	Detect tipping points using Kolmogorov-Smirnov test
utils.lerm_transitions.lerm_transition	Detect transitions using LERM Fisher Information threshold crossings
utils.ruptures_transitions.ruptures_transition	Detect transitions using ruptures change point detection
utils.parameters.tau_search	Find optimal tau value for time delay embedding.
utils.metrics.DetectionMetrics	Container for transition detection evaluation metrics
utils.metrics.evaluate_detection	Complete evaluation of transition detection performance
utils.plotting.bootstrap_fill_plot	Plot RQA results with bootstrap confidence bounds as a filled region
utils.plotting.bootstrap_scatter_plot	Plot RQA results highlighting points outside bootstrap confidence bounds as a scatter