1 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 2 | <?xml-stylesheet type="text/xsl" ?> |
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 | <task type="function" name="flagmanager" category="editing"> |
9 9 | <shortdescription>Enable list, save, restore, delete and rename flag version files.</shortdescription> |
10 - | <description> |
11 - | The flag version files are copies of the flag column for a measurement |
12 - | set. They can be restored to the data set to get back to a previous |
13 - | flag version. On running importvla, a flag version call 'Original' is |
14 - | automatically produced. It is recommended to save a flagversion at the |
15 - | beginning or after serious editing. |
16 - | </description> |
10 + | <description> |
11 + | These flag version files are copies of the flag column for a |
12 + | measurement set. They can be restored to the data set to get |
13 + | back to a previous flag version. On running importvla, a flag |
14 + | version call 'Original' is automatically produced. |
15 + | </description> |
30 - | <shortdescription>Operation: list, save, restore, delete, rename</shortdescription> |
31 - | <description>Flag version operation |
32 - | Default: 'list' |
33 - | Options: list, save, restore, delete, rename |
34 - | |
35 - | * 'list': it will list in the logger the existing |
36 - | flag versions of the MS. This option will also |
37 - | return by default a dictionary containing the |
38 - | name of the MS, the name of the flag version |
39 - | and the comment. This information is taken from |
40 - | the FLAG_VERSION_LIST file inside the |
41 - | .flagversions directory. |
42 - | * 'save': will save the FLAG column from vis to a |
43 - | specified flag file. If the name given in |
44 - | versionname already exists, the task will give |
45 - | a warning and rename it to a name with a suffix |
46 - | '.old.timestamp'. The respective entry in |
47 - | FLAG_VERSION_LIST will also be updated. |
48 - | * 'restore': will place the specified flag file |
49 - | into vis |
50 - | * 'delete': will delete specified flag file |
51 - | * 'rename': will rename a specified flag file |
52 - | </description> |
24 + | <description>Operation: list, save, restore, delete, rename</description> |
133 - | https://casa.nrao.edu/casadocs/ |
77 + | |
78 + | The flag version files are copies of the FLAG column of a |
79 + | Measurement Set. They can be restored to the data set to obtain |
80 + | a previous flag version. On running importasdm, a flag |
81 + | version called 'Original' is produced by default. It is recommended to |
82 + | save a flagversion at the beginning or after serious editing. |
83 + | |
84 + | Keyword arguments: |
85 + | vis -- Name of input visibility file |
86 + | default: none. example: vis='ngc5921.ms' |
87 + | |
88 + | mode -- Flag version operation |
89 + | default: 'list': it will list in the logger the existing flag versions of the MS. |
90 + | This option will also return by default a dictionary containing the |
91 + | name of the MS, the name of the flag version and the comment. This |
92 + | information is taken from the FLAG_VERSION_LIST file inside the |
93 + | .flagversions directory. |
94 + | |
95 + | 'save': will save the FLAG column from vis to a specified flag file. If the name given |
96 + | in versionname already exists, the task will give a warning and rename it |
97 + | to a name with a suffix '.old.timestamp'. The respective entry in FLAG_VERSION_LIST |
98 + | will also be updated. |
99 + | |
100 + | 'restore': will place the specified flag file into vis |
101 + | |
102 + | 'delete': will delete specified flag file |
103 + | |
104 + | 'rename': will rename a specified flag file |
105 + | |
106 + | versionname -- Flag version name |
107 + | default: none; example: versionname='original_data' |
108 + | No imbedded blanks in the versionname |
109 + | |
110 + | comment -- Short description of a versionname, when mode is 'save' or 'rename' |
111 + | default: ''; example: comment='Clip above 1.85' |
112 + | comment = versionname |
113 + | |
114 + | oldname -- When mode='rename', the flag file to rename |
115 + | |
116 + | merge -- Merge operation |
117 + | Options: 'or','and', but not recommended for now. |
118 + | |