SNRatioEstimator.h
1 //-*-C++-*-
2 /***************************************************************************
3  *
4  * Copyright (C) 2016 by Willem van Straten
5  * Licensed under the Academic Free License version 2.1
6  *
7  ***************************************************************************/
8 
9 // psrchive/More/General/Pulsar/SNRatioEstimator.h
10 
11 #ifndef __Pulsar_SNRatioEstimator_h
12 #define __Pulsar_SNRatioEstimator_h
13 
14 #include "Pulsar/Algorithm.h"
15 #include "TextInterface.h"
16 
17 namespace Pulsar {
18 
19  class Profile;
20 
22  class SNRatioEstimator : public Algorithm
23  {
24 
25  public:
26 
28  virtual float get_snr (const Profile* profile) = 0;
29 
31  virtual TextInterface::Parser* get_interface () = 0;
32 
34  virtual SNRatioEstimator* clone () const = 0;
35 
37  static SNRatioEstimator* factory (const std::string& name_and_parse);
38 
39  };
40 
41  std::ostream& operator<< (std::ostream&, SNRatioEstimator*);
42 
43  std::istream& operator>> (std::istream&, SNRatioEstimator*&);
44 
45 }
46 
47 
48 #endif // !defined __Pulsar_SNRatioEstimator_h
Pulsar::PhaseSNR
Calculates the signal-to-noise ratio using old default algorithm.
Definition: PhaseSNR.h:31
Pulsar::FortranSNR
Calculates the signal-to-noise ratio by fitting against a standard.
Definition: FortranSNR.h:27
Pulsar::SNRatioEstimator::factory
static SNRatioEstimator * factory(const std::string &name_and_parse)
Construct a new SNRatioEstimator from a string.
Definition: SNRatioEstimator.C:22
Pulsar::AdaptiveSNR
Calculates the signal-to-noise ratio using a ProfileWeightFunction.
Definition: AdaptiveSNR.h:26
Pulsar::SNRatioEstimator::get_snr
virtual float get_snr(const Profile *profile)=0
Return the signal to noise ratio.
Pulsar::FourierSNR
Calculates the signal-to-noise ratio in the Fourier domain.
Definition: FourierSNR.h:26
Pulsar::SNRatioEstimator
Algorithms that estimate the signal-to-noise ratio of pulse profiles.
Definition: SNRatioEstimator.h:27
Pulsar
Defines the PSRCHIVE library.
Definition: CalSource.h:17
Pulsar::ModularSNR
Calculates the S/N using an on-pulse and off-pulse ProfileWeightFunction.
Definition: ModularSNR.h:26
Pulsar::SquareWave
Calculates the signal-to-noise ratio using (on-off)/rms.
Definition: SquareWave.h:31
Pulsar::StandardSNR
Calculates the signal-to-noise ratio by fitting against a standard.
Definition: StandardSNR.h:27
Pulsar::SNRatioEstimator::clone
virtual SNRatioEstimator * clone() const =0
Return a copy constructed instance of self.
Pulsar::SNRatioEstimator::get_interface
virtual TextInterface::Parser * get_interface()=0
Return a text interface that can be used to configure this instance.
Generated using doxygen 1.8.17