Plot to a PGPLOT device "local" to this process. More...

#include <PGPlotterLocal.h>

Inheritance diagram for casa::PGPlotterLocal:

Public Member Functions
	PGPlotterLocal (const casacore::String &device)
	Open "device", which must be a valid PGPLOT style device, for example `/cps` for colour postscript (or `myfile.ps/cps` if you want to name the file), or `/xs` or `/xw` for and X-windows display. More...

virtual	~PGPlotterLocal ()
	The destructor closes the pgplot device. More...

virtual casacore::Record	curs (casacore::Float x, casacore::Float y)
	This is an emulated standard PGPLOT command. More...

virtual void	arro (casacore::Float x1, casacore::Float y1, casacore::Float x2, casacore::Float y2)
	Standard PGPLOT commands. More...

virtual void	ask (casacore::Bool flag)

virtual void	bbuf ()

virtual void	bin (const casacore::Vector< casacore::Float > &x, const casacore::Vector< casacore::Float > &data, casacore::Bool center)

virtual void	box (const casacore::String &xopt, casacore::Float xtick, casacore::Int nxsub, const casacore::String &yopt, casacore::Float ytick, casacore::Int nysub)

virtual void	circ (casacore::Float xcent, casacore::Float ycent, casacore::Float radius)

virtual void	conb (const casacore::Matrix< casacore::Float > &a, const casacore::Vector< casacore::Float > &c, const casacore::Vector< casacore::Float > &tr, casacore::Float blank)

virtual void	conl (const casacore::Matrix< casacore::Float > &a, casacore::Float c, const casacore::Vector< casacore::Float > &tr, const casacore::String &label, casacore::Int intval, casacore::Int minint)

virtual void	cons (const casacore::Matrix< casacore::Float > &a, const casacore::Vector< casacore::Float > &c, const casacore::Vector< casacore::Float > &tr)

virtual void	cont (const casacore::Matrix< casacore::Float > &a, const casacore::Vector< casacore::Float > &c, casacore::Bool nc, const casacore::Vector< casacore::Float > &tr)

virtual void	ctab (const casacore::Vector< casacore::Float > &l, const casacore::Vector< casacore::Float > &r, const casacore::Vector< casacore::Float > &g, const casacore::Vector< casacore::Float > &b, casacore::Float contra, casacore::Float bright)

virtual void	draw (casacore::Float x, casacore::Float y)

virtual void	ebuf ()

virtual void	env (casacore::Float xmin, casacore::Float xmax, casacore::Float ymin, casacore::Float ymax, casacore::Int just, casacore::Int axis)

virtual void	eras ()

virtual void	errb (casacore::Int dir, const casacore::Vector< casacore::Float > &x, const casacore::Vector< casacore::Float > &y, const casacore::Vector< casacore::Float > &e, casacore::Float t)

virtual void	errx (const casacore::Vector< casacore::Float > &x1, const casacore::Vector< casacore::Float > &x2, const casacore::Vector< casacore::Float > &y, casacore::Float t)

virtual void	erry (const casacore::Vector< casacore::Float > &x, const casacore::Vector< casacore::Float > &y1, const casacore::Vector< casacore::Float > &y2, casacore::Float t)

virtual void	gray (const casacore::Matrix< casacore::Float > &a, casacore::Float fg, casacore::Float bg, const casacore::Vector< casacore::Float > &tr)

virtual void	hi2d (const casacore::Matrix< casacore::Float > &data, const casacore::Vector< casacore::Float > &x, casacore::Int ioff, casacore::Float bias, casacore::Bool center, const casacore::Vector< casacore::Float > &ylims)

virtual void	hist (const casacore::Vector< casacore::Float > &data, casacore::Float datmin, casacore::Float datmax, casacore::Int nbin, casacore::Int pcflag)

virtual void	iden ()

virtual void	imag (const casacore::Matrix< casacore::Float > &a, casacore::Float a1, casacore::Float a2, const casacore::Vector< casacore::Float > &tr)

virtual void	lab (const casacore::String &xlbl, const casacore::String &ylbl, const casacore::String &toplbl)

virtual void	ldev ()

virtual casacore::Vector < casacore::Float >	len (casacore::Int units, const casacore::String &string)

virtual void	line (const casacore::Vector< casacore::Float > &xpts, const casacore::Vector< casacore::Float > &ypts)

virtual void	move (casacore::Float x, casacore::Float y)

virtual void	mtxt (const casacore::String &side, casacore::Float disp, casacore::Float coord, casacore::Float fjust, const casacore::String &text)

virtual casacore::String	numb (casacore::Int mm, casacore::Int pp, casacore::Int form)

virtual void	page ()

virtual void	panl (casacore::Int ix, casacore::Int iy)

virtual void	pap (casacore::Float width, casacore::Float aspect)

virtual void	pixl (const casacore::Matrix< casacore::Int > &ia, casacore::Float x1, casacore::Float x2, casacore::Float y1, casacore::Float y2)

virtual void	pnts (const casacore::Vector< casacore::Float > &x, const casacore::Vector< casacore::Float > &y, const casacore::Vector< casacore::Int > symbol)

virtual void	poly (const casacore::Vector< casacore::Float > &xpts, const casacore::Vector< casacore::Float > &ypts)

virtual void	pt (const casacore::Vector< casacore::Float > &xpts, const casacore::Vector< casacore::Float > &ypts, casacore::Int symbol)

virtual void	ptxt (casacore::Float x, casacore::Float y, casacore::Float angle, casacore::Float fjust, const casacore::String &text)

virtual casacore::Vector < casacore::Float >	qah ()

virtual casacore::Int	qcf ()

virtual casacore::Float	qch ()

virtual casacore::Int	qci ()

virtual casacore::Vector < casacore::Int >	qcir ()

virtual casacore::Vector < casacore::Int >	qcol ()

virtual casacore::Vector < casacore::Float >	qcr (casacore::Int ci)

virtual casacore::Vector < casacore::Float >	qcs (casacore::Int units)

virtual casacore::Int	qfs ()

virtual casacore::Vector < casacore::Float >	qhs ()

virtual casacore::Int	qid ()

virtual casacore::String	qinf (const casacore::String &item)

virtual casacore::Int	qitf ()

virtual casacore::Int	qls ()

virtual casacore::Int	qlw ()

virtual casacore::Vector < casacore::Float >	qpos ()

virtual casacore::Int	qtbg ()

virtual casacore::Vector < casacore::Float >	qtxt (casacore::Float x, casacore::Float y, casacore::Float angle, casacore::Float fjust, const casacore::String &text)

virtual casacore::Vector < casacore::Float >	qvp (casacore::Int units)

virtual casacore::Vector < casacore::Float >	qvsz (casacore::Int units)

virtual casacore::Vector < casacore::Float >	qwin ()

virtual void	rect (casacore::Float x1, casacore::Float x2, casacore::Float y1, casacore::Float y2)

virtual casacore::Float	rnd (casacore::Float x, casacore::Int nsub)

virtual casacore::Vector < casacore::Float >	rnge (casacore::Float x1, casacore::Float x2)

virtual void	sah (casacore::Int fs, casacore::Float angle, casacore::Float vent)

virtual void	save ()

virtual void	scf (casacore::Int font)

virtual void	sch (casacore::Float size)

virtual void	sci (casacore::Int ci)

virtual void	scir (casacore::Int icilo, casacore::Int icihi)

virtual void	scr (casacore::Int ci, casacore::Float cr, casacore::Float cg, casacore::Float cb)

virtual void	scrn (casacore::Int ci, const casacore::String &name)

virtual void	sfs (casacore::Int fs)

virtual void	shls (casacore::Int ci, casacore::Float ch, casacore::Float cl, casacore::Float cs)

virtual void	shs (casacore::Float angle, casacore::Float sepn, casacore::Float phase)

virtual void	sitf (casacore::Int itf)

virtual void	sls (casacore::Int ls)

virtual void	slw (casacore::Int lw)

virtual void	stbg (casacore::Int tbci)

virtual void	subp (casacore::Int nxsub, casacore::Int nysub)

virtual void	svp (casacore::Float xleft, casacore::Float xright, casacore::Float ybot, casacore::Float ytop)

virtual void	swin (casacore::Float x1, casacore::Float x2, casacore::Float y1, casacore::Float y2)

virtual void	tbox (const casacore::String &xopt, casacore::Float xtick, casacore::Int nxsub, const casacore::String &yopt, casacore::Float ytick, casacore::Int nysub)

virtual void	text (casacore::Float x, casacore::Float y, const casacore::String &text)

virtual void	unsa ()

virtual void	updt ()

virtual void	vect (const casacore::Matrix< casacore::Float > &a, const casacore::Matrix< casacore::Float > &b, casacore::Float c, casacore::Int nc, const casacore::Vector< casacore::Float > &tr, casacore::Float blank)

virtual void	vsiz (casacore::Float xleft, casacore::Float xright, casacore::Float ybot, casacore::Float ytop)

virtual void	vstd ()

virtual void	wedg (const casacore::String &side, casacore::Float disp, casacore::Float width, casacore::Float fg, casacore::Float bg, const casacore::String &label)

virtual void	wnad (casacore::Float x1, casacore::Float x2, casacore::Float y1, casacore::Float y2)

Public Member Functions inherited from casacore::PGPlotterInterface
virtual	~PGPlotterInterface ()

virtual Bool	isAttached () const
	True if it is OK to plot to this object. More...

virtual void	message (const String &text)
	This is not a standard PGPLOT command. More...

virtual void	resetPlotNumber ()
	This is not a standard PGPLOT command. More...

Static Public Member Functions
static casacore::PGPlotter	createPlotter (const casacore::String &device, casacore::uInt, casacore::uInt, casacore::uInt, casacore::uInt)
	The create function to create a casacore::PGPlotter object using a PGPlotterLocal. More...

Private Member Functions
	PGPlotterLocal (const PGPlotterLocal &)
	Undefined and inaccessible. More...

PGPlotterLocal &	operator= (const PGPlotterLocal &)

Private Attributes
int	id_p
	PGPLOT id. More...

Detailed Description

Plot to a PGPLOT device "local" to this process.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

casacore::PGPlotterInterface

Etymology

"Local" is used to denote that the actuall plotting is done by PGPLOT calls linked into this executable, as opposed to the common case where the PGPLOT calls are sent over the Glish bus to a "remote" display.

Synopsis

Generally programmers should not use this class, instead they should use casacore::PGPlotter instead.

This class make a concrete casacore::PGPlotterInterface object which calls PGPLOT directly, i.e. PGPLOT is linked into the current executable.

Example

// plot y = x*x
casacore::Vector<casacore::Float> x(100), y(100);
indgen(x);
y = x*x;
PGPlotterLocal plotter("myplot.ps/ps");
plotter.env(0, 100, 0, 100*100, 0, 0);
plotter.line(x, y);

Motivation

It might be necessary to call PGPLOT directly in some circumstances. For example, it might be too inefficient to pass a lot of Image data over the glish bus.

To Do

Add more plot calls.

Definition at line 95 of file PGPlotterLocal.h.

Constructor & Destructor Documentation

casa::PGPlotterLocal::PGPlotterLocal ( const casacore::String & device )

Open "device", which must be a valid PGPLOT style device, for example /cps for colour postscript (or myfile.ps/cps if you want to name the file), or /xs or /xw for and X-windows display.

Thrown Exceptions

An casacore::AipsError will be thrown if the underlying PGPLOT open fails for some reason.

virtual casa::PGPlotterLocal::~PGPlotterLocal ( )

virtual

The destructor closes the pgplot device.

casa::PGPlotterLocal::PGPlotterLocal ( const PGPlotterLocal & )

private

Undefined and inaccessible.

Member Function Documentation

virtual void casa::PGPlotterLocal::arro	(	casacore::Float	x1,
		casacore::Float	y1,
		casacore::Float	x2,
		casacore::Float	y2
	)

virtual

Standard PGPLOT commands.

Documentation for the individual commands can be found in the Glish manual and in the standard PGPLOT documentation which may be found at http://astro.caltech.edu/~tjp/pgplot/. The Glish/PGPLOT documentation is preferred since this interface follows it exactly (e.g. the array sizes are inferred both here and in Glish, whereas they must be passed into standard PGPLOT).

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes