Source
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<?xml-stylesheet type="text/xsl" ?>
3
3
4
4
<casaxml xmlns="http://casa.nrao.edu/schema/psetTypes.html"
5
5
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6
6
xsi:schemaLocation="http://casa.nrao.edu/schema/casa.xsd
7
7
file:///opt/casa/code/xmlcasa/xml/casa.xsd">
8
8
9
9
<task type="function" name="calstat" category="calibration">
10
10
<shortdescription>Displays statistical information on a calibration table</shortdescription>
11
+
<description>
12
+
This task returns statistical information about a column in a
13
+
calibration table. The following values are computed: mean value, sum
14
+
of values, sum of squared values, median, median absolute deviation,
15
+
quartile, minimum, maximum, variance, standard deviation, root mean
16
+
square.
17
+
</description>
18
+
<example>
19
+
</example>
11
20
12
21
<input>
13
22
<param type="string" name="caltable" mustexist="true">
14
-
<description>Name of input calibration table</description>
23
+
<shortdescription>Name of input calibration table</shortdescription>
24
+
<description>Name of input calibration table
25
+
Default: ''
26
+
27
+
Example: vis='ggtau.1mm.amp.gcal'
28
+
</description>
15
29
<value></value>
16
30
</param>
17
31
18
32
<param type="string" name="axis">
19
-
<description>Which values to use</description>
33
+
<shortdescription>Which values to use</shortdescription>
34
+
<description>Which data to analyze.
35
+
Default: 'amplitude'
36
+
Options: 'amp', 'amplitude', 'phase', 'real',
37
+
'imag', 'imaginary'. Also, the name of any real
38
+
valued MS column can be given, e.g. TIME,
39
+
POLY_COEFF_AMP, REF_ANT, ANTENNA1, FLAG, ...
40
+
41
+
Note: the phase of a complex number is in
42
+
radians in the range [-pi; pi].
43
+
</description>
20
44
<value type="string">amplitude</value>
21
45
</param>
22
46
23
47
<param type="string" name="datacolumn" subparam="true">
24
-
<description>Which data column to use</description>
48
+
<shortdescription>Which data column to use</shortdescription>
49
+
<description>Which data column to use if axis is 'amp', 'amplitude', 'phase', 'real', 'imag' or 'imaginary'.
50
+
Default: 'gain'
51
+
</description>
25
52
<value type="string">gain</value>
26
53
</param>
27
54
28
55
<param type="bool" name="useflags">
29
-
<description>Take flagging into account? (not implemented)</description>
56
+
<shortdescription>Take flagging into account? (not implemented)</shortdescription>
57
+
<description>Take flagging into account? (not implemented, this
58
+
parameter has no effect!)
59
+
Default: False
60
+
61
+
If useflags=False, flagged values are included in
62
+
the statistics.
63
+
If useflags=True, any flagged values are not used
64
+
in the statistics.
65
+
</description>
30
66
<value>True</value>
31
67
<example>useflags=True</example>
32
68
</param>
33
69
34
70
<constraints>
35
71
<when param="axis">
36
72
<equals type="string" value="amp">
37
73
<default param="datacolumn"><value type="string">gain</value></default>
38
74
</equals>
39
75
<equals type="string" value="amplitude">
60
96
<param type="any" name="xstat">
61
97
<description>Statistical information for the calibration table</description>
62
98
<any type="variant"/>
63
99
<value>{}</value>
64
100
</param>
65
101
</output>
66
102
67
103
<returns type="void"/>
68
104
69
105
<example>
70
-
This task returns statistical information about a column in a calibration table.
71
-
72
-
The following values are computed: mean value, sum of values, sum of squared values,
73
-
median, median absolute deviation, quartile, minimum, maximum,
74
-
variance, standard deviation, root mean square.
75
-
76
-
Keyword arguments:
77
-
78
-
caltable -- Name of input calibration table
79
-
default: '', example: vis='ggtau.1mm.amp.gcal'
80
-
81
-
axis -- Which data to analyze. The possible values are 'amp', 'amplitude', 'phase',
82
-
'real', 'imag', 'imaginary'. Also, the name of any real valued MS column can be
83
-
given, e.g. TIME, POLY_COEFF_AMP, REF_ANT, ANTENNA1, FLAG, ...
84
-
85
-
default: 'amplitude'
86
-
axis='gain'
87
-
88
-
The phase of a complex number is in radians in the range [-pi; pi[.
89
106
107
+
For more information, see the task pages of calstat in CASA Docs:
90
108
91
-
datacolumn -- Which data column to use if axis is 'amp', 'amplitude',
92
-
'phase', 'real', 'imag' or 'imaginary'.
93
-
default: 'gain'
94
-
datacolumn='gain'
109
+
https://casa.nrao.edu/casadocs/
95
110
96
-
useflags -- Take MS flags into account (not implemented, this parameter
97
-
has no effect!)
98
-
default: False
99
-
useflag=False
100
-
useflag=True
101
-
If useflags=False, flagged values are included in the statistics.
102
-
If useflags=True, any flagged values are not used in the statistics.
103
111
</example>
104
112
105
113
</task>
106
114
107
115
</casaxml>