casacore
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::PGPlotterNull Class Reference

More...

#include <PGPlotterNull.h>

Public Member Functions

 PGPlotterNull (const 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 ~PGPlotterNull ()
 The destructor closes the pgplot device. 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< Floatlen (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< Floatqah ()
 
virtual Int qcf ()
 
virtual Float qch ()
 
virtual Int qci ()
 
virtual Vector< Intqcir ()
 
virtual Vector< Intqcol ()
 
virtual Vector< Floatqcr (Int ci)
 
virtual Vector< Floatqcs (Int units)
 
virtual Int qfs ()
 
virtual Vector< Floatqhs ()
 
virtual Int qid ()
 
virtual String qinf (const String &item)
 
virtual Int qitf ()
 
virtual Int qls ()
 
virtual Int qlw ()
 
virtual Vector< Floatqpos ()
 
virtual Int qtbg ()
 
virtual Vector< Floatqtxt (Float x, Float y, Float angle, Float fjust, const String &text)
 
virtual Vector< Floatqvp (Int units)
 
virtual Vector< Floatqvsz (Int units)
 
virtual Vector< Floatqwin ()
 
virtual void rect (Float x1, Float x2, Float y1, Float y2)
 
virtual Float rnd (Float x, Int nsub)
 
virtual Vector< Floatrnge (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 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 PGPlotter createPlotter (const String &device, uInt, uInt, uInt, uInt)
 The create function to create a PGPlotter object using a PGPlotterNull. More...
 

Private Member Functions

 PGPlotterNull (const PGPlotterNull &)
 Undefined and inaccessible. More...
 
PGPlotterNulloperator= (const PGPlotterNull &)
 
void noplotter ()
 

Private Attributes

int id_p
 PGPLOT id. More...
 
Bool beenWarned
 

Detailed Description

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

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

"Null" is used to denote that no plotting is done

Synopsis

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

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

Example

// plot y = x*x
Vector<Float> x(100), y(100);
indgen(x);
y = x*x;
PGPlotterNull plotter("myplot.ps/ps");
plotter.env(0, 100, 0, 100*100, 0, 0);
plotter.line(x, y);
PGPlotterNull(const String &device)
Open "device", which must be a valid PGPLOT style device, for example /cps for colour postscript (or ...
void indgen(TableVector< T > &tv, T start, T inc)
Definition: TabVecMath.h:400

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

Definition at line 89 of file PGPlotterNull.h.

Constructor & Destructor Documentation

◆ PGPlotterNull() [1/2]

casacore::PGPlotterNull::PGPlotterNull ( const 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 AipsError will be thrown if the underlying PGPLOT open fails for some reason.

◆ ~PGPlotterNull()

virtual casacore::PGPlotterNull::~PGPlotterNull ( )
virtual

The destructor closes the pgplot device.

◆ PGPlotterNull() [2/2]

casacore::PGPlotterNull::PGPlotterNull ( const PGPlotterNull )
private

Undefined and inaccessible.

Member Function Documentation

◆ arro()

virtual void casacore::PGPlotterNull::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).

Implements casacore::PGPlotterInterface.

◆ ask()

virtual void casacore::PGPlotterNull::ask ( Bool  flag)
virtual

◆ bbuf()

virtual void casacore::PGPlotterNull::bbuf ( )
virtual

◆ bin()

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

◆ box()

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

◆ circ()

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

◆ conb()

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

◆ conl()

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

◆ cons()

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

◆ cont()

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

◆ createPlotter()

static PGPlotter casacore::PGPlotterNull::createPlotter ( const String device,
uInt  ,
uInt  ,
uInt  ,
uInt   
)
static

The create function to create a PGPlotter object using a PGPlotterNull.

It only uses the device argument.

◆ ctab()

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

◆ curs()

virtual Record casacore::PGPlotterNull::curs ( Float  x,
Float  y 
)
virtual

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.
float Float
Definition: aipstype.h:54
bool Bool
Define the standard types used by Casacore.
Definition: aipstype.h:42

Implements casacore::PGPlotterInterface.

◆ draw()

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

◆ ebuf()

virtual void casacore::PGPlotterNull::ebuf ( )
virtual

◆ env()

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

◆ eras()

virtual void casacore::PGPlotterNull::eras ( )
virtual

◆ errb()

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

◆ errx()

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

◆ erry()

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

◆ gray()

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

◆ hi2d()

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

◆ hist()

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

◆ iden()

virtual void casacore::PGPlotterNull::iden ( )
virtual

◆ imag()

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

◆ lab()

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

◆ ldev()

virtual void casacore::PGPlotterNull::ldev ( )
virtual

◆ len()

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

◆ line()

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

◆ move()

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

◆ mtxt()

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

◆ noplotter()

void casacore::PGPlotterNull::noplotter ( )
private

◆ numb()

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

◆ operator=()

PGPlotterNull& casacore::PGPlotterNull::operator= ( const PGPlotterNull )
private

◆ page()

virtual void casacore::PGPlotterNull::page ( )
virtual

◆ panl()

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

◆ pap()

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

◆ pixl()

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

◆ pnts()

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

◆ poly()

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

◆ pt()

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

◆ ptxt()

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

◆ qah()

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

◆ qcf()

virtual Int casacore::PGPlotterNull::qcf ( )
virtual

◆ qch()

virtual Float casacore::PGPlotterNull::qch ( )
virtual

◆ qci()

virtual Int casacore::PGPlotterNull::qci ( )
virtual

◆ qcir()

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

◆ qcol()

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

◆ qcr()

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

◆ qcs()

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

◆ qfs()

virtual Int casacore::PGPlotterNull::qfs ( )
virtual

◆ qhs()

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

◆ qid()

virtual Int casacore::PGPlotterNull::qid ( )
virtual

◆ qinf()

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

◆ qitf()

virtual Int casacore::PGPlotterNull::qitf ( )
virtual

◆ qls()

virtual Int casacore::PGPlotterNull::qls ( )
virtual

◆ qlw()

virtual Int casacore::PGPlotterNull::qlw ( )
virtual

◆ qpos()

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

◆ qtbg()

virtual Int casacore::PGPlotterNull::qtbg ( )
virtual

◆ qtxt()

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

◆ qvp()

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

◆ qvsz()

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

◆ qwin()

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

◆ rect()

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

◆ rnd()

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

◆ rnge()

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

◆ sah()

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

◆ save()

virtual void casacore::PGPlotterNull::save ( )
virtual

◆ scf()

virtual void casacore::PGPlotterNull::scf ( Int  font)
virtual

◆ sch()

virtual void casacore::PGPlotterNull::sch ( Float  size)
virtual

◆ sci()

virtual void casacore::PGPlotterNull::sci ( Int  ci)
virtual

◆ scir()

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

◆ scr()

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

◆ scrn()

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

◆ sfs()

virtual void casacore::PGPlotterNull::sfs ( Int  fs)
virtual

◆ shls()

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

◆ shs()

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

◆ sitf()

virtual void casacore::PGPlotterNull::sitf ( Int  itf)
virtual

◆ sls()

virtual void casacore::PGPlotterNull::sls ( Int  ls)
virtual

◆ slw()

virtual void casacore::PGPlotterNull::slw ( Int  lw)
virtual

◆ stbg()

virtual void casacore::PGPlotterNull::stbg ( Int  tbci)
virtual

◆ subp()

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

◆ svp()

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

◆ swin()

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

◆ tbox()

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

◆ text()

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

◆ unsa()

virtual void casacore::PGPlotterNull::unsa ( )
virtual

◆ updt()

virtual void casacore::PGPlotterNull::updt ( )
virtual

◆ vect()

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

◆ vsiz()

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

◆ vstd()

virtual void casacore::PGPlotterNull::vstd ( )
virtual

◆ wedg()

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

◆ wnad()

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

Member Data Documentation

◆ beenWarned

Bool casacore::PGPlotterNull::beenWarned
private

Definition at line 253 of file PGPlotterNull.h.

◆ id_p

int casacore::PGPlotterNull::id_p
private

PGPLOT id.

Definition at line 252 of file PGPlotterNull.h.


The documentation for this class was generated from the following file: