Standard plotting object for application programmers. More...

#include <PGPlotter.h>

Inheritance diagram for casacore::PGPlotter:

Public Types
typedef PGPlotter	CreateFunction (const String &device, uInt mincolors, uInt maxcolors, uInt sizex, uInt sizey)
	Define the signature of a function creating a PGPlotter object. More...

Public Member Functions
	PGPlotter ()
	The default constructor does not attach to any plotter, that is `isAttached()` returns False. More...

	PGPlotter (const String &device, uInt mincolors=2, uInt maxcolors=100, uInt sizex=600, uInt sizey=450)
	Create PGPlotter object using the curreent create function. More...

	PGPlotter (PGPlotterInterface *)
	Create from the given PGPlotterInterface instantiation. More...

	PGPlotter (const PGPlotter &other)
	Copies use reference semantics, i.e. More...

PGPlotter &	operator= (const PGPlotter &other)

virtual	~PGPlotter ()
	If this is the last reference, close the plot. More...

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

void	detach ()
	Detach from the object. More...

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

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

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

virtual void	ask (Bool flag)

virtual void	bbuf ()

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

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

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

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

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

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

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

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

virtual void	draw (Float x, Float y)

virtual void	ebuf ()

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

virtual void	eras ()

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

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

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

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

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

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

virtual void	iden ()

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

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

virtual void	ldev ()

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

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

virtual void	move (Float x, Float y)

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

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

virtual void	page ()

virtual void	panl (Int ix, Int iy)

virtual void	pap (Float width, Float aspect)

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

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

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

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

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

virtual Vector< Float >	qah ()

virtual Int	qcf ()

virtual Float	qch ()

virtual Int	qci ()

virtual Vector< Int >	qcir ()

virtual Vector< Int >	qcol ()

virtual Vector< Float >	qcr (Int ci)

virtual Vector< Float >	qcs (Int units)

virtual Int	qfs ()

virtual Vector< Float >	qhs ()

virtual Int	qid ()

virtual String	qinf (const String &item)

virtual Int	qitf ()

virtual Int	qls ()

virtual Int	qlw ()

virtual Vector< Float >	qpos ()

virtual Int	qtbg ()

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

virtual Vector< Float >	qvp (Int units)

virtual Vector< Float >	qvsz (Int units)

virtual Vector< Float >	qwin ()

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

virtual Float	rnd (Float x, Int nsub)

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

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

virtual void	save ()

virtual void	scf (Int font)

virtual void	sch (Float size)

virtual void	sci (Int ci)

virtual void	scir (Int icilo, Int icihi)

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

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

virtual void	sfs (Int fs)

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

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

virtual void	sitf (Int itf)

virtual void	sls (Int ls)

virtual void	slw (Int lw)

virtual void	stbg (Int tbci)

virtual void	subp (Int nxsub, Int nysub)

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

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

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

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

virtual void	unsa ()

virtual void	updt ()

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

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

virtual void	vstd ()

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

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

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

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

Static Public Member Functions
static PGPlotter	create (const String &device, uInt mincolors=2, uInt maxcolors=100, uInt sizex=600, uInt sizey=450)
	Create a PGPlotter object using the current create function. More...

static CreateFunction *	setCreateFunction (CreateFunction *, Bool override=True)
	Set the create function. More...

Private Member Functions
void	ok () const
	Throws an exception if !isAttached() More...

Private Attributes
CountedPtr< PGPlotterInterface >	worker_p

Static Private Attributes
static CreateFunction *	creator_p

Detailed Description

Standard plotting object for application programmers.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

PGPlotterInterface

Synopsis

This is the class that a programmer should instantiate if he wants to open a "device" to plot to. The device might be local, or it might be remote (i.e., running under Glish). The philosophy of the plotting interface is described in the PGPlotterInterface documentation.

It is possible that the object might not be attached to a valid plot device (for example, the user might have said "no plotting." Programerss should check the isAttached() member before plotting. If you attempt to plot to an unattached plotter, an exception is thrown.

Copying a PGPlotter uses reference semantics – after copying plotting on the old and new objects will result in the plot commands appearing on the same device. The device is closed only when the last reference is destructed.

You can detach a plotter from a device with the detach() call. If there are no other references to the plotter, this will close the device. (What it actually does is call the destructor on the object. For a local PGPPLOT device this will close it).

Example

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

To Do

Add more plot calls.

Definition at line 95 of file PGPlotter.h.

Member Typedef Documentation

typedef PGPlotter casacore::PGPlotter::CreateFunction(const String &device, uInt mincolors, uInt maxcolors, uInt sizex, uInt sizey)

Define the signature of a function creating a PGPlotter object.

Definition at line 99 of file PGPlotter.h.

Constructor & Destructor Documentation

casacore::PGPlotter::PGPlotter ( )

The default constructor does not attach to any plotter, that is isAttached() returns False.

An exception is thrown if you attempt to plot to an unattached PGPlotter.

casacore::PGPlotter::PGPlotter	(	const String &	device,
		uInt	mincolors = `2`,
		uInt	maxcolors = `100`,
		uInt	sizex = `600`,
		uInt	sizey = `450`
	)

Create PGPlotter object using the curreent create function.

casacore::PGPlotter::PGPlotter ( PGPlotterInterface * )

Create from the given PGPlotterInterface instantiation.

It takes over the pointer.

casacore::PGPlotter::PGPlotter ( const PGPlotter & other )

Copies use reference semantics, i.e.

after copying the new and old copy both draw onto the same surface.

virtual casacore::PGPlotter::~PGPlotter ( )

virtual

If this is the last reference, close the plot.

Member Function Documentation

virtual void casacore::PGPlotter::arro	(	Float	x1,
		Float	y1,
		Float	x2,
		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).

Thrown Exceptions

An AipsError will be thrown if the plotter is unattached.

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes