ColourMap.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2004 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/More/Plotting/pgutil/ColourMap.h
 
#ifndef __ColourMap_H
#define __ColourMap_H
 
#include "Pulsar/Config.h"
#include "TextInterface.h"
#include <string>
 
namespace pgplot {

  class ColourMap : public Reference::Able {
 
  public:
    enum Name {
      GreyScale,
      Inverse,
      Heat,
      Cold,
      Plasma,
      Forest,
      AlienGlow,
      CubeHelix,
      Test
    };

    ColourMap ();
 
    ColourMap (const Name _name);

    void set_name (Name name);
    Name get_name () const { return name; }

    void set_contrast (float contrast);
    float get_contrast () const { return contrast; }

    void set_brightness (float brightness);
    float get_brightness () const { return brightness; }

    void set_logarithmic (bool log) { logarithmic = log; }
    bool get_logarithmic () const { return logarithmic; }

    void apply ();

    class Interface;
    
  protected:

    Name name;

    float contrast;

    float brightness;

    bool logarithmic;
 
  public:
 
    static Pulsar::Option<std::string> default_colour_map;
  };
 
  class ColourMap::Interface : public TextInterface::To<ColourMap> {
  public:
    Interface (ColourMap* = 0);
  };

  std::ostream& operator << (std::ostream&, ColourMap::Name);

  std::istream& operator >> (std::istream&, ColourMap::Name&);
 
 
}
#endif