Pulsar::FluctuationSpectrumStats Class Reference

Computes statistics of the fluctuation spectrum (Fourier transform of pulse profile) More...

#include <FluctuationSpectrumStats.h>

Inheritance diagram for Pulsar::FluctuationSpectrumStats:
Pulsar::FluctSpectStats< Profile, ProfileStats > Pulsar::Algorithm Reference::Able Reference::HeapTracked

Public Member Functions

std::complex< Estimate< double > > get_baseline_variance () const
 Returns the variance of the baseline.
double get_noise_variance () const
 Returns the total variance of the noise.
Public Member Functions inherited from Pulsar::FluctSpectStats< Profile, ProfileStats >
 FluctSpectStats ()
 Default constructor.
void set_profile (const Profile *)
 Set the Profile from which statistics will be derived.
void select_profile (const Profile *)
 Set the Profile that defines the last harmonic and baseline.
void set_regions (const PhaseWeight &pulse, const PhaseWeight &baseline)
 Set the on-pulse and baseline regions.
void get_regions (PhaseWeight &on, PhaseWeight &off) const
 Set the on-pulse and baseline regions.
unsigned get_last_harmonic () const
 Return the last harmonic chosen in the on-pulse signal.
const Profileget_fourier () const
 Get the fourier transform of the last set profile.
const ProfileStatsget_real () const
 Get the real component statistics.
const ProfileStatsget_imag () const
 Get the imaginary component statistics.
void set_plan (FTransform::Plan *p)
 Set the fourier transform plan.
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

Protected Member Functions

const Profilereference (const Profile *profile)
 Extract the reference profile.
Protected Member Functions inherited from Pulsar::FluctSpectStats< Profile, ProfileStats >
virtual void preprocess (Profile *fourier_transform)
 Perform any preprocessing on fourier_transform.
void build ()
 Computes the phase bin masks.
Protected Member Functions inherited from Reference::Able
Handle__reference (bool active) const
void __dereference (bool auto_delete=true) const

Additional Inherited Members

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 Attributes inherited from Pulsar::FluctSpectStats< Profile, ProfileStats >
Reference::To< const Profileprofile
 The Profile from which statistics will be derived.
Reference::To< Profilefourier
 The Fourier transform of the profile.
Reference::To< ProfileStatsreal
 Computes the statistics of the real component.
Reference::To< ProfileStatsimag
 Computes the statistics of the imaginary component.
bool regions_set
 When, true the onpulse and baseline estimators have been selected.
PhaseWeight onpulse
PhaseWeight baseline
unsigned last_harmonic
FTransform::Planplan
 The fourier transform plan (useful in multi-threaded applications)

Detailed Description

Computes statistics of the fluctuation spectrum (Fourier transform of pulse profile)

Member Function Documentation

◆ get_baseline_variance()

std::complex< Estimate< double > > Pulsar::FluctuationSpectrumStats::get_baseline_variance ( ) const

Returns the variance of the baseline.

Returns the variance of the baseline for the specified polarization.

References Pulsar::FluctSpectStats< Profile, ProfileStats >::imag, and Pulsar::FluctSpectStats< Profile, ProfileStats >::real.

◆ reference()

const Profile * Pulsar::FluctuationSpectrumStats::reference ( const Profile * )
inlineprotectedvirtual

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

Generated using doxygen 1.14.0