Pulsar::PolnSpectrumStats Class Reference

Computes statistics of full-polarization fluctuation spectra. More...

#include <PolnSpectrumStats.h>

Inheritance diagram for Pulsar::PolnSpectrumStats:
Pulsar::FluctSpectStats< PolnProfile, PolnProfileStats > Pulsar::Algorithm Reference::Able Reference::HeapTracked

Public Member Functions

Stokes< std::complex< Estimate< double > > > get_stokes (unsigned) const
 Get the Stokes parameters for the specified harmonic.
Estimate< double > get_total_squared_invariant () const
 Returns the total squared invariant of the on-pulse phase bins.
std::complex< Estimate< double > > get_baseline_variance (unsigned) const
 Returns the variance of the baseline for the specified polarization.
Public Member Functions inherited from Pulsar::FluctSpectStats< PolnProfile, PolnProfileStats >
 FluctSpectStats ()
 Default constructor.
void set_profile (const PolnProfile *)
 Set the Profile from which statistics will be derived.
void select_profile (const PolnProfile *)
 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 PolnProfileget_fourier () const
 Get the fourier transform of the last set profile.
const PolnProfileStatsget_real () const
 Get the real component statistics.
const PolnProfileStatsget_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

void preprocess (PolnProfile *)
 Ensure that the PolnProfile is in the Stokes state.
const Profilereference (const PolnProfile *profile)
 Return the total intensity profile.
Protected Member Functions inherited from Pulsar::FluctSpectStats< PolnProfile, PolnProfileStats >
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< PolnProfile, PolnProfileStats >
Reference::To< const PolnProfileprofile
 The Profile from which statistics will be derived.
Reference::To< PolnProfilefourier
 The Fourier transform of the profile.
Reference::To< PolnProfileStatsreal
 Computes the statistics of the real component.
Reference::To< PolnProfileStatsimag
 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 full-polarization fluctuation spectra.

Member Function Documentation

◆ preprocess()

void Pulsar::PolnSpectrumStats::preprocess ( PolnProfile * fourier)
protectedvirtual

◆ reference()

const Profile * Pulsar::PolnSpectrumStats::reference ( const PolnProfile * profile)
inlineprotectedvirtual

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

Generated using doxygen 1.14.0