exportasdm.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_exportasdm
def exportasdm(vis='', asdm='', datacolumn='data', archiveid='S0', rangeid='X1', subscanduration='24h', sbduration='2700s', apcorrected=True, verbose=True, showversion=True, useversion='v3'):

        """Convert a CASA visibility file (MS) into an ALMA Science Data Model

  Keyword arguments:
  vis -- MS name,
         default: none

  asdm -- Name of output ASDM file (directory),
          default: none; example: asdm='ExecBlock3'

  datacolumn -- specifies which of the MS data columns (data,
           corrected, or model) should be used as the
           visibilities in the ASDM, default: data

  archiveid -- the X0 in uid://X0/X1/X<running>
               default: "S0"

  rangeid -- the X1 in uid://X0/X1/X<running>
             default: "X1"

  subscanduration -- maximum duration of a subscan in the output ASDM
                     default: "24h"

  sbduration -- maximum duration of a scheduling block in the output ASDM
                     default: "2700s"

  apcorrected -- If true, the data in column datacolumn will be marked
                 as having atmospheric phase correction, default: True

  verbose     -- produce log output, default: True

  showversion -- report the version of the ASDM class set, 
                 default: True

  useversion -- Selects the version of MS2asdm to be used (\'v3\' (default) or \'v2\' (version before May 2011))
                default: v3

  exportasdm(vis='ngc4826.ms', asdm='uid___S021_X1418_X1', 
  datacolumn='corrected', archiveid='S021', rangeid='X1418', 
  verbose=False)
  will produce an ASDM named 'uid___S021_X1418_X1' using the 
  datacolumn 'corrected' in the MS 'ngc4826.ms' with minimal
  log output. 

  Note concerning ALMA data: exportasdm presently is not able to export 
  from MSs containing WVR data. If you attempt to export such an MS, you
  will receive an error message saying that you can only export data of
  processor type "CORRELATOR". It will also give you the list of SPWs
  which contain CORRELATOR data. You will then have to split out these
  SPWs using the task "split" and run exportasdm on the resulting MS. 

  
        """

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

        mytmp['vis'] = vis
        mytmp['asdm'] = asdm
        mytmp['datacolumn'] = datacolumn
        mytmp['archiveid'] = archiveid
        mytmp['rangeid'] = rangeid
        mytmp['subscanduration'] = subscanduration
        mytmp['sbduration'] = sbduration
        mytmp['apcorrected'] = apcorrected
        mytmp['verbose'] = verbose
        mytmp['showversion'] = showversion
        mytmp['useversion'] = useversion
        pathname='file:///'+os.environ.get('CASAPATH').split()[0]+'/share/xml/'
        trec = casac.utils().torecord(pathname+'exportasdm.xml')

        casalog.origin('exportasdm')
        if trec.has_key('exportasdm') and casac.utils().verify(mytmp, trec['exportasdm']) :
            result = task_exportasdm.exportasdm(vis, asdm, datacolumn, archiveid, rangeid, subscanduration, sbduration, apcorrected, verbose, showversion, useversion)

        else :
          result = False
        return result