Source code for pipeline.hifv.cli.hifv_priorcals

##################### generated by xml-casa (v2) from hifv_priorcals.xml ############
##################### 0b5fbc3adb2cc67b449a3a3f8bf206ca ##############################
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_priorcals import hifv_priorcals as _hifv_priorcals_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_priorcals:
    """
    hifv_priorcals ---- Runs gaincurves, opacities, requantizer gains, antenna position corrections, tec_maps, switched power.

    --------- 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']
    tecmaps       Run tecmaps priorcal
    swpow_spw     Spectral-window(s) for plotting: "" ==>all, spw="6,14"
    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.

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

    
    
    Output:
    
    results -- If pipeline mode is 'getinputs' then None is returned. Otherwise
    the results object for the pipeline task is returned.
    
    
    Examples
    
    1. Run gaincurves, opacities, requantizer gains and antenna position corrections.
    
    hifv_priorcals()


    """

    _info_group_ = """pipeline"""
    _info_desc_ = """Runs gaincurves, opacities, requantizer gains, antenna position corrections, tec_maps, switched power."""

    def __call__( self, vis=[  ], tecmaps=False, swpow_spw='', pipelinemode='automatic', dryrun=False, acceptresults=True ):
        schema = {'vis': {'type': 'cStrVec', 'coerce': [_coerce.to_list,_coerce.to_strvec]}, 'tecmaps': {'type': 'cBool'}, 'swpow_spw': {'anyof': [{'type': 'cStr', 'coerce': _coerce.to_str}, {'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'}}
        doc = {'vis': vis, 'tecmaps': tecmaps, 'swpow_spw': swpow_spw, 'pipelinemode': pipelinemode, 'dryrun': dryrun, 'acceptresults': acceptresults}
        assert _pc.validate(doc,schema), str(_pc.errors)
        _logging_state_ = _start_log( 'hifv_priorcals', [ 'vis=' + repr(_pc.document['vis']), 'tecmaps=' + repr(_pc.document['tecmaps']), 'swpow_spw=' + repr(_pc.document['swpow_spw']), 'pipelinemode=' + repr(_pc.document['pipelinemode']), 'dryrun=' + repr(_pc.document['dryrun']), 'acceptresults=' + repr(_pc.document['acceptresults']) ] )
        return _end_log( _logging_state_, 'hifv_priorcals', _hifv_priorcals_t( _pc.document['vis'], _pc.document['tecmaps'], _pc.document['swpow_spw'], _pc.document['pipelinemode'], _pc.document['dryrun'], _pc.document['acceptresults'] ) )

hifv_priorcals = _hifv_priorcals( )