Inheritance diagram for asap.asapplotter.asapplotter:

Public Member Functions
def	__init__
def	casabar_exists
def	plot
def	gca
def	refresh
def	create_mask
def	text
def	arrow
def	annotate
def	axvline
def	axhline
def	axvspan
def	axhspan
def	set_data
def	set_mode
def	set_panelling
def	set_layout
def	set_stacking
def	set_range
def	set_legend
def	set_title
def	set_ordinate
def	set_abcissa
def	set_colors
def	set_histogram
def	set_linestyles
def	set_font
def	set_margin
def	plot_lines
def	save
def	set_mask
def	set_selection
def	plotazel
def	plotpointing
def	plottp
def	figtext
def	print_header
def	clear_header
def	plotgrid
Static Public Attributes
	set_colours
Private Member Functions
def	_translate
def	_reload_plotter
def	_new_custombar
def	_assert_plotter
def	_axes_callback
def	_reset_counters
def	_reset_margin
def	_slice_indeces
def	_reset
def	_reset_header
def	_plot
def	_get_sortstring
def	_get_selected_n
def	_get_label
def	_plottp
def	_header_plot
Private Attributes
	_visible
	_plotter
	_inikwg
	_panelling
	_stacking
	_rows
	_cols
	_minmaxx
	_minmaxy
	_datamask
	_data
	_lmap
	_title
	_ordinate
	_abcissa
	_abcunit
	_usermask
	_maskselection
	_selection
	_hist
	_fp
	_margins
	_offset
	_startrow
	_ipanel
	_panelrows
	_headtext
	_colormap
	_linestyles
	_legendloc
	_usermaskspectra

Detailed Description

The ASAP plotter.
By default the plotter is set up to plot polarisations
'colour stacked' and scantables across panels.

.. note::

    Currenly it only plots 'spectra' not Tsys or
    other variables.

Definition at line 32 of file asapplotter.py.

Constructor & Destructor Documentation

def asap.asapplotter.asapplotter.__init__	(	self,
		visible = `None`,
		kwargs
	)

Reimplemented in asap.flagplotter.flagplotter.

Definition at line 44 of file asapplotter.py.

Member Function Documentation

def asap.asapplotter.asapplotter._assert_plotter	(	self,
		action = `"status"`,
		errmsg = `None`
	)	`[private]`

Check plot window status. Returns True if plot window is alive.
Parameters
    action:    An action to take if the plotter window is not alive.
       ['status'|'reload'|'halt']
       The action 'status' simply returns False if asaplot
       is not alive. When action='reload', plot window is
       reloaded and the method returns True. Finally, an
       error is raised when action='halt'.
    errmsg:    An error (warning) message to send to the logger,
       when plot window is not alive.

Definition at line 129 of file asapplotter.py.

References asap.asapplotter.asapplotter._plotter, and asap.asapplotter.asapplotter._reload_plotter().

def asap.asapplotter.asapplotter._axes_callback	(	self,
		axesfunc,
		args,
		kwargs
	)	`[private]`

Definition at line 378 of file asapplotter.py.

References asap.asapplotter.asapplotter._assert_plotter().

Referenced by asap.asapplotter.asapplotter.annotate(), asap.asapplotter.asapplotter.arrow(), asap.asapplotter.asapplotter.axhline(), asap.asapplotter.asapplotter.axhspan(), asap.asapplotter.asapplotter.axvline(), asap.asapplotter.asapplotter.axvspan(), and asap.asapplotter.asapplotter.text().

def asap.asapplotter.asapplotter._get_label	(	self,
		scan,
		row,
		mode,
		userlabel = `None`
	)	`[private]`

Reimplemented in asap.flagplotter.flagplotter.

Definition at line 1241 of file asapplotter.py.

Referenced by asap.asapplotter.asapplotter._plot(), asap.flagplotter.flagplotter._plot_with_flag(), and asap.asapplotter.asapplotter._plottp().

def asap.asapplotter.asapplotter._get_selected_n	(	self,
		scan
	)	`[private]`

Definition at line 1222 of file asapplotter.py.

References asap.asapplotter.asapplotter._panelling, and asap.asapplotter.asapplotter._stacking.

Referenced by asap.asapplotter.asapplotter._plot().

def asap.asapplotter.asapplotter._get_sortstring	(	self,
		lorders
	)	`[private]`

Definition at line 1176 of file asapplotter.py.

Referenced by asap.asapplotter.asapplotter._plot(), and asap.asapplotter.asapplotter.set_selection().

def asap.asapplotter.asapplotter._header_plot	(	self,
		texts,
		fontsize = `9`
	)	`[private]`

Definition at line 1558 of file asapplotter.py.

References asap.asapplotter.asapplotter._headtext, and nf_regression.append.

Referenced by asap.asapplotter.asapplotter.print_header().

def asap.asapplotter.asapplotter._new_custombar ( self ) [private]

Reimplemented in asap.flagplotter.flagplotter.

Definition at line 110 of file asapplotter.py.

References asap.asapplotter.asapplotter._visible.

Referenced by asap.asapplotter.asapplotter._reload_plotter().

def asap.asapplotter.asapplotter._plot	(	self,
		scan
	)	`[private]`

Reimplemented in asap.flagplotter.flagplotter.

Definition at line 971 of file asapplotter.py.

Referenced by asap.asapplotter.asapplotter.plot().

def asap.asapplotter.asapplotter._plottp	(	self,
		scan
	)	`[private]`

private method for plotting total power data

Definition at line 1447 of file asapplotter.py.

References asap.asapplotter.asapplotter._abcissa, asap.asapplotter.asapplotter._get_label(), asap.asapplotter.asapplotter._ordinate, asap.asapplotter.asapplotter._panelling, asap.asapplotter.asapplotter._stacking, asap.asapplotter.asapplotter._title, and listvis_regression.array.

Referenced by asap.asapplotter.asapplotter.plottp().

def asap.asapplotter.asapplotter._reload_plotter ( self ) [private]

Definition at line 90 of file asapplotter.py.

References asap.asapplotter.asapplotter._colormap, asap.asapplotter.asapplotter._inikwg, asap.asapplotter.asapplotter._legendloc, asap.asapplotter.asapplotter._linestyles, asap.asapplotter.asapplotter._new_custombar(), asap.asapplotter.asapplotter._plotter, asap.asapplotter.asapplotter._visible, asap.asapplotter.asapplotter.casabar_exists(), and asap.asapplotter.new_asaplot().

Referenced by asap.asapplotter.asapplotter._assert_plotter().

def asap.asapplotter.asapplotter._reset ( self ) [private]

Definition at line 961 of file asapplotter.py.

References asap.asapplotter.asapplotter._usermask.

Referenced by asap.asapplotter.asapplotter.plottp(), asap.selector.selector.reset(), and asap.asapplotter.asapplotter.set_data().

def asap.asapplotter.asapplotter._reset_counters ( self ) [private]

Definition at line 523 of file asapplotter.py.

References asap.asapplotter.asapplotter._ipanel, asap.asapplotter.asapplotter._panelrows, and asap.asapplotter.asapplotter._startrow.

Referenced by asap.asapplotter.asapplotter.set_panelling(), and asap.asapplotter.asapplotter.set_stacking().

def asap.asapplotter.asapplotter._reset_header ( self ) [private]

Definition at line 968 of file asapplotter.py.

References asap.asapplotter.asapplotter._headtext.

Referenced by asap.asapplotter.asapplotter.clear_header(), and asap.asapplotter.asapplotter.plot().

def asap.asapplotter.asapplotter._reset_margin ( self ) [private]

Definition at line 784 of file asapplotter.py.

References asap.asapplotter.asapplotter.plot_lines().

Referenced by asap.asapplotter.asapplotter.set_margin().

def asap.asapplotter.asapplotter._slice_indeces	(	self,
		data
	)	`[private]`

Definition at line 926 of file asapplotter.py.

References asap.asapplotter.asapplotter._minmaxx.

Referenced by asap.asapplotter.asapplotter._plot(), and asap.asapplotter.asapplotter.plotgrid().

def asap.asapplotter.asapplotter._translate	(	self,
		instr
	)	`[private]`

Definition at line 81 of file asapplotter.py.

Referenced by asap.asapplotter.asapplotter.set_panelling(), and asap.asapplotter.asapplotter.set_stacking().

def asap.asapplotter.asapplotter.annotate	(	self,
		text,
		xy = `None`,
		xytext = `None`,
		kwargs
	)

Definition at line 316 of file asapplotter.py.

References asap.asapplotter.asapplotter._assert_plotter(), and asap.asapplotter.asapplotter._axes_callback().

def asap.asapplotter.asapplotter.arrow	(	self,
		args,
		kwargs
	)

Definition at line 303 of file asapplotter.py.

References asap.asapplotter.asapplotter._assert_plotter(), and asap.asapplotter.asapplotter._axes_callback().

def asap.asapplotter.asapplotter.axhline	(	self,
		args,
		kwargs
	)

Definition at line 338 of file asapplotter.py.

References asap.asapplotter.asapplotter._assert_plotter(), and asap.asapplotter.asapplotter._axes_callback().

def asap.asapplotter.asapplotter.axhspan	(	self,
		args,
		kwargs
	)

Definition at line 363 of file asapplotter.py.

References asap.asapplotter.asapplotter._assert_plotter(), and asap.asapplotter.asapplotter._axes_callback().

def asap.asapplotter.asapplotter.axvline	(	self,
		args,
		kwargs
	)

Definition at line 328 of file asapplotter.py.

References asap.asapplotter.asapplotter._assert_plotter(), and asap.asapplotter.asapplotter._axes_callback().

Referenced by asap.asapplotter.asapplotter.create_mask().

def asap.asapplotter.asapplotter.axvspan	(	self,
		args,
		kwargs
	)

Definition at line 348 of file asapplotter.py.

References asap.asapplotter.asapplotter._assert_plotter(), and asap.asapplotter.asapplotter._axes_callback().

Referenced by asap.asapplotter.asapplotter.create_mask().

def asap.asapplotter.asapplotter.casabar_exists ( self )

Definition at line 122 of file asapplotter.py.

Referenced by asap.asapplotter.asapplotter._plot(), asap.asapplotter.asapplotter._reload_plotter(), asap.asapplotter.asapplotter.plot(), asap.asapplotter.asapplotter.plotgrid(), and asap.asapplotter.asapplotter.plottp().

def asap.asapplotter.asapplotter.clear_header ( self )

Definition at line 1569 of file asapplotter.py.

References asap.asapplotter.asapplotter._assert_plotter(), asap.asapplotter.asapplotter._headtext, and asap.asapplotter.asapplotter._reset_header().

def asap.asapplotter.asapplotter.create_mask	(	self,
		nwin = `1`,
		panel = `0`,
		color = `None`
	)

Interactively define a mask. It retruns a mask that is equivalent to
the one created manually with scantable.create_mask.
Parameters:
    nwin:       The number of mask windows to create interactively
        default is 1.
    panel:      Which panel to use for mask selection. This is useful
        if different IFs are spread over panels (default 0)

Definition at line 233 of file asapplotter.py.

References asap.asapplotter.asapplotter._assert_plotter(), asap.asapplotter.asapplotter._data, asap.asapplotter.asapplotter.axvline(), asap.asapplotter.asapplotter.axvspan(), regression_utility.cleanup(), asap.asapplotter.asapplotter.refresh(), asap.asapplotter.asapplotter.text(), and asap.asaplotbase.asaplotbase.text().

def asap.asapplotter.asapplotter.figtext	(	self,
		args,
		kwargs
	)

Add text to figure at location x,y (relative 0-1 coords).
This method forwards *args and **kwargs to a Matplotlib method,
matplotlib.Figure.text.
See the method help for detailed information.

Definition at line 1493 of file asapplotter.py.

References asap.asapplotter.asapplotter._assert_plotter().

def asap.asapplotter.asapplotter.gca ( self )

Definition at line 220 of file asapplotter.py.

References asap.asapplotter.asapplotter._assert_plotter().

def asap.asapplotter.asapplotter.plot	(	self,
		scan = `None`
	)

Plot a scantable.
Parameters:
    scan:   a scantable
Note:
    If a scantable was specified in a previous call
    to plot, no argument has to be given to 'replot'
    NO checking is done that the abcissas of the scantable
    are consistent e.g. all 'channel' or all 'velocity' etc.

Reimplemented in asap.flagplotter.flagplotter.

Definition at line 181 of file asapplotter.py.

def asap.asapplotter.asapplotter.plot_lines	(	self,
		linecat = `None`,
		doppler = `0.0`,
		deltachan = `10`,
		rotate = `90.0`,
		location = `None`
	)

Plot a line catalog.
Parameters:
    linecat:      the linecatalog to plot
    doppler:      the velocity shift to apply to the frequencies
    deltachan:    the number of channels to include each side of the
          line to determine a local maximum/minimum
    rotate:       the rotation (in degrees) for the text label (default 90.0)
    location:     the location of the line annotation from the 'top',
          'bottom' or alternate (None - the default)
Notes:
If the spectrum is flagged no line will be drawn in that location.

Definition at line 790 of file asapplotter.py.

References asap.asapplotter.asapplotter._assert_plotter(), asap.asapplotter.asapplotter._data, and irc_cs_task_regression.max.

Referenced by asap.asapplotter.asapplotter._reset_margin().

def asap.asapplotter.asapplotter.plotazel	(	self,
		scan = `None`,
		outfile = `None`
	)

plot azimuth and elevation versus time of a scantable

Reimplemented in asap.flagplotter.flagplotter.

Definition at line 1261 of file asapplotter.py.

References asap.asapplotter.asapplotter._data, asap.asapplotter.asapplotter._margins, asap.asapplotter.asapplotter._visible, listvis_regression.array, irc_cs_task_regression.max, and asap.asapplotter.asapplotter.set_margin().

def asap.asapplotter.asapplotter.plotgrid	(	self,
		scan = `None`,
		center = `None`,
		spacing = `None`,
		rows = `None`,
		cols = `None`
	)

Plot spectra based on direction.

Parameters:
    scan:      a scantable to plot
    center:    the grid center direction (a list) of plots in the
       unit of DIRECTION column.
       (default) the center of map region
    spacing:   a list of horizontal (R.A.) and vertical (Dec.)
       spacing in the unit of DIRECTION column.
       (default) Calculated by the extent of map region and
       the number of rows and cols to cover
    rows:      number of panels (grid points) in horizontal direction
    cols:      number of panels (grid points) in vertical direction

Note:
- Only the first IFNO, POLNO, and BEAM in the scantable will be
plotted.
- This method doesn't re-grid and average spectra in scantable. Use
asapgrid module to re-grid spectra before plotting with this method.
Only the first spectrum is plotted in case there are multiple
spectra which belong to a grid.

Definition at line 1586 of file asapplotter.py.

def asap.asapplotter.asapplotter.plotpointing	(	self,
		scan = `None`,
		outfile = `None`
	)

plot telescope pointings

Reimplemented in asap.flagplotter.flagplotter.

Definition at line 1365 of file asapplotter.py.

References asap.asapplotter.asapplotter._data, asap.asapplotter.asapplotter._margins, asap.asapplotter.asapplotter._visible, listvis_regression.array, and asap.asapplotter.asapplotter.set_margin().

def asap.asapplotter.asapplotter.plottp	(	self,
		scan = `None`
	)

Definition at line 1408 of file asapplotter.py.

References asap.asapplotter.asapplotter._assert_plotter(), asap.asapplotter.asapplotter._data, asap.asapplotter.asapplotter._margins, asap.asapplotter.asapplotter._minmaxy, asap.asapplotter.asapplotter._plottp(), asap.asapplotter.asapplotter._reset(), asap.asapplotter.asapplotter.casabar_exists(), and asap.asapplotter.asapplotter.set_margin().

def asap.asapplotter.asapplotter.print_header	(	self,
		plot = `True`,
		fontsize = `9`,
		logger = `False`,
		selstr = `''`,
		extrastr = `''`
	)

print data (scantable) header on the plot and/or logger.
To plot the header on the plot, this method should be called after
plotting spectra by the method, asapplotter.plot.
Parameters:
    plot:      whether or not print header info on the plot.
    fontsize:  header font size (valid only plot=True)
    logger:    whether or not print header info on the logger.
    selstr:    additional selection string (not verified)
    extrastr:  additional string to print at the beginning (not verified)

Definition at line 1507 of file asapplotter.py.

References asap.asapplotter.asapplotter._assert_plotter(), asap.asapplotter.asapplotter._data, asap.asapplotter.asapplotter._header_plot(), and asap.asapplotter.asapplotter._headtext.

def asap.asapplotter.asapplotter.refresh ( self )

Do a soft refresh

Definition at line 226 of file asapplotter.py.

References asap.asapplotter.asapplotter._assert_plotter().

Referenced by asap.asapplotter.asapplotter.create_mask().

def asap.asapplotter.asapplotter.save	(	self,
		filename = `None`,
		orientation = `None`,
		dpi = `None`
	)

Save the plot to a file. The known formats are 'png', 'ps', 'eps'.
Parameters:
     filename:    The name of the output file. This is optional
          and autodetects the image format from the file
          suffix. If non filename is specified a file
          called 'yyyymmdd_hhmmss.png' is created in the
          current directory.
     orientation: optional parameter for postscript only (not eps).
          'landscape', 'portrait' or None (default) are valid.
          If None is choosen for 'ps' output, the plot is
          automatically oriented to fill the page.
     dpi:         The dpi of the output non-ps plot

Definition at line 868 of file asapplotter.py.

References asap.asapplotter.asapplotter._assert_plotter().

def asap.asapplotter.asapplotter.set_abcissa	(	self,
		abcissa = `None`,
		fontsize = `None`,
		refresh = `True`
	)

Set the x-axis label of the plot. If multiple panels are plotted,
multiple labels have to be specified.
Parameters:
    abcissa:     a list of abcissa labels. None (default) let
         data determine the labels
    fontsize:    a font size of horizontal axis labels (integer)
    refresh:     True (default) or False. If True, the plot is
         replotted based on the new parameter setting(s).
         Otherwise,the parameter(s) are set without replotting.
Example:
     # two panels are visible on the plotter
     plotter.set_ordinate(['First X-Axis','Second X-Axis'])

Definition at line 644 of file asapplotter.py.

References asap.asapplotter.asapplotter._abcissa, asap.asapplotter.asapplotter._data, __casac__.calplot.calplot.plot(), asap.asapplotter.asapplotter.plot(), asap.asapgrid.asapgrid_base.plot(), asap.asaplotbase.asaplotbase.plot(), asap.asapgrid.asapgrid.plot(), __casac__.msplot.msplot.plot(), asap.asapgrid._SDGridPlotter.plot(), and asap.asapfitter.fitter.plot().

def asap.asapplotter.asapplotter.set_colors	(	self,
		colmap,
		refresh = `True`
	)

Set the colours to be used. The plotter will cycle through
these colours when lines are overlaid (stacking mode).
Parameters:
    colmap:     a list of colour names
    refresh:    True (default) or False. If True, the plot is
        replotted based on the new parameter setting(s).
        Otherwise,the parameter(s) are set without replotting.
Example:
     plotter.set_colors('red green blue')
     # If for example four lines are overlaid e.g I Q U V
     # 'I' will be 'red', 'Q' will be 'green', U will be 'blue'
     # and 'V' will be 'red' again.

Definition at line 667 of file asapplotter.py.

References asap.asapplotter.asapplotter._colormap, asap.asapplotter.asapplotter._data, __casac__.calplot.calplot.plot(), asap.asapplotter.asapplotter.plot(), asap.asapgrid.asapgrid_base.plot(), asap.asaplotbase.asaplotbase.plot(), asap.asapgrid.asapgrid.plot(), __casac__.msplot.msplot.plot(), asap.asapgrid._SDGridPlotter.plot(), and asap.asapfitter.fitter.plot().

def asap.asapplotter.asapplotter.set_data	(	self,
		scan,
		refresh = `True`
	)

Set a scantable to plot.
Parameters:
    scan:      a scantable
    refresh:   True (default) or False. If True, the plot is
       replotted based on the new parameter setting(s).
       Otherwise,the parameter(s) are set without replotting.
Note:
   The user specified masks and data selections will be reset
   if a new scantable is set. This method should be called before
   setting data selections (set_selection) and/or masks (set_mask).

Reimplemented in asap.flagplotter.flagplotter.

Definition at line 398 of file asapplotter.py.

References asap.asapplotter.asapplotter._abcunit, asap.asapplotter.asapplotter._data, asap.asapplotter.asapplotter._datamask, asap.asapplotter.asapplotter._minmaxx, asap.asapplotter.asapplotter._minmaxy, asap.asapplotter.asapplotter._reset(), __casac__.calplot.calplot.plot(), asap.asapplotter.asapplotter.plot(), asap.asapgrid.asapgrid_base.plot(), asap.asaplotbase.asaplotbase.plot(), asap.asapgrid.asapgrid.plot(), __casac__.msplot.msplot.plot(), asap.asapgrid._SDGridPlotter.plot(), and asap.asapfitter.fitter.plot().

Referenced by asap.asapplotter.asapplotter.plot(), and asap.asapplotter.asapplotter.plotgrid().

def asap.asapplotter.asapplotter.set_font	(	self,
		refresh = `True`,
		kwargs
	)

Set font properties.
Parameters:
    family:    one of 'sans-serif', 'serif', 'cursive', 'fantasy', 'monospace'
    style:     one of 'normal' (or 'roman'), 'italic'  or 'oblique'
    weight:    one of 'normal or 'bold'
    size:      the 'general' font size, individual elements can be adjusted
       seperately
    refresh:   True (default) or False. If True, the plot is
       replotted based on the new parameter setting(s).
       Otherwise,the parameter(s) are set without replotting.

Definition at line 739 of file asapplotter.py.

References asap.asapplotter.asapplotter._data, asap.asapplotter.asapplotter._fp, __casac__.calplot.calplot.plot(), asap.asapplotter.asapplotter.plot(), asap.asapgrid.asapgrid_base.plot(), asap.asaplotbase.asaplotbase.plot(), asap.asapgrid.asapgrid.plot(), __casac__.msplot.msplot.plot(), asap.asapgrid._SDGridPlotter.plot(), and asap.asapfitter.fitter.plot().

def asap.asapplotter.asapplotter.set_histogram	(	self,
		hist = `True`,
		linewidth = `None`,
		refresh = `True`
	)

Enable/Disable histogram-like plotting.
Parameters:
    hist:        True (default) or False. The fisrt default
         is taken from the .asaprc setting
         plotter.histogram
    linewidth:   a line width
    refresh:     True (default) or False. If True, the plot is
         replotted based on the new parameter setting(s).
         Otherwise,the parameter(s) are set without replotting.

Definition at line 691 of file asapplotter.py.

References asap.asapplotter.asapplotter._data, asap.asapplotter.asapplotter._hist, __casac__.calplot.calplot.plot(), asap.asapplotter.asapplotter.plot(), asap.asapgrid.asapgrid_base.plot(), asap.asaplotbase.asaplotbase.plot(), asap.asapgrid.asapgrid.plot(), __casac__.msplot.msplot.plot(), asap.asapgrid._SDGridPlotter.plot(), and asap.asapfitter.fitter.plot().

def asap.asapplotter.asapplotter.set_layout	(	self,
		rows = `None`,
		cols = `None`,
		refresh = `True`
	)

Set the multi-panel layout, i.e. how many rows and columns plots
are visible.
Parameters:
     rows:   The number of rows of plots
     cols:   The number of columns of plots
     refresh:  True (default) or False. If True, the plot is
       replotted based on the new parameter setting(s).
       Otherwise,the parameter(s) are set without replotting.
Note:
     If no argument is given, the potter reverts to its auto-plot
     behaviour.

Definition at line 486 of file asapplotter.py.

References asap.asapplotter.asapplotter._cols, asap.asapplotter.asapplotter._data, asap.asapplotter.asapplotter._rows, __casac__.calplot.calplot.plot(), asap.asapplotter.asapplotter.plot(), asap.asapgrid.asapgrid_base.plot(), asap.asaplotbase.asaplotbase.plot(), asap.asapgrid.asapgrid.plot(), __casac__.msplot.msplot.plot(), asap.asapgrid._SDGridPlotter.plot(), and asap.asapfitter.fitter.plot().

def asap.asapplotter.asapplotter.set_legend	(	self,
		mp = `None`,
		fontsize = `None`,
		mode = `0`,
		refresh = `True`
	)

Specify a mapping for the legend instead of using the default
indices:
Parameters:
    mp:        a list of 'strings'. This should have the same length
       as the number of elements on the legend and then maps
       to the indeces in order. It is possible to uses latex
       math expression. These have to be enclosed in r'',
       e.g. r'$x^{2}$'
    fontsize:  The font size of the label (default None)
    mode:      where to display the legend
       Any other value for loc else disables the legend:
        0: auto
        1: upper right
        2: upper left
        3: lower left
        4: lower right
        5: right
        6: center left
        7: center right
        8: lower center
        9: upper center
        10: center
    refresh:    True (default) or False. If True, the plot is
        replotted based on the new parameter setting(s).
        Otherwise,the parameter(s) are set without replotting.

Example:
     If the data has two IFs/rest frequencies with index 0 and 1
     for CO and SiO:
     plotter.set_stacking('i')
     plotter.set_legend(['CO','SiO'])
     plotter.plot()
     plotter.set_legend([r'$^{12}CO$', r'SiO'])

Definition at line 555 of file asapplotter.py.

References asap.asapplotter.asapplotter._data, asap.asapplotter.asapplotter._legendloc, asap.asapplotter.asapplotter._lmap, __casac__.calplot.calplot.plot(), asap.asapplotter.asapplotter.plot(), asap.asapgrid.asapgrid_base.plot(), asap.asaplotbase.asaplotbase.plot(), asap.asapgrid.asapgrid.plot(), __casac__.msplot.msplot.plot(), asap.asapgrid._SDGridPlotter.plot(), and asap.asapfitter.fitter.plot().

Referenced by asap.flagplotter.flagplotter.plot().

def asap.asapplotter.asapplotter.set_linestyles	(	self,
		linestyles = `None`,
		linewidth = `None`,
		refresh = `True`
	)

Set the linestyles to be used. The plotter will cycle through
these linestyles when lines are overlaid (stacking mode) AND
only one color has been set.
Parameters:
    linestyles:      a list of linestyles to use.
             'line', 'dashed', 'dotted', 'dashdot',
             'dashdotdot' and 'dashdashdot' are
             possible
    linewidth:       a line width
    refresh:         True (default) or False. If True, the plot is
             replotted based on the new parameter setting(s).
             Otherwise,the parameter(s) are set without replotting.
Example:
     plotter.set_colors('black')
     plotter.set_linestyles('line dashed dotted dashdot')
     # If for example four lines are overlaid e.g I Q U V
     # 'I' will be 'solid', 'Q' will be 'dashed',
     # U will be 'dotted' and 'V' will be 'dashdot'.

Definition at line 709 of file asapplotter.py.

References asap.asapplotter.asapplotter._data, asap.asapplotter.asapplotter._linestyles, __casac__.calplot.calplot.plot(), asap.asapplotter.asapplotter.plot(), asap.asapgrid.asapgrid_base.plot(), asap.asaplotbase.asaplotbase.plot(), asap.asapgrid.asapgrid.plot(), __casac__.msplot.msplot.plot(), asap.asapgrid._SDGridPlotter.plot(), and asap.asapfitter.fitter.plot().

def asap.asapplotter.asapplotter.set_margin	(	self,
		margin = `[]`,
		refresh = `True`
	)

Set margins between subplots and plot edges.
Parameters:
    margin:   a list of margins in figure coordinate (0-1),
      i.e., fraction of the figure width or height.
      The order of elements should be:
      [left, bottom, right, top, horizontal space btw panels,
      vertical space btw panels].
    refresh:  True (default) or False. If True, the plot is
      replotted based on the new parameter setting(s).
      Otherwise,the parameter(s) are set without replotting.
Note
* When margin is not specified, the values are reset to the defaults
  of matplotlib.
* If any element is set to be None, the current value is adopted.

Definition at line 760 of file asapplotter.py.

References asap.asapplotter.asapplotter._data, asap.asapplotter.asapplotter._margins, asap.asapplotter.asapplotter._reset_margin(), __casac__.calplot.calplot.plot(), asap.asapplotter.asapplotter.plot(), asap.asapgrid.asapgrid_base.plot(), asap.asaplotbase.asaplotbase.plot(), asap.asapgrid.asapgrid.plot(), __casac__.msplot.msplot.plot(), asap.asapgrid._SDGridPlotter.plot(), and asap.asapfitter.fitter.plot().

Referenced by asap.asapplotter.asapplotter.plotazel(), asap.asapplotter.asapplotter.plotgrid(), asap.asapplotter.asapplotter.plotpointing(), and asap.asapplotter.asapplotter.plottp().

def asap.asapplotter.asapplotter.set_mask	(	self,
		mask = `None`,
		selection = `None`,
		refresh = `True`
	)

Set a plotting mask for a specific polarization.
This is useful for masking out 'noise' Pangle outside a source.
Parameters:
     mask:           a mask from scantable.create_mask
     selection:      the spectra to apply the mask to.
     refresh:        True (default) or False. If True, the plot is
             replotted based on the new parameter setting(s).
             Otherwise,the parameter(s) are set without replotting.
Example:
     select = selector()
     select.setpolstrings('Pangle')
     plotter.set_mask(mymask, select)

Definition at line 890 of file asapplotter.py.

References asap.asapplotter.asapplotter._data, asap.asapplotter.asapplotter._maskselection, asap.asapplotter.asapplotter._usermask, listvis_regression.array, __casac__.calplot.calplot.plot(), asap.asapplotter.asapplotter.plot(), asap.asapgrid.asapgrid_base.plot(), asap.asaplotbase.asaplotbase.plot(), asap.asapgrid.asapgrid.plot(), __casac__.msplot.msplot.plot(), asap.asapgrid._SDGridPlotter.plot(), and asap.asapfitter.fitter.plot().

def asap.asapplotter.asapplotter.set_mode	(	self,
		stacking = `None`,
		panelling = `None`,
		refresh = `True`
	)

Set the plots look and feel, i.e. what you want to see on the plot.
Parameters:
    stacking:     tell the plotter which variable to plot
          as line colour overlays (default 'pol')
    panelling:    tell the plotter which variable to plot
          across multiple panels (default 'scan'
    refresh:      True (default) or False. If True, the plot is
          replotted based on the new parameter setting(s).
          Otherwise,the parameter(s) are set without replotting.
Note:
    Valid modes are:
 'beam' 'Beam' 'b':     Beams
 'if' 'IF' 'i':         IFs
 'pol' 'Pol' 'p':       Polarisations
 'scan' 'Scan' 's':     Scans
 'time' 'Time' 't':     Times
 'row' 'Row' 'r':       Rows
    When either 'stacking' or 'panelling' is set to 'row',
    the other parameter setting is ignored.

Definition at line 434 of file asapplotter.py.

References asap.asapplotter.asapplotter._data, __casac__.calplot.calplot.plot(), asap.asapplotter.asapplotter.plot(), asap.asapgrid.asapgrid_base.plot(), asap.asaplotbase.asaplotbase.plot(), asap.asapgrid.asapgrid.plot(), __casac__.msplot.msplot.plot(), asap.asapgrid._SDGridPlotter.plot(), and asap.asapfitter.fitter.plot().

def asap.asapplotter.asapplotter.set_ordinate	(	self,
		ordinate = `None`,
		fontsize = `None`,
		refresh = `True`
	)

Set the y-axis label of the plot. If multiple panels are plotted,
multiple labels have to be specified.
Parameters:
    ordinate:    a list of ordinate labels. None (default) let
         data determine the labels
    fontsize:    a font size of vertical axis labels (integer)
    refresh:     True (default) or False. If True, the plot is
         replotted based on the new parameter setting(s).
         Otherwise,the parameter(s) are set without replotting.
Example:
     # two panels are visible on the plotter
     plotter.set_ordinate(['First Y-Axis','Second Y-Axis'])

Definition at line 621 of file asapplotter.py.

References asap.asapplotter.asapplotter._data, asap.asapplotter.asapplotter._ordinate, __casac__.calplot.calplot.plot(), asap.asapplotter.asapplotter.plot(), asap.asapgrid.asapgrid_base.plot(), asap.asaplotbase.asaplotbase.plot(), asap.asapgrid.asapgrid.plot(), __casac__.msplot.msplot.plot(), asap.asapgrid._SDGridPlotter.plot(), and asap.asapfitter.fitter.plot().

def asap.asapplotter.asapplotter.set_panelling	(	self,
		what = `None`
	)

Set the 'panelling' mode i.e. which type of spectra should be
spread across different panels.

Reimplemented in asap.flagplotter.flagplotter.

Definition at line 467 of file asapplotter.py.

References asap.asapplotter.asapplotter._panelling, asap.asapplotter.asapplotter._reset_counters(), asap.asapplotter.asapplotter._title, and asap.asapplotter.asapplotter._translate().

def asap.asapplotter.asapplotter.set_range	(	self,
		xstart = `None`,
		xend = `None`,
		ystart = `None`,
		yend = `None`,
		refresh = `True`,
		offset = `None`
	)

Set the range of interest on the abcissa of the plot
Parameters:
    [x,y]start,[x,y]end:  The start and end points of the 'zoom' window
    refresh:  True (default) or False. If True, the plot is
      replotted based on the new parameter setting(s).
      Otherwise,the parameter(s) are set without replotting.
    offset:   shift the abcissa by the given amount. The abcissa label will
      have '(relative)' appended to it.
Note:
    These become non-sensical when the unit changes.
    use plotter.set_range() without parameters to reset

Reimplemented in asap.flagplotter.flagplotter.

Definition at line 528 of file asapplotter.py.

References asap.asapplotter.asapplotter._data, asap.asapplotter.asapplotter._minmaxx, asap.asapplotter.asapplotter._minmaxy, asap.asapplotter.asapplotter._offset, __casac__.calplot.calplot.plot(), asap.asapplotter.asapplotter.plot(), asap.asapgrid.asapgrid_base.plot(), asap.asaplotbase.asaplotbase.plot(), asap.asapgrid.asapgrid.plot(), __casac__.msplot.msplot.plot(), asap.asapgrid._SDGridPlotter.plot(), and asap.asapfitter.fitter.plot().

def asap.asapplotter.asapplotter.set_selection	(	self,
		selection = `None`,
		refresh = `True`,
		kw
	)

Parameters:
    selection:  a selector object (default unset the selection)
    refresh:    True (default) or False. If True, the plot is
        replotted based on the new parameter setting(s).
        Otherwise,the parameter(s) are set without replotting.

Definition at line 1193 of file asapplotter.py.

References asap.asapplotter.asapplotter._data, asap.asapplotter.asapplotter._get_sortstring(), asap.asapplotter.asapplotter._panelling, asap.asapfitter.fitter._selection, asap.asapplotter.asapplotter._selection, asap.asapplotter.asapplotter._stacking, __casac__.calplot.calplot.plot(), asap.asapplotter.asapplotter.plot(), asap.asapgrid.asapgrid_base.plot(), asap.asaplotbase.asaplotbase.plot(), asap.asapgrid.asapgrid.plot(), __casac__.msplot.msplot.plot(), asap.asapgrid._SDGridPlotter.plot(), and asap.asapfitter.fitter.plot().

Referenced by asap.scantable.scantable._select_copy(), asap.scantable.scantable.auto_quotient(), asap.scantable.scantable.flag_nans(), and asap.scantable.scantable.set_sourcetype().

def asap.asapplotter.asapplotter.set_stacking	(	self,
		what = `None`
	)

Set the 'stacking' mode i.e. which type of spectra should be
overlayed.

Definition at line 505 of file asapplotter.py.

References asap.asapplotter.asapplotter._lmap, asap.asapplotter.asapplotter._reset_counters(), asap.asapplotter.asapplotter._stacking, and asap.asapplotter.asapplotter._translate().

def asap.asapplotter.asapplotter.set_title	(	self,
		title = `None`,
		fontsize = `None`,
		refresh = `True`
	)

Set the title of sub-plots. If multiple sub-plots are plotted,
multiple titles have to be specified.
Parameters:
    title:      a list of titles of sub-plots.
    fontsize:   a font size of titles (integer)
    refresh:    True (default) or False. If True, the plot is
        replotted based on the new parameter setting(s).
        Otherwise,the parameter(s) are set without replotting.
Example:
     # two panels are visible on the plotter
     plotter.set_title(['First Panel','Second Panel'])

Definition at line 600 of file asapplotter.py.

References asap.asapplotter.asapplotter._data, asap.asapplotter.asapplotter._title, __casac__.calplot.calplot.plot(), asap.asapplotter.asapplotter.plot(), asap.asapgrid.asapgrid_base.plot(), asap.asaplotbase.asaplotbase.plot(), asap.asapgrid.asapgrid.plot(), __casac__.msplot.msplot.plot(), asap.asapgrid._SDGridPlotter.plot(), and asap.asapfitter.fitter.plot().