Shadowing

orbithunter.shadowing.cover(orbit_cover, verbose=False, **kwargs)[source]

Function to perform multiple shadowing computations given a collection of orbits.

Parameters
orbit_coverOrbitCover

Object which contains the base orbit, window orbits, thresholds, and everything else.

Returns
tuple(orbit_cover, np.ndarray, [np.ndarray, np.ndarray])

NumPy arrays whose indices along the first axis correspond to the window orbits’ position in `window_orbits` and whose other dimensions consist of scores or masking values. If return_pivot_arrays==True then also return the score and masking arrays for the pivots in addition to the orbit scores and pivots.

Notes

If a pivot mask is not provided, then any elements of the score array which are beneath threshold are not recalculated.