FluctuationSpectrumStats.h
1 //-*-C++-*-
2 /***************************************************************************
3  *
4  * Copyright (C) 2023 by Willem van Straten
5  * Licensed under the Academic Free License version 2.1
6  *
7  ***************************************************************************/
8 
9 // psrchive/More/Polarimetry/Pulsar/FluctuationSpectrumStats.h
10 
11 #ifndef __Pulsar_FluctuationSpectrumStats_h
12 #define __Pulsar_FluctuationSpectrumStats_h
13 
14 #include "Pulsar/FluctSpectStats.h"
15 #include "Pulsar/ProfileStats.h"
16 #include "Pulsar/Profile.h"
17 
18 namespace Pulsar {
19 
21  class FluctuationSpectrumStats : public FluctSpectStats<Profile,ProfileStats>
22  {
23  public:
24 
26  std::complex< Estimate<double> > get_baseline_variance () const;
27 
29  double get_noise_variance () const;
30 
31  protected:
32 
33  const Profile* reference (const Profile* profile) { return profile; }
34 
35  };
36 
37 }
38 
39 #endif
40 
41 
42 
unsigned get_nbin() const
Get the number of weights in the array.
Definition: PhaseWeight.h:70
double get_noise_variance() const
Returns the total variance of the noise.
Definition: FluctuationSpectrumStats.C:25
Stores a weight for each Profile phase bin.
Definition: PhaseWeight.h:29
std::complex< Estimate< double > > get_baseline_variance() const
Returns the variance of the baseline.
Definition: FluctuationSpectrumStats.C:17
Any quantity recorded as a function of pulse phase.
Definition: Profile.h:45
Reference::To< const Profile > profile
The Profile from which statistics will be derived.
Definition: FluctSpectStats.h:70
const Profile * reference(const Profile *profile)
Extract the reference profile.
Definition: FluctuationSpectrumStats.h:43
Defines the PSRCHIVE library.
Definition: CalSource.h:17

Generated using doxygen 1.8.17