Commits
Rui Xue authored b455d4974cf Merge
1 1 | import sys |
2 2 | |
3 3 | from . import utils |
4 4 | |
5 5 | |
6 6 | # docstring and type hints: inherits from h.tasks.exportdata.exportdata.ExportDataInputs.__init__ |
7 7 | cli_wrapper | .
8 - | def h_exportdata(vis=None, session=None, imaging_products_only=None, exportmses=None, pprfile=None, calintents=None, |
8 + | def h_exportdata(vis=None, session=None, imaging_products_only=None, exportmses=None, tarms=None, pprfile=None, calintents=None, |
9 9 | calimages=None, targetimages=None, products_dir=None): |
10 - | |
11 - | """Prepare interferometry data for export |
10 + | """Prepare interferometry data for export. |
12 11 | |
13 12 | The hif_exportdata task exports the data defined in the pipeline context |
14 13 | and exports it to the data products directory, converting and or |
15 14 | packing it as necessary. |
16 15 | |
17 16 | The current version of the task exports the following products |
18 17 | |
19 18 | - an XML file containing the pipeline processing request |
20 - | - a tar file per ASDM / MS containing the final flags version |
19 + | - a tar file per ASDM / MS containing the final flags version (exportmses=False) |
20 + | - or, a tar file or MeasurementSets per EB (exportmses=True) |
21 21 | - a text file per ASDM / MS containing the final calibration apply list |
22 22 | - a FITS image for each selected calibrator source image |
23 23 | - a FITS image for each selected science target source image |
24 24 | - a tar file per session containing the caltables for that session |
25 25 | - a tar file containing the file web log |
26 26 | - a text file containing the final list of CASA commands |
27 27 | |
28 - | Returns |
29 - | |
30 - | The results object for the pipeline task is returned. |
31 28 | |
32 29 | Returns: |
33 30 | The results object for the pipeline task is returned. |
34 31 | |
35 32 | Examples: |
36 33 | 1. Export the pipeline results for a single session to the data products |
37 34 | directory |
38 35 | |
39 36 | >>> !mkdir ../products |
40 37 | >>> hif_exportdata (products_dir='../products') |
41 38 | |
42 39 | 2. Export the pipeline results to the data products directory specify that |
43 40 | only the gain calibrator images be saved. |
44 41 | |
45 42 | >>> !mkdir ../products |
46 43 | >>> hif_exportdata (products_dir='../products', calintents='*PHASE*') |
47 44 | |
48 45 | """ |
49 - | |
50 46 | ########################################################################## |
51 47 | # # |
52 48 | # CASA task interface boilerplate code starts here. No edits should be # |
53 49 | # needed beyond this point. # |
54 50 | # # |
55 51 | ########################################################################## |
56 52 | |
57 53 | # create a dictionary containing all the arguments given in the |
58 54 | # constructor |
59 55 | all_inputs = vars() |