Commits

Darrell Schiebel authored c4163813c30 Merge 
Merge pull request #470 in CASA/casa from CAS-11293 to master

* commit 'f6385644d7e31a580943d43e6ecd81c8ec32ad3e':
  CAS-9767 fix listcal Plone documentation
  CAS-10566 fix fixplanets Plone documentation
  CAS-10582 fix listvis Plone documentation
  CAS-10577 fix imreframe Plone documentation
3abd97bbdec
master

gcwrap/tasks/fixplanets.xml

Modified
13 13 <shortdescription>Changes FIELD and SOURCE table entries based on user-provided direction or POINTING table, optionally fixes the UVW coordinates</shortdescription>
14 14 <description>
15 15 This task's main purpose is to correct observations which were performed
16 16 with correct pointing and correlation but for which incorrect direction
17 17 information was entered in the FIELD and SOURCE table of the MS.
18 18 If you actually want to change the phase center of the visibilties in an MS,
19 19 you should use task fixvis.
20 20 ​
21 21 Input Parameters
22 22 vis -- Name of the input visibility set
23 -
23 +​
24 24 field -- field selection string
25 -
25 +​
26 26 fixuvw -- recalc uvw coordinates? (default: False)
27 27 ​
28 28 direction -- if set, don't use pointing table but set direction to this value.
29 29 The direction can either be given explicitly or as the path
30 30 to a JPL Horizons ephemeris (for an example of the format,
31 31 see directory data/ephemerides/JPL-Horizons/).
32 32 Alternatively, the ephemeris table can also be provided as mime format file,
33 33 i.e. a saved email as obtained via the commands (for example):
34 34 import recipes.ephemerides.request as jplreq
35 35 jplreq.request_from_JPL(objnam='Mars',startdate='2012-01-01',enddate='2013-12-31',
36 36 date_incr='0.1 d', get_axis_orientation=False, get_axis_ang_orientation=True,
37 37 get_sub_long=True, use_apparent=False, get_sep=False,
38 38 return_address='YOUR_EMAIL_ADDESS', mailserver='YOUR_MAIL_SERVER_ADDRESS')
39 39 Note: some mail clients may not save the JPL mail properly.
40 40 Confirmed to work is Thunderbird.
41 41 ​
42 42 default= '' (use pointing table)
43 -
43 +​
44 44 example: 'J2000 19h30m00 -40d00m00'
45 45 ​
46 46 refant -- if using pointing table information, use it from this antenna
47 47 default: 0 (antenna id 0)
48 48 examples: 'DV06' (antenna with name DV06)
49 49 3 (antenna id 3)
50 50 reftime -- if using pointing table information, use it from this timestamp
51 51 default: 'first'
52 52 examples: 'median' will use the median timestamp for the given field
53 - using only the unflagged maintable rows
53 + using only the unflagged maintable rows
54 54 '2012/07/11/08:41:32' will use the given timestamp (must be
55 55 within the observaton time)
56 56 </description>
57 57 ​
58 58 <input>
59 59 <param type="string" name="vis" kind="ms" mustexist="true">
60 60 <description>Name of the input visibility set.</description>
61 61 <value></value>
62 62 <example>vis='ngc5921.ms'</example>
63 63 </param>
64 64 <param type="any" direction="in" name="field">
65 65 <description>Fields to operate on. Blank = all.</description>
66 66 <any type="variant"/>
67 67 <value>""</value>
68 68 </param>
69 69 <param type="bool" name="fixuvw">
70 70 <description>recalc uvw?</description>
71 71 <value>False</value>
72 72 </param>
73 73 <param type="any" name="direction">
74 - <description>if set, don\'t use pointing table but set direction to this value</description>
74 + <description>if set, do not use pointing table but set direction to this value</description>
75 75 <any type="variant"/>
76 76 <value type="string"></value>
77 77 </param>
78 78 <param type="any" name="refant">
79 79 <description>if using pointing table information, use it from this antenna</description>
80 80 <any type="variant"/>
81 81 <value>0</value>
82 82 </param>
83 83 <param type="string" name="reftime">
84 - <description>if using pointing table information, use it from this timestamp (\'first\', \'median\', or YYYY/MM/DD/hh:mm:ss)</description>
84 + <description>if using pointing table information, use it from this timestamp </description>
85 85 <value>first</value>
86 - <example>reftime='2012/07/11/08:41:32'</example>
86 + <example>
87 + Timstamp options: ('first', 'median', or YYYY/MM/DD/hh:mm:ss)
88 + For example: reftime='2012/07/11/08:41:32'
89 + </example>
87 90 </param>
88 91 ​
89 92 </input>
90 93 ​
91 94 <example>
92 95 ​
93 96 Examples:
94 97 ​
95 98 fixplanets('uid___A002_X1c6e54_X223.ms', 'Titan', True)
96 - will look up the pointing direction from antenna 0 for field 'Titan' in
97 - the POINTING table based on the first timestamp in the main table rows for
98 - this field, enter this direction in the FIELD and SOURCE tables, and then
99 + will look up the pointing direction from antenna 0 for field 'Titan' in
100 + the POINTING table based on the first timestamp in the main table rows for
101 + this field, enter this direction in the FIELD and SOURCE tables, and then
99 102 recalculate the UVW coordinates for this field.
100 103 ​
101 104 fixplanets('uid___A002_X1c6e54_X223.ms', 'Titan', True, 'Titan_55438-56292dUTC.tab')
102 105 will attach the ephemeris table 'Titan_55438-56292dUTC.tab' to field 'Titan'
103 106 and then recalculate the UVW coordinates for this field.
104 107 ​
105 108 fixplanets('uid___A002_X1c6e54_X223.ms', 'Titan', False, 'J2000 12h30m15 -02d12m00')
106 109 will set the directions for field 'Titan' in the FIELD and SOURCE table to the
107 110 given direction and not recalculate the UVW coordinates.
108 111 (This can be useful for several purposes, among them preparing a concatenation

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

Add shortcut