Commits
1 1 | |
2 2 | |
3 3 | <casaxml xmlns="http://casa.nrao.edu/schema/psetTypes.html" |
4 4 | xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
5 5 | xsi:schemaLocation="http://casa.nrao.edu/schema/casa.xsd |
6 6 | file:///opt/casa/code/xmlcasa/xml/casa.xsd"> |
7 7 | |
8 8 | |
9 9 | <task type="function" name="exportasdm" category="import/export"> |
10 10 | |
11 11 | <shortdescription>Convert a CASA visibility file (MS) into an ALMA or EVLA Science Data Model</shortdescription> |
12 + | <description> |
12 13 | |
14 + | </description> |
13 15 | <input> |
14 16 | |
15 17 | <param type="string" name="vis" kind="ms" mustexist="true"> |
16 - | <description>MS name</description> |
18 + | <shortdescription>Name of input visibility file</shortdescription> |
19 + | <description>Name of input visibility file |
20 + | Default: none |
21 + | |
22 + | Example: vis='ngc5921.ms' |
23 + | </description> |
17 24 | <value></value> |
18 25 | </param> |
19 26 | |
20 27 | |
21 28 | <param type="string" name="asdm" kind="asdm" mustexist="false"> |
22 - | <description>Name of output ASDM directory (on disk)</description> |
29 + | <shortdescription>>Name of output ASDM directory (on disk)</shortdescription> |
30 + | <description>Name of output ASDM directory (on disk) |
31 + | Default: none |
32 + | </description> |
23 33 | <value></value> |
24 34 | </param> |
25 35 | |
26 36 | <param type="string" name="datacolumn" ignorecase="True"> |
27 - | <description>specifies which MS data column is used to fill the visibilites in the ASDM</description> |
37 + | <shortdescription>Which data column(s) to process.</shortdescription> |
38 + | <description>Which data column(s) to use for processing |
39 + | (case-insensitive). |
40 + | Default: 'corrected' |
41 + | Options: 'data', 'model', 'corrected', |
42 + | 'all','float_data', 'lag_data', |
43 + | 'float_data,data', 'lag_data,data' |
44 + | |
45 + | Example: datacolumn='data' |
46 + | |
47 + | NOTE: 'all' = whichever of the above that are |
48 + | present. If the requested column does not exist, |
49 + | the task will exit with an error. |
50 + | </description> |
28 51 | <value>data</value> |
29 52 | <allowed kind="enum"> |
30 53 | <value>data</value> |
31 54 | <value>corrected</value> |
32 55 | <value>model</value> |
33 56 | </allowed> |
34 57 | </param> |
35 58 | <param type="string" name="archiveid"> |
36 - | <description>the X0 in uid://X0/X1/X2</description> |
59 + | <shortdescription>The X0 in uid://X0/X1/X2</shortdescription> |
60 + | <description>The X0 in uid://X0/X1/X2 |
61 + | Default: 'S0' |
62 + | </description> |
37 63 | <value>S0</value> |
38 64 | </param> |
39 65 | <param type="string" name="rangeid"> |
40 - | <description>the X1 in uid://X0/X1/X2</description> |
66 + | <shortdescription>The X1 in uid://X0/X1/X2</shortdescription> |
67 + | <description>The X1 in uid://X0/X1/X2 |
68 + | Default: 'X1' |
69 + | </description> |
41 70 | <value>X1</value> |
42 71 | </param> |
43 72 | <param type="string" name="subscanduration"> |
44 - | <description>maximum duration of a subscan in the output ASDM</description> |
73 + | <shortdescription>Maximum duration of a subscan in the output ASDM</shortdescription> |
74 + | <description>Maximum duration of a subscan in the output ASDM |
75 + | Default: 24h |
76 + | </description> |
45 77 | <value>24h</value> |
46 78 | </param> |
47 79 | <param type="string" name="sbduration"> |
48 - | <description>maximum duration of a scheduling block (and therefore exec block) in the output ASDM</description> |
80 + | <shortdescription>Maximum duration of a scheduling block (and therefore exec block) in the output ASDM</shortdescription> |
81 + | <description>Maximum duration of a scheduling block (and therefore |
82 + | exec block) in the output ASDM |
83 + | Default: '2700s' |
84 + | |
85 + | The sbduration parameter controls the number of |
86 + | execution blocks (EBs) into which exportasdm |
87 + | subdivides the visibilities from your input |
88 + | MS. If the total observation time in the MS is |
89 + | shorter than what is given in sbduration, a |
90 + | single EB will be created. |
91 + | </description> |
49 92 | <value>2700s</value> |
50 93 | </param> |
51 94 | <param type="bool" name="apcorrected"> |
52 - | <description>data to be marked as having atmospheric phase correction</description> |
95 + | <shortdescription>Data to be marked as having atmospheric phase correction</shortdescription> |
96 + | <description>Data to be marked as having atmospheric phase correction |
97 + | Default: False |
98 + | Options: False|True |
99 + | </description> |
53 100 | <value>False</value> |
54 101 | </param> |
55 102 | <param type="bool" name="verbose"> |
56 - | <description>produce log output</description> |
103 + | <shortdescription>Produce log output</shortdescription> |
104 + | <description>Produce log output? |
105 + | Default: True |
106 + | Options: True|False |
107 + | </description> |
57 108 | <value>True</value> |
58 109 | </param> |
59 110 | <param type="bool" name="showversion"> |
60 - | <description>Report the version of ASDM class set being used</description> |
111 + | <shortdescription>Report the version of ASDM class set being used</shortdescription> |
112 + | <description>Report the version of ASDM class set being used |
113 + | Default: True |
114 + | Options: True|False |
115 + | </description> |
61 116 | <value>True</value> |
62 117 | </param> |
63 118 | |
64 119 | <param type="string" name="useversion" > |
65 - | <description>Selects the version of MS2asdm to be used (\'v3\')</description> |
120 + | <shortdescription>Selects the version of MS2asdm to be used</shortdescription> |
121 + | <description>Selects the version of MS2asdm to be used |
122 + | Default: 'v3' |
123 + | </description> |
66 124 | <value>v3</value> |
67 125 | <allowed kind="enum"> |
68 126 | <value>v3</value> |
69 127 | <value></value> |
70 128 | </allowed> |
71 129 | </param> |
72 130 | |
73 131 | </input> |
74 132 | |
75 133 | <returns type="bool"/> |
76 134 | |
77 135 | <example> |
136 + | For more information, see the task pages of exportasdm in CASA Docs: |
78 137 | |
79 - | exportasdm(vis='ngc4826.ms', asdm='uid___S021_X1418_X1', |
80 - | datacolumn='corrected', archiveid='S021', rangeid='X1418', |
81 - | verbose=False) |
82 - | will produce an ASDM named 'uid___S021_X1418_X1' using the |
83 - | datacolumn 'corrected' in the MS 'ngc4826.ms' with minimal |
84 - | log output. |
85 - | |
86 - | The sbduration parameter controls the number of execution blocks (EBs) |
87 - | into which exportasdm subdivides the visibilities from your input MS. |
88 - | If the total observation time in the MS is shorter than what is given |
89 - | in sbduration, a single EB will be created. |
90 - | |
91 - | Note concerning ALMA data: exportasdm presently is not able to export |
92 - | from MSs containing WVR data. If you attempt to export such an MS, you |
93 - | will receive an error message saying that you can only export data of |
94 - | processor type "CORRELATOR". It will also give you the list of SPWs |
95 - | which contain CORRELATOR data. You will then have to split out these |
96 - | SPWs using the task "split" and run exportasdm on the resulting MS. |
97 - | |
98 - | Also EVLA data can be exported. Note here that exportasdm does not produce |
99 - | online flags and that a subsequent reimport of the data must be done with |
100 - | online=False. Also, importevla will only work on your ASDM if you have |
101 - | exported it with apcorrected=False (the default). |
102 - | |
103 - | importevla('xosrosdm', vis = 'xosro.ms') |
104 - | exportasdm(vis='xosro.ms', asdm='xosrosdm', apcorrected=False) |
105 - | importevla(asdm='xosro2asdm', vis='xosro2-reimp.ms', online=False) |
106 - | |
138 + | https://casa.nrao.edu/casadocs/ |
107 139 | </example> |
108 140 | |
109 141 | </task> |
110 142 | |
111 143 | </casaxml> |