StokesFluctPlot.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2006 - 2015 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/More/Plotting/Pulsar/StokesFluctPlot.h
 
#ifndef __Pulsar_StokesFluctPlot_h
#define __Pulsar_StokesFluctPlot_h
 
#include "Pulsar/FluctPlot.h"
 
namespace Pulsar {
 
  class Profile;

  class StokesFluctPlot : public FluctPlot {
 
  public:

    StokesFluctPlot ();

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

    void prepare (const Archive* data);

    void draw (const Archive*);

    std::string get_ylabel (const Archive*);

    void get_profiles (const Archive*);

    void set_plot_values (const std::string& plot) { plot_values = plot; }
    std::string get_plot_values () const { return plot_values; }

    void set_signal_to_noise (const bool plot) { signal_to_noise = plot; }
    bool get_signal_to_noise () const { return signal_to_noise; }

    void set_harmonic_outliers (const bool plot)
    {
      harmonic_outliers = plot;
      if (harmonic_outliers)
        signal_to_noise = false;
    }
    bool get_harmonic_outliers () const { return harmonic_outliers; }

    void set_plot_colours (const std::string& plot) { plot_colours = plot; }
    std::string get_plot_colours () const { return plot_colours; }
 
    void set_plot_lines (const std::string& plot) { plot_lines = plot; }
    std::string get_plot_lines () const { return plot_lines; }
 
    void set_plot_last_harmonic (bool p) { plot_last_harmonic = p; }
    bool get_plot_last_harmonic () const { return plot_last_harmonic; }

    void set_plot_fluctuation_phase (bool p) { plot_fluctuation_phase = p; }
    bool get_plot_fluctuation_phase () const { return plot_fluctuation_phase; }
 
  protected:
 
    bool plot_log;
    bool signal_to_noise;
    bool harmonic_outliers;
    
    std::string plot_values;
    std::string plot_colours;
    std::string plot_lines;
 
    bool plot_last_harmonic;
    bool plot_fluctuation_phase;
    unsigned last_harmonic;
 
  };
 
}
 
#endif