Functions that predict pulse phase. More...

#include <FixedFrequencyPredictor.h>

Inheritance diagram for Pulsar::FixedFrequencyPredictor:

Public Member Functions
	FixedFrequencyPredictor ()
	Set frequency later.
	FixedFrequencyPredictor (long double Hz)
	Construct from fixed frequency.
void	set_topocentric_frequency (long double Hz)
	Set the frequency at which data are folded (Hz)
long double	get_topocentric_frequency () const
	Get the topocentric frequency at which data are folded (Hz)
void	set_epoch (const MJD &t)
	Set the epoch.
const MJD &	get_epoch () const
	Get the epoch.
virtual void	set_observing_frequency (long double MHz)
	Set the observing frequency at which phase and time are related.
virtual long double	get_observing_frequency () const
	Get the observing frequency at which phase and epoch are related.
virtual Phase	phase (const MJD &t) const
	Return the phase, given the epoch.
virtual MJD	iphase (const Phase &phase, const MJD *guess=0) const
	Return the epoch, given the phase and, optionally, a first guess.
virtual long double	frequency (const MJD &t) const
	Return the spin frequency, given the epoch.
virtual Phase	dispersion (const MJD &t, long double MHz) const
	Return the phase correction for dispersion delay.
virtual Predictor *	clone () const
	Return a new, copy constructed instance of self.
virtual Generator *	generator () const
	Return a new Generator set up to produce a new Predictor like self.
virtual void	insert (const Predictor *)
	Add the information from the supplied predictor to self.
virtual void	keep (const std::vector< MJD > &)
	Keep only the components required to span the given epochs.
virtual bool	matches (const Predictor *) const
	Return true if the Predictor configuration matches this.
virtual void	load (FILE *)
	Load from an open stream.
virtual void	unload (FILE *) const
	Unload to an open stream.
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.

Protected Attributes
long double	m_freq
	The fixed topocentric frequency.
long double	m_obs_freq
	The observing frequency – irrelevant.
MJD	m_epoch
	epoch (basically used for reference phase)

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 simple version assumes folding at a fixed topocentric frequency, as e.g. a pulsed cal.

Member Function Documentation

◆ clone()

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

inlinevirtual

Return a new, copy constructed instance of self.

Implements Pulsar::Predictor.

◆ dispersion()

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

virtual

Return the phase correction for dispersion delay.

Implements Pulsar::Predictor.

◆ frequency()

long double Pulsar::FixedFrequencyPredictor::frequency ( const MJD & t ) const

virtual

Return the spin frequency, given the epoch.

Implements Pulsar::Predictor.

References m_freq.

◆ generator()

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

inlinevirtual

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

Implements Pulsar::Predictor.

◆ get_observing_frequency()

long double Pulsar::FixedFrequencyPredictor::get_observing_frequency ( ) const

virtual

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

Implements Pulsar::Predictor.

References m_obs_freq.

◆ insert()

virtual void Pulsar::FixedFrequencyPredictor::insert ( const Predictor * )

inlinevirtual

Add the information from the supplied predictor to self.

This method should check to avoid inconsistency and duplication

Implements Pulsar::Predictor.

◆ iphase()

MJD Pulsar::FixedFrequencyPredictor::iphase	(	const Phase &	phase,
		const MJD *	guess = 0 ) const

virtual

Return the epoch, given the phase and, optionally, a first guess.

Implements Pulsar::Predictor.

References m_epoch, m_freq, and phase().

◆ keep()

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

inlinevirtual

Keep only the components required to span the given epochs.

Implements Pulsar::Predictor.

◆ load()

virtual void Pulsar::FixedFrequencyPredictor::load ( FILE * )

inlinevirtual

Load from an open stream.

Implements Pulsar::Predictor.

◆ matches()

virtual bool Pulsar::FixedFrequencyPredictor::matches ( const Predictor * ) const

inlinevirtual

Return true if the Predictor configuration matches this.

Implements Pulsar::Predictor.

◆ phase()

Pulsar::Phase Pulsar::FixedFrequencyPredictor::phase ( const MJD & t ) const

virtual

Return the phase, given the epoch.

Implements Pulsar::Predictor.

References m_epoch, and m_freq.

Referenced by iphase().

◆ set_observing_frequency()

void Pulsar::FixedFrequencyPredictor::set_observing_frequency ( long double MHz )

virtual

Set the observing frequency at which phase and time are related.

Implements Pulsar::Predictor.

References m_obs_freq.

◆ unload()

virtual void Pulsar::FixedFrequencyPredictor::unload ( FILE * ) const

inlinevirtual

Unload to an open stream.

Implements Pulsar::Predictor.

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

FixedFrequencyPredictor.h
FixedFrequencyPredictor.C

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clone()

◆ dispersion()

◆ frequency()

◆ generator()

◆ get_observing_frequency()

◆ insert()

◆ iphase()

◆ keep()

◆ load()

◆ matches()

◆ phase()

◆ set_observing_frequency()

◆ unload()