Reference / API

superfreq Package

This is an Astropy affiliated package.

Functions

check_for_primes(n[, max_prime]) Given an integer, n, ensure that it doest not have large prime divisors, which can wreak havok for FFT’s.
closest_resonance(freqs[, max_int]) Find the closest resonant vector for the given set of fundamental frequencies.
compute_actions(freqs, table[, max_int]) Reconstruct approximations to the actions using Percival’s equation.
find_frequencies(orbit[, force_box, …]) Compute the fundamental frequencies of an orbit, w.
find_integer_vectors(freqs, table[, max_int]) Given the fundamental frequencies and table of all frequency components, determine how each frequency component is related to the fundamental frequencies (e.g., determine the integer vector for each frequency such that \(n\cdot \Omega \approx 0.\)).
orbit_to_fs(orbit, units[, style]) Convert the orbit (position and velocity time series) into complex time series to be analyzed by SuperFreq.
test([package, test_path, args, plugins, …]) Run the tests using py.test.

Classes

SuperFreq(t[, p, keep_calm]) Implementation of the Numerical Analysis of Fundamental Frequencies method of Laskar, later modified by Valluri and Merritt (see references below), with some slight modifications.

Class Inheritance Diagram

Inheritance diagram of superfreq.naff.SuperFreq