##################### generated by xml-casa (v2) from hifa_importdata.xml ###########
##################### 266789a14cb7a924036ac99496b631b2 ##############################
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_hifa_importdata import hifa_importdata as _hifa_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 _hifa_importdata:
"""
hifa_importdata ---- Imports data into the interferometry pipeline
Imports data into the interferometry pipeline.
--------- 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 visibility data sessions
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 Extra ASDM tables to convert as is
process_caldevice Import the caldevice table from the ASDM
overwrite Overwrite existing files on import
nocopy Disable copying of MS to working directory
bdfflags Apply BDF flags on import
asimaging Import MeasurementSets as imaging MeasurementSets
lazy Use the lazy filler import
dbservice Use the online flux catalog
ocorr_mode ALMA default set to ca
createmms Create an MMS
minparang Minimum required parallactic angle range for polarisation calibrator,
in degrees. The default of 0.0 is used for non-polarisation processing.
dryrun Run the task (False) or display task command (True)
acceptresults Add the results into the pipeline context
--------- examples -----------------------------------------------------------
The hifa_importdata task loads the specified visibility data into the pipeline
context unpacking and / or converting it as necessary.
Keyword arguments
---- pipeline parameter arguments which can be set in any pipeline mode
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.
default: []
example: session=['session_1', 'session_2']
---- pipeline context defined parameter argument which can be set only in
'interactive mode'
asis -- ASDM tables to convert as is.
default: 'SBSummary ExecBlock Antenna Station Receiver Source CalAtmosphere CalWVR'
example: asis='Receiver', asis=''
process_caldevice -- Ingest the ASDM caldevice table.
default: False
example: process_caldevice=True
overwrite -- Overwrite existing MSes on output.
default: False
nocopy -- When importing an MS, disable copying of the MS to the working
directory.
default: False
bdfflags -- Apply BDF flags on line.
default: True
ocorr_mode -- Read in cross- and auto-correlation data(ca), cross-
correlation data only (co), or autocorrelation data only (ao).
default: ca
lazy -- Use the lazy filter import.
default: False
dbservice -- Use online flux catalog on import.
default: False
ocorr_mode -- Read in cross- and auto-correlation data(ca), cross-
correlation data only (co), or autocorrelation data only (ao).
default: ca
createmms -- Create a multi-MeasurementSet ('true') ready for full parallel
processing, or a standard MeasurementSet ('false'). The default setting
('automatic') creates an MMS if running in a cluster environment.
default: 'false'
--- pipeline task execution modes
dryrun -- Run the commands (True) or generate the commands to be run but
do not execute (False).
default: True
acceptresults -- Add the results of the task to the pipeline context (True) or
reject them (False).
default: True
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:
hifa_importdata(vis=['../rawdata/uid___A002_X30a93d_X43e',
'../rawdata/uid_A002_x30a93d_X44e'])
2. Load an MS in the current directory into the context:
hifa_importdata(vis=[uid___A002_X30a93d_X43e.ms])
3. Load a tarred ASDM in ../rawdata into the context:
hifa_importdata(vis=['../rawdata/uid___A002_X30a93d_X43e.tar.gz'])
4. Check the hif_importdata inputs, then import the data:
myvislist = ['uid___A002_X30a93d_X43e.ms', 'uid_A002_x30a93d_X44e.ms']
hifa_importdata(vis=myvislist, pipelinemode='getinputs')
hifa_importdata(vis=myvislist)
5. Load an ASDM but check the results before accepting them into the context.
results = hifa_importdata(vis=['uid___A002_X30a93d_X43e.ms'],
acceptresults=False)
results.accept()
6. Run in dryrun mode before running for real:
results = hifa_importdata(vis=['uid___A002_X30a93d_X43e.ms'], dryrun=True)
results = hifa_importdata(vis=['uid___A002_X30a93d_X43e.ms'])
"""
_info_group_ = """pipeline"""
_info_desc_ = """Imports data into the interferometry pipeline"""
def __call__( self, vis=[ ], session=[ ], pipelinemode='automatic', asis='SBSummary ExecBlock Antenna Station Receiver Source CalAtmosphere CalWVR CalPointing', process_caldevice=False, overwrite=False, nocopy=False, bdfflags=True, asimaging=False, lazy=False, dbservice=False, ocorr_mode='ca', createmms='false', minparang=float(0.0), 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'}, 'asimaging': {'type': 'cBool'}, 'lazy': {'type': 'cBool'}, 'dbservice': {'type': 'cBool'}, 'ocorr_mode': {'type': 'cStr', 'coerce': _coerce.to_str}, 'createmms': {'type': 'cStr', 'coerce': _coerce.to_str, 'allowed': [ 'false', 'true', 'automatic' ]}, 'minparang': {'type': 'cFloat', 'coerce': _coerce.to_float}, '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, 'asimaging': asimaging, 'lazy': lazy, 'dbservice': dbservice, 'ocorr_mode': ocorr_mode, 'createmms': createmms, 'minparang': minparang, 'dryrun': dryrun, 'acceptresults': acceptresults}
assert _pc.validate(doc,schema), str(_pc.errors)
_logging_state_ = _start_log( 'hifa_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']), 'asimaging=' + repr(_pc.document['asimaging']), 'lazy=' + repr(_pc.document['lazy']), 'dbservice=' + repr(_pc.document['dbservice']), 'ocorr_mode=' + repr(_pc.document['ocorr_mode']), 'createmms=' + repr(_pc.document['createmms']), 'minparang=' + repr(_pc.document['minparang']), 'dryrun=' + repr(_pc.document['dryrun']), 'acceptresults=' + repr(_pc.document['acceptresults']) ] )
return _end_log( _logging_state_, 'hifa_importdata', _hifa_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['asimaging'], _pc.document['lazy'], _pc.document['dbservice'], _pc.document['ocorr_mode'], _pc.document['createmms'], _pc.document['minparang'], _pc.document['dryrun'], _pc.document['acceptresults'] ) )
hifa_importdata = _hifa_importdata( )