FluxPlot.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2006 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/More/Plotting/Pulsar/FluxPlot.h
 
#ifndef __Pulsar_FluxPlot_h
#define __Pulsar_FluxPlot_h
 
#include "Pulsar/PhasePlot.h"
#include "Pulsar/ProfileVectorPlotter.h"
#include "Pulsar/Index.h"
 
namespace Pulsar {
 
  class Profile;
  class PhaseWeight;
  class InfoLabel;

  class FluxPlot : public PhasePlot {
 
  public:

    FluxPlot ();

    ~FluxPlot ();

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

    void prepare (const Archive*);

    std::string get_ylabel (const Archive*);

    virtual void get_profiles (const Archive*) = 0;

    virtual float get_phase_error (const Archive* data);

    virtual float get_flux_error (const Profile* data);

    virtual float get_flux_maximum (const Profile* data);

    virtual void plot_error_box (const Archive* data);

    virtual void auto_scale_phase (const Profile* data, float buffer);

    void set_subint (Index _isubint) { isubint = _isubint; }
    Index get_subint () const { return isubint; }
    
    void set_chan (Index _ichan) { ichan = _ichan; }
    Index get_chan () const { return ichan; }

    void set_pol (Index _ipol) { ipol = _ipol; }
    Index get_pol () const { return ipol; }

    void set_logarithmic (int val) { logarithmic = val; }
    int get_logarithmic () const { return logarithmic; }

    void set_peak_zoom (float zoom) { peak_zoom = zoom; }
    float get_peak_zoom () const { return peak_zoom; }

    void set_baseline_zoom (float zoom) { baseline_zoom = zoom; }
    float get_baseline_zoom () const { return baseline_zoom; }

    void set_info_label (bool flag = true);
    bool get_info_label () const;

    void set_plot_error_box (int code) { plot_ebox = code; }
    int get_plot_error_box () const { return plot_ebox; }

    void set_plot_histogram (bool f = true) { plotter.plot_histogram = f; }
    bool get_plot_histogram () const { return plotter.plot_histogram; }


    void set_original_nchan (unsigned nchan) { original_nchan = nchan; }
    unsigned get_original_nchan () const { return original_nchan; }

    void draw (const Archive*);


    void plot_profile (const Profile*);

    const ProfileVectorPlotter* get_plotter () const { return &plotter; }

    void set_selection (const PhaseWeight*);
    
    void set_crop( float new_crop ) { crop = new_crop; }
    
    float get_crop() const { return crop; }
 
  protected:
 
    ProfileVectorPlotter plotter;
 
    Index isubint;
    Index ichan;
    Index ipol;
 
    int logarithmic;
 
    int plot_ebox;
    float peak_zoom;
    bool peak_centre_origin;
    float baseline_zoom;
    unsigned original_nchan;
    
    float crop;
 
    Reference::To<InfoLabel> info_label;
    Reference::To<const PhaseWeight> selection;
 
    void plot_selection ();
 
  };
 
}
 
#endif