Source code for pipeline.hifv.cli.hifv_circfeedpolcal

##################### generated by xml-casa (v2) from hifv_circfeedpolcal.xml #######
##################### 72ca2096ccddb344f4742f639c1dfbd1 ##############################
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_circfeedpolcal import hifv_circfeedpolcal as _hifv_circfeedpolcal_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_circfeedpolcal:
    """
    hifv_circfeedpolcal ---- Base circfeedpolcal task

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

    vis             List of input visibility data
    Dterm_solint    D-terms spectral averaging.  Example:  refantignore='ea02,ea03'
    refantignore    String list of antennas to ignore
    leakage_poltype poltype to use in first polcal execution - blank string means use default heuristics
    mbdkcross       Run gaincal KCROSS grouped by baseband
    clipminmax      Range to use for flag clipping
    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. Basic circfeedpolcal task
    
    hifv_circfeedpolcal()


    """

    _info_group_ = """pipeline"""
    _info_desc_ = """Base circfeedpolcal task"""

    def __call__( self, vis=[  ], Dterm_solint='2MHz', refantignore='', leakage_poltype='', mbdkcross=True, clipminmax=[ float(0.0),float(0.25) ], pipelinemode='automatic', dryrun=False, acceptresults=True ):
        schema = {'vis': {'type': 'cStrVec', 'coerce': [_coerce.to_list,_coerce.to_strvec]}, 'Dterm_solint': {'type': 'cStr', 'coerce': _coerce.to_str}, 'refantignore': {'type': 'cStr', 'coerce': _coerce.to_str}, 'leakage_poltype': {'type': 'cStr', 'coerce': _coerce.to_str}, 'mbdkcross': {'type': 'cBool'}, 'clipminmax': {'type': 'cFloatVec', 'coerce': [_coerce.to_list,_coerce.to_floatvec]}, 'pipelinemode': {'type': 'cStr', 'coerce': _coerce.to_str, 'allowed': [ 'automatic', 'interactive', 'getinputs' ]}, 'dryrun': {'type': 'cBool'}, 'acceptresults': {'type': 'cBool'}}
        doc = {'vis': vis, 'Dterm_solint': Dterm_solint, 'refantignore': refantignore, 'leakage_poltype': leakage_poltype, 'mbdkcross': mbdkcross, 'clipminmax': clipminmax, 'pipelinemode': pipelinemode, 'dryrun': dryrun, 'acceptresults': acceptresults}
        assert _pc.validate(doc,schema), str(_pc.errors)
        _logging_state_ = _start_log( 'hifv_circfeedpolcal', [ 'vis=' + repr(_pc.document['vis']), 'Dterm_solint=' + repr(_pc.document['Dterm_solint']), 'refantignore=' + repr(_pc.document['refantignore']), 'leakage_poltype=' + repr(_pc.document['leakage_poltype']), 'mbdkcross=' + repr(_pc.document['mbdkcross']), 'clipminmax=' + repr(_pc.document['clipminmax']), 'pipelinemode=' + repr(_pc.document['pipelinemode']), 'dryrun=' + repr(_pc.document['dryrun']), 'acceptresults=' + repr(_pc.document['acceptresults']) ] )
        return _end_log( _logging_state_, 'hifv_circfeedpolcal', _hifv_circfeedpolcal_t( _pc.document['vis'], _pc.document['Dterm_solint'], _pc.document['refantignore'], _pc.document['leakage_poltype'], _pc.document['mbdkcross'], _pc.document['clipminmax'], _pc.document['pipelinemode'], _pc.document['dryrun'], _pc.document['acceptresults'] ) )

hifv_circfeedpolcal = _hifv_circfeedpolcal( )