StatisticsInterface.h
1 //-*-C++-*-
2 /***************************************************************************
3  *
4  * Copyright (C) 2008 by Willem van Straten
5  * Licensed under the Academic Free License version 2.1
6  *
7  ***************************************************************************/
8 
9 // psrchive/More/General/Pulsar/StatisticsInterface.h
10 
11 #ifndef __Pulsar_StatisticsInterface_h
12 #define __Pulsar_StatisticsInterface_h
13 
14 #include "Pulsar/Statistics.h"
15 #include "TextInterface.h"
16 
17 namespace Pulsar {
18 
20  class Statistics::Interface : public TextInterface::To<Statistics>
21  {
22  public:
23 
26 
28  ~Interface();
29 
31  static unsigned get_instance_count ();
32 
33  };
34 
35 }
36 
37 
38 #endif
Interface(Statistics *=0)
Default constructor.
Definition: StatisticsInterface.C:20
double get_weighted_frequency() const
Get the weighted frequency from the Pulsar::Archive.
Definition: Statistics.C:203
double get_dispersive_smearing() const
Get the dispersive smearing in the worst channel in seconds.
Definition: Statistics.C:215
double get_2bit_dist() const
Get the predicted level of 2-bit distortion.
Definition: Statistics.C:148
virtual unsigned get_nsubint() const =0
Get the number of sub-integrations stored in the file.
~Interface()
Destructor.
Definition: StatisticsInterface.C:89
void set_chan(Index _ichan)
Set the frequency channel.
Definition: HasArchive.C:84
double get_effective_duty_cycle() const
Get the effective duty cycle.
Definition: Statistics.C:82
const Archive * get_Archive() const
Get the instance.
Definition: HasArchive.C:42
ProfileStats * get_stats()
Get the Profile statistics interface.
Definition: Statistics.C:192
void set_pol(Index _ipol)
Set the polarization.
Definition: HasArchive.C:105
static unsigned get_instance_count()
Return the number of Statistics::Interface intances in existence.
Definition: StatisticsInterface.C:18
Interface to a variety of useful statistics.
Definition: Statistics.h:30
Phase::Value get_peak() const
Get the phase of the pulse peak.
Definition: Statistics.C:60
double get_design_effect() const
Get Kish's design effect.
Definition: Statistics.C:98
double get_nfnr() const
Get the Fourier-noise-to-noise ratio.
Definition: Statistics.C:74
static unsigned verbose
A verbosity flag that can be set for debugging purposes.
Definition: IntegrationManager.h:38
void set_subint(Index _isubint)
Set the sub-integration.
Definition: HasArchive.C:62
Profile statistics text interface.
Definition: ProfileStatsInterface.h:25
double get_bin_width() const
Get the width of a phase bin in seconds.
Definition: Statistics.C:209
Defines the PSRCHIVE library.
Definition: CalSource.h:17
Computes pulse profile statistics.
Definition: ProfileStats.h:35
unsigned get_nzero() const
Get the number of profiles that have zero weight.
Definition: Statistics.C:126
unsigned get_cal_ntrans() const
Get the number of cal transitions.
Definition: Statistics.C:91

Generated using doxygen 1.8.17