ScalarTemplateMatching.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2003 - 2023 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/More/Polarimetry/Pulsar/ScalarTemplateMatching.h
 
#ifndef __Pulsar_ScalarTemplateMatching_h
#define __Pulsar_ScalarTemplateMatching_h
 
#include "Pulsar/PhaseWeight.h"
#include "FTransformAgent.h"
#include "toa.h"
 
namespace Pulsar
{
  class Profile;
  class FluctuationSpectrumStats;


 
  class ScalarTemplateMatching : public Reference::Able
  {
    ScalarTemplateMatching (const ScalarTemplateMatching& fit);

    ScalarTemplateMatching& operator = (const ScalarTemplateMatching& fit);

    ScalarTemplateMatching* clone () const;
 
  public:

    static bool verbose;

    ScalarTemplateMatching ();

    ~ScalarTemplateMatching ();

    void set_standard (const Profile* standard);

    const Profile* get_standard () const;

    void add_observation ( const Profile* );

    void set_observation ( const Profile* );

    void delete_observations ();

    void fit (const Profile* observation);

    void solve ();

    Estimate<double> get_phase () const;

    Estimate<double> get_scale () const;

    void set_maximum_harmonic (unsigned max);

    unsigned get_maximum_harmonic () const { return maximum_harmonic; }

    void set_choose_maximum_harmonic (bool flag);

    bool get_choose_maximum_harmonic () const { return choose_maximum_harmonic; }

    unsigned get_nharmonic () const { return n_harmonic; }

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

    void set_plan (FTransform::Plan*);

    void set_compute_reduced_chisq (bool flag) { compute_reduced_chisq = flag; }

    double get_reduced_chisq () const;
 
  protected:

    Reference::To<FluctuationSpectrumStats> stats;

    unsigned maximum_harmonic;

    bool choose_maximum_harmonic;

    unsigned n_harmonic;


    bool compute_reduced_chisq;

    class Data;

    std::vector<Data> data;

    void init ();

    void model_profile ();
 
    Estimate<double> best_shift;
    Estimate<double> best_scale;
 
    double chisq;
    unsigned nfree;
 
  private:

    bool regions_set;
 
  };
 
  class ScalarTemplateMatching::Data
  {
  public: 
    void set_stats (FluctuationSpectrumStats*);
    FluctuationSpectrumStats* get_stats ();
 
    void set_standard (const Profile*);
    const Profile* get_standard () const;
    const Profile* get_standard_fourier () const;
 
    void set_observation (const Profile*);
    const Profile* get_observation () const;
    const Profile* get_observation_fourier () const;

    double get_residual_variance (double scale) const;
 
  protected:

    Reference::To<FluctuationSpectrumStats> stats;
 
    class ProfileData
    {
    public: 
      ProfileData() { variance = 0.0; }

      Reference::To<const Profile> profile;

      Reference::To<const Profile> fourier;

      double variance;
 
    }; // class ProfileData
 
    ProfileData standard;
    ProfileData observation;
 
  }; // class ScalarTemplateMatching::Data
 
} // namespace Pulsar
 
#endif