Pulsar::WeightedFrequency Class Reference

Compute the weighted mean frequency. More...

#include <WeightedFrequency.h>

Public Member Functions
virtual	~WeightedFrequency ()
	Destructor.
double	operator() (unsigned istart, unsigned iend) const
	Return the weighted mean frequency.
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

start	the index of the first frequency to include in the mean
end	one more than the index of the last frequency

References get_frequency(), get_nindex(), get_weight(), round_to_kHz, and Pulsar::IntegrationManager::verbose.

---

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

• WeightedFrequency.h
• WeightedFrequency.C