<casaxml xsi:schemaLocation="http://casa.nrao.edu/schema/casa.xsd file:///opt/casa/code/xmlcasa/xml/casa.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://casa.nrao.edu/schema/psetTypes.html">
<task category="simulation" name="simanalyze" type="function">
<shortdescription>image and analyze measurement sets created with simobserve</shortdescription>
This task is for imaging and analyzing MeasurementSets simulated with simobserve or simalma.
It consists of two main steps, controlled by the image and analyze parameters.
-------------------------------
Output produced: (not all will always exist, depending on input parameters)
To support different runs with different arrays, the names have the
configuration name from antennalist appended.
-------------------------------
[project].[cfg].image = synthesized image
[project].[cfg].residual = residual image after cleaning
[project].[cfg].pb = primary beam
[project].[cfg].image.pbcor = synthesized image corrected for primary beam attenuation
[project].[cfg].psf = synthesized (dirty) beam calculated from weighted uv distribution
[project].[cfg].mask = clean mask
[project].[cfg].model = sky brightness model
[project].[cfg].sumwt = single pixel image containing sum-of-weights
[project].[cfg].weight = Fourier transform of gridder weights, or un-normalized sum of PB-square (for all pointings)
[project].[cfg].tclean.last = parameter file of what parameters were used in the tclean task; also generated by simutil even when dryrun=True
[project].[cfg].skymodel.flat.regrid.conv = input sky regridded to match the output image, and convolved with the output clean beam
[project].[cfg].fidelity = fidelity image
[project].[cfg].image.png = diagnostic figure of clean image and residual
[project].[cfg].analysis.png = diagnostic figure of difference and fidelity
[project].[cfg].diff = difference image between flattened convolved model and flattened output
[project].[cfg].image.flat = 2D integrated intensity image, not corrected for primary beam; see simutil.modifymodel
[project].[cfg].simanalyze.last = saved input parameters for simanalyze task, available in CASAshell
-------------------------------
* "project" needs to be the directory of results generated by running
simobserve or simalma. In particular $project/$project.skymodel
will be required in order to compare output and input images.
* NOTE: simanalyze was designed to be used after one or more runs of
simobserve, and as such it assumes it will be able to find a
sky model image called $project/$project.skymodel, .newmodel, or
.compskymodel in the $project/ subdirectory. If the simulated
MS has been created by means other than simply calling simobserve,
the user may have to copy their sky model image into the $project
subdirectory and call it "$project.skymodel".
* interactive clean or use of more parameters than the subset
visible here are available by simply running the tclean task directly,
then using simanalyze in the mode image=False (see below).
* Sometimes it is preferable to grid the single dish MS using the
sdimaging task for more control. In that case one can input
the resulting single dish imaging under "featherimage", only
put interferometric MSs in "vis", and simanalyze will clean the
interferometric and feather with your "featherimage".
* uses Cotton-Schwab clean for single fields and Mosaic gridding
for multiple fields (with Clark PSF calculation in minor cycles).
<param name="project" type="string">
<shortdescription>root prefix for output file names</shortdescription>
root prefix for input and output file names.
This must be the directory of results generated by running
simobserve or simalma. In particular $project/$project.skymodel
will be required in order to compare output and input images.
<param name="image" type="bool">
<shortdescription>(re)image $project.*.ms to $project.image</shortdescription>
<description>Controls whether tclean is called to image the MeasurementSet data. If true, input one or more simulated MSs using the vis parameter. These can include a total power MS. This task will grid any total power MS, invert and deconvolve any interferometric MS(s) (using the simutil method imtclean), and feather the results. If this parameter is set to False (e.g., if the user has created a synthesized image themselves or simanalyze has previously been run with image=True) the user should provide that image as input to the imagename parameter. This task will then attempt to find an appropriate skymodel image (such as the optionally rescaled *.skymodel produced by simobserve or simalma and used to create the MS).</description>
<param subparam="true" name="imagename" type="string"><shortdescription>simulation output image to analyze</shortdescription><description>Name of image to image/analyze, expected to be of the same form as those generated by simobserve. Defaults to the first file found with the name $project/*.image</description>
<param subparam="true" name="skymodel" type="string"><shortdescription>skymodel image to analyze</shortdescription><description>Name of a specific .skymodel image created by simobserve or simalma and used by one of those tasks to create a MS. If unspecified, will try to find one similar to your specified output image name.</description>