##################### generated by xml-casa (v2) from hif_makecutoutimages.xml ######
##################### 24b8a29d487243173bbe9a40f456bacd ##############################
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_hif_makecutoutimages import hif_makecutoutimages as _hif_makecutoutimages_t
from casatasks.private.task_logging import start_log as _start_log
from casatasks.private.task_logging import end_log as _end_log
class _hif_makecutoutimages:
"""
hif_makecutoutimages ---- Base makecutoutimages task
The hif_makecutoutimages task
Output:
results -- If pipeline mode is 'getinputs' then None is returned. Otherwise
the results object for the pipeline task is returned.
--------- parameter descriptions ---------------------------------------------
vis List of visibility data files.
These may be ASDMs, tar files of ASDMs, MSs,
or tar files of MSs.
If ASDM files are specified, they will be converted to
MS format.
(can be set only in 'interactive mode')
example: vis=['X227.ms', 'asdms.tar.gz']
offsetblc -x and -y offsets to the bottom lower corner (blc)
in arcseconds
(can be set in any pipeline mode)
offsettrc +x and +y offsets to the top right corner (trc)
in arcseconds
(can be set in any pipeline mode)
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.
(can be set in any pipeline mode)
dryrun Run the commands (False) or generate the commands to be
run but do not execute (True).
acceptresults Add the results of the task to the pipeline context (True)
or reject them (False).
--------- examples -----------------------------------------------------------
1. Basic makecutoutimages task
hif_makecutoutimages()
"""
_info_group_ = """pipeline"""
_info_desc_ = """Base makecutoutimages task"""
def __call__( self, vis=[ ], offsetblc=[ ], offsettrc=[ ], pipelinemode='automatic', dryrun=False, acceptresults=True ):
schema = {'vis': {'type': 'cStrVec', 'coerce': [_coerce.to_list,_coerce.to_strvec]}, 'offsetblc': {'type': 'cFloatVec', 'coerce': [_coerce.to_list,_coerce.to_floatvec]}, 'offsettrc': {'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, 'offsetblc': offsetblc, 'offsettrc': offsettrc, 'pipelinemode': pipelinemode, 'dryrun': dryrun, 'acceptresults': acceptresults}
assert _pc.validate(doc,schema), str(_pc.errors)
_logging_state_ = _start_log( 'hif_makecutoutimages', [ 'vis=' + repr(_pc.document['vis']), 'offsetblc=' + repr(_pc.document['offsetblc']), 'offsettrc=' + repr(_pc.document['offsettrc']), 'pipelinemode=' + repr(_pc.document['pipelinemode']), 'dryrun=' + repr(_pc.document['dryrun']), 'acceptresults=' + repr(_pc.document['acceptresults']) ] )
return _end_log( _logging_state_, 'hif_makecutoutimages', _hif_makecutoutimages_t( _pc.document['vis'], _pc.document['offsetblc'], _pc.document['offsettrc'], _pc.document['pipelinemode'], _pc.document['dryrun'], _pc.document['acceptresults'] ) )
hif_makecutoutimages = _hif_makecutoutimages( )