Algorithms that estimate the width of the pulse profile. More...

#include <WidthEstimator.h>

Inheritance diagram for Pulsar::WidthEstimator:
Pulsar::Algorithm Reference::Able Reference::HeapTracked Pulsar::PhaseWidth

Public Member Functions

virtual Phase::Value get_width (const Profile *profile)
 Return the width of the pulse profile in turns.
 
virtual TextInterface::Parserget_interface ()=0
 Return a text interface that can be used to configure this instance.
 
virtual WidthEstimatorclone () const =0
 Return a copy constructed instance of self.
 
- 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 WidthEstimatorfactory (const std::string &name_and_parse)
 Construct a new WidthEstimator 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 ()
 

Protected Member Functions

virtual double get_width_turns (const Profile *profile)=0
 Derived classes must implement this method.
 
- Protected Member Functions inherited from Reference::Able
Handle__reference (bool active) const
 
void __dereference (bool auto_delete=true) const
 

Detailed Description

Algorithms that estimate the width of the pulse profile.

This pure virtual base class of PhaseWeight algorithms defines the interface by which various routines, such as baseline estimators can be accessed


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

Generated using doxygen 1.8.17