##################### generated by xml-casa (v2) from hifv_solint.xml ###############
##################### 4703b621186a2d30cbde3bac497a3f8c ##############################
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_solint import hifv_solint as _hifv_solint_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_solint:
"""
hifv_solint ---- Determines different solution intervals
The hifv_solint task determines different solution intervals. Note that the short solint value is switched to 'int' when
the minimum solution interval corresponds to one integration.
--------- 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.
limit_short_solint Keyword argument in units of seconds to limit the short solution interval.
Can be a string or float numerical value in units of seconds of '0.45' or 0.45.
Can be set to a string value of 'int'.
refantignore String list of antennas to ignore
Example: refantignore='ea02,ea03'
--------- examples -----------------------------------------------------------
Output:
results -- If pipeline mode is 'getinputs' then None is returned. Otherwise
the results object for the pipeline task is returned.
Examples
1. Determines different solution intervals:
hifv_solint()
"""
_info_group_ = """pipeline"""
_info_desc_ = """Determines different solution intervals"""
def __call__( self, vis=[ ], pipelinemode='automatic', dryrun=False, acceptresults=True, limit_short_solint='', refantignore='' ):
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'}, 'limit_short_solint': {'type': 'cVariant', 'coerce': [_coerce.to_variant]}, 'refantignore': {'type': 'cStr', 'coerce': _coerce.to_str}}
doc = {'vis': vis, 'pipelinemode': pipelinemode, 'dryrun': dryrun, 'acceptresults': acceptresults, 'limit_short_solint': limit_short_solint, 'refantignore': refantignore}
assert _pc.validate(doc,schema), str(_pc.errors)
_logging_state_ = _start_log( 'hifv_solint', [ 'vis=' + repr(_pc.document['vis']), 'pipelinemode=' + repr(_pc.document['pipelinemode']), 'dryrun=' + repr(_pc.document['dryrun']), 'acceptresults=' + repr(_pc.document['acceptresults']), 'limit_short_solint=' + repr(_pc.document['limit_short_solint']), 'refantignore=' + repr(_pc.document['refantignore']) ] )
return _end_log( _logging_state_, 'hifv_solint', _hifv_solint_t( _pc.document['vis'], _pc.document['pipelinemode'], _pc.document['dryrun'], _pc.document['acceptresults'], _pc.document['limit_short_solint'], _pc.document['refantignore'] ) )
hifv_solint = _hifv_solint( )