PolnProfileStats.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2005 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/More/Polarimetry/Pulsar/PolnProfileStats.h
 
#ifndef __Pulsar_PolnProfileStats_h
#define __Pulsar_PolnProfileStats_h
 
#include "Pulsar/ProfileStats.h"
#include "Stokes.h"
 
namespace Pulsar {
 
  class PolnProfile;

  class PolnProfileStats : public Algorithm {
    
  public:

    PolnProfileStats (const PolnProfile* profile = 0);

    ~PolnProfileStats();

    void set_avoid_zero_determinant (bool flag=true);

    void set_profile (const PolnProfile*);

    void select_profile (const PolnProfile*);

    void select_profile (const Profile*);

    void set_regions (const PhaseWeight& pulse, const PhaseWeight& baseline);

    void get_regions (PhaseWeight& pulse, PhaseWeight& base) const;

    ProfileStats* get_stats () { return stats; }
    const ProfileStats* get_stats () const { return stats; }

    void set_stats (ProfileStats* s) { stats = s; }

    Stokes< Estimate<double> > get_stokes (unsigned ibin) const;

    Estimate<double> get_total_intensity () const;

    Estimate<double> get_total_polarized () const;

    Estimate<double> get_total_polarized_squared () const;

    Estimate<double> get_total_squared_invariant () const;

    Estimate<double> get_total_determinant () const;

    Estimate<double> get_total_linear () const;

    Estimate<double> get_total_linear_squared () const;

    Estimate<double> get_total_circular () const;

    Estimate<double> get_total_abs_circular () const;

    Estimate<double> get_baseline_variance (unsigned ipol) const;

    Estimate<double> get_invariant () const;

    double get_linear_variance () const;

    TextInterface::Parser* get_interface ();

    class Interface;
 
  protected:

    Reference::To<const PolnProfile, false> profile;

    Reference::To<ProfileStats> stats;

    bool regions_set;

    bool avoid_zero_determinant;

    mutable Stokes< Estimate<double> > baseline_variance;

    void build ();
 
  };
 
}
 
 
#endif