Tempo2::Predictor Class Reference

Functions that predict pulse phase. More...

#include <T2Predictor.h>

Inheritance diagram for Tempo2::Predictor:

Public Member Functions
	Predictor ()
	Default constructor.
	Predictor (const Predictor &)
	Copy constructor.
	~Predictor ()
	Destructor.
Pulsar::Predictor *	clone () const
	Return a new, copy constructed instance of self.
Pulsar::Generator *	generator () const
	Return a new Generator set up to produce a new Predictor like self.
unsigned	get_time_ncoeff () const
	Get the number of time coefficients.
unsigned	get_frequency_ncoeff () const
	Get the number of frequency coefficients.
long double	get_segment_length () const
	Get the length of each polynomial segment in days.
std::string	get_psrname () const
	Get the name of the pulsar.
std::string	get_sitename () const
	Get the name of the observatory.
long double	get_freq_start () const
	Get the start frequency in MHz.
long double	get_freq_end () const
	Get the end frequency in MHz.
long double	get_dispersion_constant () const
	Get the disersion constant.
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 the Predictor configuration matches this.
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.
void	sanity_check (const char *context) const
	Perform a sanity check on the T2Predictor.
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.
Able &	operator= (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.
HeapTracked &	operator= (const HeapTracked &)
	Assignment operator.
virtual	~HeapTracked ()
	Destructor.
bool	__is_on_heap () const
	Return true if this instance is found in heap addresses.

Friends
class	Generator

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.
Static Public Attributes inherited from Pulsar::Predictor
static bool	verbose = false
	Verbosity flag.
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

Functions that predict pulse phase.

This pure virtual base class defines the interface to pulse phase predictors

Member Function Documentation

clone()

Pulsar::Predictor * Tempo2::Predictor::clone ( ) const

virtual

Return a new, copy constructed instance of self.

Implements Pulsar::Predictor.

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

dispersion()

Pulsar::Phase Tempo2::Predictor::dispersion ( const MJD & t, long double MHz ) const

virtual

Return the phase correction for dispersion delay.

Implements Pulsar::Predictor.

References get_dispersion_constant().

frequency()

long double Tempo2::Predictor::frequency ( const MJD & t ) const

virtual

Return the spin frequency, given the epoch.

Implements Pulsar::Predictor.

generator()

Pulsar::Generator * Tempo2::Predictor::generator ( ) const

virtual

Return a new Generator set up to produce a new Predictor like self.

Implements Pulsar::Predictor.

References get_frequency_ncoeff(), get_segment_length(), get_time_ncoeff(), Tempo2::Generator::set_frequency_ncoeff(), Tempo2::Generator::set_segment_length(), and Tempo2::Generator::set_time_ncoeff().

get_frequency_ncoeff()

unsigned Tempo2::Predictor::get_frequency_ncoeff

(

)

const

Get the number of frequency coefficients.

Set the number of frequency coefficients.

Referenced by generator().

get_observing_frequency()

long double Tempo2::Predictor::get_observing_frequency ( ) const

virtual

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

Implements Pulsar::Predictor.

get_segment_length()

long double Tempo2::Predictor::get_segment_length

(

)

const

Get the length of each polynomial segment in days.

Set the length of each polynomial segment in days.

Referenced by generator().

get_time_ncoeff()

unsigned Tempo2::Predictor::get_time_ncoeff

(

)

const

Get the number of time coefficients.

Set the number of time coefficients.

Referenced by generator().

insert()

void Tempo2::Predictor::insert ( const Pulsar::Predictor * from )

virtual

Add the information from the supplied predictor to self.

Implements Pulsar::Predictor.

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

iphase()

MJD Tempo2::Predictor::iphase ( const Pulsar::Phase & phase, const MJD * guess ) const

virtual

Return the epoch, given the phase.

Implements Pulsar::Predictor.

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

keep()

void Tempo2::Predictor::keep ( const std::vector< MJD > & epochs )

virtual

Keep only the components required to span the given epochs.

Implements Pulsar::Predictor.

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

load()

void Tempo2::Predictor::load ( FILE * fptr )

virtual

Load from an open stream.

Implements Pulsar::Predictor.

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

matches()

bool Tempo2::Predictor::matches ( const Pulsar::Predictor * other ) const

virtual

Return true if the Predictor configuration matches this.

Implements Pulsar::Predictor.

References get_dispersion_constant(), get_freq_end(), get_freq_start(), get_psrname(), get_sitename(), Predictor(), and Pulsar::Predictor::verbose.

phase()

Pulsar::Phase Tempo2::Predictor::phase ( const MJD & t ) const

virtual

Return the phase, given the epoch.

Implements Pulsar::Predictor.

References Pulsar::Predictor::verbose.

Referenced by iphase().

set_observing_frequency()

void Tempo2::Predictor::set_observing_frequency ( long double MHz )

virtual

Set the observing frequency at which predictions will be made.

Implements Pulsar::Predictor.

unload()

void Tempo2::Predictor::unload ( FILE * fptr ) const

virtual

Unload to an open stream.

Implements Pulsar::Predictor.

References sanity_check().

---

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

• T2Predictor.h
• T2Predictor.C