##################### generated by xml-casa (v2) from hifv_importdata.xml ###########
##################### b8e323688cfcaab9bbc8c49205c8b27a ##############################
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_hifv_importdata import hifv_importdata as _hifv_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 _hifv_importdata:
"""
hifv_importdata ---- Imports data into the VLA pipeline
The hifv_importdata task loads the specified visibility data into the pipeline
context unpacking and / or converting it as necessary.
--------- 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 to convert as is
Only can be set in pipelinemode='interactive'
examples: 'Receiver CalAtmosphere'
'Receiver', ''
overwrite Only can be set in pipelinemode='interactive'
nocopy When importing an MS, disable copying of the MS to the working directory.
Only can be set in pipelinemode='interactive'
createmms Create a multi-MeasurementSet ('true') ready for parallel
processing, or a standard MeasurementSet ('false'). The default setting
('automatic') creates an MMS if running in a cluster environment.
ocorr_mode Read in cross- and auto-correlation data(ca), cross-
correlation data only (co), or autocorrelation data only (ao).
dryrun Run the commands (True) or generate the commands to be run but
do not execute (False). This is a pipeline task execution mode.
acceptresults Add the results of the task to the pipeline context (True) or
reject them (False). This is a pipeline task execution mode.
--------- examples -----------------------------------------------------------
Output:
results -- If pipeline mode is 'getinputs' then None is returned. Otherwise
the results object for the pipeline task is returned.
Examples
1. Load an ASDM list in the ../rawdata subdirectory into the context.
hifv_importdata (vis=['../rawdata/uid___A002_X30a93d_X43e',
'../rawdata/uid_A002_x30a93d_X44e'])
2. Load an MS in the current directory into the context.
hifv_importdata (vis=[uid___A002_X30a93d_X43e.ms])
3. Load a tarred ASDM in ../rawdata into the context.
hifv_importdata (vis=['../rawdata/uid___A002_X30a93d_X43e.tar.gz'])
4. Check the hifv_importdata inputs, then import the data
myvislist = ['uid___A002_X30a93d_X43e.ms', 'uid_A002_x30a93d_X44e.ms']
hifv_importdata(vis=myvislist, pipelinemode='getinputs')
hifv_importdata(vis=myvislist)
5. Load an ASDM but check the results before accepting them into the context.
results = hifv_importdata (vis=['uid___A002_X30a93d_X43e.ms'],
acceptresults=False)
results.accept()
6. Run in dryrun mode before running for real
results = hifv_importdata (vis=['uid___A002_X30a93d_X43e.ms'], dryrun=True)
results = hifv_importdata (vis=['uid___A002_X30a93d_X43e.ms'])
"""
_info_group_ = """pipeline"""
_info_desc_ = """Imports data into the VLA pipeline"""
def __call__( self, vis=[ ], session=[ ], pipelinemode='automatic', asis='Receiver CalAtmosphere', overwrite=False, nocopy=False, createmms='automatic', ocorr_mode='co', 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}, 'overwrite': {'type': 'cBool'}, 'nocopy': {'type': 'cBool'}, 'createmms': {'type': 'cStr', 'coerce': _coerce.to_str, 'allowed': [ 'automatic', 'true', 'false' ]}, 'ocorr_mode': {'type': 'cStr', 'coerce': _coerce.to_str}, 'dryrun': {'type': 'cBool'}, 'acceptresults': {'type': 'cBool'}}
doc = {'vis': vis, 'session': session, 'pipelinemode': pipelinemode, 'asis': asis, 'overwrite': overwrite, 'nocopy': nocopy, 'createmms': createmms, 'ocorr_mode': ocorr_mode, 'dryrun': dryrun, 'acceptresults': acceptresults}
assert _pc.validate(doc,schema), str(_pc.errors)
_logging_state_ = _start_log( 'hifv_importdata', [ 'vis=' + repr(_pc.document['vis']), 'session=' + repr(_pc.document['session']), 'pipelinemode=' + repr(_pc.document['pipelinemode']), 'asis=' + repr(_pc.document['asis']), 'overwrite=' + repr(_pc.document['overwrite']), 'nocopy=' + repr(_pc.document['nocopy']), 'createmms=' + repr(_pc.document['createmms']), 'ocorr_mode=' + repr(_pc.document['ocorr_mode']), 'dryrun=' + repr(_pc.document['dryrun']), 'acceptresults=' + repr(_pc.document['acceptresults']) ] )
return _end_log( _logging_state_, 'hifv_importdata', _hifv_importdata_t( _pc.document['vis'], _pc.document['session'], _pc.document['pipelinemode'], _pc.document['asis'], _pc.document['overwrite'], _pc.document['nocopy'], _pc.document['createmms'], _pc.document['ocorr_mode'], _pc.document['dryrun'], _pc.document['acceptresults'] ) )
hifv_importdata = _hifv_importdata( )