Pulsar::PhaseWidth Class Reference

Calculates the pulse width in the phase domain. More...

#include <PhaseWidth.h>

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

Public Member Functions

 PhaseWidth ()
 Default constructor.
 
double get_width_turns (const Profile *profile)
 Return the width of the pulse profile in turns.
 
Phase::Value get_error () const
 
float get_fraction_of_maximum () const
 
void set_fraction_of_maximum (float)
 
TextInterface::Parserget_interface ()
 Return a text interface that can be used to configure this instance.
 
PhaseWidthclone () const
 Return a copy constructed instance of self.
 
- Public Member Functions inherited from Pulsar::WidthEstimator
virtual Phase::Value get_width (const Profile *profile)
 Return the width of the pulse profile in turns.
 
- 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
 
- Public Member Functions inherited from Pulsar::HasBaselineEstimator
 HasBaselineEstimator ()
 Default constructor.
 
 HasBaselineEstimator (const HasBaselineEstimator &)
 Copy constructor.
 
 ~HasBaselineEstimator ()
 Destructor.
 
virtual void set_baseline_estimator (ProfileWeightFunction *)
 Set the algorithm used to find the off-pulse phase bins.
 
ProfileWeightFunctionget_baseline_estimator () const
 Get the algorithm used to find the off-pulse phase bins.
 
void share (HasBaselineEstimator *other)
 Share the baseline estimator of other.
 

Additional Inherited Members

- Static Public Member Functions inherited from Pulsar::WidthEstimator
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 ()
 
- Static Public Member Functions inherited from Pulsar::HasBaselineEstimator
template<typename Child >
static void import (typename Child::Interface *)
 
- Protected Member Functions inherited from Reference::Able
Handle__reference (bool active) const
 
void __dereference (bool auto_delete=true) const
 

Detailed Description

Calculates the pulse width in the phase domain.

This default implementation of the width estimator is taken from pdv.


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

Generated using doxygen 1.8.17