Statistics.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2004 - 2016 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/More/General/Pulsar/Statistics.h
 
#ifndef __Pulsar_Statistics_h
#define __Pulsar_Statistics_h
 
#include "Pulsar/HasArchive.h"
#include "TextInterface.h"
#include "PhaseRange.h"
 
namespace Pulsar {
 
  class ProfileStats;
  class PhaseWeight;
  class StrategySet;
  
  class Statistics : public Reference::Able, public HasArchive
  {
 
  public:

    static unsigned get_instance_count ();

    Statistics (const Archive* = 0);

    ~Statistics ();

    StrategySet* get_strategy () const;

    ::Phase::Value get_peak () const;
 
    double get_effective_duty_cycle () const;

    double get_nfnr () const;

    unsigned get_cal_ntrans () const;

    unsigned get_nzero () const;

    double get_design_effect () const;

    double get_2bit_dist () const;
    
    PhaseWeight* get_baseline ();

    PhaseWeight* get_onpulse ();

    PhaseWeight* get_all ();

    ProfileStats* get_stats ();

    double get_weighted_frequency () const;

    double get_bin_width () const;

    double get_dispersive_smearing () const;

    class Interface;

    TextInterface::Parser* get_interface ();

    class Plugin;

    void add_plugin (Plugin*);
 
  protected:
 
    void setup_stats ();
    mutable Reference::To<ProfileStats> stats;
 
    mutable std::vector< Reference::To<Plugin> > plugins;

    void set_period (::Phase::HasUnit&) const;
 
  };
 
  class Statistics::Plugin : public Reference::Able
  {
  public:
 
    Plugin () { setup = false; }
 
    virtual TextInterface::Parser* get_interface () = 0;
 
    const Integration* get_Integration ()
    { return parent->get_Integration(); }
 
  protected:
    friend class Statistics;
    Reference::To<Statistics, false> parent;
    virtual void set_setup (bool flag) { setup = flag; }
    mutable bool setup;
  };
 
}
 
// standard interface constructor defined in More/General/standard_interface.C
TextInterface::Parser* standard_interface (Pulsar::Archive*);
 
// also defined in More/General/standard_interface.C
std::string process (TextInterface::Parser* interface, const std::string& txt);
 
#endif