PeriodicEvent

class astroplan.PeriodicEvent(epoch, period, duration=None, name=None)[source]

Bases: object

A periodic event defined by an epoch and period.

Parameters:

epoch : Time

Time of event

period : Quantity

Period of event

duration : Quantity (optional)

Duration of event

name : str (optional)

Name of target/event

Methods Summary

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

Methods Documentation

phase(time)[source]

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

Parameters:

time : Time

Evaluate the phase at this time or times

Returns:

phase_array : ndarray

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