sdcoadd.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_sdcoadd
def sdcoadd(infiles=[''], antenna=0, fluxunit='', telescopeparm='', specunit='', frame='', doppler='', scanaverage=False, timeaverage=False, tweight='none', polaverage=False, pweight='none', outfile='', outform='ASAP', overwrite=False):

        """ASAP SD task: coadd multiple scantables into one
  Keyword arguments:
        infiles -- list of names of input SD dataset
        antenna -- antenna name or id (only effective for MS input). 
        fluxunit -- units for line flux
                options: 'K','Jy',''
                default: '' (keep current fluxunit of the first data in the infiles)

            >>> fluxunit expandable parameter
                 telescopeparm -- the telescope characteristics
                         options: (str) name or (list) list of gain info
                         default: '' (none set)
                         example: if telescopeparm='', it tries to get the telescope
                                  name from the data.
                                  Full antenna parameters (diameter,ap.eff.) known
                                  to ASAP are
                                  'ATPKSMB', 'ATPKSHOH', 'ATMOPRA', 'DSS-43',
                                  'CEDUNA','HOBART'. For GBT, it fixes default fluxunit
                                  to 'K' first then convert to a new fluxunit.
                                  telescopeparm=[104.9,0.43] diameter(m), ap.eff.
                                  telescopeparm=[0.743] gain in Jy/K
                                  telescopeparm='FIX' to change default fluxunit
                                  see description below

        specunit -- units for spectral axis
                options: (str) 'channel','km/s','GHz','MHz','kHz','Hz'
                default: '' (=current)
                example: this will be the units for masklist
        frame -- frequency frame for spectral axis
                options: (str) 'LSRK','REST','TOPO','LSRD','BARY',
                         'GEO','GALACTO','LGROUP','CMB'
                default: currently set frame in scantable
                WARNING: frame='REST' not yet implemented
        doppler -- doppler mode
                options: (str) 'RADIO','OPTICAL','Z','BETA','GAMMA'
                default: currently set doppler in scantable
        scanaverage -- average integrations within scans
                options: (bool) True,False
                default: False
                example: if True, this happens in read-in
                For GBT, set False!
        timeaverage -- average times for multiple scan cycles
                options: (bool) True,False
                default: False
                example: if True, this happens after calibration

            >>>timeaverage expandable parameter
                 tweight -- weighting for time average
                         options: 'none' 
                                  'var'   (1/var(spec) weighted)
                                  'tsys'  (1/Tsys**2 weighted)
                                  'tint'  (integration time weighted)
                                  'tintsys'  (Tint/Tsys**2)
                                  'median'  ( median averaging)
                         default: 'none'

        polaverage -- average polarizations
                options: (bool) True,False
                default: False

            >>>polaverage expandable parameter
                 pweight -- weighting for polarization average
                         options: 'none'
                                  'var'  (1/var(spec) weighted)
                                  'tsys' (1/Tsys**2 weighted)
                         default: 'none'

        outfile -- Name of output file
                default: '' (scantable)
                example:
        outform -- format of output file
                options: 'ASCII','SDFITS','MS','ASAP'
                default: 'ASAP'
                example: the ASAP format is easiest for further sd
                         processing; use MS for CASA imaging.
                         If ASCII, then will append some stuff to
                         the outfile name
        overwrite -- overwrite the output file if already exists
                options: (bool) True,False
                default: False
                WARNING: if outform='ASCII', this parameter is ignored 



        DESCRIPTION:

        Task sdcoadd performs co-add multiple single dish spectral data given by
        a list of spectral data file names in any of the following formats,
        ASAP, MS2,SDFITS, and ASCII.
        The units of line flux, the units of spectral axis, frame, and doppler
        are assumed to be those of the first one in the infiles if not
        specified.
        timaverage and polaverage are used to perform time
        and polarization averaging over scans on the co-added scantable before
        saving to a file on disk.

        WARNING for the GBT raw SDFITS format data as input:
        SDtasks are able to handle GBT raw SDFITS format data since the 
        data filler is available. However, the functionality is not well 
        tested yet, so that there may be unknown bugs.  

  
        """
        if type(infiles)==str: infiles=[infiles]

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

        mytmp['infiles'] = infiles
        mytmp['antenna'] = antenna
        mytmp['fluxunit'] = fluxunit
        mytmp['telescopeparm'] = telescopeparm
        mytmp['specunit'] = specunit
        mytmp['frame'] = frame
        mytmp['doppler'] = doppler
        mytmp['scanaverage'] = scanaverage
        mytmp['timeaverage'] = timeaverage
        mytmp['tweight'] = tweight
        mytmp['polaverage'] = polaverage
        mytmp['pweight'] = pweight
        mytmp['outfile'] = outfile
        mytmp['outform'] = outform
        mytmp['overwrite'] = overwrite
        pathname='file:///'+os.environ.get('CASAPATH').split()[0]+'/share/xml/'
        trec = casac.utils().torecord(pathname+'sdcoadd.xml')

        casalog.origin('sdcoadd')
        if trec.has_key('sdcoadd') and casac.utils().verify(mytmp, trec['sdcoadd']) :
            result = task_sdcoadd.sdcoadd(infiles, antenna, fluxunit, telescopeparm, specunit, frame, doppler, scanaverage, timeaverage, tweight, polaverage, pweight, outfile, outform, overwrite)

        else :
          result = False
        return result