casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables
Functions
importasdm Namespace Reference

Functions

def importasdm

Function Documentation

def importasdm.importasdm (   asdm = '',
  vis = '',
  singledish = False,
  antenna = 0,
  corr_mode = 'all',
  srt = 'all',
  time_sampling = 'all',
  ocorr_mode = 'ca',
  compression = False,
  asis = '',
  wvr_corrected_data = 'no',
  scans = '',
  ignore_time = False,
  process_syspower = True,
  process_caldevice = True,
  process_pointing = True,
  process_flags = True,
  tbuff = 0.0,
  applyflags = False,
  savecmds = True,
  outfile = '',
  verbose = False,
  overwrite = False,
  showversion = False,
  useversion = 'v3' 
)
Convert an ALMA Science Data Model observation into a CASA visibility file (MS) or single-dish data format (Scantable)                         
Keyword arguments:
asdm -- Name of input ASDM file (directory)
default: none; example: asdm='ExecBlock3'

vis       -- Root ms or scantable name, note a prefix (.ms or .asap) is NOT appended to this name
     default: none

singledish   -- Set True to write data as single-dish format (Scantable)
        default: False

    >>> singledish expandable parameter
         antenna -- antenna name or id.
 
corr_mode -- correlation mode to be considered on input. Could
     be one or more of the following, ao, co, ac, or all
     default: 'all'

srt       -- spectral resolution type. Could be one or more of
     the following, fr, ca, bw, or all
     default: 'all'

time_sampling -- specifies the time sampling, INTEGRATION and/or
         SUBINTEGRAION. could be one or more of the following
         i, si, or all.
         default: 'all'

ocorr_mode    -- output data for correlation mode AUTO_ONLY 
         (ao) or CROSS_ONLY (co) or CROSS_AND_AUTO (ca)
         default: 'ca'
         

compression  -- produces comrpressed columns in the resulting measurement set.
        default: False


asis         --  creates verbatim copies of the ASDM tables in 
         the output measurement set. The value given to
         this option must be a list of table names separated
         by space characters; the wildcard character '*' is 
         allowed in table names.
        default: none

wvr_corrected_data -- specifies wich values are considered in the 
              ASDM binary data to fill the DATA column in 
              the MAIN table of the MS. Expected values for 
              this option are 'no' for the uncorrected data 
              (this is the default), 'yes' for the corrected
              data and 'both' for corrected and uncorrected 
              data. In the latter case, two measurement sets
              are created, one containing the uncorrected 
              data and the other one, whose name is suffixed
              by '-wvr-corrected', containing the corrected 
              data.
          default: 'no'

scans --          processes only the scans specified in the option's value. This value is a semicolon 
          separated list of scan specifications. A scan specification consists in an exec bock index 
          followed by the character ':' followed by a comma separated list of scan indexes or scan 
          index ranges. A scan index is relative to the exec block it belongs to. Scan indexes are 
          1-based while exec blocks's are 0-based. '0:1' or '2:2~6' or '0:1,1:2~6,8;2:,3:24~30' '1,2' 
          are valid values for the option. '3:' alone will be interpreted as 'all the scans of the 
          exec block#3'. An scan index or a scan index range not preceded by an exec block index will
          be interpreted as 'all the scans with such indexes in all the exec blocks'.  By default 
          all the scans are considered.
            default: none (all scans)

ignore_time -- All the rows of the tables Feed, History, Pointing, Source, SysCal, CalDevice, SysPower,
       and Weather are processed independently of the time range of the selected exec block / scan.
            default: False

process_syspower -- The SysPower table is processed if and only if this parameter is set to True.
            default: True

process_caldevice -- The CalDevice table is processed if and only if this parameter is set to True.
            default: True

process_pointing -- The Pointing table is processed if and only if this parameter is set to True.
            default: True

process_flags    -- Create online flags based on the Flag.xml, Antenna.xml and SpectralWindow.xml files
            and copy them to the FLAG_CMD sub-table of the MS. The flags will NOT be applied unless 
            the parameter applyflags is set to True. Optionally, the flags can also be saved to
            an external ASCII file if savecmds is set to True.
            default: True
            
    >>> process_flags expandable parameter
         tbuff   -- Time padding buffer (in seconds)
            default: 0.0

         NOTE: this time is in seconds. You should currently
         set the value of tbuff to be 1.5x the correlator
         integration time if greater than 1 second.  For
         example, if the SDM has integrations of 3 seconds,
         set tbuff=4.5.  Likewise, set tbuff=15.0 for 10-sec
         integrations.

         applyflags -- Apply the online flags to the MS.
         default: False


        savecmds -- Save the flag commands to an ASCII file given by the parameter outfile. 
        default: False
            
        outfile -- Filename where to save the flag commands.
        default: ' ' --> by default it will save on a filename composed from the MS name.
            Example: vis='uid_A02.ms', the outfile will be 'uid_A02_cmd.txt'. 
            
            NOTE: The file is open to save in append mode.


verbose     -- produce log output as asdm2MS is being run
            default: False

showversion -- report the version of the asdm2MS being used.
            default: False

useversion -- Selects the version of asdm2MS to be used (\'v3\' (default, should work for all data))
      default: v3

Definition at line 13 of file importasdm.py.