FourierSNR.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/FourierSNR.h
10 
11 #ifndef __Pulsar_FourierSNR_h
12 #define __Pulsar_FourierSNR_h
13 
14 #include "Pulsar/SNRatioEstimator.h"
15 
16 namespace Pulsar {
17 
18  class Profile;
19 
21  class FourierSNR : public SNRatioEstimator {
22 
23  public:
24 
27 
29  float get_snr (const Profile* profile);
30 
33 
35  class Interface;
36 
38  FourierSNR* clone () const;
39 
41  void set_baseline_extent (float width);
42  float get_baseline_extent () const { return baseline_extent; }
43 
44  protected:
45 
47  float baseline_extent;
48 
49  };
50 
51 }
52 
53 #endif
FourierSNR * clone() const
Return a copy constructed instance of self.
Definition: FourierSNR.C:107
float get_snr(const Profile *profile)
Return the signal to noise ratio.
Definition: FourierSNR.C:31
void set_baseline_extent(float width)
Set the fractional number of high frequencies used to calculate noise.
Definition: FourierSNR.C:21
FourierSNR()
Default constructor.
Definition: FourierSNR.C:15
Any quantity recorded as a function of pulse phase.
Definition: Profile.h:45
float baseline_extent
The fractional number of high frequencies used to calculate noise.
Definition: FourierSNR.h:52
Calculates the signal-to-noise ratio in the Fourier domain.
Definition: FourierSNR.h:26
TextInterface::Parser * get_interface()
Return a text interface that can be used to configure this instance.
Definition: FourierSNR.C:101
Profile * fourier_transform(const Profile *, FTransform::Plan *=0)
Return the forward Fourier transform of the input Profile.
Definition: Fourier.C:41
void detect(Profile *input)
Square-law detect the input complex-valued Profile.
Definition: Fourier.C:103
Defines the PSRCHIVE library.
Definition: CalSource.h:17

Generated using doxygen 1.8.17