Tempo::Predict Class Reference

Uses tempo orediction mode to produce polynomial ephemerides (polyco) More...

#include <Predict.h>

Inheritance diagram for Tempo::Predict:

Public Member Functions
	Predict (const Pulsar::Parameters *parameters=0)
	Default constructor.
Predict *	clone () const
	Return a new, copy constructed instance of self.
void	set_parameters (const Pulsar::Parameters *)
	Set the parameters used to generate the predictor.
void	set_time_span (const MJD &start, const MJD &finish)
	Set the range of epochs over which to generate.
void	set_frequency_span (long double low, long double high)
	Set the range of frequencies over which to generate.
void	set_site (const std::string &)
	Set the site at which the signal is observed.
Pulsar::Predictor *	generate () const
	Return a new Predictor instance.
void	set_asite (char code)
	Set the observatory site code.
void	set_frequency (double MHz)
	Set the observing frequency.
void	set_maxha (unsigned hours)
	Set the maximum hour angle of observations.
void	set_nspan (unsigned minutes)
	Set the time spanned by each polynomial ephemeris.
void	set_ncoef (unsigned ncoef)
	Set the number of coefficients per polynomial ephemeris.
void	set_verify (bool verify)
	Set flag to verify time spanned by polynomial ephemerides.
polyco	get_polyco (const MJD &m1, const MJD &m2)
	Returns a polyco valid over the range in MJD specified by m1 and m2.
void	write_tzin () const
	Write the tz.in file according to the tempo definition.
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.

Static Public Member Functions
static Configuration::Parameter< unsigned > &	get_minimum_nspan ()
	The minimum value of nspan allowed.
static Configuration::Parameter< double > &	get_maximum_rms ()
	The maximum rms allowed, in turns.
Static Public Member Functions inherited from Pulsar::Generator
static Generator *	get_default ()
	Return a pointer to a new Generator of the default derived type.
static Generator *	factory (const Parameters *)
	Return a pointer to a new Generator that can best handle the parameters.
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
polyco	generate_work () const
	Does the work for the two different interfaces.
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.

Protected Attributes
char	asite
	The observatory site code.
double	frequency
	The observing frequency in MHz.
unsigned	maxha
	The maximum hour angle of observations in hours.
unsigned	nspan
	The time spanned by each polynomial ephemeris in minutes.
unsigned	ncoef
	The number of coefficients per polynomial ephemeris.
Reference::To< const Pulsar::Parameters >	parameters
	The pulsar parameters.
std::string	psrname
	The pulsar name.
bool	verify
	Verify the time spanned by polynomial ephemerides.
MJD	m1
MJD	m2

Additional Inherited Members
Static Protected Member Functions inherited from Pulsar::Generator
static Configuration::Parameter< Generator * > &	get_default_generator ()
	Default generator of new predictors.

Detailed Description

Uses tempo orediction mode to produce polynomial ephemerides (polyco)

Member Function Documentation

clone()

Tempo::Predict * Tempo::Predict::clone ( ) const

virtual

Return a new, copy constructed instance of self.

Implements Pulsar::Generator.

References Predict().

generate()

Pulsar::Predictor * Tempo::Predict::generate ( ) const

virtual

Return a new Predictor instance.

Implements Pulsar::Generator.

References generate_work(), and Reference::To< Type, active >::release().

set_asite()

void Tempo::Predict::set_asite

(

char

code

)

Set the observatory site code.

Correponds to ASITE in tz.in

References asite, and Tempo::code().

Referenced by set_site().

set_frequency()

void Tempo::Predict::set_frequency

(

double

MHz

)

Set the observing frequency.

Corresponds to FREQ in tz.in

References frequency.

Referenced by set_frequency_span().

set_frequency_span()

void Tempo::Predict::set_frequency_span ( long double low, long double high )

virtual

Set the range of frequencies over which to generate.

Implements Pulsar::Generator.

References set_frequency().

set_maxha()

void Tempo::Predict::set_maxha

(

unsigned

hours

)

Set the maximum hour angle of observations.

Corresponds to MAXHA in tz.in

References maxha.

set_ncoef()

void Tempo::Predict::set_ncoef

(

unsigned

ncoef

)

Set the number of coefficients per polynomial ephemeris.

Corresponds to NCOEFF in tz.in

References ncoef.

Referenced by polyco::generator().

set_nspan()

void Tempo::Predict::set_nspan

(

unsigned

minutes

)

Set the time spanned by each polynomial ephemeris.

Corresponds to NSPAN in tz.in

References get_minimum_nspan(), and nspan.

Referenced by polyco::generator().

set_parameters()

void Tempo::Predict::set_parameters ( const Pulsar::Parameters * p )

virtual

Set the parameters used to generate the predictor.

Implements Pulsar::Generator.

References Pulsar::TextParameters::get_value(), ncoef, nspan, parameters, and psrname.

set_site()

void Tempo::Predict::set_site ( const std::string & site )

virtual

Set the site at which the signal is observed.

Implements Pulsar::Generator.

References Tempo::code(), and set_asite().

set_time_span()

void Tempo::Predict::set_time_span ( const MJD & start, const MJD & finish )

virtual

Set the range of epochs over which to generate.

Implements Pulsar::Generator.

write_tzin()

void Tempo::Predict::write_tzin

(

)

const

Write the tz.in file according to the tempo definition.

The file tz.in will be written in the directory returned by Tempo::get_directory, according to the following format:

TZ.IN FORMAT

The tz.in file is a free-format, ASCII file. Items on a line may be separated by any number of spaces and tabs.

The first line contains default parameters: ASITE a one-character site code (as in TOA LINES, above) MAXHADEF default maximum hour angle for observations (hr) NSPANDEF default time span per ephemeris entry (minutes) NCOEFFDEF default number of coefficients per ephemeris entry FREQDEF default observing frequency (MHz)

References asite, frequency, maxha, ncoef, nspan, and psrname.

Referenced by generate_work().

---

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

• Predict.h
• Predict.C