Public Member Functions
def	__init__
def	result
def	__call__
def	paramgui
def	defaults
def	check_params
def	description
def	itsdefault
Public Attributes
	parameters
Static Public Attributes
	rkey
	Handle globals or user over-ride of arguments.
	i_am_a_casapy_task
list	retval
	This function sets the default values but also will return the list of parameters or the default value of a given parameter.
string	valornotval
tuple	retval
Private Attributes
	__bases__
	__doc__
	__globals__
Static Private Attributes
string	__name__
dictionary	__async__

Detailed Description

Definition at line 18 of file wvrgcal_cli.py.

Constructor & Destructor Documentation

def wvrgcal_cli.wvrgcal_cli_.__init__ ( self )

Definition at line 26 of file wvrgcal_cli.py.

Member Function Documentation

def wvrgcal_cli.wvrgcal_cli_.__call__	(	self,
		vis = `None`,
		caltable = `None`,
		toffset = `None`,
		segsource = `None`,
		sourceflag = `None`,
		tie = `None`,
		nsol = `None`,
		disperse = `None`,
		wvrflag = `None`,
		statfield = `None`,
		statsource = `None`,
		smooth = `None`,
		scale = `None`,
		reversespw = `None`,
		cont = `None`,
		async = `None`
	)

Generate a gain table based on Water Vapour Radiometer data

Information about the observation and the performance of WVRGCAL is written to the CASA logger; 
see the CASA cookbook for a more detailed description of these parameters.

Of particular note is the discrepancy parameter (Disc): high values (> a few hundred microns) 
may indicate some levels of cloud contamination and the effect of applying the WVRGCAL correction 
should be checked; values > 1000 um in all antennas have currently been found to indicate that 
WVRGCAL correction should not be used.

      
  vis -- Name of input visibility file
      default: none; example: vis='ngc5921.ms'

  caltable -- Name of output gain calibration table
      default: none; example: caltable='ngc5921.wvr'

  toffset -- Time offset (sec) between interferometric and WVR data
     default: -1 (ALMA default)

  segsource -- Do a new coefficient calculation for each source
     default: True

  tie -- Prioritise tieing the phase of these sources as well as possible
 (requires segsource=True)
     default: [] example: ['3C273,NGC253', 'IC433,3C279']

  sourceflag -- Flag the WVR data for these source(s) as bad and do not produce corrections for it
       (requires segsource=True)
       default: [] (none) example: ['3C273']

  nsol -- Number of solutions for phase correction coefficients during this observation.
  By default only one set of coefficients is generated for the entire observation. 
  If more sets are requested, then they will be evenly distributed in time throughout 
  the observation. Values > 1 require segsource=False.
     default: 1

  disperse -- Apply correction for dispersion
     default: False

  wvrflag -- Flag the WVR data for these antenna(s) as bad and replace its data with interpolated values
       default: [] (none) example: ['DV03','DA05','PM02']           

  statfield -- Compute the statistics (Phase RMS, Disc) on this field only
       default: '' (all) 

  statsource -- Compute the statistics (Phase RMS, Disc) on this source only
       default: '' (all)             

  smooth -- Smooth WVR data by this many samples before applying the correction
     default: 1 (no smoothing) example: 3

  scale -- Scale the entire phase correction by this factor
     default: 1. (no scaling)

  reversespw -- Reverse the sign of the correction for the listed SPWs
(only neede for early ALMA data before Cycle 0)
     default: '' (none), example: reversespw='0~2,4'; spectral windows 0,1,2,4

  cont -- Estimate the continuum (e.g., due to clouds)
     default: False

Definition at line 46 of file wvrgcal_cli.py.

def wvrgcal_cli.wvrgcal_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 333 of file wvrgcal_cli.py.

def wvrgcal_cli.wvrgcal_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 272 of file wvrgcal_cli.py.

def wvrgcal_cli.wvrgcal_cli_.description	(	self,
		key = `'wvrgcal'`,
		subkey = `None`
	)

Definition at line 364 of file wvrgcal_cli.py.

def wvrgcal_cli.wvrgcal_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 392 of file wvrgcal_cli.py.

Referenced by wvrgcal_cli.wvrgcal_cli_.defaults().

def wvrgcal_cli.wvrgcal_cli_.paramgui	(	self,
		useGlobals = `True`,
		ipython_globals = `None`
	)

Opens a parameter GUI for this task.  If useGlobals is true, then any relevant global parameter settings are used.

Definition at line 248 of file wvrgcal_cli.py.

def wvrgcal_cli.wvrgcal_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file wvrgcal_cli.py.

References accum_cli.accum_cli_.__async__, wvrgcal_cli.wvrgcal_cli_.__async__, widefield_cli.widefield_cli_.__async__, widebandpbcor_cli.widebandpbcor_cli_.__async__, visstat_cli.visstat_cli_.__async__, vishead_cli.vishead_cli_.__async__, virtualconcat_cli.virtualconcat_cli_.__async__, viewer_cli.viewer_cli_.__async__, uvsub_cli.uvsub_cli_.__async__, uvmodelfit_cli.uvmodelfit_cli_.__async__, uvcontsub_cli.uvcontsub_cli_.__async__, uvcontsub3_cli.uvcontsub3_cli_.__async__, uvcontsub2_cli.uvcontsub2_cli_.__async__, testconcat_cli.testconcat_cli_.__async__, tclean_cli.tclean_cli_.__async__, statwt_cli.statwt_cli_.__async__, ssoflux_cli.ssoflux_cli_.__async__, split_cli.split_cli_.__async__, splattotable_cli.splattotable_cli_.__async__, specfit_cli.specfit_cli_.__async__, smoothcal_cli.smoothcal_cli_.__async__, slsearch_cli.slsearch_cli_.__async__, simobserve_cli.simobserve_cli_.__async__, simanalyze_cli.simanalyze_cli_.__async__, simalma_cli.simalma_cli_.__async__, setjy_cli.setjy_cli_.__async__, sdtpimaging_cli.sdtpimaging_cli_.__async__, sdstat_cli.sdstat_cli_.__async__, sdsmooth_cli.sdsmooth_cli_.__async__, sdscale_cli.sdscale_cli_.__async__, sdsave_cli.sdsave_cli_.__async__, sdreduce_cli.sdreduce_cli_.__async__, sdplot_cli.sdplot_cli_.__async__, sdmath_cli.sdmath_cli_.__async__, sdlist_cli.sdlist_cli_.__async__, sdimprocess_cli.sdimprocess_cli_.__async__, sdimaging_cli.sdimaging_cli_.__async__, sdgrid_cli.sdgrid_cli_.__async__, sdflagmanager_cli.sdflagmanager_cli_.__async__, sdflag_cli.sdflag_cli_.__async__, sdfit_cli.sdfit_cli_.__async__, sdcoadd_cli.sdcoadd_cli_.__async__, sdcal_cli.sdcal_cli_.__async__, sdbaseline_cli.sdbaseline_cli_.__async__, rmtables_cli.rmtables_cli_.__async__, predictcomp_cli.predictcomp_cli_.__async__, polcal_cli.polcal_cli_.__async__, plotxy_cli.plotxy_cli_.__async__, plotweather_cli.plotweather_cli_.__async__, plotuv_cli.plotuv_cli_.__async__, plotms_cli.plotms_cli_.__async__, plotcal_cli.plotcal_cli_.__async__, plotants_cli.plotants_cli_.__async__, peel_cli.peel_cli_.__async__, pclean_cli.pclean_cli_.__async__, partition_cli.partition_cli_.__async__, msview_cli.msview_cli_.__async__, msmoments_cli.msmoments_cli_.__async__, mosaic_cli.mosaic_cli_.__async__, makemask_cli.makemask_cli_.__async__, listvis_cli.listvis_cli_.__async__, listsdm_cli.listsdm_cli_.__async__, listpartition_cli.listpartition_cli_.__async__, listobs_cli.listobs_cli_.__async__, listhistory_cli.listhistory_cli_.__async__, listfits_cli.listfits_cli_.__async__, listcal_cli.listcal_cli_.__async__, imview_cli.imview_cli_.__async__, imval_cli.imval_cli_.__async__, imtrans_cli.imtrans_cli_.__async__, imsubimage_cli.imsubimage_cli_.__async__, imstat_cli.imstat_cli_.__async__, imsmooth_cli.imsmooth_cli_.__async__, imregrid_cli.imregrid_cli_.__async__, imreframe_cli.imreframe_cli_.__async__, importvla_cli.importvla_cli_.__async__, importuvfits_cli.importuvfits_cli_.__async__, importgmrt_cli.importgmrt_cli_.__async__, importfitsidi_cli.importfitsidi_cli_.__async__, importfits_cli.importfits_cli_.__async__, importevla_cli.importevla_cli_.__async__, importasdm_cli.importasdm_cli_.__async__, impbcor_cli.impbcor_cli_.__async__, immoments_cli.immoments_cli_.__async__, immath_cli.immath_cli_.__async__, imhead_cli.imhead_cli_.__async__, imfit_cli.imfit_cli_.__async__, imcontsub_cli.imcontsub_cli_.__async__, imcollapse_cli.imcollapse_cli_.__async__, hanningsmooth_cli.hanningsmooth_cli_.__async__, gencal_cli.gencal_cli_.__async__, gaincal_cli.gaincal_cli_.__async__, ft_cli.ft_cli_.__async__, fluxscale_cli.fluxscale_cli_.__async__, flagmanager_cli.flagmanager_cli_.__async__, flagdata_cli.flagdata_cli_.__async__, flagcmd_cli.flagcmd_cli_.__async__, fixvis_cli.fixvis_cli_.__async__, fixplanets_cli.fixplanets_cli_.__async__, find_cli.find_cli_.__async__, feather_cli.feather_cli_.__async__, exportuvfits_cli.exportuvfits_cli_.__async__, exportfits_cli.exportfits_cli_.__async__, exportasdm_cli.exportasdm_cli_.__async__, delmod_cli.delmod_cli_.__async__, deconvolve_cli.deconvolve_cli_.__async__, cvel_cli.cvel_cli_.__async__, csvclean_cli.csvclean_cli_.__async__, conjugatevis_cli.conjugatevis_cli_.__async__, concat_cli.concat_cli_.__async__, clearstat_cli.clearstat_cli_.__async__, clearplot_cli.clearplot_cli_.__async__, clearcal_cli.clearcal_cli_.__async__, clean_cli.clean_cli_.__async__, caltabconvert_cli.caltabconvert_cli_.__async__, calstat_cli.calstat_cli_.__async__, browsetable_cli.browsetable_cli_.__async__, boxit_cli.boxit_cli_.__async__, blcal_cli.blcal_cli_.__async__, bandpass_cli.bandpass_cli_.__async__, autoclean_cli.autoclean_cli_.__async__, asdmsummary_cli.asdmsummary_cli_.__async__, and applycal_cli.applycal_cli_.__async__.

Member Data Documentation

dictionary wvrgcal_cli.wvrgcal_cli_.__async__ [static, private]

Definition at line 20 of file wvrgcal_cli.py.

Referenced by wvrgcal_cli.wvrgcal_cli_.result().

wvrgcal_cli.wvrgcal_cli_.__bases__ [private]

Definition at line 27 of file wvrgcal_cli.py.

wvrgcal_cli.wvrgcal_cli_.__doc__ [private]

Definition at line 28 of file wvrgcal_cli.py.

wvrgcal_cli.wvrgcal_cli_.__globals__ [private]

Definition at line 112 of file wvrgcal_cli.py.

Referenced by wvrgcal_cli.wvrgcal_cli_.check_params(), wvrgcal_cli.wvrgcal_cli_.defaults(), and wvrgcal_cli.wvrgcal_cli_.paramgui().

string wvrgcal_cli.wvrgcal_cli_.__name__ [static, private]

Definition at line 19 of file wvrgcal_cli.py.

wvrgcal_cli.wvrgcal_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file wvrgcal_cli.py.

wvrgcal_cli.wvrgcal_cli_.parameters

Definition at line 30 of file wvrgcal_cli.py.

Referenced by wvrgcal_cli.wvrgcal_cli_.itsdefault().

tuple wvrgcal_cli.wvrgcal_cli_.retval [static]

This function sets the default values but also will return the list of parameters or the default value of a given parameter.

Definition at line 312 of file wvrgcal_cli.py.

tuple wvrgcal_cli.wvrgcal_cli_.retval [static]

Definition at line 325 of file wvrgcal_cli.py.

wvrgcal_cli.wvrgcal_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file wvrgcal_cli.py.

string wvrgcal_cli.wvrgcal_cli_.valornotval [static]

Definition at line 315 of file wvrgcal_cli.py.

The documentation for this class was generated from the following file:

wvrgcal_cli.py

Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation