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 applycal_cli.py.

Constructor & Destructor Documentation

def applycal_cli.applycal_cli_.__init__ ( self )

Definition at line 26 of file applycal_cli.py.

Member Function Documentation

def applycal_cli.applycal_cli_.__call__	(	self,
		vis = `None`,
		field = `None`,
		spw = `None`,
		intent = `None`,
		selectdata = `None`,
		timerange = `None`,
		uvrange = `None`,
		antenna = `None`,
		scan = `None`,
		observation = `None`,
		msselect = `None`,
		gaintable = `None`,
		gainfield = `None`,
		interp = `None`,
		spwmap = `None`,
		gaincurve = `None`,
		opacity = `None`,
		parang = `None`,
		calwt = `None`,
		applymode = `None`,
		flagbackup = `None`,
		async = `None`
	)

Apply calibrations solutions(s) to data


       Applycal reads the specified gain calibration tables, applies
       them to the (raw) data column (with the specified selection),
       and writes the calibrated results into the corrected column.
       This is done in one step, so all available calibration tables must
       be specified.  Included parang, gaincurve, and opacity are used in
       obtaining previous calibration tables.

       Applycal will overwrite existing corrected data, and will flag data
       for which there is no calibration available.

       All calibration tables (both temporal, frequency, polarization
       calibrations) are specified in the gaintable parameter.  The
       calibration values associated with a restricted list of fields
       can also be selected for each table in gainfield.

       See task accum for instructions on forming calibration
       incrementally.  See task split for copying out any portion of the data
       and selected columns to a new visibility file.

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

      --- Data Selection: the data to which the calibration will be applied
(see help par.selectdata for more detailed information)

      field -- Select field id(s) or field name(s) to apply calibration.
 [run listobs to obtain the list id's or names]
       default: ''=all fields
       If field's string is an integer >=0, it is assumed to be an index
 otherwise, it is assumed to be a field name
       field='0~2'; field ids 0,1,2
       field='0,4,5~7'; field ids 0,4,5,6,7
       field='3C286,3C295'; fields named 3C286 and 3C295
       field = '3,4C*'; field id 3, all names starting with 4C
      spw -- Select spectral window/channels 
       type 'help par.selection' for more examples.
     spw='0~2,4'; spectral windows 0,1,2,4 (all channels)
     spw='<2';  spectral windows less than 2 (i.e. 0,1)
     spw='0:5~61'; spw 0, channels 5 to 61, INCLUSIVE
     spw='*:5~61'; all spw with channels 5 to 62
     spw='0,10,3:3~45'; spw 0,10 all channels, spw 3, channels 3 to 45.
     spw='0~2:2~6'; spw 0,1,2 with channels 2 through 6 in each.
     spw='0:0~10;15~60'; spectral window 0 with channels 0-10,15-60
       NOTE ';' to separate channel selections
     spw='0:0~10^2,1:20~30^5'; spw 0, channels 0,2,4,6,8,10,
   spw 1, channels 20,25,30
       intent -- Select observing intent
 default: ''  (no selection by intent)
 intent='*BANDPASS*'  (selects data labelled with
                       BANDPASS intent)
       selectdata -- Other data selection parameters
      default: True
       timerange  -- Select data based on time range:
      default = '' (all); examples,
      timerange = 'YYYY/MM/DD/hh:mm:ss~YYYY/MM/DD/hh:mm:ss'
      Note: if YYYY/MM/DD is missing, date defaults to first day in
    data set
      timerange='09:14:0~09:54:0' picks 40 min on first day
      timerange= '25:00:00~27:30:00' picks 1 hr to 3 hr 30min on next day
      timerange='09:44:00' data within one integration of time
      timerange='>10:24:00' data after this time
       uvrange -- Select data within uvrange (default units meters)
      default: '' (all); example:
      uvrange='0~1000kl'; uvrange from 0-1000 kilo-lambda
      uvrange='>4kl';uvranges greater than 4 kilolambda
       antenna -- Select data based on antenna/baseline
      default: '' (all)
      If antenna's string is an integer >=0, it is taken to be an index
otherwise, it is assumed to be an antenna name
      antenna='5&6'; baseline between antenna index 5 and index 6.
      antenna='VA05&VA06'; baseline between VLA antenna 5 and 6.
      antenna='5&6;7&8'; baseline 5-6 and 7-8
      antenna='5'; all baselines with antenna index 5
      antenna='05'; all baselines with antenna name 05--vla antenna 5.
      antenna='5,6,10'; all baselines with antennas 5,6 and 10
       scan -- Scan number range
       observation -- Select by observation ID(s).
       default: '' = all
       example: '0~3,6'
       msselect -- Optional complex data selection (ignore for now)

       --- Calibration files to apply
       gaintable -- Gain calibration table(s) to apply 
       default: '' (none);
       examples: gaintable='ngc5921.gcal'
   gaintable=['n5921.ampcal','n5921.phcal','n5921.bpass']
       All gain table types: 'G', GSPLINE, 'T', 'B', 'BPOLY', 'D's'
   can be applied.
       gainfield -- Select a subset of calibrators from each gaintable
       default:'' ==> all sources in table;
       'nearest' ==> nearest (on sky) available field in table
       otherwise, same syntax as field
       example: gainfield='0~3'
        gainfield=['0~3','4~6']  (for multiple gaintables)
       interp -- Interpolation type (in time[,freq]) to use for each gaintable.
When frequency interpolation is relevant (B, Df, Xf),
separate time-dependent and freq-dependent interp
types with a comma (freq _after_ the comma).                
Specifications for frequency are ignored when the
calibration table has no channel-dependence.
Time-dependent interp options ending in 'PD' enable a
"phase delay" correction per spw for non-channel-dependent
calibration types.
default: '' --> 'linear,linear' for all gaintable(s)
example: interp='nearest'   (in time, freq-dep will be
                             linear, if relevant)
         interp='linear,cubic'  (linear in time, cubic
                                 in freq)
         interp=',spline'  (spline in freq; linear in
                            time by default)
         interp=['nearest,spline','linear']  (for multiple gaintables)
Options: Time: 'nearest', 'linear', 'nearestPD', 'linearPD'
         Freq: 'nearest', 'linear', 'cubic', 'spline'
       spwmap -- Spectral windows combinations to form for gaintable(s)
       default: [] (apply solutions from each spw to that spw only)
       Example:  spwmap=[0,0,1,1] means apply the caltable solutions
         from spw = 0 to the spw 0,1 and spw 1 to spw 2,3.
         spwmap=[[0,0,1,1],[0,1,0,1]]  (for multiple gaintables)
         
  Complicated example:

    gaintable=['tab1','tab2','tab3']
    gainfield='3C286'
    interp=['linear','nearest']
    spwmap=[[],[0,0,2]]
    
    This means: apply 3 cal tables, selecting only solutions for 3C286
    from tab1 (but all fields from tab2 and tab3, indicated by
    no gainfield entry for these files).  Linear interpolation
    (in time) will be used for 'tab1' and 'tab3' (default); 'tab2' will
    use nearest.  For the 'tab2', the calibration spws map
    will be mapped to the data spws according to 0->0, 0->1, 2->2.
    (I.e., for data spw=0 and 2, the spw mapping is one to one,
    but data spw 1 will be calibrated by solutions from spw 0.)  
   
       gaincurve -- Apply internal VLA/EVLA  antenna gain curve correction (True/False)
       default: False;
       Use gaincurve=True ONLY for VLA or EVLA data
       opacity -- Opacity correction to apply (nepers), per spw
       default: [] (no opacity correction for any spw)
       examples: 
   A global value for all spws:
     opacity=0.051 
   Different values for spws 0,1,2:
     opacity=[0.051, 0.055, 0.057] 
   (if fewer opacity values than spws are specified,
    then the last-specified value will be duplicated 
    for all higher-numbered spws, e.g., in the above 
    example, 0.057 will be used for spws 3 and higher, 
    if they exist)
       Typical VLA values are: 5 GHz - 0.013, 8 GHz - 0.013
       15 GHz - 0.016, 23 GHz - 0.051, 43 GHz - 0.07
       parang -- If True, apply the parallactic angle correction.  FOR ANY
       POLARIZATION CALIBRATION AND IMAGING, parang = True
       default: False
       calwt -- Calibrate weights along with data for all
       relevant calibrations
       default: True; example: calwt=False
       applymode -- Calibration apply mode:
       ''='calflag' (default) calibrate data and apply flags from solutions
       'trial' report on flags from solutions, dataset entirely unchanged
       'flagonly' apply flags from solutions only, data not calibrated
       'calonly' calibrate data only (by unflagged solutions), flags from solutions NOT applied (use with extreme caution!)
       flagbackup -- Back up the state of the flags before applying calibration
     default: True
       async -- Run task in a separate process 
default: False; example: async=True

Definition at line 46 of file applycal_cli.py.

def applycal_cli.applycal_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 461 of file applycal_cli.py.

References accum_cli.accum_cli_.__globals__, and applycal_cli.applycal_cli_.__globals__.

def applycal_cli.applycal_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 397 of file applycal_cli.py.

References accum_cli.accum_cli_.__globals__, applycal_cli.applycal_cli_.__globals__, accum_cli.accum_cli_.itsdefault(), and applycal_cli.applycal_cli_.itsdefault().

def applycal_cli.applycal_cli_.description	(	self,
		key = `'applycal'`,
		subkey = `None`
	)

Definition at line 492 of file applycal_cli.py.

def applycal_cli.applycal_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 526 of file applycal_cli.py.

References accum_cli.accum_cli_.parameters, and applycal_cli.applycal_cli_.parameters.

def applycal_cli.applycal_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 373 of file applycal_cli.py.

References accum_cli.accum_cli_.__globals__, and applycal_cli.applycal_cli_.__globals__.

def applycal_cli.applycal_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file applycal_cli.py.

References accum_cli.accum_cli_.__async__, and applycal_cli.applycal_cli_.__async__.

Member Data Documentation

dictionary applycal_cli.applycal_cli_.__async__ [static, private]

Definition at line 20 of file applycal_cli.py.

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

applycal_cli.applycal_cli_.__bases__ [private]

Definition at line 27 of file applycal_cli.py.

applycal_cli.applycal_cli_.__doc__ [private]

Definition at line 28 of file applycal_cli.py.

applycal_cli.applycal_cli_.__globals__ [private]

Definition at line 223 of file applycal_cli.py.

string applycal_cli.applycal_cli_.__name__ [static, private]

Definition at line 19 of file applycal_cli.py.

applycal_cli.applycal_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file applycal_cli.py.

applycal_cli.applycal_cli_.parameters

Definition at line 30 of file applycal_cli.py.

tuple applycal_cli.applycal_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 440 of file applycal_cli.py.

tuple applycal_cli.applycal_cli_.retval [static]

Definition at line 453 of file applycal_cli.py.

applycal_cli.applycal_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file applycal_cli.py.

string applycal_cli.applycal_cli_.valornotval [static]

Definition at line 443 of file applycal_cli.py.

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

applycal_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