Interface to a variety of useful statistics. More...

#include <Statistics.h>

Inheritance diagram for Pulsar::Statistics:
Reference::Able Pulsar::HasArchive Reference::HeapTracked

Classes

class  Interface
 Archive statistics text interface. More...

Public Member Functions

 Statistics (const Archive *=0)
 Default constructor.
 ~Statistics ()
 Destructor.
StrategySet * get_strategy () const
 Get the strategy manager owned by the Archive.
::Phase::Value get_peak () const
 Get the phase of the pulse peak.
double get_effective_duty_cycle () const
 Get the effective duty cycle.
double get_nfnr () const
 Get the Fourier-noise-to-noise ratio.
unsigned get_cal_ntrans () const
 Get the number of cal transitions.
unsigned get_nzero () const
 Get the number of profiles that have zero weight.
double get_design_effect () const
 Get Kish's design effect.
double get_2bit_dist () const
 Get the predicted level of 2-bit distortion.
PhaseWeightget_baseline ()
 Get the off-pulse baseline.
PhaseWeightget_onpulse ()
 Get the on-pulse phase bins.
PhaseWeightget_all ()
 Get all phase bins.
ProfileStatsget_stats ()
 Get the Profile statistics interface.
double get_weighted_frequency () const
 Get the weighted frequency from the Pulsar::Archive.
double get_bin_width () const
 Get the width of a phase bin in seconds.
double get_dispersive_smearing () const
 Get the dispersive smearing in the worst channel in seconds.
TextInterface::Parserget_interface ()
 Get the text interface to this.
void add_plugin (Plugin *)
 Add a plugin.
Public Member Functions inherited from Reference::Able
 Able (const Able &)
Ableoperator= (const Able &)
unsigned get_reference_count () const
Public Member Functions inherited from Reference::HeapTracked
 HeapTracked (const HeapTracked &)
HeapTrackedoperator= (const HeapTracked &)
bool __is_on_heap () const
Public Member Functions inherited from Pulsar::HasArchive
 HasArchive ()
 Default constructor.
 ~HasArchive ()
 Desctructor.
virtual void set_Archive (const Archive *)
 Set the instance.
const Archiveget_Archive () const
 Get the instance.
void set_subint (Index _isubint)
 Set the sub-integration.
Index get_subint () const
void set_chan (Index _ichan)
 Set the frequency channel.
Index get_chan () const
void set_pol (Index _ipol)
 Set the polarization.
Index get_pol () const
const Profileget_Profile () const
 Get the profile defined by the current indeces.
const Integrationget_Integration () const
 Get the sub-integration defined by the current indeces.

Static Public Member Functions

static unsigned get_instance_count ()
 Get the number of Statistics objects in existence.
Static Public Member Functions inherited from Reference::Able
static size_t get_instance_count ()
Static Public Member Functions inherited from Reference::HeapTracked
static void * operator new (size_t size, void *ptr=0)
static void operator delete (void *location, void *ptr)
static void operator delete (void *location)
static size_t get_heap_queue_size ()

Protected Member Functions

void setup_stats ()
void set_period (::Phase::HasUnit &) const
 Set the period attribute of the Phase::Value/Range/Ranges argument.
Protected Member Functions inherited from Reference::Able
Handle__reference (bool active) const
void __dereference (bool auto_delete=true) const
Protected Member Functions inherited from Pulsar::HasArchive
bool is_current () const
 Returns true when mutable profile and integration attributes are current.

Protected Attributes

Reference::To< ProfileStatsstats
std::vector< Reference::To< Plugin > > plugins
Protected Attributes inherited from Pulsar::HasArchive
Reference::To< const Archive, false > archive
Index isubint
Index ichan
Index ipol
Reference::To< const Profile, false > profile
Reference::To< const Integration, false > integration

Detailed Description

Interface to a variety of useful statistics.

Member Function Documentation

◆ get_2bit_dist()

double Pulsar::Statistics::get_2bit_dist ( ) const

Get the predicted level of 2-bit distortion.

Get the two bit distortion (or distance from theory)

References Pulsar::TwoBitStats::get_distortion(), and Pulsar::TwoBitStats::get_ndig().

Referenced by Pulsar::Statistics::Interface::Interface().

◆ get_stats()

Pulsar::ProfileStats * Pulsar::Statistics::get_stats ( )

Get the Profile statistics interface.

Get the statistics calculator.

Referenced by get_all(), get_baseline(), get_onpulse(), and Pulsar::Statistics::Interface::Interface().

◆ get_weighted_frequency()

double Pulsar::Statistics::get_weighted_frequency ( ) const

Get the weighted frequency from the Pulsar::Archive.

Get the weighted frequency of the Pulsar::Archive.

References Pulsar::get_Integration().

Referenced by Pulsar::Statistics::Interface::Interface().


The documentation for this class was generated from the following files:

Generated using doxygen 1.14.0