Algorithms that estimate pulse phase shifts. More...

#include <ShiftEstimator.h>

Inheritance diagram for Pulsar::ShiftEstimator:
Pulsar::Algorithm Reference::Able Reference::HeapTracked Pulsar::PolnProfileShiftEstimator Pulsar::ProfileShiftEstimator Pulsar::RotatingVectorModelShift Pulsar::ComponentModel Pulsar::FluxCentroid Pulsar::MeanPhase Pulsar::ProfileStandardShift Pulsar::FourierDomainFit Pulsar::GaussianShift Pulsar::ParIntShift Pulsar::PhaseGradShift Pulsar::SincInterpShift Pulsar::ZeroPadShift

Public Member Functions

virtual Estimate< double > get_shift () const =0
 Return the shift estimate.
 
virtual double get_reduced_chisq () const
 Return the statistical goodness of fit.
 
virtual double get_snr () const
 Return the profile S/N ratio.
 
virtual TextInterface::Parserget_interface ()=0
 Return a text interface that can be used to configure this instance.
 
virtual ShiftEstimatorclone () const =0
 Return a copy constructed instance of self.
 
virtual std::string get_name () const
 Return a name that can be subsituted for the template/standard.
 
virtual void preprocess (Archive *)
 Prepare the data for use. More...
 
- 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
 

Static Public Member Functions

static ShiftEstimatorfactory (const std::string &name_and_parse)
 Construct a new ShiftEstimator from a string.
 
- 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 ()
 

Static Public Attributes

static bool verbose = false
 

Additional Inherited Members

- Protected Member Functions inherited from Reference::Able
Handle__reference (bool active) const
 
void __dereference (bool auto_delete=true) const
 

Detailed Description

Algorithms that estimate pulse phase shifts.

Member Function Documentation

◆ preprocess()

void Pulsar::ShiftEstimator::preprocess ( Archive archive)
virtual

Prepare the data for use.

Most estimators work with total intensity

Reimplemented in Pulsar::RotatingVectorModelShift.

References Signal::Stokes.


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

Generated using doxygen 1.8.17