Commits
187 187 | <equals type="bool" value="False"/> |
188 188 | <equals type="bool" value="True"> |
189 189 | <default param="timebin"><value type="string">0s</value></default> |
190 190 | <default param="timespan"><value type="string"></value></default> |
191 191 | <default param="maxuvwdistance"><value type="double">0.0</value></default> |
192 192 | </equals> |
193 193 | </when> |
194 194 | |
195 195 | </constraints> |
196 196 | </input> |
197 - | <output> |
198 - | <param type="any" name="xstat"> |
199 - | <description>Statistical information for the selected MeasurementSet</description> |
200 - | <any type="variant"/> |
201 - | <value>{}</value> |
202 - | </param> |
203 - | </output> |
204 - | <returns type="void"/> |
197 + | <returns type="record"/> |
205 198 | |
206 199 | <example> |
207 200 | |
208 201 | This task returns statistical information about data in a MeasurementSet |
209 202 | or Multi-MS. |
210 203 | |
211 - | The following values are computed: mean value, sum of values, sum of |
204 + | The following statistics are computed: mean value, sum of values, sum of |
212 205 | squared values, median, median absolute deviation, first and third |
213 206 | quartiles, minimum, maximum, variance, standard deviation, and root mean |
214 207 | square. |
215 208 | |
216 - | The following axes are supported: uvw, flag, weight, sigma, antenna1, |
217 - | antenna2, feed1, feed2, field_id, array_id, data_desc_id, flag_row, |
218 - | interval, scan, scan_number, time, weight_spectrum, amp, amplitude, |
219 - | phase, real, imag, imaginary, and uvrange. |
209 + | Statistics may be computed on any of the following values: uvw, flag, |
210 + | weight, sigma, antenna1, antenna2, feed1, feed2, field_id, array_id, |
211 + | data_desc_id, flag_row, interval, scan, scan_number, time, |
212 + | weight_spectrum, amp, amplitude, phase, real, imag, imaginary, and |
213 + | uvrange. |
214 + | |
215 + | The 'reportingaxes' argument is used to partition the sample set along an |
216 + | axis. For example, setting its value to 'ddid' will result in the |
217 + | statistics of the chosen sample values partitioned by unique values of the |
218 + | data description id. Thus setting 'axis' to 'amp' and 'reportingaxes' to |
219 + | 'ddid' will report statistics of visibility amplitudes for each unique |
220 + | value of data description id in the MeasurementSet. |
220 221 | |
221 222 | Optionally, the statistical information can be computed based only |
222 223 | on a given subset of the MeasurementSet. |
223 224 | |
224 225 | Note: If the MS consists of inhomogeneous data, for example several |
225 226 | spectral windows each having a different number of channels, it may be |
226 227 | necessary to use selection parameters to select a homogeneous subset of |
227 228 | the MS, e.g. spw='2'. |
228 229 | |
229 230 | Keyword arguments: |