PhaseSNR.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/PhaseSNR.h
10 
11 #ifndef __Pulsar_PhaseSNR_h
12 #define __Pulsar_PhaseSNR_h
13 
14 #include "Pulsar/SNRatioEstimator.h"
15 #include <vector>
16 
17 namespace Pulsar {
18 
20 
26  class PhaseSNR : public SNRatioEstimator
27  {
28 
29  public:
30 
32  float get_snr (const Profile* profile);
33 
35  TextInterface::Parser* get_interface ();
36 
38  class Interface;
39 
41  PhaseSNR* clone () const;
42 
43  };
44 
45 }
46 
47 #endif
48 
Pulsar::PhaseSNR
Calculates the signal-to-noise ratio using old default algorithm.
Definition: PhaseSNR.h:31
Pulsar::PhaseSNR::get_interface
TextInterface::Parser * get_interface()
Return a text interface that can be used to configure this instance.
Definition: PhaseSNR.C:70
Pulsar::Profile::find_min_phase
float find_min_phase(float duty_cycle=default_duty_cycle) const
Returns the phase of the centre of the region with minimum mean.
Definition: Profile_find_minmax_phase.C:21
Pulsar::Profile
Any quantity recorded as a function of pulse phase.
Definition: Profile.h:45
Pulsar::ProfileAmps::get_nbin
unsigned get_nbin() const
Return the number of bins.
Definition: ProfileAmps.h:50
Pulsar::PhaseSNR::get_snr
float get_snr(const Profile *profile)
Return the signal to noise ratio based on the shift.
Definition: PhaseSNR.C:19
Pulsar::Profile::stats
void stats(double *mean, double *variance=0, double *varmean=0, int bin_start=0, int bin_end=0) const
Calculates the mean, variance, and variance of the mean.
Definition: Profile_stats.C:27
Pulsar
Defines the PSRCHIVE library.
Definition: CalSource.h:17
Pulsar::PhaseSNR::clone
PhaseSNR * clone() const
Return a copy constructed instance of self.
Definition: PhaseSNR.C:76
Pulsar::Profile::find_peak_edges
void find_peak_edges(int &rise, int &fall) const
Find the bin numbers at which the cumulative power crosses thresholds.
Definition: Profile_find_peak_edges.C:34
Pulsar::Profile::sum
void sum(const Profile *profile)
add profile to this
Definition: Profile.C:336
Generated using doxygen 1.8.17