##################### generated by xml-casa (v2) from hifv_testBPdcals.xml ##########
##################### b42c57f0b7deec9d830661ecedaa7ea6 ##############################
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_testBPdcals import hifv_testBPdcals as _hifv_testBPdcals_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_testBPdcals:
"""
hifv_testBPdcals ---- Runs initial delay calibration to set up heuristic flagging
--------- 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']
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.
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.
weakbp Activate weak bandpass heuristics
refantignore String list of antennas to ignore
Example: refantignore='ea02,ea03'
doflagundernspwlimit If the number of bad spws is greater than zero, and the keyword is True, then spws are flagged individually.
--------- examples -----------------------------------------------------------
Output:
results -- If pipeline mode is 'getinputs' then None is returned. Otherwise
the results object for the pipeline task is returned.
Examples
1. Initial delay calibration to set up heuristic flagging.
hifv_testBPdcals()
"""
_info_group_ = """pipeline"""
_info_desc_ = """Runs initial delay calibration to set up heuristic flagging"""
def __call__( self, vis=[ ], pipelinemode='automatic', dryrun=False, acceptresults=True, weakbp=False, refantignore='', doflagundernspwlimit=False ):
schema = {'vis': {'type': 'cStrVec', 'coerce': [_coerce.to_list,_coerce.to_strvec]}, 'pipelinemode': {'type': 'cStr', 'coerce': _coerce.to_str, 'allowed': [ 'automatic', 'interactive', 'getinputs' ]}, 'dryrun': {'type': 'cBool'}, 'acceptresults': {'type': 'cBool'}, 'weakbp': {'type': 'cBool'}, 'refantignore': {'type': 'cStr', 'coerce': _coerce.to_str}, 'doflagundernspwlimit': {'type': 'cBool'}}
doc = {'vis': vis, 'pipelinemode': pipelinemode, 'dryrun': dryrun, 'acceptresults': acceptresults, 'weakbp': weakbp, 'refantignore': refantignore, 'doflagundernspwlimit': doflagundernspwlimit}
assert _pc.validate(doc,schema), str(_pc.errors)
_logging_state_ = _start_log( 'hifv_testBPdcals', [ 'vis=' + repr(_pc.document['vis']), 'pipelinemode=' + repr(_pc.document['pipelinemode']), 'dryrun=' + repr(_pc.document['dryrun']), 'acceptresults=' + repr(_pc.document['acceptresults']), 'weakbp=' + repr(_pc.document['weakbp']), 'refantignore=' + repr(_pc.document['refantignore']), 'doflagundernspwlimit=' + repr(_pc.document['doflagundernspwlimit']) ] )
return _end_log( _logging_state_, 'hifv_testBPdcals', _hifv_testBPdcals_t( _pc.document['vis'], _pc.document['pipelinemode'], _pc.document['dryrun'], _pc.document['acceptresults'], _pc.document['weakbp'], _pc.document['refantignore'], _pc.document['doflagundernspwlimit'] ) )
hifv_testBPdcals = _hifv_testBPdcals( )