Pulsar::FluxCentroid Class Reference

Estimates phase shift using the flux "centre of mass". More...

#include <FluxCentroid.h>

Inheritance diagram for Pulsar::FluxCentroid:
Pulsar::ProfileShiftEstimator Pulsar::ShiftEstimator Pulsar::Algorithm Reference::Able Reference::HeapTracked

Public Member Functions

 FluxCentroid ()
 Default constructor.
 
Estimate< double > get_shift () const
 Return the shift estimate.
 
void set_duty_cycle (float dc)
 Set the duty cycle over which flux will be integrated.
 
float get_duty_cycle () const
 
TextInterface::Parserget_interface ()
 Return a text interface that can be used to configure this instance.
 
FluxCentroidclone () const
 Return a copy constructed instance of self.
 
- Public Member Functions inherited from Pulsar::ProfileShiftEstimator
void set_observation (const Profile *p)
 Set the profile from which the shift will be estimated.
 
const Profileget_observation () const
 Get the profile from which the shift will be estimated.
 
- Public Member Functions inherited from Pulsar::ShiftEstimator
virtual double get_reduced_chisq () const
 Return the statistical goodness of fit.
 
virtual double get_snr () const
 Return the profile S/N ratio.
 
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
 

Protected Attributes

float duty_cycle
 Duty cycle of pulse, over which flux will be integrated.
 
- Protected Attributes inherited from Pulsar::ProfileShiftEstimator
Reference::To< const Profileobservation
 

Additional Inherited Members

- Static Public Member Functions inherited from Pulsar::ShiftEstimator
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 inherited from Pulsar::ShiftEstimator
static bool verbose = false
 
- Protected Member Functions inherited from Reference::Able
Handle__reference (bool active) const
 
void __dereference (bool auto_delete=true) const
 

Detailed Description

Estimates phase shift using the flux "centre of mass".


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

Generated using doxygen 1.8.17