Commmon statistics that can be derived from an Archive. More...

#include <ArchiveStatistic.h>

Inheritance diagram for Pulsar::ArchiveStatistic:
Pulsar::HasArchive

Public Member Functions

 ArchiveStatistic (const std::string &name, const std::string &description)
 Construct with a name and description.
 
virtual double get ()=0
 Derived types define the value returned.
 
virtual TextInterface::Parserget_interface ()=0
 Return a text interface that can be used to configure this instance.
 
virtual ArchiveStatisticclone () const =0
 Derived types must also define clone method.
 
virtual void set_file (FILE *f)
 Set the file to which auxiliary data will be printed.
 
virtual void fclose ()
 Close the file to which auxiliary data were printed.
 
- 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. More...
 
Index get_subint () const
 
void set_chan (Index _ichan)
 Set the frequency channel. More...
 
Index get_chan () const
 
void set_pol (Index _ipol)
 Set the polarization. More...
 
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 ArchiveStatisticfactory (const std::string &name)
 Create a new instance of ArchiveStatistic based on name.
 

Protected Member Functions

 ArchiveStatistic ()
 Construct without a name and description. More...
 
- Protected Member Functions inherited from Pulsar::HasArchive
bool is_current () const
 Returns true when mutable profile and integration attributes are current.
 

Protected Attributes

FILE * fptr
 File to which auxiliary data will be printed.
 
- 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

Commmon statistics that can be derived from an Archive.

Each statistic can be computed as a function of sub-integration, frequency-channel, and polarization

Constructor & Destructor Documentation

◆ ArchiveStatistic()

Pulsar::ArchiveStatistic::ArchiveStatistic ( )
protected

Construct without a name and description.

Available only to derived classes


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

Generated using doxygen 1.8.17