FourthMomentStats.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2009-2011 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/More/Polarimetry/Pulsar/FourthMomentStats.h
 
#ifndef __Pulsar_FourthMomentStats_h
#define __Pulsar_FourthMomentStats_h
 
#include "Pulsar/PolnProfileStats.h"
#include "Matrix.h"
 
namespace Pulsar {
 
  class Archive;
  class StokesCovariance;

  class FourthMomentStats : public PolnProfileStats {
    
  public:

    FourthMomentStats (const PolnProfile* profile = 0);

    ~FourthMomentStats();

    static void debias (Archive*, bool xcovar = true);
    
    void set_profile (const PolnProfile* _profile);
    void set_bandwidth (double bw);
    void set_duration (double T) { duration = T; }
    void set_folding_period (double P) { folding_period = P; }
 
    void set_remove_eigen_baseline (bool flag) { remove_eigen_baseline = flag; }
    bool get_remove_eigen_baseline () const { return remove_eigen_baseline; }

    Matrix< 4,4,Estimate<double> > get_covariance (unsigned ibin) const;
 
    const StokesCovariance* get_covariance () const;

    void eigen (PolnProfile* = 0, PolnProfile* = 0, PolnProfile* = 0);
 
    void smooth_eigenvectors (PolnProfile*, PolnProfile*, PolnProfile*);

    const Profile* get_eigen_value (unsigned k);

    const Profile* get_regression_coefficient (unsigned k);

    const Profile* get_natural_covariance (unsigned k);

    void separate (PolnProfile& modeA, PolnProfile& modeB);

    Reference::To<Profile> get_modulation_index();
 
    Reference::To<Profile> get_nonorthogonality() { return nonorthogonality; }
 
    Reference::To<Profile> get_sin_theta() { return sin_theta; }
    Reference::To<Profile> get_cos_theta() { return cos_theta; }
    Reference::To<Profile> get_norm_theta() { return norm_theta; }

    Estimate<double> get_moment_variance (unsigned) const;
 
  protected:
 
    Reference::To<const StokesCovariance> covariance;

    double duration;

    double folding_period;

    double bandwidth;

    bool remove_eigen_baseline;
 
    std::vector< Reference::To<Profile> > eigen_value;
    std::vector< Reference::To<Profile> > regression_coefficient;
    std::vector< Reference::To<Profile> > natural_covariance;
    Reference::To<Profile> nonorthogonality;
 
    Reference::To<Profile> sin_theta;
    Reference::To<Profile> cos_theta;
    Reference::To<Profile> norm_theta;

    mutable std::vector< Estimate<double> > moment_variance;
 
    void smooth (unsigned poln, unsigned ibin, Stokes<double>& match,
                 std::vector<PolnProfile*>& eigen_vector);
 
  };
 
}
 
 
#endif