Pulsar::WeightedFrequency Class Referenceabstract

Compute the weighted mean frequency. More...

#include <WeightedFrequency.h>

Inherited by PolnCalExtFrequency, Pulsar::WeightedFrequency::OverEpoch, and Pulsar::WeightedFrequency::OverFrequency.

Public Member Functions

virtual ~WeightedFrequency ()
 Destructor.
 
double operator() (unsigned istart, unsigned iend) const
 Return the weighted mean frequency. More...
 
virtual unsigned get_nindex () const =0
 Get the number of frequencies available.
 
virtual double get_frequency (unsigned index) const =0
 Get the frequency for the specified index.
 
virtual double get_weight (unsigned index) const =0
 Get the weight for the specified index.
 

Static Public Attributes

static Option< bool > round_to_kHz
 Round the weighted frequency to the nearest kHz.
 

Detailed Description

Compute the weighted mean frequency.

Member Function Documentation

◆ operator()()

double Pulsar::WeightedFrequency::operator() ( unsigned  istart,
unsigned  iend 
) const

Return the weighted mean frequency.

Returns
the weighted mean centre frequency (in MHz)
Parameters
startthe index of the first frequency to include in the mean
endone more than the index of the last frequency

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

Generated using doxygen 1.8.17