Commits

Yohei Hayashi authored dd5cf93a93d
update class document in gencal.
No tags

casatasks/src/private/task_gencal.py

Modified
23 23 def gencal(vis=None, caltable=None, caltype=None, infile='None',
24 24 endpoint='asdm', timeout=180, retry=3, retry_wait_time=5,
25 25 spw=None, antenna=None, pol=None,
26 26 parameter=None, uniform=None):
27 27 """Externally specify calibration solutions of various types.
28 28
29 29 Arguments:
30 30 vis {str} -- The file path stored the visibility data.
31 31 caltable {str} -- A file name which store the caltable.
32 32 caltype {str} -- The calibration type.
33 - infile {str} -- Specifies the name of the file to read.
33 + Subparameter of caltype='gc|gceff|tecim|jyperk'
34 + infile {str} -- Specifies the name of the file to read.
34 35 subparameter of caltype='jyperk:
35 36 endpoint {str} -- The endpoint of the Jy/K DB Web API to access.
36 37 options are 'asdm' (default), 'model-fit', 'interpolation'.
37 38 timeout {int} -- Maximum waiting time [sec] for the Web API access,
38 39 defaults to 180 sec.
39 40 retry {int} -- Number of retry when the Web API access fails,
40 41 defaults to 3 times.
41 42 retry_wait_time {int} -- Waiting time [sec] until next query
42 43 when the Web API access fails, defaults to 5 sec.
43 44 spw {str} -- The spectral windows.
44 - antenna {str} --
45 - pol {str} --
46 - parameter {} --
47 - uniform {} --
45 + antenna {str} -- Select data based on antenna/baseline.
46 + pol {str} -- Polarization selection for specified parameters.
47 + parameter {doubleVec} -- The calibration values.
48 + uniform {bool} -- Assume uniform calibration values across the array.
48 49 """
49 50
50 51 # validate arguments
51 52 if (caltable == ''):
52 53 raise ValueError('A caltable name must be specified')
53 54
54 55 if caltype == 'tecim' and not (type(infile) == str and os.path.exists(infile)):
55 56 raise ValueError('An existing tec map must be specified in infile')
56 57
57 58 if caltype == 'jyperk' and endpoint not in ['asdm', 'interpolation', 'model-fit']:

Everything looks good. We'll let you know here if there's anything you should know about.

Add shortcut