PhaseScale.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2006 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/More/Plotting/Pulsar/PhaseScale.h
 
#ifndef __Pulsar_PhaseScale_h
#define __Pulsar_PhaseScale_h
 
#include "Pulsar/PlotScale.h"
#include "PhaseRange.h"
 
namespace Pulsar {
 
  class Archive;

  class PhaseScale : public PlotScale {
 
  public:

    PhaseScale ();
 
    // Text interface to the PhaseScale class
    class Interface : public TextInterface::To<PhaseScale> {
    public:
      Interface (PhaseScale* = 0);
    };

    void init (const Archive*);

    void get_indeces (const Archive*, unsigned& min, unsigned& max) const;

    void get_ordinates (const Archive* data, std::vector<float>& axis) const;

    std::string get_label () const;

    float get_scale (const Archive*) const;
    float get_scale (const Archive*, Phase::Unit) const;

    void set_units (Phase::Unit s) { units = s; }
    Phase::Unit get_units () const { return units; }

    void set_origin_norm (float f) { origin_norm = f; }
    float get_origin_norm () const { return origin_norm; }
 
    void set_origin (float f) { origin = f; origin_units = units; }
    float get_origin () const { return origin; }
 
  protected:

    Phase::Unit units;

    Phase::Unit origin_units;

    float origin_norm;

    float origin;
  };
}
 
#endif