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

Constructor & Destructor Documentation

def plotcal_cli.plotcal_cli_.__init__ ( self )

Definition at line 26 of file plotcal_cli.py.

Member Function Documentation

def plotcal_cli.plotcal_cli_.__call__	(	self,
		caltable = `None`,
		xaxis = `None`,
		yaxis = `None`,
		poln = `None`,
		field = `None`,
		antenna = `None`,
		spw = `None`,
		timerange = `None`,
		subplot = `None`,
		overplot = `None`,
		clearpanel = `None`,
		iteration = `None`,
		plotrange = `None`,
		showflags = `None`,
		plotsymbol = `None`,
		plotcolor = `None`,
		markersize = `None`,
		fontsize = `None`,
		showgui = `None`,
		figfile = `None`,
		async = `None`
	)

An all-purpose plotter for calibration results 

The values for all calibration solutions (G, T, GSPLINE, B, BPOLY, D, M) 
can be displayed for a variety of polarization combinations and calibrations.
The plot solutions may be iterated through antennas/spw/fields during one execution,
and many frames can be obtained in each plot.

The plotter permits zooming, listing and flagging of solutions, although
the results of flagged solutions are not yet available.


The plotter permits zooming, listing and flagging of solutions, although
the implications of flagged solutions are not yet made.  See some hints at the end
of this description.


Keyword arguments:
caltable -- Name of input calibration table 
default: none; example: caltable='ngc5921.gcal'
The type of calibration table is determined automatically.
xaxis -- Value to plot on the x axis
Options: 'time','scan','chan','freq','antenna','amp','phase','real','imag','snr'
Default: cal type dependent, usually 'time'
yaxis -- Value to plot on the y-axis
Options: 'amp','phase','real','imag','snr','antenna','tsys','delay','spgain'
Default: cal type dependent, usually 'amp'
poln -- Polarization (or combination) to plot
default: '' (RL); all polarizations
Options: '' = ('RL'),'R','L','XY','X','Y',
               '/' --> form complex poln ratio
                     (amp ratio and phase difference)
field -- Select field using field id(s) or field name(s).
  ['go listobs' to obtain the fieldt id's or names]
       default: ''=all fields
       If field string is a non-negative integer, it is assumed a
       field index, otherwise it is assumed 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'; field named 3C286 and 3C295
       field = '3,4C*'; field id 3, all names starting with 4C
antenna -- Antenna selection (baseline syntax ignored)
       default: '' (all);
       example: antenna='1,3~5' means antenna
  indices 1,3,4,5.  
spw -- Select spectral window (channel syntax ignored, except for D)
       default: ''=all spectral windows
       spw='0~2,4'; spectral windows 0,1,2,4
       spw='<2';  spectral windows less than 2
timerange -- Time selection
  default: '' (all)
  example: timerange='1995/04/13/09:15:00~1995/04/13/09:25:00'

--- Plot Options ---
subplot -- Panel number on the display screen
       default: 111 (full screen display);
       examples:
       if iteration = 'antenna'; subplot=321 then
  a plot frame will contain the first 6 antennas, in three
  rows and two columns.  Follow instructions on screen to
  cycle through the frames
       if iteration = ''; then one frame can be filled with many
  plots in a piecemeal fashion; for example
  antenna='0'; subplot=221; plotcal()
  antenna='1'; subplot=222; plotcal()
  antenna='2'; subplot=223; plotcal()
  antenna='3'; subplot=224; plotcal()
overplot -- Overplot these values on current plot (if possible)
       default: False;
  True (overplotting) can be done ONLY IF iteration=''
clearpanel -- Ignore this parameter.
  Clear nothing on the plot window, automatically
  clear plotting area, clear the current plot area, or
  clear the whole plot panel.
       options: None, Auto, Current, All (None and Auto not supported)
       default: Auto
       example: clearpanel='Current'
iteration -- Create a sequence of plots, iterating over antenna, time,
 field, and/or spw  
       default: '' --> create in all in one plot
       example: iteration='antenna' --> create a sequence of
        separate plots separated by antenna. Flagging cannot
        be done in iteration mode.
plotrange -- Control the x and y ranges of the plot, as a list of
 values, e.g., [xmin,xmax,ymin,ymax]
 default=[] --> plot will self-scale
 Note: time plotting ranges are cumbersome to use.
       Use the zoom option
showflags -- If true, only flagged solutions will be plotted
 default: false --> only show unflagged solutions
plotsymbol -- pylab plot symbol.  See cookbook for details
   default: '.': large points
   ',' = small points (see markersize)
   '-' = connect points by line
   colors are cycled automatically for multi-function plots
plotcolor -- Initial color to use on each plot
 default: 'blue'
markersize -- Control the size of plot symbols
  default: 5.0 --> a nice size for symbols
fontsize -- Control the font size of title (axes labels will be
  80% of this size)
  default: 10.0
showgui -- Whether or not to display the plotting GUI
  default: True; example showgui=False
figfile -- File name to save the plotted figure to.
  default: ''; example figfile=myPlot.png

 Hints on using plotxy (see section 3.4 in cookbook)

 Useful Buttons at bottom left:
      5th--magnifying glass.  Click on this,
       left mouse button rectangle drag will zoom
       right mose button rectangle drag will unzoom a certain amount
      1st--restore original magnification

 Useful regions just above:
      Quit will terminate plotter
      Next will go to next plot as specified by iteration
      To locate, you must click 'Mark Region' first
 then make appropriate region(s)
 then click locate to list points on logger
 DO NOT USE Flag, Unflag at the present time.

Definition at line 46 of file plotcal_cli.py.

def plotcal_cli.plotcal_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 407 of file plotcal_cli.py.

def plotcal_cli.plotcal_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 340 of file plotcal_cli.py.

def plotcal_cli.plotcal_cli_.description	(	self,
		key = `'plotcal'`,
		subkey = `None`
	)

Definition at line 438 of file plotcal_cli.py.

def plotcal_cli.plotcal_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 467 of file plotcal_cli.py.

Referenced by rmtables_cli.rmtables_cli_.defaults(), uvsub_cli.uvsub_cli_.defaults(), uvcontsub2_cli.uvcontsub2_cli_.defaults(), plotweather_cli.plotweather_cli_.defaults(), smoothcal_cli.smoothcal_cli_.defaults(), tclean_cli.tclean_cli_.defaults(), splattotable_cli.splattotable_cli_.defaults(), sdflagmanager_cli.sdflagmanager_cli_.defaults(), testconcat_cli.testconcat_cli_.defaults(), sdlist_cli.sdlist_cli_.defaults(), viewer_cli.viewer_cli_.defaults(), sdscale_cli.sdscale_cli_.defaults(), slsearch_cli.slsearch_cli_.defaults(), predictcomp_cli.predictcomp_cli_.defaults(), uvcontsub_cli.uvcontsub_cli_.defaults(), wvrgcal_cli.wvrgcal_cli_.defaults(), ssoflux_cli.ssoflux_cli_.defaults(), vishead_cli.vishead_cli_.defaults(), uvcontsub3_cli.uvcontsub3_cli_.defaults(), sdimprocess_cli.sdimprocess_cli_.defaults(), virtualconcat_cli.virtualconcat_cli_.defaults(), sdsmooth_cli.sdsmooth_cli_.defaults(), visstat_cli.visstat_cli_.defaults(), widebandpbcor_cli.widebandpbcor_cli_.defaults(), sdcoadd_cli.sdcoadd_cli_.defaults(), uvmodelfit_cli.uvmodelfit_cli_.defaults(), sdsave_cli.sdsave_cli_.defaults(), simanalyze_cli.simanalyze_cli_.defaults(), sdmath_cli.sdmath_cli_.defaults(), sdgrid_cli.sdgrid_cli_.defaults(), sdtpimaging_cli.sdtpimaging_cli_.defaults(), sdstat_cli.sdstat_cli_.defaults(), split_cli.split_cli_.defaults(), sdimaging_cli.sdimaging_cli_.defaults(), statwt_cli.statwt_cli_.defaults(), sdflag_cli.sdflag_cli_.defaults(), simalma_cli.simalma_cli_.defaults(), sdfit_cli.sdfit_cli_.defaults(), sdcal_cli.sdcal_cli_.defaults(), simobserve_cli.simobserve_cli_.defaults(), polcal_cli.polcal_cli_.defaults(), sdbaseline_cli.sdbaseline_cli_.defaults(), setjy_cli.setjy_cli_.defaults(), widefield_cli.widefield_cli_.defaults(), plotxy_cli.plotxy_cli_.defaults(), specfit_cli.specfit_cli_.defaults(), plotms_cli.plotms_cli_.defaults(), and sdreduce_cli.sdreduce_cli_.defaults().

def plotcal_cli.plotcal_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 316 of file plotcal_cli.py.

def plotcal_cli.plotcal_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file plotcal_cli.py.

References accum_cli.accum_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 plotcal_cli.plotcal_cli_.__async__ [static, private]

Definition at line 20 of file plotcal_cli.py.

Referenced by plotcal_cli.plotcal_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(), and plotms_cli.plotms_cli_.result().

plotcal_cli.plotcal_cli_.__bases__ [private]

Definition at line 27 of file plotcal_cli.py.

plotcal_cli.plotcal_cli_.__doc__ [private]

Definition at line 28 of file plotcal_cli.py.

plotcal_cli.plotcal_cli_.__globals__ [private]

Definition at line 172 of file plotcal_cli.py.

string plotcal_cli.plotcal_cli_.__name__ [static, private]

Definition at line 19 of file plotcal_cli.py.

plotcal_cli.plotcal_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file plotcal_cli.py.

plotcal_cli.plotcal_cli_.parameters

Definition at line 30 of file plotcal_cli.py.

tuple plotcal_cli.plotcal_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 386 of file plotcal_cli.py.

tuple plotcal_cli.plotcal_cli_.retval [static]

Definition at line 399 of file plotcal_cli.py.

plotcal_cli.plotcal_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file plotcal_cli.py.

string plotcal_cli.plotcal_cli_.valornotval [static]

Definition at line 389 of file plotcal_cli.py.

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

plotcal_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