sdtpimaging.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_sdtpimaging
def sdtpimaging(infile='', calmode='none', masklist=[], blpoly=1, backup=True, flaglist=[], antenna='', spw=0, stokes='', createimage=False, outfile='', imsize=[256, 256], cell=['1.0arcmin', '1.0arcmin'], phasecenter='', ephemsrcname='', pointingcolumn='direction', gridfunction='BOX', plotlevel=0):

        """SD task: do a simple calibration and imaging for total power data 
  Keyword arguments:
        infile -- name of input SD (MS) dataset
        calmode -- calibration mode (currently only baseline subtraction)
                options: 'baseline','none'
                default: 'none'
                example: choose mode 'none' if you have
                         already calibrated and want to do
                         plotting nd/or imaging 
            >>> calmode='baseline' expandable parameters
               masklist -- mask in numbers of rows from each edge of each scan 
                           to be included for baseline fitting
                 default: none
                 example: [30,30] or [30] 
                          used first 30 rows and last 30 rows of each scan for 
                          the baseline 
               blpoly -- polynomial order for the baseline fit
                 default: 1
               backup -- set True to create backup for input data
                 default: True
        flaglist -- list of scan numbers to flag (ranges can be accepted)  
                default: [] (use all scans)
                example: [[0,3],80]
                         flag the scan range [0,3] = [0,1,2,3] and scan 80 
        antenna -- select data based on antenna name(s) or id(s) in string
                default: '' (use all antennas)
                example: '0,1', 'DV01'
                WARNING: currently baseline subtraction properly 
                         only one of the antennas.
        spw -- spectral window id
                default: 0
                example: 1
        stokes -- select data based on stokes or polarization type 
                default: '' (use all polarizations)
                example: 'XX'
        createimage -- do imaging? 
                default: False 
            >>> createimage=True expandable parameters
               outfile -- output image name
                 default: none
                 example: 'mySDimage.im'
               imsize -- x and y image size in pixels, symmetric for single 
                         value
                 default: [256,256]
                 example: imsize=200 (equivalent to [200,200])
               cell -- x and y cell size. default unit arcmin
                 default: '1.0arcmin'
                 example: cell=['0.2arcmin, 0.2arcmin']
                          cell='0.2arcmin' (equivalent to example above)
               phasecenter -- image phase center: direction measure or fieldid 
                 default: 0
                 example: 'J2000 13h44m00 -17d02m00', 'AZEL -123d48m29 15d41m41'
               ephemsrcname -- ephemeris source name to proper shifting to 
                               center on the moving source for imaging
                 default: ''
                          if the source name in the data matches one of the 
                          known solar objects by the system, this task 
                          automatically set the source name. 
                 example: 'moon' 
               pointingcolumn -- pointing data column to use
                 option: 'direction', 'target', 'pointing_offset', 
                         'source_offset', 'encoder' 
                 default: 'direction'
               gridfunction -- gridding function for imaging
                 options: 'BOX' (Box-car), 'SF' (Spheroidal), 
                          'PB' (Primary-beam), 'GAUSS' (Gaussian),
                          'GJINC' (Gaussian*Jinc)
                 default: 'BOX'
                 example: 'SF'
        plotlevel -- control for plotting of results
                options: (int) 0=none, 1=some, 2=more, <0=hardcopy
                default: 0 (no plotting)
                example: plotlevel<0 as abs(plotlevel), e.g.
                         -1: hardcopy plot 
                             (will be named <infile>_scans.eps)
                          1: plot raw data, calibrated data 
                             (for calmode='baseline)
                             plot raw or if exist calibrated data 
                             (for calmode='none')
                          2: plot raw data, progressively display baseline 
                             fitting for each scan, and final calibrated data 
                             (for calmode='baseline')  


        DESCRIPTION:

        Task sdtpimaging performs data selection, calibration, and imaging for 
        single-dish totalpower raster scan data.  This is a still experimental 
        task made to work mostly for the data taken at the ALMA Testing 
        Facility (ATF) or OSF. Currently, this task directly accesses the 
        Measurement Set data only because of the data access efficiency. So it 
        differs from other single-dish tasks that mostly operate on the ASAP 
        scantable data format.  By setting calmode='none', one can run 
        sdtpimaging to plot the data (raw or calibrated, if exists) and 
        further imaging by setting createimage=True. 
        
        The calibration available at this moment is just a simple baseline 
        subtraction for each scan. The fitted regions set by masklist are the 
        common for all the scans. Selection of the antennas can be made by 
        setting antennaid(s) or antenna name(s) in string (e.g. '0', '0,1', 
        'DV01',etc.). 

        For baseline subtraction, it currently works properly for a single 
        antenna selection. So a separate sdtpimaging task needs to be ran for 
        each antenna. It currently assumes that the data has a single spw(=0) 
        and fieldid(=0). By setting flaglist, one can set flag by scan numbers 
        to be excluded from imaging. (Note: 'scan numbers' are determined from 
        state id and related to SUB_SCAN column in STATE subtable and not to 
        SCAN_NUMBER in MS.) By default, baseline subtraction stage overwrites 
        (FLOAT_)DATA column of input data. You can keep original data by 
        setting backup parameter to True. In this case, the task make a copy 
        of input data specified by infile parameter. Name of backup file is 
        <infile>.sdtpimaging.bak.<timestamp>.  

        The selection of polarizations can be made by specifying the 
        polarization name in stokes, such as 'XX' or 'YY' for linear 
        polarizations. For example, with createimage=True, stokes='XXYY' will 
        produces an image cube with each plane contains the image of one of
        the polarizations while stokes='' or stokes='I' will produces a 'total 
        intensity' or Stokes I image. 

        Among the imaging sub-parameters, ephemsrcname is used to set the name 
        of a moving source such as planets to produce a stationary image (can 
        be omitted), and pointingcolumn is used to specify which pointing data 
        column to use for imaging. Convolution kernel for imaging can be 
        specified by using gridfunction. Available options are 'Box' (Box-car),
        'SF' (Spheroidal), 'PB' (Primary-beam), 'GAUSS' (Gaussian), and 
        'GJINC' (Gaussian*Jinc), where Jinc(x) = J_1(pi*x/c)/(pi*x/c) with a 
        first order Bessel function J_1. Sub-parameters for convolution 
        functions cannot be specified in this task. To costomize your 
        convolution function, please do imaging using sdimaging task or 
        imager tool.
  
        """
        if type(masklist)==int: masklist=[masklist]
        if type(flaglist)==int: flaglist=[flaglist]
        if type(imsize)==int: imsize=[imsize]
        if type(cell)==float: cell=[cell]

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

        mytmp['infile'] = infile
        mytmp['calmode'] = calmode
        mytmp['masklist'] = masklist
        mytmp['blpoly'] = blpoly
        mytmp['backup'] = backup
        mytmp['flaglist'] = flaglist
        mytmp['antenna'] = antenna
        mytmp['spw'] = spw
        mytmp['stokes'] = stokes
        mytmp['createimage'] = createimage
        mytmp['outfile'] = outfile
        mytmp['imsize'] = imsize
        if type(cell) == str :
           mytmp['cell'] = casac.quanta().quantity(cell)
        else :
           mytmp['cell'] = cell
        mytmp['phasecenter'] = phasecenter
        mytmp['ephemsrcname'] = ephemsrcname
        mytmp['pointingcolumn'] = pointingcolumn
        mytmp['gridfunction'] = gridfunction
        mytmp['plotlevel'] = plotlevel
        pathname='file:///'+os.environ.get('CASAPATH').split()[0]+'/share/xml/'
        trec = casac.utils().torecord(pathname+'sdtpimaging.xml')

        casalog.origin('sdtpimaging')
        if trec.has_key('sdtpimaging') and casac.utils().verify(mytmp, trec['sdtpimaging']) :
            result = task_sdtpimaging.sdtpimaging(infile, calmode, masklist, blpoly, backup, flaglist, antenna, spw, stokes, createimage, outfile, imsize, cell, phasecenter, ephemsrcname, pointingcolumn, gridfunction, plotlevel)

        else :
          result = False
        return result