Skip to content

Commit 2da12bb

Browse files
Jorge Fernandez HernandezJorge Fernandez Hernandez
authored andcommitted
EUCLIDSWRQ-250 Review documentation
1 parent 0d9d2c8 commit 2da12bb

1 file changed

Lines changed: 19 additions & 17 deletions

File tree

astroquery/esa/euclid/core.py

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1519,49 +1519,51 @@ def __is_multiple(self, value):
15191519
def get_sia(self, *, coordinates, radius=1.0, search_type='CIRCLE', calibration=2, instrument='ALL', band=None,
15201520
collection='sedm', dsr_part1=None, dsr_part2=None, dsr_part3=None, output_file=None, verbose=False):
15211521
"""
1522-
Query the Euclid Observation Images service through the IVOA SIAP 2.0 interface. The service provides access to
1523-
public calibrated and stacked VIS and NISP images, MER mosaics, and Level 1 (raw) VIS and NISP observations.
1522+
Query the Euclid Observation Images service through the IVOA SIAP 2.0 interface.
1523+
1524+
The service provides access to public calibrated and stacked VIS and NISP images, MER mosaics, and Level 1 (raw)
1525+
VIS and NISP observations.
15241526
15251527
Parameters
15261528
----------
15271529
coordinates: str or SkyCoord, mandatory, default None
15281530
Center of the search region.
15291531
radius: float or quantity, optional, default value 1.0 degree
15301532
Radius of the search region. If a numeric value is provided, it is interpreted in degrees. An
1531-
astropy.units.Quantity may also be supplied. If "BOX" uses this value as half-width or width
1533+
astropy.units.Quantity may also be supplied. If "BOX" uses this value as width
15321534
search_type : str, optional, default CIRCLE
15331535
Shape of the search region. Supported values are "CIRCLE" and "BOX".
15341536
calibration: int, optional, default 2
15351537
Calibration level following the ObsCore data model:
1536-
1: raw instrumental data
1537-
2: instrumental data in a standard format
1538-
3: science-ready data
1539-
4: enhanced data products
1538+
- 1: raw instrumental data
1539+
- 2: instrumental data in a standard format
1540+
- : science-ready data
1541+
- 4: enhanced data products
15401542
instrument: str, optional, default ALL
15411543
Instrument to query. Supported values are "ALL", "VIS", and "NISP".
15421544
band: str, optional, default None
15431545
Filter name. This parameter is ignored when instrument="ALL". Valid values are:
1544-
1: "VIS" for the VIS instrument
1545-
2: "NIR_Y", "NIR_J", "NIR_H", or "NISP" for the NISP instrument
1546+
- 1: "VIS" for the VIS instrument
1547+
- 2: "NIR_Y", "NIR_J", "NIR_H", or "NISP" for the NISP instrument
15461548
collection : str, optional, default sedm
15471549
Name of the data collection.
15481550
dsr_part1: str, optional, default None
1549-
the data set release part 1: for OTF environment, the activity code; for REG and IDR, the target environment
1551+
First component of the dataset release identifier: for OTF environment, the activity code; for REG and IDR,
1552+
the target environment
15501553
dsr_part2: str, optional, default None
1551-
the data set release part 2: for OTF environment, the patch id (a positive integer); for REG and IDR,
1552-
the activity code
1554+
Second component of the dataset release identifier: for OTF environment, the patch id (a positive integer);
1555+
for REG and IDR, the activity code
15531556
dsr_part3: str, optional, default None
1554-
the data set release part 3: for OTF, REG and IDR environment, the version (an integer greater than 1)
1555-
output_file : string, optional, default None
1556-
Path of the output file. If provided, the query results are written to this file.
1557+
Third component of the dataset release identifier: for OTF, REG and IDR environment, the version (an integer
1558+
greater than 1) output_file : string, optional, default None
1559+
Output file where the query results are written.
15571560
verbose : bool, optional, default 'False'
15581561
flag to display information about the process
15591562
15601563
Returns
15611564
-------
15621565
astropy.table.Table or str
1563-
Query results as an `astropy.table.Table`. If `output_file` is
1564-
specified, the results are also written as a VOTable to the given file.
1566+
Query results. If ``output_file`` is specified, the results are also written as a VOTable.
15651567
"""
15661568

15671569
valid_search_types = {'CIRCLE', 'BOX'}

0 commit comments

Comments
 (0)