ALMA Cycle 8 Imaging Pipeline Reprocessing: Difference between revisions
No edit summary |
Tag: Undo |
||
| (17 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
== About This Guide == | == About This Guide == | ||
| Line 62: | Line 61: | ||
<br> | <br> | ||
== | == Alternative to scriptForPI: Restore calibrated data in latest CASA (Cycle 5 and later data) == | ||
After | After retrieving and untarring the archive tarballs, one finds the following directories | ||
* calibration/ | * calibration/ | ||
** Contains the original pipeline calibration and flagging information. | ** Contains the original pipeline calibration and flagging information. | ||
| Line 72: | Line 71: | ||
Create a set of three directories anywhere, with these contents: | Create a set of three directories anywhere, with these contents: | ||
* products/ | * products/ | ||
** this entire directory can be a symbolic link to your calibration/ directory retrieved from the archive, or you can copy the contents from that directory to this one. It will only be read, not written to. | ** this entire directory can be a symbolic link to your calibration/ directory retrieved from the archive, or you can copy the contents from that directory to this one. It will only be read, not written to. You will also need to copy the *pipeline_manifest.xml file from the script/ directory to this location. | ||
* rawdata/ | * rawdata/ | ||
** this needs to contain links to all of the ASDMs in your raw/ directory retrieved from the archive, *with the "asdm.sdm" removed* e.g. | ** this needs to contain links to all of the ASDMs in your raw/ directory retrieved from the archive, *with the "asdm.sdm" removed* e.g. | ||
| Line 95: | Line 94: | ||
</source> | </source> | ||
If the script contains additional commands e.g. "fixsyscaltimes" or "fixplanets", | If the script contains additional commands e.g. "fixsyscaltimes" or "fixplanets", note that the call to import these tasks have changed from 'from recipes.almahelpers import fixsyscaltimes' and 'from tasks import fixplanets' to 'from casarecipes.almahelpers import fixsyscaltimes' and 'from casatasks import fixplanets', respectively, for CASA versions 6.1 and above. | ||
You can run that script in working/: | |||
<source lang="python"> | <source lang="python"> | ||
execfile("member.uid___A001_X1465_X2182.hifa_calimage.casa_piperestorescript.py") | execfile("member.uid___A001_X1465_X2182.hifa_calimage.casa_piperestorescript.py") | ||
</source> | </source> | ||
== Applying renormalization corrections to data == | |||
ALMA observations of sources with strong line emission are affected by amplitude calibration issues caused by the ALMA normalization strategy, as described in the following Knowledgebase Articles: [https://help.almascience.org/kb/articles/what-are-the-amplitude-calibration-issues-caused-by-alma-s-normalization-strategy] and [https://help.almascience.org/kb/articles/what-errors-could-originate-from-the-correlator-spectral-normalization-and-tsys-calibration]. | |||
If a correction factor of more than 2% is calculated for a dataset, it will be corrected during data reduction for all newly observed datasets. If you have a dataset where this correction has not been applied (this should be indicated in the QA2 report), the following script will calculate and apply the corrections to the dataset: | |||
<source lang="python"> | |||
__rethrow_casa_exceptions = True | |||
h_init() | |||
try: | |||
hifa_importdata(vis=['uid___A002_Xe3da01_X18fa.ms'], session=['session_1'], ocorr_mode='ca') | |||
hifa_renorm(apply=True) | |||
hif_mstransform(pipelinemode='automatic') | |||
finally: | |||
h_save() | |||
</source> | |||
This script should be run in the calibrated/working/ directory after you've restored the calibrated data. The resulting uid*.ms file will be corrected if the renormalization factor is >2%. The calculated renormalization factors along with plots can be viewed in the weblog produced by the script. For more information, please refer to the [https://almascience.nrao.edu/documents-and-tools/alma-science-pipeline-users-guide-casa-6-2.1 Pipeline User's Guide]. Please note that the hifa_renorm task is only available in CASA version 6.2.1-7 and Pipeline version 2021.2.0.128 and above. | |||
== CASA imaging pipeline script to fully reproduce the pipeline products == | == CASA imaging pipeline script to fully reproduce the pipeline products == | ||
| Line 105: | Line 121: | ||
<source lang="python"> | <source lang="python"> | ||
import glob as glob | |||
__rethrow_casa_exceptions = True | __rethrow_casa_exceptions = True | ||
context = h_init() | context = h_init() | ||
| Line 150: | Line 167: | ||
The relevant tasks for imaging pipeline reprocessing described in this CASA guide are hifa_importdata, hif_mstransform, hifa_flagtargets, hifa_imageprecheck, hif_checkproducts, hif_checkproductsize, hif_uvcontfit, hif_uvcontsub, hif_makeimlist, hif_makeimages. | The relevant tasks for imaging pipeline reprocessing described in this CASA guide are hifa_importdata, hif_mstransform, hifa_flagtargets, hifa_imageprecheck, hif_checkproducts, hif_checkproductsize, hif_uvcontfit, hif_uvcontsub, hif_makeimlist, hif_makeimages. | ||
'''Note 1''': One of important features of ALMA pipeline is to check the final imaging product size and make necessary | '''Note 1''': One of important features of ALMA pipeline is to check the final imaging product size and make necessary adjustments to the channel binning, cell size, image size and possibly the number of fields to be imaged. These are modified to avoid creating large images and cubes that take up significant computing resources and are not necessary for user's science goals. hif_checkproductsize task does this job and we insert this task in all imaging example script in below. We recommend that users copy hif_checkproductsize task from the provided casa_pipescript.py without changing parameters: maxcubelimit, maxproductsize and maxcubesize. However users can comment it out if they don't want this size mitigation or they can explicitly specify the nbins, hm_imsize and hm_cell parameters in hif_makeimlist task. | ||
'''Note 2''': hifa_imageprecheck calculates the synthesized beam and estimates the sensitivity for the aggregate bandwidth and representative bandwidth, for three values of the robust parameter. Then the best robust value is chosen based on heuristics, for subsequent imaging. Therefore if a user wants to use a different robust value from the user's own choice, hifa_imageprecheck should not be run. | |||
'''Note | '''Note 3''': hifa_importdata will display QA notifications warning that the Flux catalog service is not being used and that the measurement set may already be processed (see screenshot). This is expected - in operations the best flux catalog values must be used, but since you are not going to use the flux densities for anything here, and the amplitude scale of the data has already been calibrated and all calibrations were applied, you can ignore these messages. You should however delete the flux.csv that gets created, if you are going to run any pipeline calibration steps later, and instead use the flux.csv that was delivered with your dataset. | ||
[[File:Hifa_importdata.png|thumb|<caption>QA warnings for hifa_importdata</caption>]] | |||
For reference, the description of pipeline tasks for interferometric and single dish data reduction can be found in the [https://almascience.nrao.edu/documents-and-tools/reference-manual-2021.2 6.2.1-7 Pipeline Reference Manual] | For reference, the description of pipeline tasks for interferometric and single dish data reduction can be found in the [https://almascience.nrao.edu/documents-and-tools/reference-manual-2021.2 6.2.1-7 Pipeline Reference Manual] | ||
| Line 164: | Line 185: | ||
=== Restore Pipeline Continuum Subtraction and Manually Make Image Products === | === Restore Pipeline Continuum Subtraction and Manually Make Image Products === | ||
==== Re-determine and Apply Pipeline Continuum Subtraction using Pipeline Tasks ==== | |||
==== | |||
The following script splits off the calibrated science target data for all spws and fields for each execution, applies any flagging commands found in the <uid_name>_flagtargetstemplate.txt file(s) (one for each execution), uses the existing cont.dat file to fit and subtract the continuum emission, leaving the result in the CORRECTED column. Before running this script, you can manually modify both the <uid_name>_flagtargetstemplate.txt file(s) and cont.dat file to add flag commands or change the cont.dat frequency ranges. Once you're happy with the script, you can run it in a CASA session (that was started with the --pipeline option) using execfile(script_name). | The following script splits off the calibrated science target data for all spws and fields for each execution, applies any flagging commands found in the <uid_name>_flagtargetstemplate.txt file(s) (one for each execution), uses the existing cont.dat file to fit and subtract the continuum emission, leaving the result in the CORRECTED column. Before running this script, you can manually modify both the <uid_name>_flagtargetstemplate.txt file(s) and cont.dat file to add flag commands or change the cont.dat frequency ranges. Once you're happy with the script, you can run it in a CASA session (that was started with the --pipeline option) using execfile(script_name). | ||
| Line 212: | Line 231: | ||
</source> | </source> | ||
==== Make Images Manually ==== | ==== Make Images Manually ==== | ||
| Line 571: | Line 481: | ||
h_save() | h_save() | ||
</source> | </source> | ||
=== Remake images with uvtaper === | === Remake images with uvtaper === | ||
Latest revision as of 20:11, 10 May 2024
About This Guide
This guide describes some examples for perfecting the interferometric imaging products from the ALMA Cycle 8 Pipeline. If your data were manually imaged by ALMA, you should instead consult the scriptForImaging.py delivered with your data.
The Section Restore Pipeline Calibration and Prepare for Re-imaging describes the first steps to do. After that, the individual sections are self-contained (and they typically assume the "Restore" has been performed). It illustrates how to completely re-run the pipeline from beginning to end in order to reproduce the pipeline run done at your ARC.
Additional documentation on the Cycle 8 pipeline can be found in the Pipeline User's Guide which can also be found at the ALMA Science Portal. The User's guide describes how to obtain the ALMA Pipeline, how to use it to calibrate and image ALMA interferometric (IF) and single-dish (SD) data, and a description of the Pipeline WebLog.
Note that the scripts described in this guide have only been tested in Linux.
Getting and Starting CASA
If you do not already have CASA installed on your machine, you will have to download and install it.
Download and installation instructions are available here:
http://casa.nrao.edu/casa_obtaining.shtml
CASA 6.2.1-7 is required to reprocess ALMA Cycle 8 data using the scripts in this guide.
NOTE: To use pipeline tasks, you must start CASA with
casa --pipeline
Restore Pipeline Calibration and Prepare for Re-imaging (all Options)
STEP 1: Follow instructions in your QA2 report for restoring pipeline calibrated data using the scriptForPI.py. In general, scriptForPI.py is only compatible with CASA versions similar to the one used for its creation. See the Table at https://almascience.org/processing/science-pipeline for details. NOTE: the SPACESAVING parameter cannot be larger than 1, and for pipeline calibrated and imaged data, scriptForPI.py does not automatically split science spectral windows.
Once completed, the following files and directories will be present, with specific things about pipeline re-imaging noted:
- calibrated/
- In cases where the PI explicitly set "DOSPLIT=True" before running scriptForPI.py, this directory contains a file(s) called <uid_name>.ms.split.cal (one for each execution in the MOUS) -- these type of files have been split to contain the calibrated pipeline uv-data in the DATA column, and only the science spectral window ids (spws) that match spws listed in the pipeline weblog or other pipeline produced products like the science target flag template files (*.flagtargetstemplate.txt) or continuum ranges (cont.dat). Though this type of file has been the starting point for manual ALMA imaging, ms.split.cal files CANNOT BE DIRECTLY USED IN THE EXAMPLES GIVEN IN THIS GUIDE.
- Provided that the restore is done with a SPACESAVING=1, within the "calibrated" directory there is a "working" directory which does contain the <uid_name>.ms (i.e. no split has been run on them) that is of the form expected as the starting point of the ALMA imaging pipeline. This is the best location to do ALMA pipeline image reprocessing.
- calibration/
- This directory contains a continuum range file named "cont.dat", with the frequency ranges identified by the pipeline as being likely to only contain continuum emission. If the cont.dat is present in the "calibrated/working" directory where pipeline imaging tasks are run, it will be used.
- This directory also contains the *.flagtargetstemplate.txt for each execution which can be used to do science target specific flagging.
- product/
- Contains the original pipeline image products.
- qa/
- Contains the original pipeline weblog and the QA2 and QA0 reports. The QAs reports contains summaries of the scheduling block (SB), and calibration and imaging results.
- raw/
- Contains the raw asdm(s).
- script/
- Contains the file scriptForPI.py (named member.<uid_name>.scriptForPI.py) which internally runs member.<uid_name>.hifa_calimage.casa_piperestorescript.py and other necessary tasks to restore the data.
- Also contains member.<uid_name>.hifa_calimage.casa_pipescript.py, a full CASA pipeline script that reproduces all pipeline products and <mous_name>.hifa_calimage.casa_commands.log which contains all the equivalent casa commands run during the course of the pipeline processing, in particular the tclean commands to make the image products.
STEP 2: Change to directory that contains the calibrated data suitable for running pipeline imaging tasks (i.e. *.ms) called "calibrated/working" after the pipeline restore and start CASA 6.2.1-7.
casa --pipeline
STEP 3: Run the following commands in CASA to copy the cont.dat file that contains the frequency ranges used to create the continuum images and the continuum subtraction, and the flag target template file (*.flagtargetstemplate.txt) for each execution which can be used to do science target specific flagging, to the directory you will be working in.
os.system('cp ../../calibration/cont.dat ./cont.dat')
os.system('cp ../../calibration/*.flagtargetstemplate.txt ./*.flagtargetstemplate.txt)
Alternative to scriptForPI: Restore calibrated data in latest CASA (Cycle 5 and later data)
After retrieving and untarring the archive tarballs, one finds the following directories
- calibration/
- Contains the original pipeline calibration and flagging information.
- raw/
- Contains the raw asdm(s), with "asdm.sdm" appended.
Create a set of three directories anywhere, with these contents:
- products/
- this entire directory can be a symbolic link to your calibration/ directory retrieved from the archive, or you can copy the contents from that directory to this one. It will only be read, not written to. You will also need to copy the *pipeline_manifest.xml file from the script/ directory to this location.
- rawdata/
- this needs to contain links to all of the ASDMs in your raw/ directory retrieved from the archive, *with the "asdm.sdm" removed* e.g.
ln -s ..../raw/uid___A002_Xe3da01_X18fa.asdm.sdm uid___A002_Xe3da01_X18fa
- working/
In working/, start casa
casa --pipeline
Find script/member.[MOUS UID].hifa_[recipe].casa_piperestorescript.py in the materials from the archive. It should look like this
__rethrow_casa_exceptions = True
h_init()
try:
hifa_restoredata (vis=['uid___A002_Xe3da01_X18fa'], session=['session_1'], ocorr_mode='ca')
finally:
h_save()
If the script contains additional commands e.g. "fixsyscaltimes" or "fixplanets", note that the call to import these tasks have changed from 'from recipes.almahelpers import fixsyscaltimes' and 'from tasks import fixplanets' to 'from casarecipes.almahelpers import fixsyscaltimes' and 'from casatasks import fixplanets', respectively, for CASA versions 6.1 and above. You can run that script in working/:
execfile("member.uid___A001_X1465_X2182.hifa_calimage.casa_piperestorescript.py")
Applying renormalization corrections to data
ALMA observations of sources with strong line emission are affected by amplitude calibration issues caused by the ALMA normalization strategy, as described in the following Knowledgebase Articles: [1] and [2].
If a correction factor of more than 2% is calculated for a dataset, it will be corrected during data reduction for all newly observed datasets. If you have a dataset where this correction has not been applied (this should be indicated in the QA2 report), the following script will calculate and apply the corrections to the dataset:
__rethrow_casa_exceptions = True
h_init()
try:
hifa_importdata(vis=['uid___A002_Xe3da01_X18fa.ms'], session=['session_1'], ocorr_mode='ca')
hifa_renorm(apply=True)
hif_mstransform(pipelinemode='automatic')
finally:
h_save()
This script should be run in the calibrated/working/ directory after you've restored the calibrated data. The resulting uid*.ms file will be corrected if the renormalization factor is >2%. The calculated renormalization factors along with plots can be viewed in the weblog produced by the script. For more information, please refer to the Pipeline User's Guide. Please note that the hifa_renorm task is only available in CASA version 6.2.1-7 and Pipeline version 2021.2.0.128 and above.
CASA imaging pipeline script to fully reproduce the pipeline products
The following script runs all necessary pipeline tasks to reproduce the imaging results produced by pipeline. Please ignore "context.set_state()" statements, which are to set ancillary information and indeed not really necessary for pipeline imaging. The workflows in the following sections reproduce parts of, and/or variants of, what is produced by this script.
import glob as glob
__rethrow_casa_exceptions = True
context = h_init()
#The following context.set_state() statements are setting ancillary information and indeed not really necessary for imaging.
context.set_state('ProjectSummary', 'proposal_code', 'E2E6.1.00092.S')
context.set_state('ProjectSummary', 'piname', 'unknown')
context.set_state('ProjectSummary', 'proposal_title', 'unknown')
context.set_state('ProjectStructure', 'ous_part_id', 'X118955135')
context.set_state('ProjectStructure', 'ous_title', 'Undefined')
context.set_state('ProjectStructure', 'ppr_file', '../working/PPR_uid___A002_Xd0adbd_X56.xml')
context.set_state('ProjectStructure', 'ps_entity_id', 'uid://A002/Xd0adbd/X51')
context.set_state('ProjectStructure', 'recipe_name', 'hifa_image')
context.set_state('ProjectStructure', 'ous_entity_id', 'uid://A002/Xd0adbd/X4d')
context.set_state('ProjectStructure', 'ousstatus_entity_id', 'uid://A002/Xd0adbd/X55')
#
## Delete uid*_target.ms and flagversions if it exists
os.system('rm -rf uid*_target.ms')
os.system('rm -rf uid*_target.ms.flagversions')
MyVis=glob.glob('*.ms')
try:
hifa_importdata(vis=MyVis,dbservice=False)
hif_mstransform(pipelinemode="automatic")
hifa_flagtargets(pipelinemode="automatic")
hifa_imageprecheck(pipelinemode="automatic")
hif_checkproductsize(maxproductsize=350.0, maxcubesize=40.0, maxcubelimit=60.0)
hif_makeimlist(specmode='mfs')
hif_findcont(pipelinemode="automatic")
hif_uvcontfit(pipelinemode="automatic")
hif_uvcontsub(pipelinemode="automatic")
hif_makeimages(pipelinemode="automatic")
hif_makeimlist(specmode='cont')
hif_makeimages(pipelinemode="automatic")
hif_makeimlist(specmode='cube')
hif_makeimages(pipelinemode="automatic")
hif_makeimlist(specmode='repBW')
hif_makeimages(pipelinemode="automatic")
hifa_exportdata(imaging_products_only=True)
finally:
h_save()
The relevant tasks for imaging pipeline reprocessing described in this CASA guide are hifa_importdata, hif_mstransform, hifa_flagtargets, hifa_imageprecheck, hif_checkproducts, hif_checkproductsize, hif_uvcontfit, hif_uvcontsub, hif_makeimlist, hif_makeimages.
Note 1: One of important features of ALMA pipeline is to check the final imaging product size and make necessary adjustments to the channel binning, cell size, image size and possibly the number of fields to be imaged. These are modified to avoid creating large images and cubes that take up significant computing resources and are not necessary for user's science goals. hif_checkproductsize task does this job and we insert this task in all imaging example script in below. We recommend that users copy hif_checkproductsize task from the provided casa_pipescript.py without changing parameters: maxcubelimit, maxproductsize and maxcubesize. However users can comment it out if they don't want this size mitigation or they can explicitly specify the nbins, hm_imsize and hm_cell parameters in hif_makeimlist task.
Note 2: hifa_imageprecheck calculates the synthesized beam and estimates the sensitivity for the aggregate bandwidth and representative bandwidth, for three values of the robust parameter. Then the best robust value is chosen based on heuristics, for subsequent imaging. Therefore if a user wants to use a different robust value from the user's own choice, hifa_imageprecheck should not be run.
Note 3: hifa_importdata will display QA notifications warning that the Flux catalog service is not being used and that the measurement set may already be processed (see screenshot). This is expected - in operations the best flux catalog values must be used, but since you are not going to use the flux densities for anything here, and the amplitude scale of the data has already been calibrated and all calibrations were applied, you can ignore these messages. You should however delete the flux.csv that gets created, if you are going to run any pipeline calibration steps later, and instead use the flux.csv that was delivered with your dataset.
For reference, the description of pipeline tasks for interferometric and single dish data reduction can be found in the 6.2.1-7 Pipeline Reference Manual
Common Re-imaging Examples
Next, chose the example below that best fits your use case. Due to the need to preserve the indentation of the python commands, the examples will work best if you copy the entire block of python commands (orange-shaded regions) for a particular example into its own python script, check that the indentation is preserved, edit the USER SET INPUTS section, and then execute the file.
Restore Pipeline Continuum Subtraction and Manually Make Image Products
Re-determine and Apply Pipeline Continuum Subtraction using Pipeline Tasks
The following script splits off the calibrated science target data for all spws and fields for each execution, applies any flagging commands found in the <uid_name>_flagtargetstemplate.txt file(s) (one for each execution), uses the existing cont.dat file to fit and subtract the continuum emission, leaving the result in the CORRECTED column. Before running this script, you can manually modify both the <uid_name>_flagtargetstemplate.txt file(s) and cont.dat file to add flag commands or change the cont.dat frequency ranges. Once you're happy with the script, you can run it in a CASA session (that was started with the --pipeline option) using execfile(script_name).
## Edit the USER SET INPUTS section below and then execute
## this script (note it must be in the 'calibrated/working' directory.
import glob as glob
__rethrow_casa_exceptions = True
pipelinemode='automatic'
context = h_init()
###########################################################
## USER SET INPUTS
## Select a title for the weblog
context.project_summary.proposal_code='Restore Continuum Subtraction'
## Delete uid*_target.ms and flagversions if it exists
os.system('rm -rf uid*_target.ms')
os.system('rm -rf uid*_target.ms.flagversions')
############################################################
## Make a list of all uv-datasets appended with *.ms
MyVis=glob.glob('*.ms')
try:
## Load the *.ms files into the pipeline
hifa_importdata(vis=MyVis,dbservice=False,pipelinemode=pipelinemode)
## Split off the science target data into its own ms (called
## *target.ms) and apply science target specific flags
hif_mstransform(pipelinemode=pipelinemode)
hifa_flagtargets(pipelinemode=pipelinemode)
## Fit and subtract the continuum using the cont.dat for all spws all fields
hif_uvcontfit(pipelinemode=pipelinemode)
hif_uvcontsub(pipelinemode=pipelinemode)
finally:
h_save()
Make Images Manually
At this point you will have created a *target.ms for each execution of your SB. Each of these measurement sets contains the original calibrated continuum + line data in the DATA column and the calibrated continuum subtracted data in the the CORRECTED column. The new CASA task for imaging tclean (which is used by the ALMA Pipeline) allows the user to select which column to use for imaging. tclean also allows a list for the vis parameter so that it is not necessary to concat the data before imaging.
NOTE: If you think you might want to self-calibrate your data using either the continuum or line emission it is ESSENTIAL that you first split off the column that you want to operate on before imaging. Otherwise, the CORRECTED column containing the continuum subtracted data will be overwritten when applycal is run during the self-calibration process. Users of CASA 5.1.1 using TCLEAN() with multi-scale should also be aware that there is a known issue that the MODEL column will not be correctly written under some circumstances. The issue and the work-around for it are described at [3]
To manually clean your data at this stage, there are two options:
- Use modified versions of the relevant tclean commands from the "logs/<MOUS_name>.hifa_calimage.casa_commands.log". These are the exact commands originally run by the imaging pipeline to produce your imaging products.
- They will contain within them the frequency ranges (from the cont.dat) used for making the various images.
- There will be two tclean commands per image product, the first with an image name containing iter0 only makes a dirty image, while the second with iter1 makes a cleaned image.
- For example to make the aggregate continuum image but with interactive clean masking, simply copy the corresponding iter1 command (it will contain all of the spw numbers in its name), but set interactive=True, calcres=True, calcpsf=True, restart=False. Additionally set mask=. If you are using the *.target.ms file(s) you can keep datacolumn='DATA'.
- Note if you are trying to save the model, i.e. for self-calibration, you must also set savemodel='modelcolumn' (or virtual). Also be aware that exiting from interactive clean using the Red X symbol in the interactive viewer, does not save the model in 4.7.0 tclean. To fill the model after stopping this way, rerun same clean command (being careful not to remove existing files) except set restart=True, calcpsf=False, calcres=False, niter=0, interactive=False. This re-run only takes a couple minutes with these settings.
- If you have split off the data of interest for self-calibration (as recommended above), you will first need to image the datacolumn='DATA'. After applying a self-calibration table, you will want to image the datacolumn='CORRECTED'. This should happen by default in typical data reduction use cases since TCLEAN defaults to using the CORRECTED column (when it exists) for imaging, and automatically falls back to the DATA column (if it does not exist).
- Use examples on the casaguide page TCLEAN_and_ALMA to formulate your own special purpose commands.
Make Pipeline Aggregate Continuum Image With All Channels
This example moves the cont.dat file to a backup name so it is not picked up by pipeline, in which case all unflagged channels are used to make an aggregate continuum image with no continuum subtraction and default pipeline cleaning. This may be beneficial for continuum only projects for which the hif_findcont stage of the weblog shows that more continuum bandwidth is possible than it identified (i.e. due to noise spikes etc).
## Edit the USER SET INPUTS section below and then execute
## this script (note it must be in the 'calibrated/working' directory.
import glob as glob
__rethrow_casa_exceptions = True
pipelinemode='automatic'
context = h_init()
###########################################################
## USER SET INPUTS
## Select a title for the weblog
context.project_summary.proposal_code='NEW AGGREGATE CONT'
## Delete uid*_target.ms and flagversions if it exists
os.system('rm -rf uid*_target.ms')
os.system('rm -rf uid*_target.ms.flagversions')
############################################################
## Move cont.dat to another name if it exists
os.system('mv cont.dat original.cont.dat')
## Make a list of all uv-datasets appended with *.ms
MyVis=glob.glob('*.ms')
try:
## Load the *.ms files into the pipeline
hifa_importdata(vis=MyVis,dbservice=False,pipelinemode=pipelinemode)
## Split off the science target data into its own ms (called
## *target.ms) and apply science target specific flags
hif_mstransform(pipelinemode=pipelinemode)
hifa_flagtargets(pipelinemode=pipelinemode)
## calculate the synthesized beam and estimate the sensitivity
## for the aggregate bandwidth and representative bandwidth
## for three values of the robust parameter.
hifa_imageprecheck(pipelinemode="automatic")
## check the imaging product size and adjust the relevent
## imaging parameters (channel binning, cell size and image size)
## User can comment this out if they don't want size mitigation.
hif_checkproductsize(maxproductsize=350.0, maxcubesize=40.0, maxcubelimit=60.0)
## Skip the continuum subtraction steps and make an aggregate
## continuum image with all unflagged channels (file named
## cont.dat should NOT be present in directory).
hif_makeimlist(specmode='cont',pipelinemode=pipelinemode)
hif_makeimages(pipelinemode=pipelinemode)
## Export new images to fits format if desired.
hifa_exportdata(pipelinemode=pipelinemode)
finally:
h_save()
Revise the Continuum Ranges (cont.dat) Before Pipeline Continuum Subtraction and Remake Pipeline Images
This example uses the pipeline imaging tasks to remake the pipeline imaging products for one spw (17 in the example) after manually editing the cont.dat file.
## Edit the cont.dat file(s) for the spw(s) you want
## to change the continuum subtraction for. In this example
## spw 17 was changed.
## Edit the USER SET INPUTS section below and then execute
## this script (note it must be in the 'calibrated/working' directory.
import glob as glob
__rethrow_casa_exceptions = True
pipelinemode='automatic'
context = h_init()
###########################################################
## USER SET INPUTS
## Select a title for the weblog
context.project_summary.proposal_code = 'NEW CONTSUB'
## Delete uid*_target.ms and flagversions if it exists
os.system('rm -rf uid*_target.ms')
os.system('rm -rf uid*_target.ms.flagversions')
## Select spw(s) that have new cont.dat parameters
## If all spws have changed use MySpw=''
MySpw='17'
############################################################
## Make a list of all uv-datasets appended with *.ms
MyVis=glob.glob('*.ms')
try:
## Load the *.ms files into the pipeline
hifa_importdata(vis=MyVis,dbservice=False,pipelinemode=pipelinemode)
## Split off the science target data into its own ms (called
## *target.ms) and apply science target specific flags
hif_mstransform(pipelinemode=pipelinemode)
hifa_flagtargets(pipelinemode=pipelinemode)
## Fit and subtract the continuum using revised cont.dat for all spws
hif_makeimlist(specmode='mfs',spw=MySpw)
hif_uvcontfit(pipelinemode=pipelinemode)
hif_uvcontsub(pipelinemode=pipelinemode)
hif_makeimages(pipelinemode=pipelinemode)
## calculate the synthesized beam and estimate the sensitivity
## for the aggregate bandwidth and representative bandwidth
## for three values of the robust parameter.
hifa_imageprecheck(pipelinemode=pipelinemode)
## check the imaging product size and adjust the relevent
## imaging parameters (channel binning, cell size and image size)
## User can comment this out if they don't want size mitigation.
hif_checkproductsize(maxproductsize=350.0, maxcubesize=40.0, maxcubelimit=60.0)
## Make new aggregate cont
hif_makeimlist(specmode='cont',pipelinemode=pipelinemode)
hif_makeimages(pipelinemode=pipelinemode)
## Make new continuum subtracted cube for revised spw(s)
hif_makeimlist(specmode='cube',spw=MySpw,pipelinemode=pipelinemode)
hif_makeimages(pipelinemode=pipelinemode)
## Export new images to fits format if desired.
hifa_exportdata(pipelinemode=pipelinemode)
finally:
h_save()
Restore Pipeline Continuum Subtraction for Subset of SPWs and Fields and Use Channel Binning for Pipeline Imaging of Cubes
Using Pipeline Tasks
This example uses the pipeline imaging tasks to remake the cubes for a subset of spws and fields with channel binning and a more naturally-weighted Briggs robust parameter.
## Edit the USER SET INPUTS section below and then execute
## this script (note it must be in the 'calibrated/working' directory.
import glob as glob
__rethrow_casa_exceptions = True
pipelinemode='automatic'
context = h_init()
###########################################################
## USER SET INPUTS
## Select a title for the weblog
context.project_summary.proposal_code = 'SUBSET CUBE IMAGING'
## Delete uid*_target.ms and flagversions if it exists
os.system('rm -rf uid*_target.ms')
os.system('rm -rf uid*_target.ms.flagversions')
## Select spw(s) to image and channel binning for each spcified
## MySpw. All spws listed in MySpw must have a corresponding MyNbins
## entry, even if it is 1 for no binning.
MySpw='17,23'
MyNbins='17:8,23:2'
## Select subset of sources to image by field name.
## To select all fields, set MyFields=''
MyFields='CoolSource1,CoolSource2'
## Select Briggs Robust factor for data weighting (affects angular
## resolution of images)
MyRobust=1.5
############################################################
## Make a list of all uv-datasets appended with *.ms
MyVis=glob.glob('*.ms')
try:
## Load the *.ms files into the pipeline
hifa_importdata(vis=MyVis, dbservice=False, pipelinemode=pipelinemode)
## Split off the science target data into its own ms (called
## *target.ms) and apply science target specific flags
## In this example we split off all science targets and science
## spws, however hif_mstransform could also contain the spw and field
## selections
hif_mstransform(pipelinemode=pipelinemode)
hifa_flagtargets(pipelinemode=pipelinemode)
## Fit and subtract the continuum using existing cont.dat
## for selected spws and fields only.
hif_makeimlist(specmode='mfs')
hif_uvcontfit(spw=MySpw,field=MyFields,pipelinemode=pipelinemode)
hif_uvcontsub(spw=MySpw,field=MyFields,pipelinemode=pipelinemode)
hif_makeimages(pipelinemode=pipelinemode)
## calculate the synthesized beam and estimate the sensitivity
## for the aggregate bandwidth and representative bandwidth
## for three values of the robust parameter.
## Don't need to run this task if you will use a different robust value anyway.
## hifa_imageprecheck(pipelinemode=pipelinemode)
## check the imaging product size and adjust the relevent
## imaging parameters (channel binning, cell size and image size)
## User can comment this out if they don't want size mitigation.
hif_checkproductsize(maxproductsize=350.0, maxcubesize=40.0, maxcubelimit=60.0)
## Make new continuum subtracted cube for selected spw(s) and fields
hif_makeimlist(specmode='cube',spw=MySpw,nbins=MyNbins,field=MyFields,robust=MyRobust, pipelinemode=pipelinemode)
hif_makeimages(pipelinemode=pipelinemode)
## Export new images to fits format if desired.
hifa_exportdata(pipelinemode=pipelinemode)
finally:
h_save()
Remake images with uvtaper
This example uses the pipeline imaging tasks to remake the pipeline imaging products with uvtaper.
## Edit the USER SET INPUTS section below and then execute
## this script (note it must be in the 'calibrated/working' directory.
import glob as glob
__rethrow_casa_exceptions = True
pipelinemode='automatic'
context = h_init()
###########################################################
## USER SET INPUTS
## Select a title for the weblog
context.project_summary.proposal_code = 'NEW IMAGE WITH UVTAPER'
## Delete uid*_target.ms and flagversions if it exists
os.system('rm -rf uid*_target.ms')
os.system('rm -rf uid*_target.ms.flagversions')
# To make sense of using uvtaper the most, use robust = +2.0 which corresponds to the natural weighting
MyRobust=2.0
############################################################
## Make a list of all uv-datasets appended with *.ms
MyVis=glob.glob('*.ms')
try:
## Load the *.ms files into the pipeline
hifa_importdata(vis=MyVis,dbservice=False,pipelinemode=pipelinemode)
## Split off the science target data into its own ms (called
## *target.ms) and apply science target specific flags
hif_mstransform(pipelinemode=pipelinemode)
hifa_flagtargets(pipelinemode=pipelinemode)
## Fit and subtract the continuum using revised cont.dat for all spws
hif_uvcontfit(pipelinemode=pipelinemode)
hif_uvcontsub(pipelinemode=pipelinemode)
## calculate the synthesized beam and estimate the sensitivity
## for the aggregate bandwidth and representative bandwidth
## for three values of the robust parameter.
## Don't need to run this task if you will use a different robust value anyway.
## hifa_imageprecheck(pipelinemode=pipelinemode)
## check the imaging product size and adjust the relevent
## imaging parameters (channel binning, cell size and image size)
## User can comment this out if they don't want size mitigation.
hif_checkproductsize(maxproductsize=350.0, maxcubesize=40.0, maxcubelimit=60.0)
## Make new aggregate cont
hif_makeimlist(specmode='cont',robust=MyRobust, uvtaper=['1arcsec'], pipelinemode=pipelinemode)
hif_makeimages(pipelinemode=pipelinemode)
## Make new continuum subtracted cube
hif_makeimlist(specmode='cube', robust=MyRobust, uvtaper=['1arcsec'], pipelinemode=pipelinemode)
hif_makeimages(pipelinemode=pipelinemode)
## Export new images to fits format if desired.
hifa_exportdata(pipelinemode=pipelinemode)
finally:
h_save()
