Pulsar::Flux Class Referenceabstract

Computes average flux of a Profile. More...

#include <Flux.h>

Inheritance diagram for Pulsar::Flux:
Pulsar::Algorithm Reference::Able Reference::HeapTracked Pulsar::StandardFlux

Public Member Functions

 Flux ()
 Default constructor.
 ~Flux ()
 Destructor.
Estimate< double > operator() (const Profile *p)
 Return flux.
virtual Estimate< double > get_flux (const Profile *p)=0
 Return flux w/ uncertainty.
virtual std::string get_method () const
 Return name of flux algorithm.
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

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 ()
Protected Member Functions inherited from Reference::Able
Handle__reference (bool active) const
void __dereference (bool auto_delete=true) const

Detailed Description

Computes average flux of a Profile.

Virtual base class, different algorithms implemented by descendents. NOTE this class is very similar to the algorithms currently used by the various S/N estimators, it may be possible to merge the code.

Member Function Documentation

◆ get_flux()

virtual Estimate< double > Pulsar::Flux::get_flux ( const Profile * p)
pure virtual

Return flux w/ uncertainty.

Implemented in Pulsar::StandardFlux.

Referenced by operator()().

◆ get_method()

virtual std::string Pulsar::Flux::get_method ( ) const
inlinevirtual

Return name of flux algorithm.

Reimplemented in Pulsar::StandardFlux.


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

Generated using doxygen 1.14.0