source: tags/release-1.1/src/Utils/mycpgplot.hh @ 1323

// -----------------------------------------------------------------------
// mycpgplot.hh: Enumerations, shortcuts and other useful functions
//               for use with PGPLOT.
// -----------------------------------------------------------------------
// Copyright (C) 2006, Matthew Whiting, ATNF
//
// This program is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the
// Free Software Foundation; either version 2 of the License, or (at your
// option) any later version.
//
// Duchamp 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 General Public License
// for more details.
//
// You should have received a copy of the GNU General Public License
// along with Duchamp; if not, write to the Free Software Foundation,
// Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA
//
// Correspondence concerning Duchamp may be directed to:
//    Internet email: Matthew.Whiting [at] atnf.csiro.au
//    Postal address: Dr. Matthew Whiting
//                    Australia Telescope National Facility, CSIRO
//                    PO Box 76
//                    Epping NSW 1710
//                    AUSTRALIA
// -----------------------------------------------------------------------
#ifndef MYCPGPLOT_H
#define MYCPGPLOT_H
#include <string>
#include <cpgplot.h>

// The following are in pgplot_related.c
//
/** Is a PGPLOT device open? */
extern "C" int  cpgtest();

/** Is a PGPLOT device a postscript (hardcopy) device? */ 
extern "C" int  cpgIsPS(); 

/** Do a logarithmic-scaled wedge, as in PGWEDG */
extern "C" void cpgwedglog(const char* side, float disp, float width, 
                           float fg, float bg, const char *label);

/** Do CPGHIST but with the y-axis logarithmic */
extern "C" void cpghistlog(int npts, float *data, float datamin, 
                           float datamax, int nbin, int pgflag);

/** Do a PGPLOT cumulative distribution */
extern "C" void cpgcumul(int npts, float *data, float datamin, 
                         float datamax, int pgflag);

//--------------------
/**
 * A namespace that holds definitions and basic functions to aid the
 * use of PGPLOT.
 */

namespace mycpgplot
{
  /** Enumerated PGPLOT colour names. */
  enum COLOUR {BACKGND=0, FOREGND, RED, GREEN, BLUE, CYAN, 
               MAGENTA, YELLOW, ORANGE, GREENYELLOW, GREENCYAN, BLUECYAN, 
               BLUEMAGENTA, REDMAGENTA, DARKGREY, LIGHTGREY, DARKGREEN};

  /** Enumerated colour names for the inverse case, such as for /xs devices.*/
  enum INVERSE {XS_BLACK, XS_WHITE};

  /** 
   * Define the DARKGREEN colour, with RGB value of (0,0.7,0).
   */
  inline void setDarkGreen(){cpgscr(DARKGREEN,0.,0.7,0.);};

  /**
   * A device independent way to set the colour to white.
   *
   * Uses cpgIsPS() to determine whether a device is a postscript
   * one. If so, we use the BACKGND colour (ie. 0), otherwise use
   * FOREGND (1).
   */
  inline void setWhite(){
    if(cpgIsPS()) cpgsci(BACKGND);
    else cpgsci(FOREGND);
  };

  /**
   * A device independent way to set the colour to black.
   *
   * Uses cpgIsPS() to determine whether a device is a postscript
   * one. If so, we use the FOREGND colour (ie. 1), otherwise use
   * BACKGND (0).
   */
  inline void setBlack(){
    if(cpgIsPS()) cpgsci(FOREGND);
    else cpgsci(BACKGND);
  };

  /** Enumerated PGPLOT line styles. */
  enum LINESTYLE {FULL=1, DASHED, DASHDOT, DOTTED, DASHDOT3};

  /** Enumerated PGPLOT area fill styles. */
  enum FILLSTYLE {SOLID=1, OUTLINE, HATCHED, CROSSHATCHED};

  /** Enumerated PGPLOT plotting symbols. */
  enum SYMBOLS {SOLIDPENT=-5, SOLIDDIAMOND, DOT=1, PLUS, ASTERISK, 
                CIRCLE, CROSS, SQUARE, TRIANGLE, OPLUS, ODOT, FOURSTAR,
                DIAMOND, STAR, SOLIDTRIANGLE, OPENPLUS, DAVID, 
                SOLIDSQUARE, SOLIDCIRCLE, SOLIDSTAR, LARGESQUARE,
                CIRCLE1, CIRCLE2, CIRCLE3, CIRCLE4, CIRCLE5, CIRCLE6,
                CIRCLE7, CIRCLE8, LEFT, RIGHT, UP, DOWN};

  enum FONTS {NORMAL=1, ROMAN, ITALIC, SCRIPT};

  const std::string degrees="\\(0718)";   ///< The degrees symbol: \f$^\circ\f$
  const std::string plusminus="\\(2233)"; ///< The plus-minus symbol: \f$\pm\f$
  const std::string times="\\(2235)";     ///< Similar to \f$\times\f$
  const std::string tick="\\(2267)";      ///< A tick, which is good for square roots: similar to \f$\surd\f$
  const std::string odot="\\(2281)";      ///< \f$\odot\f$
  const std::string integral="\\(2268)";  ///< The integral symbol \f$\int\f$

}


#endif