Fermi Gamma-ray Space Telescope

Binary Orbital Phase Calculation (gtophase) Tutorial

The gtophase tool's purpose is to assign an orbital phase to each record in an event file, based on one or more known pulsar ephemerides.

Prerequisites

  • Event data file in FT1 format a.k.a. a photon data file. (See Extract LAT Data).
  • Orbit file to use for the barycentric correction
  • Pulsar ephemeris database file which contains binary orbital parameters of a pulsar of interest
  • Right Ascension (R.A.) and Declination (Dec) of the source (pulsar) location for the barycentric correction

Sample Files. To try the examples in this section, you can download the following simulated data files. The simulated data is for demonstration purposes and the simulated pulsar is slightly brighter than the Vela pulsar. For more information, see the parameters used for the simulation.

Note: Like gtpphase, this tool operates on files in place. The event file processed by gtophase will be identical to:

which is also available for download for your comparison.

Also see:

Tutorial Fermitools References
Pulsar Analysis Tutorial: Calculate Pulse Phase for Each Photon gtpsearch
Period Search Tutorial gtpphase
Pulse Phase Calculation gtophase

» Fermitools References

How To Assign Orbital Phases

The tool automatically extracts one or more ephemerides from an existing pulsar ephemerides database file. Unlike the similar tool gtpphase, there is no option for entering orbital ephemerides manually. This tool does not produce a separate output file, but operates directly on the input file in place. If execution is successful, the tool produces no textual output. 

prompt> gtophase
Event data file name[] fakepulsar_event.fits
Spacecraft data file name[] simscdata_1week.fits
Pulsar ephemerides database file name[] bogus_pulsardb.fits
Pulsar name[ANY] PSR J1834-0010
Right Ascension to be used for barycenter corrections (degrees)[0.] 278.571942
Declination to be used for barycenter corrections (degrees)[0.] -0.180347
prompt>

The following plot of the modified events file was produced by fplot, and shows the ORBITAL_PHASE column as a function of TIME in the events file. 

prompt> fplot
Name of FITS file and [ext#][] fakepulsar_event.fits
Name of X Axis Parameter[error][] TIME
Name of Y Axis Parameter[error] up to 8 allowed[] ORBITAL_PHASE
Lists of rows[-] -
Device: /XWindow, /XTerm, /TK, /PS, etc[/XW] /xserv
Any legal PLT command[] marker on
PLT> exit
prompt>

gtophase example 1 (graphical output)

Getting More Information on Computation

If gtophase is invoked with chatter parameter set to 4 or larger, it will display brief summaries of loaded ephemerides, arrival time corrections, and time systems being used. This feature shows you additional information on computations being performed, which may help you understand the tool. Also, the extra information printed may contain a clue to diagnose certain types of problem. So, try a high chatter when you are unsure on the tool's behavior. 

prompt> gtophase chatter=4
Event data file name[] fakepulsar_event.fits
Spacecraft data file name[] simscdata_1week.fits
Pulsar ephemerides database file name[] bogus_pulsardb.fits
Pulsar name[ANY] PSR J1834-0010
Right Ascension to be used for barycenter corrections (degrees)[0.] 278.571942
Declination to be used for barycenter corrections (degrees)[0.] -0.180347
gtophase: INFO: ==========================
gtophase: INFO: Pulsar ephemerides are loaded and/or filtered as follows:
gtophase: INFO:    Load FITSDB AUTHOR='Anonymous Tester' DATE='2009-02-11T19:12:04'
gtophase: INFO:    Filter by pulsar name 'PSR J1834-0010'
gtophase: INFO:    Filter by solar system ephemeris 'JPL DE405'
gtophase: INFO: ==========================
gtophase: INFO: Pulsar ephemerides FITS files loaded are:
gtophase: INFO: [1] PULSARDB AUTHOR='Anonymous Tester' DATE='2009-02-11T19:12:04'
gtophase: INFO:    * Load TEXTDB SPIN_PARAMETERS(FREQ) FILENAME='bogus_pulsardb_spin.txt'
gtophase: INFO:    * Load TEXTDB OBSERVERS FILENAME='bogus_pulsardb_obs.txt'
gtophase: INFO:    * Load FITSDB AUTHOR='Masaharu Hirayama' DATE='2006-03-24T15:40:16'
gtophase: INFO: ==========================
gtophase: INFO: Orbital ephemerides in the database are summarized as follows:
gtophase: INFO:    19 orbital ephemeri(de)s in total
gtophase: INFO:    1 orbital ephemeri(de)s for pulsar "PSR J1834-0010"
gtophase: INFO:    1 orbital ephemeri(de)s with solar system ephemeris "JPL DE405" for pulsar "PSR J1834-0010"
gtophase: INFO:    1 orbital ephemeri(de)s loaded into memory
gtophase: INFO: ==========================
gtophase: INFO: --------------------------
gtophase: INFO: Arrival time corrections are applied as follows:
gtophase: INFO:    Barycentric correction: Applied if necessary
gtophase: INFO:    Binary demodulation: Applied
gtophase: INFO:    Pdot cancellation: Not applied
gtophase: INFO: Following time system(s) are listed for this task:
gtophase: INFO:    Spin ephemeri(de)s are defined in: None
gtophase: INFO:    Orbital ephemeri(de)s are defined in: TDB(1)
gtophase: INFO:    Pdot cancellation will be performed in: None
gtophase: INFO:    Time series analysis will be performed in: TDB
gtophase: INFO: --------------------------
prompt>

Last updated: 11/09/2017