Commits

Takahiro Tsutsumi authored e764769f2a7 
Few documentation fixes
No tags
0e355448c90
master

casatasks/xml/getephemtable.xml

Modified
5 5 This task retrieves the ephemeris data of a specific ephemeris object by sending
6 6 a query to JPL's Horizons system and creates the ephemeris data stored in a CASA table
7 7 format.
8 8 ​
9 9 </description>
10 10 <input>
11 11
12 12 <param type="string" name="objectname">
13 13 <shortdescription>Name of ephemeris object</shortdescription>
14 14 <description>Name of ephemeris object. The common name of major bodies such as
15 - planets will be converted into the (NAIF/SPK) ID. If the parameter, asis
16 - is set to True, no such check or conversion will be performed before sending
17 - a query to the database.
15 + planets known in CASA will be converted into the (NAIF/SPK) ID. If the parameter, asis
16 + is set to True, objectname is passed to the query as is to the JPL-Horizons system.
17 + If the object ID is used asis must be set to True.
18 +
18 19 Default: ''
19 20 ​
20 21 Example:
21 22 objectname='Titan'
22 - objectname='606'
23 + objectname='606' (should set asis=True in this case)
23 24 </description>
24 - <value type="string"/>
25 + </value>
25 26 </param>
26 27 ​
27 28 <param type="bool" name="asis">
28 29 <shortdescription>A toggle for objectnamne check to be done or not</shortdescription>
29 30 <description>A toggle for objectname check to be done or not before sending a query to the JPL-Horizons system.
30 31 Default: False
31 32 ​
32 - When asis=False, objectname is checked against the known objects (a list of the supported
33 - ephemeris sources in setjy task plus a few others) by CASA.
34 - Setting asis=True will skip this check and the name has to be uniquly recognized by
35 - the JPL-Horzions system.
36 - For example, objectname='Jupiter' with asis=True result in the JPL-Horizons system to return
37 - no ephemeris data as multiple objects matches with the name.
33 + As described in objectname parameter description, when asis=False, objectname is checked
34 + against the known objects (a list of the supported ephemeris sources in setjy task plus
35 + a few others) in CASA (See Description in CASA Docs).
36 + Setting asis=True will skip this check/conversion thus objectname has to be uniquly
37 + recognized by the JPL-Horzions system.
38 + For example, objectname='Jupiter' with asis=True results in the JPL-Horizons system
39 + to return no ephemeris data as multiple objects matches with the name.
38 40 ​
39 41
40 42 </description>
41 43 <value type="bool">False</value>
42 44 </param>
43 45 ​
44 46 <param type="string" name="timerange">
45 47 <shortdescription>time range of ephemeris data to be queried</shortdescription>
46 48 <description>Time range of ephemeris data to be queried.
47 49 Default: ''
50 52 or by Modified Julian date or Julian date if the string is prefixed by 'MJD' or 'JD'.
51 53 ​
52 54 Examples:
53 55 timerange = '2023/09/01/20:45~2023/09/02/04:00'
54 56 (Note: Both start and end times need to be fully specified starting with YYYY
55 57 but hours or minutes can be omitted as long as the
56 58 start and stop times are distinguishable. The omitted hours or minutes are translated as '00')
57 59 timerange = 'MJD 60175.1~60176.1'
58 60 ​
59 61 </description>
60 - <value type="string"/>
62 + </value>
61 63 </param>
62 64 ​
63 65 <param type="string" name="interval">
64 66 <shortdescription>Interval or step size of ephemeris data</shortdescription>
65 67 <description>Interval or step size of ephemeris data
66 68 Default: '5m'
67 69 ​
68 70 A string with integer value and unit (minutes, hours, days) or
69 - a string with integer value without unit (= timerange/interval).
70 - The unit can be given as the first few characters, e.g. 'm', 'min', 'h', 'd'.
71 + a string with integer value without unit (to produce equal time interval defined by
72 + timerange/interval).
73 + The unit can be given as the first few characters, e.g. 'm', 'min', 'h', or 'd'.
71 74 ​
72 - The JPL-Horizons query allows the step size by calendar months or years however
75 + Note: The JPL-Horizons query allows the step size by calendar months or years however
73 76 the task will not convert such data to the CASA table as Measures requires the ephemeris
74 77 table data in equal time interval. When the calendar months or years is specified
75 78 for interval, the task execution will result in a SEVERE error. The raw query results
76 79 will be saved even such a case if rawdatafile parameter is specified.
77 80 ​
78 81 Example:
79 82 ​
80 83 interval='5min'
81 84 interval='5minutes'
82 85 interval='1h'
87 90 ​
88 91 <param type="path" name="outfile">
89 92 <shortdescription>Name of output CASA table</shortdescription>
90 93 <description>Output CASA table name
91 94 Default: ''
92 95 ​
93 96 Example:
94 97 outfile = 'Titan_MJD60175.1-60176.1.tab'
95 98 ​
96 99 </description>
97 - <value type="string"/>
100 + </value>
98 101 </param>
99 102
100 103 <param type="string" name="rawdatafile">
101 104 <shortdescription>Name of raw ephemeris data file (optional)</shortdescription>
102 105 <description>Name of raw ephemeris data file before converting into a CASA table (optional)
103 106 Default: '' = No raw ephemeris data is saved
104 107 ​
105 - Useful for debugging when errors occured or no output table is produced.
108 + Useful for debugging when errors occured and/or no output table is produced.
106 109 ​
107 110 Example: rawdatafile='Titan-jplhorizons.dat'
108 111 </description>
109 - <value type="string"/>
112 + </value>
110 113 </param>
111 114 ​
112 115 ​
113 116 </input>
114 117 ​
115 118 <returns type="void"/>
116 119 <example>
117 120 </example>
118 121 </task>
119 122 </casaxml>

Everything looks good. We'll let you know here if there's anything you should know about.

Add shortcut