Commits
111 111 | </param> |
112 112 | <param type="bool" name="complement"> |
113 113 | <description>Return the complement of the selected set?</description> |
114 114 | <value>false</value> |
115 115 | </param> |
116 116 | </input> |
117 117 | <returns type="intArray"/> |
118 118 | <description> |
119 119 | Get spectral window IDs based on ALMA-specific criteria. The inputs are or'ed together |
120 120 | to form the returned list. If complement=True, then the complement of the selection |
121 - | is returned. |
121 + | is returned. The following algorithm is used to identify WVR spwectral windows: |
122 + | 1. check for water vapor radiometer (WVR) spectral windows using the spectral window |
123 + | name "WVR#NOMINAL" and report these. |
124 + | 2. If no SPWs match that string, then the names are checked for "WVR" and are reported instead. |
125 + | |
122 126 | </description> |
123 127 | <example> |
124 128 | msmd.open("my.ms") |
125 129 | # get all square law detector spectral window IDs |
126 130 | msmd.almaspws(sqld=True) |
127 131 | # get all spectral window IDs other than those associated with square law detectors |
128 132 | msmd.almaspws(sqld=True, complement=True) |
129 133 | </example> |
130 134 | </method> |
131 135 | |
2399 2403 | <input> |
2400 2404 | <param type="bool" direction="in" name="complement"> |
2401 2405 | <description>If True, return all non-wvr spws.</description> |
2402 2406 | <value>false</value> |
2403 2407 | </param> |
2404 2408 | </input> |
2405 2409 | <returns type="intArray"/> |
2406 2410 | <description> |
2407 2411 | <!-- DEPRECATED. USE almaspws(wvr=True) INSTEAD. --> |
2408 2412 | Get an array of spectral window IDs used for WVR. These are windows that have 4 channels. |
2409 - | If complement is True, return the complement set instead (all non-wvr spw IDs). |
2413 + | If complement is True, return the complement set instead (all non-wvr spw IDs). WVR windows |
2414 + | are identified using the algorithm |
2415 + | 1. check for water vapor radiometer (WVR) spectral windows using the spectral window |
2416 + | name "WVR#NOMINAL" and report these. |
2417 + | 2. If no SPWs match that string, then the names are checked for "WVR" and are reported instead. |
2410 2418 | </description> |
2411 2419 | <example> |
2412 2420 | msmd.open("my.ms") |
2413 2421 | # get the spectral window IDs used for WVR. |
2414 2422 | wvr_spws = msmd.wvrspws() |
2415 2423 | msmd.done() |
2416 2424 | </example> |
2417 2425 | </method> |
2418 2426 | |
2419 2427 | </tool> |
2420 2428 | </casaxml> |