run_periodicity

ell1fit.spin_stats.run_periodicity(table, local, min_period, max_period, rate_exclude=(), with_leave_one_out=False, **search_kwargs)

Periodicity searches on local F1 and the pulsed rate, each alone (search_periodicity()) and jointly, over the epochs where both are measured (search_joint_periodicity()).

Returns:

dict

{key: result} for "f1", "pulsed_rate" and "joint". Each single result also carries its input t, y and yerr for plotting; the joint one carries the same per quantity, at the joint period, under components. Searches with fewer than MIN_POINTS_FOR_PERIODICITY epochs are skipped with a warning. With with_leave_one_out, each result also has a leave_one_out list (see leave_one_out()).