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
17namespace Pulsar {
18
19 class Profile;
20
23 {
24
25 public:
26
28 virtual float get_snr (const Profile* profile) = 0;
29
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
Data manipulation implementations.
Definition Algorithm.h:19
Any quantity recorded as a function of pulse phase.
Definition Profile.h:40
Algorithms that estimate the signal-to-noise ratio of pulse profiles.
Definition SNRatioEstimator.h:23
virtual SNRatioEstimator * clone() const =0
Return a copy constructed instance of self.
static SNRatioEstimator * factory(const std::string &name_and_parse)
Construct a new SNRatioEstimator from a string.
Definition SNRatioEstimator.C:22
virtual TextInterface::Parser * get_interface()=0
Return a text interface that can be used to configure this instance.
virtual float get_snr(const Profile *profile)=0
Return the signal to noise ratio.
Defines the PSRCHIVE library.
Definition CalSource.h:17

Generated using doxygen 1.14.0