PeriodicEvent

class astroplan.PeriodicEvent(**func_kwargs)

Bases: object

A periodic event defined by an epoch and period.

Parameters

epochTime

Time of event

periodQuantity

Period of event

durationQuantity (optional)

Duration of event

namestr (optional)

Name of target/event

Methods Summary

phase(time)

Phase of periodic event, on interval [0, 1).

Methods Documentation

phase(time)

Phase of periodic event, on interval [0, 1). For example, the phase could be an orbital phase for an eclipsing binary system.

Parameters

timeTime

Evaluate the phase at this time or times

Returns

phase_arrayndarray

Phase at each time, on range [0, 1)