Skip to content

Commit 1a45e6f

Browse files
committed
updating documentation for moving_target functionality as bool
1 parent 3a33c66 commit 1a45e6f

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/mast/mast.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -816,14 +816,14 @@ Requesting a cutout by moving_target accesses the
816816
`MAST Moving Target TESScut API <https://mast.stsci.edu/tesscut/docs/getting_started.html#moving-target-cutouts>`__
817817
and returns a target pixel file, with format described
818818
`here <https://astrocut.readthedocs.io/en/latest/astrocut/file_formats.html#path-focused-target-pixel-files>`__.
819-
The moving_target may be any object name or ID understood by the
820-
`JPL Horizonf ephemerades interface <https://ssd.jpl.nasa.gov/horizons.cgi>`__.
819+
The moving_target is an optional bool argument where `True` signifies that the accompanying `objectname` input is the object name or ID understood by the
820+
`JPL Horizon ephemerades interface <https://ssd.jpl.nasa.gov/horizons.cgi>`__. The default value for moving_target is set to False. Therefore, a non-moving target can be input simply with either the objectname or coordinates.
821821

822822
.. code-block:: python
823823
824824
>>> from astroquery.mast import Tesscut
825825
826-
>>> hdulist = Tesscut.get_cutouts(moving_target="Eleonora", size=5, sector=6)
826+
>>> hdulist = Tesscut.get_cutouts(objectname="Eleonora", moving_target=True, size=5, sector=6)
827827
>>> hdulist[0].info()
828828
Filename: <class '_io.BytesIO'>
829829
No. Name Ver Type Cards Dimensions Format
@@ -834,13 +834,11 @@ The moving_target may be any object name or ID understood by the
834834
835835
836836
837-
The `~astroquery.mast.TesscutClass.download_cutouts` function takes a coordinate, object name
838-
(i.e. "M104" or "TIC 32449963"), or moving target (i.e. "Eleonora") and cutout size
839-
(in pixels or an angular quantity) and downloads the cutout target pixel file(s).
837+
The `~astroquery.mast.TesscutClass.download_cutouts` function takes a coordinate, cutout size
838+
(in pixels or an angular quantity), or object name
839+
(i.e. "M104" or "TIC 32449963") and moving target (True or False). It uses these parameters to download the cutout target pixel file(s).
840840

841-
If a given coordinate/object/moving target appears in more than one TESS sector a
842-
target pixel file will be produced for each sector. If the cutout area overlaps
843-
more than one camera or ccd a target pixel file will be produced for each one.
841+
If a given coordinate/object/moving target appears in more than one TESS sector, a target pixel file will be produced for each sector. If the cutout area overlaps more than one camera or ccd, a target pixel file will be produced for each one.
844842

845843
.. code-block:: python
846844
@@ -892,11 +890,13 @@ To access sector information for a particular coordinate, object, or moving targ
892890
893891
>>> from astroquery.mast import Tesscut
894892
895-
>>> sector_table = Tesscut.get_sectors(moving_target="Ceres")
893+
>>> sector_table = Tesscut.get_sectors(objectname="Ceres", moving_target=True)
896894
>>> print(sector_table)
897-
sectorName sector camera ccd
895+
sectorName sector camera ccd
898896
-------------- ------ ------ ---
899897
tess-s0029-1-4 29 1 4
898+
tess-s0043-3-3 43 3 3
899+
tess-s0044-2-4 44 2 4
900900
901901
Zcut
902902
====

0 commit comments

Comments
 (0)