AdaptiveSNR.h
1 //-*-C++-*-
2 /***************************************************************************
3  *
4  * Copyright (C) 2004 - 2016 by Willem van Straten
5  * Licensed under the Academic Free License version 2.1
6  *
7  ***************************************************************************/
8 
9 // psrchive/More/General/Pulsar/AdaptiveSNR.h
10 
11 #ifndef __Pulsar_AdaptiveSNR_h
12 #define __Pulsar_AdaptiveSNR_h
13 
14 #include "Pulsar/SNRatioEstimator.h"
15 
16 namespace Pulsar {
17 
18  class ProfileWeightFunction;
19 
21  class AdaptiveSNR : public SNRatioEstimator {
22 
23  public:
24 
27 
29  ~AdaptiveSNR ();
30 
33 
34  ProfileWeightFunction* get_baseline_estimator () const;
35 
37  float get_snr (const Profile* profile);
38 
41 
43  class Interface;
44 
46  AdaptiveSNR* clone () const;
47 
48  protected:
49 
52 
53  };
54 
55 }
56 
57 #endif
~AdaptiveSNR()
Destructor.
Definition: AdaptiveSNR.C:23
Any quantity recorded as a function of pulse phase.
Definition: Profile.h:45
unsigned get_nbin() const
Return the number of bins.
Definition: ProfileAmps.h:50
AdaptiveSNR * clone() const
Return a copy constructed instance of self.
Definition: AdaptiveSNR.C:105
Calculates the signal-to-noise ratio using a ProfileWeightFunction.
Definition: AdaptiveSNR.h:26
Reference::To< ProfileWeightFunction > baseline_estimator
The function used to compute the baseline.
Definition: AdaptiveSNR.h:56
float get_snr(const Profile *profile)
Return the signal to noise ratio.
Definition: AdaptiveSNR.C:44
PhaseWeight algorithms that receive an input Profile.
Definition: ProfileWeightFunction.h:26
TextInterface::Parser * get_interface()
Return a text interface that can be used to configure this instance.
Definition: AdaptiveSNR.C:99
AdaptiveSNR()
Default constructor.
Definition: AdaptiveSNR.C:18
PhaseWeight * baseline() const
Return a new PhaseWeight instance with the baseline phase bins masked.
Definition: Profile_baseline.C:15
Defines the PSRCHIVE library.
Definition: CalSource.h:17
void set_baseline_estimator(ProfileWeightFunction *function)
Set the function used to compute the baseline.
Definition: AdaptiveSNR.C:29
void sum(const Profile *profile)
add profile to this
Definition: Profile.C:336

Generated using doxygen 1.8.17