Pulsar::FluctSpectStats< ProfileType, ProfileStatsType > Class Template Referenceabstract

Manages statistics of fluctuation spectra (Fourier transform of pulse profile) More...

#include <FluctSpectStats.h>

Inheritance diagram for Pulsar::FluctSpectStats< ProfileType, ProfileStatsType >:
Pulsar::Algorithm Reference::Able Reference::HeapTracked

Public Member Functions

 FluctSpectStats ()
 Default constructor.
 
void set_profile (const ProfileType *)
 Set the Profile from which statistics will be derived.
 
void select_profile (const ProfileType *)
 Set the Profile that defines the last harmonic and baseline. More...
 
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 ProfileType * get_fourier () const
 Get the fourier transform of the last set profile.
 
const ProfileStatsType * get_real () const
 Get the real component statistics.
 
const ProfileStatsType * get_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

virtual void preprocess (ProfileType *fourier_transform)
 Perform any preprocessing on fourier_transform.
 
virtual const Profilereference (const ProfileType *)=0
 Extract the reference profile.
 
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
 

Protected Attributes

Reference::To< const ProfileType > profile
 The Profile from which statistics will be derived.
 
Reference::To< ProfileType > fourier
 The Fourier transform of the profile.
 
Reference::To< ProfileStatsType > real
 Computes the statistics of the real component.
 
Reference::To< ProfileStatsType > imag
 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)
 

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 ()
 

Detailed Description

template<class ProfileType, class ProfileStatsType>
class Pulsar::FluctSpectStats< ProfileType, ProfileStatsType >

Manages statistics of fluctuation spectra (Fourier transform of pulse profile)

Member Function Documentation

◆ select_profile()

template<class ProfileType , class ProfileStatsType >
void Pulsar::FluctSpectStats< ProfileType, ProfileStatsType >::select_profile ( const ProfileType *  _profile)

Set the Profile that defines the last harmonic and baseline.

Set the Profile from which baseline and onpulse mask will be selected.

It is assumed that all subsequent Profile instances passed to set_profile will have the same phase as set_profile

Referenced by Pulsar::PulsarCalibrator::set_standard().


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

Generated using doxygen 1.8.17