PGPlotterInterface.h

Classes

PGPlotterInterface -- Abstract base class for PGPLOT style plotting. (full description)

class PGPlotterInterface

Interface

Public Members

virtual ~PGPlotterInterface()

virtual Bool isAttached() const

virtual void message(const String &text)

virtual void resetPlotNumber ()

virtual Record curs(Float x, Float y) = 0

virtual void arro(Float x1, Float y1, Float x2, Float y2) = 0

virtual void ask(Bool flag) = 0

virtual void bbuf() = 0

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

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

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

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

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

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

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

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

virtual void draw(Float x, Float y) = 0

virtual void ebuf() = 0

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

virtual void eras() = 0

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

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

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

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

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

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

virtual void iden() = 0

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

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

virtual void ldev() = 0

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

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

virtual void move(Float x, Float y) = 0

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

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

virtual void page() = 0

virtual void panl(Int ix, Int iy) = 0

virtual void pap(Float width, Float aspect) = 0

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

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

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

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

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

virtual Vector<Float> qah() = 0

virtual Int qcf() = 0

virtual Float qch() = 0

virtual Int qci() = 0

virtual Vector<Int> qcir() = 0

virtual Vector<Int> qcol() = 0

virtual Vector<Float> qcr(Int ci) = 0

virtual Vector<Float> qcs(Int units) = 0

virtual Int qfs() = 0

virtual Vector<Float> qhs() = 0

virtual Int qid() = 0

virtual String qinf(const String &item) = 0

virtual Int qitf() = 0

virtual Int qls() = 0

virtual Int qlw() = 0

virtual Vector<Float> qpos() = 0

virtual Int qtbg() = 0

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

virtual Vector<Float> qvp(Int units) = 0

virtual Vector<Float> qvsz(Int units) = 0

virtual Vector<Float> qwin() = 0

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

virtual Float rnd(Float x, Int nsub) = 0

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

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

virtual void save() = 0

virtual void scf(Int font) = 0

virtual void sch(Float size) = 0

virtual void sci(Int ci) = 0

virtual void scir(Int icilo, Int icihi) = 0

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

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

virtual void sfs(Int fs) = 0

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

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

virtual void sitf(Int itf) = 0

virtual void sls(Int ls) = 0

virtual void slw(Int lw) = 0

virtual void stbg(Int tbci) = 0

virtual void subp(Int nxsub, Int nysub) = 0

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

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

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

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

virtual void unsa() = 0

virtual void updt() = 0

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

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

virtual void vstd() = 0

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

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

Description

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

General familiarity with PGPLOT, especially of the style of the Glish/PGPLOT binding.

Etymology

PGPlotter for the plotting style, Interface because it is an abstract base class, not a concrete derived class.

Synopsis

This class represents an interface for plotting to a PGPLOT style plotting interface. In general, the differences between actual PGPLOT and this interface is:

The functions related to opening and closing are not implemented, since it is assumed the derived class constructor/destructor will handle this.
The leading "pg" is removed from the name since by being in a class there are no namespace issues.
AIPS++ array classes are used in place of raw pointers. This also obviates the need for passing in array dimensions. Similarly the subregion arguments (I1, I2, J1, J2) are left out since the array classes have their own subsectioning methods.
Output values are returned from the function

The rules are basically the same as for the Glish/PGPLOT binding, and thus the individual routines are not documented here.

Example

    void plotFunction(const PGPlotterInterface &plotter) {
        // plot y = x*x
        Vector<Float> x(100), y(100);
        indgen(x);
        y = x*x;
        plotter.env(0, 100, 0, 100*100, 0, 0);
        plotter.line(x, y);
    }

Motivation

General plotting interface for programmers, while allowing the location and form of the plot to vary.

To Do

Add the missing PGPLOT functions.
Emulate band as well as curs?

Member Description

virtual ~PGPlotterInterface()

virtual Bool isAttached() const

True if it is OK to plot to this object. This method is implemented for devices where you have to worry about devices detaching (e.g., the Glish pgplotter might be dismissed by the user). The default implementation is to always return True.

virtual void message(const String &text)

This is not a standard PGPLOT command. In the Glish/PGPLOT window, it puts a message in the message line. By default it sends it to the logger. In any event, this is intended for short helpful messages (e.g. saying which keys to press to mark a spectrum).

virtual void resetPlotNumber ()

This is not a standard PGPLOT command. It is only needed for the PGPlotterGlish class which connects to Glish/PGPLOT window This Glish object (actually a pgplotter/pgplotwidget.g) has an internal counter plot counter which needs to be reset to 0 when the process detaches from the plotter, so that the next plot on the device is the first one again. Without this, the prompting behaviour of the Glish plotter is different from native PGPLOT

virtual Record curs(Float x, Float y) = 0

This is an emulated standard PGPLOT command. It returns a record containing the fields:

    [ok=Bool, x=Float, y=Float, ch=String];
    If the remote device cannot do cursor feedback, ok==F.

The input x,y values is the "guess" for the location the user will want to pick. On some devices, the cursor will be positioned at (world coordinates) x,y.

virtual void arro(Float x1, Float y1, Float x2, Float y2) = 0
virtual void ask(Bool flag) = 0
virtual void bbuf() = 0
virtual void bin(const Vector<Float> &x, const Vector<Float> &data, Bool center) = 0
virtual void box(const String &xopt, Float xtick, Int nxsub, const String &yopt, Float ytick, Int nysub) = 0
virtual void circ(Float xcent, Float ycent, Float radius) = 0
virtual void conb(const Matrix<Float> &a, const Vector<Float> &c, const Vector<Float> &tr, Float blank) = 0
virtual void conl(const Matrix<Float> &a, Float c, const Vector<Float> &tr, const String &label, Int intval, Int minint) = 0
virtual void cons(const Matrix<Float> &a, const Vector<Float> &c, const Vector<Float> &tr) = 0
virtual void cont(const Matrix<Float> &a, const Vector<Float> &c, Bool nc, const Vector<Float> &tr) = 0
virtual void ctab(const Vector<Float> &l, const Vector<Float> &r, const Vector<Float> &g, const Vector<Float> &b, Float contra, Float bright) = 0
virtual void draw(Float x, Float y) = 0
virtual void ebuf() = 0
virtual void env(Float xmin, Float xmax, Float ymin, Float ymax, Int just, Int axis) = 0
virtual void eras() = 0
virtual void errb(Int dir, const Vector<Float> &x, const Vector<Float> &y, const Vector<Float> &e, Float t) = 0
virtual void errx(const Vector<Float> &x1, const Vector<Float> &x2, const Vector<Float> &y, Float t) = 0
virtual void erry(const Vector<Float> &x, const Vector<Float> &y1, const Vector<Float> &y2, Float t) = 0
virtual void gray(const Matrix<Float> &a, Float fg, Float bg, const Vector<Float> &tr) = 0
virtual void hi2d(const Matrix<Float> &data, const Vector<Float> &x, Int ioff, Float bias, Bool center, const Vector<Float> &ylims) = 0
virtual void hist(const Vector<Float> &data, Float datmin, Float datmax, Int nbin, Int pcflag) = 0
virtual void iden() = 0
virtual void imag(const Matrix<Float> &a, Float a1, Float a2, const Vector<Float> &tr) = 0
virtual void lab(const String &xlbl, const String &ylbl, const String &toplbl) = 0
virtual void ldev() = 0
virtual Vector<Float> len(Int units, const String &string) = 0
virtual void line(const Vector<Float> &xpts, const Vector<Float> &ypts) = 0
virtual void move(Float x, Float y) = 0
virtual void mtxt(const String &side, Float disp, Float coord, Float fjust, const String &text) = 0
virtual String numb(Int mm, Int pp, Int form) = 0
virtual void page() = 0
virtual void panl(Int ix, Int iy) = 0
virtual void pap(Float width, Float aspect) = 0
virtual void pixl(const Matrix<Int> &ia, Float x1, Float x2, Float y1, Float y2) = 0
virtual void pnts(const Vector<Float> &x, const Vector<Float> &y, const Vector<Int> symbol) = 0
virtual void poly(const Vector<Float> &xpts, const Vector<Float> &ypts) = 0
virtual void pt(const Vector<Float> &xpts, const Vector<Float> &ypts, Int symbol) = 0
virtual void ptxt(Float x, Float y, Float angle, Float fjust, const String &text) = 0
virtual Vector<Float> qah() = 0
virtual Int qcf() = 0
virtual Float qch() = 0
virtual Int qci() = 0
virtual Vector<Int> qcir() = 0
virtual Vector<Int> qcol() = 0
virtual Vector<Float> qcr(Int ci) = 0
virtual Vector<Float> qcs(Int units) = 0
virtual Int qfs() = 0
virtual Vector<Float> qhs() = 0
virtual Int qid() = 0
virtual String qinf(const String &item) = 0
virtual Int qitf() = 0
virtual Int qls() = 0
virtual Int qlw() = 0
virtual Vector<Float> qpos() = 0
virtual Int qtbg() = 0
virtual Vector<Float> qtxt(Float x, Float y, Float angle, Float fjust, const String &text) = 0
virtual Vector<Float> qvp(Int units) = 0
virtual Vector<Float> qvsz(Int units) = 0
virtual Vector<Float> qwin() = 0
virtual void rect(Float x1, Float x2, Float y1, Float y2) = 0
virtual Float rnd(Float x, Int nsub) = 0
virtual Vector<Float> rnge(Float x1, Float x2) = 0
virtual void sah(Int fs, Float angle, Float vent) = 0
virtual void save() = 0
virtual void scf(Int font) = 0
virtual void sch(Float size) = 0
virtual void sci(Int ci) = 0
virtual void scir(Int icilo, Int icihi) = 0
virtual void scr(Int ci, Float cr, Float cg, Float cb) = 0
virtual void scrn(Int ci, const String &name) = 0
virtual void sfs(Int fs) = 0
virtual void shls(Int ci, Float ch, Float cl, Float cs) = 0
virtual void shs(Float angle, Float sepn, Float phase) = 0
virtual void sitf(Int itf) = 0
virtual void sls(Int ls) = 0
virtual void slw(Int lw) = 0
virtual void stbg(Int tbci) = 0
virtual void subp(Int nxsub, Int nysub) = 0
virtual void svp(Float xleft, Float xright, Float ybot, Float ytop) = 0
virtual void swin(Float x1, Float x2, Float y1, Float y2) = 0
virtual void tbox(const String &xopt, Float xtick, Int nxsub, const String &yopt, Float ytick, Int nysub) = 0
virtual void text(Float x, Float y, const String &text) = 0
virtual void unsa() = 0
virtual void updt() = 0
virtual void vect(const Matrix<Float> &a, const Matrix<Float> &b, Float c, Int nc, const Vector<Float> &tr, Float blank) = 0
virtual void vsiz(Float xleft, Float xright, Float ybot, Float ytop) = 0
virtual void vstd() = 0
virtual void wedg(const String &side, Float disp, Float width, Float fg, Float bg, const String &label) = 0
virtual void wnad(Float x1, Float x2, Float y1, Float y2) = 0

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).