Utility Functions (peccary.utils)

Introduction

The utils module provides a variety of useful functions for related to the PECCARY method. This includes converting between sampling intervals and pattern timescales, calculating limits of the HC plane given some sampling size \(n\), and calculating the allowed region of the HC plane.

API

peccary.utils Module

Utility functions for PECCARY

Functions

ell2tpat(ell, dt[, n])	Convert sampling interval to pattern timescale
tpat2ell(tpat, dt[, n, returnInt])	Convert pattern timescale to sampling interval
HmaxPer([n])	Calculate maximum Permutation Entropy value (H) for a periodic function given the specified sampling size n.
HminPer([n])	Calculate minimum Permutation Entropy value (H) for a periodic function given the specified sampling size n.
calcHCplane([n, nsteps])	Get maximum and minimum C(H) curves based on pattern length for plotting on the HC plane
getMaxC([n, nsteps])	Get maximum possible Statistical Complexity value from HC bounding curves for sampling size n