##################### generated by xml-casa (v2) from hifv_circfeedpolcal.xml #######
##################### 72ca2096ccddb344f4742f639c1dfbd1 ##############################
from __future__ import absolute_import
from casashell.private.stack_manip import find_local as __sf__
from casashell.private.stack_manip import find_frame as _find_frame
from casatools.typecheck import validator as _pc
from casatools.coercetype import coerce as _coerce
from pipeline.hifv.cli import hifv_circfeedpolcal as _hifv_circfeedpolcal_t
from collections import OrderedDict
import numpy
import sys
import os
import shutil
[docs]def static_var(varname, value):
def decorate(func):
setattr(func, varname, value)
return func
return decorate
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"""
__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'}}
def __init__(self):
self.__stdout = None
self.__stderr = None
self.__root_frame_ = None
def __globals_(self):
if self.__root_frame_ is None:
self.__root_frame_ = _find_frame( )
assert self.__root_frame_ is not None, "could not find CASAshell global frame"
return self.__root_frame_
def __to_string_(self,value):
if type(value) is str:
return "'%s'" % value
else:
return str(value)
def __validate_(self,doc,schema):
return _pc.validate(doc,schema)
def __do_inp_output(self,param_prefix,description_str,formatting_chars):
out = self.__stdout or sys.stdout
description = description_str.split( )
prefix_width = 23 + 16 + 4
output = [ ]
addon = ''
first_addon = True
while len(description) > 0:
## starting a new line.....................................................................
if len(output) == 0:
## for first line add parameter information............................................
if len(param_prefix)-formatting_chars > prefix_width - 1:
output.append(param_prefix)
continue
addon = param_prefix + ' #'
first_addon = True
addon_formatting = formatting_chars
else:
## for subsequent lines space over prefix width........................................
addon = (' ' * prefix_width) + '#'
first_addon = False
addon_formatting = 0
## if first word of description puts us over the screen width, bail........................
if len(addon + description[0]) - addon_formatting + 1 > self.term_width:
## if we're doing the first line make sure it's output.................................
if first_addon: output.append(addon)
break
while len(description) > 0:
## if the next description word puts us over break for the next line...................
if len(addon + description[0]) - addon_formatting + 1 > self.term_width: break
addon = addon + ' ' + description[0]
description.pop(0)
output.append(addon)
out.write('\n'.join(output) + '\n')
#--------- return nonsubparam values ----------------------------------------------
def __clipminmax_dflt( self, glb ):
return [ float(0.0),float(0.25) ]
def __clipminmax( self, glb ):
if 'clipminmax' in glb: return glb['clipminmax']
return [ float(0.0),float(0.25) ]
def __Dterm_solint_dflt( self, glb ):
return '2MHz'
def __Dterm_solint( self, glb ):
if 'Dterm_solint' in glb: return glb['Dterm_solint']
return '2MHz'
def __mbdkcross_dflt( self, glb ):
return True
def __mbdkcross( self, glb ):
if 'mbdkcross' in glb: return glb['mbdkcross']
return True
def __refantignore_dflt( self, glb ):
return ''
def __refantignore( self, glb ):
if 'refantignore' in glb: return glb['refantignore']
return ''
def __leakage_poltype_dflt( self, glb ):
return ''
def __leakage_poltype( self, glb ):
if 'leakage_poltype' in glb: return glb['leakage_poltype']
return ''
def __pipelinemode_dflt( self, glb ):
return 'automatic'
def __pipelinemode( self, glb ):
if 'pipelinemode' in glb: return glb['pipelinemode']
return 'automatic'
#--------- return inp/go default --------------------------------------------------
def __acceptresults_dflt( self, glb ):
if self.__pipelinemode( glb ) == "interactive": return bool(True)
return None
def __dryrun_dflt( self, glb ):
if self.__pipelinemode( glb ) == "interactive": return bool(False)
return None
def __vis_dflt( self, glb ):
if self.__pipelinemode( glb ) == "interactive": return []
if self.__pipelinemode( glb ) == "getinputs": return []
return None
#--------- return subparam values -------------------------------------------------
def __vis( self, glb ):
if 'vis' in glb: return glb['vis']
dflt = self.__vis_dflt( glb )
if dflt is not None: return dflt
return [ ]
def __dryrun( self, glb ):
if 'dryrun' in glb: return glb['dryrun']
dflt = self.__dryrun_dflt( glb )
if dflt is not None: return dflt
return False
def __acceptresults( self, glb ):
if 'acceptresults' in glb: return glb['acceptresults']
dflt = self.__acceptresults_dflt( glb )
if dflt is not None: return dflt
return True
#--------- subparam inp output ----------------------------------------------------
def __vis_inp(self):
if self.__vis_dflt( self.__globals_( ) ) is not None:
description = 'List of input visibility data'
value = self.__vis( self.__globals_( ) )
(pre,post) = ('','') if self.__validate_({'vis': value},{'vis': self.__schema['vis']}) else ('\x1B[91m','\x1B[0m')
self.__do_inp_output(' \x1B[92m%-13.13s =\x1B[0m %s%-23s%s' % ('vis',pre,self.__to_string_(value),post),description,9+len(pre)+len(post))
def __Dterm_solint_inp(self):
description = 'D-terms spectral averaging. Example: refantignore=\'ea02,ea03\''
value = self.__Dterm_solint( self.__globals_( ) )
(pre,post) = ('','') if self.__validate_({'Dterm_solint': value},{'Dterm_solint': self.__schema['Dterm_solint']}) else ('\x1B[91m','\x1B[0m')
self.__do_inp_output('%-16.16s = %s%-23s%s' % ('Dterm_solint',pre,self.__to_string_(value),post),description,0+len(pre)+len(post))
def __refantignore_inp(self):
description = 'String list of antennas to ignore'
value = self.__refantignore( self.__globals_( ) )
(pre,post) = ('','') if self.__validate_({'refantignore': value},{'refantignore': self.__schema['refantignore']}) else ('\x1B[91m','\x1B[0m')
self.__do_inp_output('%-16.16s = %s%-23s%s' % ('refantignore',pre,self.__to_string_(value),post),description,0+len(pre)+len(post))
def __leakage_poltype_inp(self):
description = 'poltype to use in first polcal execution - blank string means use default heuristics'
value = self.__leakage_poltype( self.__globals_( ) )
(pre,post) = ('','') if self.__validate_({'leakage_poltype': value},{'leakage_poltype': self.__schema['leakage_poltype']}) else ('\x1B[91m','\x1B[0m')
self.__do_inp_output('%-16.16s = %s%-23s%s' % ('leakage_poltype',pre,self.__to_string_(value),post),description,0+len(pre)+len(post))
def __mbdkcross_inp(self):
description = 'Run gaincal KCROSS grouped by baseband'
value = self.__mbdkcross( self.__globals_( ) )
(pre,post) = ('','') if self.__validate_({'mbdkcross': value},{'mbdkcross': self.__schema['mbdkcross']}) else ('\x1B[91m','\x1B[0m')
self.__do_inp_output('%-16.16s = %s%-23s%s' % ('mbdkcross',pre,self.__to_string_(value),post),description,0+len(pre)+len(post))
def __clipminmax_inp(self):
description = 'Range to use for flag clipping'
value = self.__clipminmax( self.__globals_( ) )
(pre,post) = ('','') if self.__validate_({'clipminmax': value},{'clipminmax': self.__schema['clipminmax']}) else ('\x1B[91m','\x1B[0m')
self.__do_inp_output('%-16.16s = %s%-23s%s' % ('clipminmax',pre,self.__to_string_(value),post),description,0+len(pre)+len(post))
def __pipelinemode_inp(self):
description = 'The pipeline operating mode'
value = self.__pipelinemode( self.__globals_( ) )
(pre,post) = ('','') if self.__validate_({'pipelinemode': value},{'pipelinemode': self.__schema['pipelinemode']}) else ('\x1B[91m','\x1B[0m')
self.__do_inp_output('\x1B[1m\x1B[47m%-16.16s =\x1B[0m %s%-23s%s' % ('pipelinemode',pre,self.__to_string_(value),post),description,13+len(pre)+len(post))
def __dryrun_inp(self):
if self.__dryrun_dflt( self.__globals_( ) ) is not None:
description = 'Run the task (False) or display task command (True)'
value = self.__dryrun( self.__globals_( ) )
(pre,post) = ('','') if self.__validate_({'dryrun': value},{'dryrun': self.__schema['dryrun']}) else ('\x1B[91m','\x1B[0m')
self.__do_inp_output(' \x1B[92m%-13.13s =\x1B[0m %s%-23s%s' % ('dryrun',pre,self.__to_string_(value),post),description,9+len(pre)+len(post))
def __acceptresults_inp(self):
if self.__acceptresults_dflt( self.__globals_( ) ) is not None:
description = 'Add the results into the pipeline context'
value = self.__acceptresults( self.__globals_( ) )
(pre,post) = ('','') if self.__validate_({'acceptresults': value},{'acceptresults': self.__schema['acceptresults']}) else ('\x1B[91m','\x1B[0m')
self.__do_inp_output(' \x1B[92m%-13.13s =\x1B[0m %s%-23s%s' % ('acceptresults',pre,self.__to_string_(value),post),description,9+len(pre)+len(post))
#--------- global default implementation-------------------------------------------
@static_var('state', __sf__('casa_inp_go_state'))
def set_global_defaults(self):
self.set_global_defaults.state['last'] = self
glb = self.__globals_( )
if 'dryrun' in glb: del glb['dryrun']
if 'refantignore' in glb: del glb['refantignore']
if 'Dterm_solint' in glb: del glb['Dterm_solint']
if 'pipelinemode' in glb: del glb['pipelinemode']
if 'mbdkcross' in glb: del glb['mbdkcross']
if 'vis' in glb: del glb['vis']
if 'acceptresults' in glb: del glb['acceptresults']
if 'clipminmax' in glb: del glb['clipminmax']
if 'leakage_poltype' in glb: del glb['leakage_poltype']
#--------- inp function -----------------------------------------------------------
def inp(self):
print("# hifv_circfeedpolcal -- %s" % self._info_desc_)
self.term_width, self.term_height = shutil.get_terminal_size(fallback=(80, 24))
self.__vis_inp( )
self.__Dterm_solint_inp( )
self.__refantignore_inp( )
self.__leakage_poltype_inp( )
self.__mbdkcross_inp( )
self.__clipminmax_inp( )
self.__pipelinemode_inp( )
self.__dryrun_inp( )
self.__acceptresults_inp( )
#--------- tget function ----------------------------------------------------------
@static_var('state', __sf__('casa_inp_go_state'))
def tget(self,file=None):
from casashell.private.stack_manip import find_frame
from runpy import run_path
filename = None
if file is None:
if os.path.isfile("hifv_circfeedpolcal.last"):
filename = "hifv_circfeedpolcal.last"
elif isinstance(file, str):
if os.path.isfile(file):
filename = file
if filename is not None:
glob = find_frame( )
newglob = run_path( filename, init_globals={ } )
for i in newglob:
glob[i] = newglob[i]
self.tget.state['last'] = self
else:
print("could not find last file, setting defaults instead...")
self.set_global_defaults( )
def __call__( self, vis=None, Dterm_solint=None, refantignore=None, leakage_poltype=None, mbdkcross=None, clipminmax=None, pipelinemode=None, dryrun=None, acceptresults=None ):
def noobj(s):
if s.startswith('<') and s.endswith('>'):
return "None"
else:
return s
_prefile = os.path.realpath('hifv_circfeedpolcal.pre')
_postfile = os.path.realpath('hifv_circfeedpolcal.last')
_return_result_ = None
_arguments = [vis,Dterm_solint,refantignore,leakage_poltype,mbdkcross,clipminmax,pipelinemode,dryrun,acceptresults]
_invocation_parameters = OrderedDict( )
if any(map(lambda x: x is not None,_arguments)):
# invoke python style
# set the non sub-parameters that are not None
local_global = { }
if Dterm_solint is not None: local_global['Dterm_solint'] = Dterm_solint
if refantignore is not None: local_global['refantignore'] = refantignore
if leakage_poltype is not None: local_global['leakage_poltype'] = leakage_poltype
if mbdkcross is not None: local_global['mbdkcross'] = mbdkcross
if clipminmax is not None: local_global['clipminmax'] = clipminmax
if pipelinemode is not None: local_global['pipelinemode'] = pipelinemode
# the invocation parameters for the non-subparameters can now be set - this picks up those defaults
_invocation_parameters['Dterm_solint'] = self.__Dterm_solint( local_global )
_invocation_parameters['refantignore'] = self.__refantignore( local_global )
_invocation_parameters['leakage_poltype'] = self.__leakage_poltype( local_global )
_invocation_parameters['mbdkcross'] = self.__mbdkcross( local_global )
_invocation_parameters['clipminmax'] = self.__clipminmax( local_global )
_invocation_parameters['pipelinemode'] = self.__pipelinemode( local_global )
# the sub-parameters can then be set. Use the supplied value if not None, else the function, which gets the appropriate default
_invocation_parameters['vis'] = self.__vis( _invocation_parameters ) if vis is None else vis
_invocation_parameters['dryrun'] = self.__dryrun( _invocation_parameters ) if dryrun is None else dryrun
_invocation_parameters['acceptresults'] = self.__acceptresults( _invocation_parameters ) if acceptresults is None else acceptresults
else:
# invoke with inp/go semantics
_invocation_parameters['vis'] = self.__vis( self.__globals_( ) )
_invocation_parameters['Dterm_solint'] = self.__Dterm_solint( self.__globals_( ) )
_invocation_parameters['refantignore'] = self.__refantignore( self.__globals_( ) )
_invocation_parameters['leakage_poltype'] = self.__leakage_poltype( self.__globals_( ) )
_invocation_parameters['mbdkcross'] = self.__mbdkcross( self.__globals_( ) )
_invocation_parameters['clipminmax'] = self.__clipminmax( self.__globals_( ) )
_invocation_parameters['pipelinemode'] = self.__pipelinemode( self.__globals_( ) )
_invocation_parameters['dryrun'] = self.__dryrun( self.__globals_( ) )
_invocation_parameters['acceptresults'] = self.__acceptresults( self.__globals_( ) )
try:
with open(_prefile,'w') as _f:
for _i in _invocation_parameters:
_f.write("%-15s = %s\n" % (_i,noobj(repr(_invocation_parameters[_i]))))
_f.write("#hifv_circfeedpolcal( ")
count = 0
for _i in _invocation_parameters:
_f.write("%s=%s" % (_i,noobj(repr(_invocation_parameters[_i]))))
count += 1
if count < len(_invocation_parameters): _f.write(",")
_f.write(" )\n")
except: pass
try:
_return_result_ = _hifv_circfeedpolcal_t( _invocation_parameters['vis'],_invocation_parameters['Dterm_solint'],_invocation_parameters['refantignore'],_invocation_parameters['leakage_poltype'],_invocation_parameters['mbdkcross'],_invocation_parameters['clipminmax'],_invocation_parameters['pipelinemode'],_invocation_parameters['dryrun'],_invocation_parameters['acceptresults'] )
except Exception as e:
from traceback import format_exc
from casatasks import casalog
casalog.origin('hifv_circfeedpolcal')
casalog.post("Exception Reported: Error in hifv_circfeedpolcal: %s" % str(e),'SEVERE')
casalog.post(format_exc( ))
_return_result_ = False
try:
os.rename(_prefile,_postfile)
except: pass
return _return_result_
hifv_circfeedpolcal = _hifv_circfeedpolcal( )