Source code for pipeline.hsd.cli.hsd_importdata

##################### generated by xml-casa (v2) from hsd_importdata.xml ############
##################### 634d01003ecd17b05cd497379f00bddb ##############################
from __future__ import absolute_import
import numpy
from casatools.typecheck import CasaValidator as _val_ctor
_pc = _val_ctor( )
from casatools.coercetype import coerce as _coerce
from .private.task_hsd_importdata import hsd_importdata as _hsd_importdata_t
from casatasks.private.task_logging import start_log as _start_log
from casatasks.private.task_logging import end_log as _end_log

class _hsd_importdata:
    """
    hsd_importdata ---- Imports data into the single dish pipeline

    
    The hsd_importdata task loads the specified visibility data into the pipeline
    context unpacking and / or converting it as necessary.
    
    Output:
    
    results -- If pipeline mode is 'getinputs' then None is returned. Otherwise
    the results object for the pipeline task is returned.

    --------- parameter descriptions ---------------------------------------------

    vis                      List of visibility data files. These may be ASDMs, tar files of ASDMs,
                             MSes, or tar files of MSes, If ASDM files are specified, they will be
                             converted to MS format.
                             example: vis=['X227.ms', 'asdms.tar.gz']
    session                  List of sessions to which the visibility files belong. Defaults
                             to a single session containing all the visibility files, otherwise
                             a session must be assigned to each vis file.
                             example: session=['Session_1', 'Sessions_2']
    pipelinemode             The pipeline operating mode. In 'automatic' mode the pipeline
                             determines the values of all context defined pipeline inputs
                             automatically.  In 'interactive' mode the user can set the pipeline
                             context defined parameters manually.  In 'getinputs' mode the user
                             can check the settings of all pipeline parameters without running
                             the task.
    asis                     ASDM tables to convert as is
                             Parameter is not available when pipelinemode='automatic'.
                             example: 'Receiver', ''
    process_caldevice        Ingest the ASDM caldevice table.
                             Parameter is not available when pipelinemode='automatic'.
                             example: True
    overwrite                Overwrite existing MSes on output.
                             Parameter is not available when pipelinemode='automatic'.
    nocopy                   Disable copying of MS to working directory
                             Parameter is not available when pipelinemode='automatic'.
    bdfflags                 Apply BDF flags on line.
                             Parameter is not available when pipelinemode='automatic'.
    lazy                     Use the lazy filter import
    with_pointing_correction add (ASDM::Pointing::encoder - ASDM::Pointing::pointingDirection)
                             to the value to be written in MS::Pointing::direction
    createmms                Create an MMS
    dryrun                   Run the task (False) or display task command (True).
                             Parameter is available only when pipelinemode='interactive'.
    acceptresults            results of the task to the pipeline context (True) or reject them (False).
                             Parameter is available only when pipelinemode='interactive'.

    --------- examples -----------------------------------------------------------

    
    1. Load an ASDM list in the ../rawdata subdirectory into the context.
    
    hsd_importdata (vis=['../rawdata/uid___A002_X30a93d_X43e',
    '../rawdata/uid_A002_x30a93d_X44e'])
    
    2. Load an MS in the current directory into the context.
    
    hsd_importdata (vis=['uid___A002_X30a93d_X43e.ms'])
    
    3. Load a tarred ASDM in ../rawdata into the context.
    
    hsd_importdata (vis=['../rawdata/uid___A002_X30a93d_X43e.tar.gz'])
    
    4. Check the hsd_importdata inputs, then import the data
    
    myvislist = ['uid___A002_X30a93d_X43e.ms', 'uid_A002_x30a93d_X44e.ms']
    hsd_importdata(vis=myvislist, pipelinemode='getinputs')
    hsd_importdata(vis=myvislist)
    
    5. Load an ASDM but check the results before accepting them into the context.
    
    results = hsd_importdata (vis=['uid___A002_X30a93d_X43e.ms'],
    acceptresults=False)
    results.accept()
    
    6. Run in dryrun mode before running for real
    results = hsd_importdata (vis=['uid___A002_X30a93d_X43e.ms'], dryrun=True)
    results = hsd_importdata (vis=['uid___A002_X30a93d_X43e.ms'])


    """

    _info_group_ = """pipeline"""
    _info_desc_ = """Imports data into the single dish pipeline"""

    def __call__( self, vis=[  ], session=[  ], pipelinemode='automatic', asis='SBSummary ExecBlock Antenna Station Receiver Source CalAtmosphere CalWVR SpectralWindow', process_caldevice=False, overwrite=False, nocopy=False, bdfflags=True, lazy=False, with_pointing_correction=True, createmms='false', dryrun=False, acceptresults=True ):
        schema = {'vis': {'type': 'cStrVec', 'coerce': [_coerce.to_list,_coerce.to_strvec]}, 'session': {'type': 'cStrVec', 'coerce': [_coerce.to_list,_coerce.to_strvec]}, 'pipelinemode': {'type': 'cStr', 'coerce': _coerce.to_str, 'allowed': [ 'automatic', 'interactive', 'getinputs' ]}, 'asis': {'type': 'cStr', 'coerce': _coerce.to_str}, 'process_caldevice': {'type': 'cBool'}, 'overwrite': {'type': 'cBool'}, 'nocopy': {'type': 'cBool'}, 'bdfflags': {'type': 'cBool'}, 'lazy': {'type': 'cBool'}, 'with_pointing_correction': {'type': 'cBool'}, 'createmms': {'type': 'cStr', 'coerce': _coerce.to_str, 'allowed': [ 'automatic', 'true', 'false' ]}, 'dryrun': {'type': 'cBool'}, 'acceptresults': {'type': 'cBool'}}
        doc = {'vis': vis, 'session': session, 'pipelinemode': pipelinemode, 'asis': asis, 'process_caldevice': process_caldevice, 'overwrite': overwrite, 'nocopy': nocopy, 'bdfflags': bdfflags, 'lazy': lazy, 'with_pointing_correction': with_pointing_correction, 'createmms': createmms, 'dryrun': dryrun, 'acceptresults': acceptresults}
        assert _pc.validate(doc,schema), str(_pc.errors)
        _logging_state_ = _start_log( 'hsd_importdata', [ 'vis=' + repr(_pc.document['vis']), 'session=' + repr(_pc.document['session']), 'pipelinemode=' + repr(_pc.document['pipelinemode']), 'asis=' + repr(_pc.document['asis']), 'process_caldevice=' + repr(_pc.document['process_caldevice']), 'overwrite=' + repr(_pc.document['overwrite']), 'nocopy=' + repr(_pc.document['nocopy']), 'bdfflags=' + repr(_pc.document['bdfflags']), 'lazy=' + repr(_pc.document['lazy']), 'with_pointing_correction=' + repr(_pc.document['with_pointing_correction']), 'createmms=' + repr(_pc.document['createmms']), 'dryrun=' + repr(_pc.document['dryrun']), 'acceptresults=' + repr(_pc.document['acceptresults']) ] )
        return _end_log( _logging_state_, 'hsd_importdata', _hsd_importdata_t( _pc.document['vis'], _pc.document['session'], _pc.document['pipelinemode'], _pc.document['asis'], _pc.document['process_caldevice'], _pc.document['overwrite'], _pc.document['nocopy'], _pc.document['bdfflags'], _pc.document['lazy'], _pc.document['with_pointing_correction'], _pc.document['createmms'], _pc.document['dryrun'], _pc.document['acceptresults'] ) )

hsd_importdata = _hsd_importdata( )