SquareWave.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2004 - 2016 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/More/General/Pulsar/SquareWave.h
 
#ifndef __Pulsar_SquareWave_h
#define __Pulsar_SquareWave_h
 
#include "Pulsar/Config.h"
#include "Pulsar/SNRatioEstimator.h"
#include "Estimate.h"
 
namespace Pulsar {
 
  class Profile;
  class Integration;
  class PhaseWeight;
  

  class SquareWave : public SNRatioEstimator {
 
  public:

    static Option<float> transition_phase;

    SquareWave ();
    
    float get_snr (const Profile* profile);

    TextInterface::Parser* get_interface ();

    class Interface;

    SquareWave* clone () const;

    void get_transitions (const Profile* profile,
                          std::vector<unsigned>& up,
                          std::vector<unsigned>& down);

    unsigned count_transitions (const Profile* profile);
 
    void levels (const Integration* subint,
                 std::vector<std::vector<Estimate<double> > >& high,
                 std::vector<std::vector<Estimate<double> > >& low);

    PhaseWeight* get_mask (const Profile*, bool on, int start, int low);

    void set_risetime (float turns) { risetime = turns; }

    float get_risetime () const { return risetime; }

    void set_threshold (float turns) { threshold = turns; }

    float get_threshold () const { return threshold; }

    void set_outlier_threshold (float f) { outlier_threshold = f; }

    float get_outlier_threshold () const { return outlier_threshold; }
 
    bool verbose;
    
  protected:
 
    float risetime;
    float threshold;
    unsigned use_nbin;
    float outlier_threshold;
  };
 
}
 
#endif