Pulsar::SimplePredictor Class Reference

Simple pulse phase model. More...

#include <SimplePredictor.h>

Inheritance diagram for Pulsar::SimplePredictor:
Pulsar::Predictor Reference::Able Reference::HeapTracked

Public Member Functions

 SimplePredictor (const char *filename=0)
 Default constructor.
 ~SimplePredictor ()
 Destructor.
Predictorclone () const
 Return a new, copy constructed instance of self.
Generatorgenerator () const
 Set up Generator to produce a new Predictor like self.
void insert (const Pulsar::Predictor *)
 Add the information from the supplied predictor to self.
void keep (const std::vector< MJD > &epochs)
 Keep only the components required to span the given epochs.
bool matches (const Pulsar::Predictor *) const
 Return true if reference attributes are equal.
void set_observing_frequency (long double MHz)
 Set the observing frequency at which predictions will be made.
long double get_observing_frequency () const
 Get the observing frequency at which phase and epoch are related.
Pulsar::Phase phase (const MJD &t) const
 Return the phase, given the epoch.
MJD iphase (const Pulsar::Phase &phase, const MJD *guess) const
 Return the epoch, given the phase.
long double frequency (const MJD &t) const
 Return the spin frequency, given the epoch.
Pulsar::Phase dispersion (const MJD &t, long double MHz) const
 Return the phase correction for dispersion delay.
void load (FILE *)
 Load from an open stream.
void unload (FILE *) const
 Unload to an open stream.
std::string get_name () const
 Source name.
sky_coord get_coordinates () const
 Coordinates.
double get_dispersion_measure () const
 Dispersion measure.
void set_reference_epoch (const MJD &epoch)
 Set the reference epoch.
MJD get_reference_epoch () const
 Get the reference epoch.
MJD get_reftime () const
 alias for reference epoch used by Pulsar::inverse_phase
Pulsar::Phase get_refphase () const
 reference phase is always zero; used by Pulsar::inverse_phase
double get_reffrequency () const
 spin frequency at reference epoch; used by Pulsar::inverse phase
Public Member Functions inherited from Pulsar::Predictor
virtual void load_file (const std::string &filename)
 Load from the specified file.
virtual void unload_file (const std::string &filename) const
 Unload to the specified file.
Public Member Functions inherited from Reference::Able
 Able ()
 Default constructor.
 Able (const Able &)
 Copy constructor.
Ableoperator= (const Able &)
 Assignment operator.
virtual ~Able ()
 Destructor.
unsigned get_reference_count () const
 Returns the number of references there are to this.
Public Member Functions inherited from Reference::HeapTracked
 HeapTracked ()
 Default constructor.
 HeapTracked (const HeapTracked &)
 Copy constructor.
HeapTrackedoperator= (const HeapTracked &)
 Assignment operator.
virtual ~HeapTracked ()
 Destructor.
bool __is_on_heap () const
 Return true if this instance is found in heap addresses.

Static Public Attributes

static double precision = 1e-10
 The precision of the prediction in seconds.
Static Public Attributes inherited from Pulsar::Predictor
static bool verbose = false
 Verbosity flag.

Additional Inherited Members

Public Types inherited from Pulsar::Predictor
enum  Policy { Input , Default , Ephemeris }
 Policy for creating new predictors. More...
Static Public Member Functions inherited from Pulsar::Predictor
static Configuration::Parameter< Policy > & get_policy ()
 Policy for creating new predictors.
static void children (std::vector< Reference::To< Predictor > > &)
 Factory helper creates a vector of pointers to derived class instances.
Static Public Member Functions inherited from Reference::Able
static size_t get_instance_count ()
 Returns the current number instances in existence.
Static Public Member Functions inherited from Reference::HeapTracked
static void * operator new (size_t size, void *ptr=0)
 Records the addresses of new instances allocated on the heap.
static void operator delete (void *location, void *ptr)
 Placement delete overload to match the placement new overload.
static void operator delete (void *location)
 Regular delete overload.
static size_t get_heap_queue_size ()
 Return the number of heap addresses awaiting processing.
Protected Member Functions inherited from Reference::Able
Handle__reference (bool active) const
 Add the address of a reference to this object.
void __dereference (bool auto_delete=true) const
 Remove the address of a reference to this object.

Detailed Description

Simple pulse phase model.

Member Function Documentation

◆ clone()

Pulsar::Predictor * Pulsar::SimplePredictor::clone ( ) const
virtual

Return a new, copy constructed instance of self.

Implements Pulsar::Predictor.

References SimplePredictor(), and Pulsar::Predictor::verbose.

◆ dispersion()

Pulsar::Phase Pulsar::SimplePredictor::dispersion ( const MJD & t,
long double MHz ) const
virtual

Return the phase correction for dispersion delay.

Implements Pulsar::Predictor.

◆ frequency()

long double Pulsar::SimplePredictor::frequency ( const MJD & t) const
virtual

Return the spin frequency, given the epoch.

Implements Pulsar::Predictor.

References SimplePredictor().

◆ generator()

Pulsar::Generator * Pulsar::SimplePredictor::generator ( ) const
virtual

Set up Generator to produce a new Predictor like self.

Implements Pulsar::Predictor.

◆ get_observing_frequency()

long double Pulsar::SimplePredictor::get_observing_frequency ( ) const
virtual

Get the observing frequency at which phase and epoch are related.

Implements Pulsar::Predictor.

◆ insert()

void Pulsar::SimplePredictor::insert ( const Pulsar::Predictor * from)
virtual

Add the information from the supplied predictor to self.

Implements Pulsar::Predictor.

◆ iphase()

MJD Pulsar::SimplePredictor::iphase ( const Pulsar::Phase & phase,
const MJD * guess ) const
virtual

Return the epoch, given the phase.

Implements Pulsar::Predictor.

References phase().

Referenced by phase().

◆ keep()

void Pulsar::SimplePredictor::keep ( const std::vector< MJD > & epochs)
virtual

Keep only the components required to span the given epochs.

Implements Pulsar::Predictor.

References Pulsar::Predictor::verbose.

◆ load()

void Pulsar::SimplePredictor::load ( FILE * fptr)
virtual

Load from an open stream.

Implements Pulsar::Predictor.

References Pulsar::Predictor::verbose.

Referenced by SimplePredictor().

◆ matches()

bool Pulsar::SimplePredictor::matches ( const Pulsar::Predictor * other) const
virtual

Return true if reference attributes are equal.

Add the information from the supplied predictor to self.

Implements Pulsar::Predictor.

References SimplePredictor().

◆ phase()

Pulsar::Phase Pulsar::SimplePredictor::phase ( const MJD & t) const
virtual

Return the phase, given the epoch.

Implements Pulsar::Predictor.

References iphase(), and SimplePredictor().

Referenced by iphase().

◆ set_observing_frequency()

void Pulsar::SimplePredictor::set_observing_frequency ( long double MHz)
virtual

Set the observing frequency at which predictions will be made.

Implements Pulsar::Predictor.

◆ unload()

void Pulsar::SimplePredictor::unload ( FILE * fptr) const
virtual

Unload to an open stream.

Implements Pulsar::Predictor.

References Pulsar::Predictor::verbose.


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

Generated using doxygen 1.14.0