simanalyze.py

Go to the documentation of this file.

#
# This file was generated using xslt from its XML file
#
# Copyright 2009, Associated Universities Inc., Washington DC
#
import sys
import os
from  casac import *
import string
from taskinit import casalog
#from taskmanager import tm
import task_simanalyze
def simanalyze(project='sim', image=True, imagename='default', vis='default', modelimage='', cell='', imsize=[128, 128], imdirection='', niter=500, threshold='0.1mJy', weighting='natural', mask=[], outertaper=[''], stokes='I', analyze=False, showuv=True, showpsf=True, showmodel=True, showconvolved=False, showclean=True, showresidual=False, showdifference=True, showfidelity=True, graphics='both', verbose=False, overwrite=True):

        """image and analyze simulated datasets

    This task is for imaging and analyzing datasets created with 
    simobserve or simalma.  New functionality is actively 
    being added, so if you have changed versions of CASA, check 
    the inputs carefully.
    More information and examples are availible at 
     http://casaguides.nrao.edu/index.php?title=Simulating_Observations_in_CASA
    Please contact CASA experts with any questions.
    -------------------------------
    project -- root filename for all output files.
               must be the same as used when simulating the observation.
               in particular $project/$project.skymodel will be required
               to compare output and input images.
    image -- invert and deconvolve the measurement set(s)
       * NOTE: interactive clean or more parameters than the subset visible
         here are available by simply running the clean task directly, 
         then returning to simanalyze to run "analyze" if desired.
       * NOTE: the channelization of the output image cube will be the 
         same as that in the simulated Measurement Set.
       * if graphics turned on, display the clean image and residual image
       * uses Cotton-Schwab clean for single fields and Mosaic gridding
         for multiple fields (with Clark PSF calculation in minor cycles).
    vis -- the simulated interferometric MS, or total-power one, or both
       * one can use '$project' to let the task automatically replace it to
         the project name, e.g., vis='$project.noisy.ms,$project.noisy.sd.ms'.
         However, note that if you created measurement set(s) using simobserve,
         they will have names including the configuration, e.g. 
         $project.alma_out20.noisy.ms
       * setting this paramter to "default" will find and attempt to image
         all measurement sets (interferometric and single dish) in the 
         project directory
    modelimage -- prior (e.g. SD) image to be used in clean
    cell -- cell size e.g '10arcsec'.  "" defaults to the skymodel cell
    imsize -- image size in spatial pixels (x,y)
       0 or -1 will use the model image size; example: imsize=[500,500]
    imdirection -- phase center for synthesized image.  default is to 
       center on the sky model.
    niter -- number of clean/deconvolution iterations, 0 for no cleaning
    threshold -- flux level to stop cleaning
    weighting -- weighting to apply to visibilities
       options: 'natural','uniform','briggs' (robust=0.5)
    mask -- Specification of cleanbox(es), mask image(s), primary beam
       coverage level, and/or region(s) to be used for CLEANing.
       CLEAN tends to perform better, and is less likely to diverge, if 
       the CLEAN component placement is limited by a mask to where real 
       emission is expected to be.  e.g. pixel ranges mask=[110,110,150,145],
       filename of mask image mask='myimage.mask', or a file with mask 
       regions --  see help for the clean task.
    outertaper -- apply additional uv outer taper of visibilities
    stokes -- Stokes parameters to image; 'I','IV','IQU','IQUV'
    -------------------------------
    analyze -- compute and display difference between model and output, 
         fidelity, etc. 
    showuv -- display uv coverage
    showpsf -- display synthesized (dirty) beam (ignored in single dish simulation)
    showmodel -- display sky model at original resolution
    showconvolved -- display sky model convolved with output beam 
    showclean -- display the synthesized image
    showresidual -- display the clean residual image (ignored in single dish simulation)
    showdifference -- display difference between output cleaned image and 
         input model sky image convolved with output clean beam
    showfidelity -- display fidelity image
         fidelity = abs(input) / max[ abs(input-output), 0.7*rms(output) ]
    
    graphics -- view plots on the screen, saved to file, both, or neither
    verbose -- print extra information to the logger and terminal
    overwrite -- overwrite existing files in the project subdirectory

    Note that the RMS is calculated in the lower quarter of the image.  
         This is likely not the best choice, so you are encouraged to 
         measure RMS yourself in an off-source region using the viewer.


    -------------------------------
    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].skymodel.flat.regrid.conv = input sky regridded to match 
         the output image, and convolved with the output clean beam

    project.[cfg].image = synthesized image
    project.[cfg].flux.pbcoverage = primary beam correction for mosaic image
    project.[cfg].residual = residual image after cleaning
    project.[cfg].clean.last = parameter file of what parameters were used in
          the clean task
    project.[cfg].psf = synthesized (dirty) beam calculated from weighted uv 
          distribution
    project.[cfg].image.png = diagnostic figure of clean image and residual
            
    project.[cfg].fidelity = fidelity image
    project.[cfg].analysis.png = diagnostic figure of difference and fidelity
            
    project.[cfg].simanalyze.last = saved input parameters for simanalyze task


        """
        if type(imsize)==int: imsize=[imsize]
        if type(outertaper)==str: outertaper=[outertaper]

#
#    The following is work around to avoid a bug with current python translation
#
        mytmp = {}

        mytmp['project'] = project
        mytmp['image'] = image
        mytmp['imagename'] = imagename
        mytmp['vis'] = vis
        mytmp['modelimage'] = modelimage
        mytmp['cell'] = cell
        mytmp['imsize'] = imsize
        mytmp['imdirection'] = imdirection
        mytmp['niter'] = niter
        mytmp['threshold'] = threshold
        mytmp['weighting'] = weighting
        mytmp['mask'] = mask
        mytmp['outertaper'] = outertaper
        mytmp['stokes'] = stokes
        mytmp['analyze'] = analyze
        mytmp['showuv'] = showuv
        mytmp['showpsf'] = showpsf
        mytmp['showmodel'] = showmodel
        mytmp['showconvolved'] = showconvolved
        mytmp['showclean'] = showclean
        mytmp['showresidual'] = showresidual
        mytmp['showdifference'] = showdifference
        mytmp['showfidelity'] = showfidelity
        mytmp['graphics'] = graphics
        mytmp['verbose'] = verbose
        mytmp['overwrite'] = overwrite
        pathname='file:///'+os.environ.get('CASAPATH').split()[0]+'/share/xml/'
        trec = casac.utils().torecord(pathname+'simanalyze.xml')

        casalog.origin('simanalyze')
        if trec.has_key('simanalyze') and casac.utils().verify(mytmp, trec['simanalyze']) :
            result = task_simanalyze.simanalyze(project, image, imagename, vis, modelimage, cell, imsize, imdirection, niter, threshold, weighting, mask, outertaper, stokes, analyze, showuv, showpsf, showmodel, showconvolved, showclean, showresidual, showdifference, showfidelity, graphics, verbose, overwrite)

        else :
          result = False
        return result