Skip to content

Commit

Permalink
Added documentation for satellite_skycoord and return type for binary…
Browse files Browse the repository at this point in the history
… sources.
  • Loading branch information
jenniferyee committed Dec 7, 2023
1 parent bf40fcb commit 6e0e134
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion source/MulensModel/model.py
Original file line number Diff line number Diff line change
Expand Up @@ -599,6 +599,7 @@ def plot_trajectory(
times = self.set_times(
t_range=t_range, t_start=t_start, t_stop=t_stop, dt=dt,
n_epochs=n_epochs)

if satellite_skycoord is None:
satellite_skycoord = self.get_satellite_coords(times)
else:
Expand Down Expand Up @@ -763,7 +764,15 @@ def get_trajectory(self, times, satellite_skycoord=None):
times: *np.ndarray*, *list of floats*, or *float*
Epochs for which source positions are requested.
Returns : A `:py:class:`~MulensModel.trajectory.Trajectory` object.
satellite_skycoord: *astropy.SkyCoord*
Allows the user to specify that the trajectory is calculated
for a satellite. If *astropy.SkyCoord* object is provided,
then these are satellite positions for all epochs.
See also :py:func:`get_satellite_coords()`
Returns : A `:py:class:`~MulensModel.trajectory.Trajectory` object. If
n_sources > 1, returns a tuple of
`:py:class:`~MulensModel.trajectory.Trajectory`s
"""
if satellite_skycoord is None:
Expand Down

0 comments on commit 6e0e134

Please sign in to comment.