Tempo::toa Class Reference

Describes a pulse Time of Arrival (TOA) More...

#include <toa.h>

Public Types
enum	Format {   Unspecified , Comment , Princeton , Parkes ,   ITOA , Psrclock , Command , Tempo2 }
	TOA output format.
enum	State {   Undefined = -2 , Deleted = -1 , Hidden = 0 , Normal = 1 ,   Selected = 2 }

Public Member Functions
	toa (Format fmt=Psrclock)
	toa (const toa &in_toa)
toa &	operator= (const toa &in_toa)
	toa (FILE *instream)
	toa (char *indata)
void	set_format (Format fmt)
void	set_StoN (float sn)
void	set_pa (float p)
void	set_bw (float b)
void	set_dur (float d)
void	set_dm (float d)
void	set_state (State st)
void	set_frequency (double freq)
void	set_arrival (const MJD &arrived)
void	set_error (float err)
void	set_reduced_chisq (float x)
void	set_flux (const Estimate< float > &x)
void	set_dispersion_measure_estimate (const Estimate< double > &x)
void	set_telescope (const std::string &telcode)
void	set_auxilliary_text (const std::string &text)
void	set_channel (unsigned chan)
void	set_subint (unsigned sub)
void	set_phase_shift (double shift)
void	set_phase_info (bool info)
Format	get_format () const
float	get_StoN () const
float	get_pa () const
float	get_bw () const
float	get_dur () const
float	get_dm () const
State	get_state () const
double	get_frequency () const
MJD	get_arrival () const
float	get_error () const
float	get_reduced_chisq () const
Estimate< float >	get_flux () const
Estimate< double >	get_dispersion_measure_estimate () const
std::string	get_telescope () const
std::string	get_auxilliary_text () const
double	get_phase_shift () const
unsigned	get_channel () const
unsigned	get_subint () const
int	load (FILE *instream)
int	load (const char *instring)
int	unload (FILE *outstream, Format fmt=Unspecified) const
int	unload (char *outstring, Format fmt=Unspecified) const
int	parkes_parse (const char *instring)
int	parkes_out (char *outstring) const
int	Parkes_load (const char *instring)
int	Parkes_unload (FILE *outstream) const
int	Parkes_unload (char *outstring) const
int	Princeton_load (const char *instring)
int	Princeton_unload (FILE *outstream) const
int	Princeton_unload (char *outstring) const
int	Psrclock_load (const char *instring)
int	Psrclock_unload (FILE *outstream) const
int	Psrclock_unload (char *outstring) const
std::string	Psrclock_unload () const
int	Command_load (const char *instring)
int	Command_unload (FILE *outstream) const
int	Command_unload (char *outstring) const
int	Comment_unload (FILE *outstream) const
int	Comment_unload (char *outstring) const
int	Tempo2_unload (FILE *outstream) const
int	Tempo2_unload (char *outstring) const
int	Tempo_unload (FILE *outstream) const
int	Tempo_unload (char *outstring) const

Static Public Member Functions
static int	load (const char *filename, std::vector< toa > *toas)
static int	load (FILE *instream, std::vector< toa > *toas)
static int	unload (const char *filename, const std::vector< toa > &toas, Format fmt=Unspecified)
static int	unload (FILE *outstream, const std::vector< toa > &toas, Format fmt=Unspecified)

Public Attributes
residual	resid

Static Public Attributes
static const float	UNSET = -999.0
static bool	verbose = false

Protected Attributes
double	frequency = 0.0
	Observing frequency (MHz)
MJD	arrival
	Time of arrival, TOA.
float	error = 0.0
	TOA uncertainty in microseconds.
float	reduced_chisq = 0.0
	Goodness-of-fit (reduced chisq) reported by the phase shift estimator.
double	phase_shift = 0
	Phase shift (turns) computed by the phase shift estimator.
std::string	telescope
	Observatory code.
unsigned	channel = 0
	Frequency channel index in data file.
unsigned	subint = 0
	Sub-integration index in data file.
float	phs = 0
	Phase offset (turns, added to TOA)
char	observatory [2]
	Observatory (two-letter code)
std::string	auxinfo
	Typically the name of the data file.
float	signal_to_noise = 0
	Signal-to-noise ratio estimate.
float	parallactic_angle = 0
	Parallactic angle ???
float	bandwidth = 0
	Bandwidth (MHz)
float	duration = 0
	Duration (s) aka integration length.
double	dispersion_measure = 0
	Dispersion measure, DM (pc cm^-3)
float	dispersion_measure_correction
	Dispersion measure correction (pc cm^-3)
Estimate< double >	dispersion_measure_estimate
	Estimated dispersion measure (pc cm^-3)
Estimate< float >	flux
bool	phase_info
Format	format
State	state

Friends
int	operator< (const toa &t1, const toa &t2)

Detailed Description

Describes a pulse Time of Arrival (TOA)

Member Data Documentation

dispersion_measure_correction

float Tempo::toa::dispersion_measure_correction

protected

Dispersion measure correction (pc cm^-3)

Parsed from Princeton format

phs

float Tempo::toa::phs = 0

protected

Phase offset (turns, added to TOA)

Parkes format-specific

---

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

• toa.h
• toa.C