/usr/include/casacore/casa/System/PGPlotter.h is in casacore-dev 2.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 | //# PGPlotter.h: Standard plotting object for application programmers.
//# Copyright (C) 1997,2000,2001
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: aips2-request@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
//#
//#
//# $Id$
#ifndef CASA_PGPLOTTER_H
#define CASA_PGPLOTTER_H
#include <casacore/casa/aips.h>
#include <casacore/casa/System/PGPlotterInterface.h>
#include <casacore/casa/Utilities/CountedPtr.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
class String;
template<class T> class Vector;
// <summary>
// Standard plotting object for application programmers.
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class="PGPlotterInterface">PGPlotterInterface</linkto>
// </prerequisite>
//
// <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
// <linkto class="PGPlotterInterface">PGPlotterInterface</linkto> 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 <src>isAttached()</src> member before plotting. If you attempt to
// plot to an unattached plotter, an exception is thrown.
//
// Copying a <src>PGPlotter</src> 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 <src>detach()</src> 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).
// </synopsis>
//
// <example>
// <srcblock>
// // 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);
// </srcblock>
// </example>
//
// <todo asof="1997/12/31">
// <li> Add more plot calls.
// </todo>
class PGPlotter : public PGPlotterInterface
{
public:
// Define the signature of a function creating a PGPlotter object.
typedef PGPlotter CreateFunction (const String &device,
uInt mincolors, uInt maxcolors,
uInt sizex, uInt sizey);
// The default constructor does not attach to any plotter, that is
// <src>isAttached()</src> returns False. An exception is thrown if you
// attempt to plot to an unattached PGPlotter.
PGPlotter();
// Create PGPlotter object using the curreent create function.
PGPlotter (const String &device,
uInt mincolors=2, uInt maxcolors=100,
uInt sizex=600, uInt sizey=450);
// Create from the given PGPlotterInterface instantiation.
// It takes over the pointer.
PGPlotter (PGPlotterInterface*);
// Copies use reference semantics, i.e. after copying the new and old
// copy both draw onto the same surface.
// <group>
PGPlotter(const PGPlotter &other);
PGPlotter &operator=(const PGPlotter &other);
// </group>
// If this is the last reference, close the plot.
virtual ~PGPlotter();
// Create a PGPlotter object using the current create function.
static PGPlotter create (const String &device,
uInt mincolors=2, uInt maxcolors=100,
uInt sizex=600, uInt sizey=450);
// Set the create function. It returns the current create function.
// It is, for example, used by ObjectController to attach to glish.
// The initial create function creates a detached PGPlotter object.
// If <src>override==False</src>, the function is only set if it was
// not already set.
static CreateFunction* setCreateFunction (CreateFunction*,
Bool override=True);
// True if it is OK to plot to this object.
virtual Bool isAttached() const;
// Detach from the object. If this is the last reference to the object,
// call its destructor (this will call pgclos on a local device).
void detach();
// 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 message(const String &text);
// This is an emulated standard PGPLOT command. It returns a record
// containing the fields:
// <srcblock>
// [ok=Bool, x=Float, y=Float, ch=String];
// If the remote device cannot do cursor feedback, ok==F.
// </srcblock>
virtual Record curs(Float x, Float y);
// 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 <src>http://astro.caltech.edu/~tjp/pgplot/</src>.
// 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>
// <li> An <linkto class="AipsError">AipsError</linkto> will be thrown
// if the plotter is unattached.
// </thrown>
// <group>
virtual void arro(Float x1, Float y1, Float x2, Float y2);
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);
// </group>
private:
CountedPtr<PGPlotterInterface> worker_p;
static CreateFunction* creator_p;
// Throws an exception if !isAttached()
void ok() const;
};
} //# NAMESPACE CASACORE - END
#endif
|