orbithunter.core.Orbit.mask

Orbit.mask(masking_array, invert=False, **kwargs)

Return an Orbit instance with a numpy masked array state

Parameters

masking_arraynp.ndarray

invertbool

Whether or not to take the inverse mask.

Notes

Typically used for plotting shadowing and clipping results.