Python Analysis Tools for High-energy Event data Manipulation

The new home of the former XTE L-Extract project!

PANTHEON is an open-source suite of tools to help analyse and visualise raw X-Ray satellite data. Comes with tools to sort relevant data out of pre-downloaded archives, construct a variety of products and manipulate these. It's easy to use, with most instructions given in the form of on-screen prompts, and the various tools are able to function mostly independently of each other.

1. Specifications
2. Overview
3. Mission-Independent Tools
4. Instrument-Specific Tools
5. FitsGenie Manual
6. PlotDemon Manual
7. SpecAngel Manual

• FITSGenie, SpecAngel, PlotDemon and DataFairy must be placed in the same directory as their associated library Pan_Lib.
• The auxilliary function library relevant to the mission of interest (i.e. SzkPan_Lib or XTEPan_Lib) must be placed in the same directory as FITSGenie.
• The following modules for Python are required:
  • astropy
  • cPickle
  • imp
  • math
  • numba
  • numpy
  • os
  • pylab
  • scipy
  • sys
  • warnings
• The following modules for Python are required for certain features:
  • PyAstronomy (for data folding only)
• You must have the 'fkeyprint' and 'make_se' tools from HEASARC's FTOOLS package in order to use Xte GoodXenon-Extractor. If you do not intend to work with XTE GoodXenon files, or want to select and make the files manually, no HEASARC products are required.

fitsgenie.py

The all-in-one extractor for event files! Currently implemented for GoodXenon_2s and E_125us_64M_0_1s data types from PCA on RXTE and .evt data types from XIS on SUZAKU (Beta).

• Extracts and analyses data from FITS event files.
• Allows user to select which energy channels they want to analyse.
• Splits the data into chunks ('Fourier Windows') and creates power spectra of each chunk such that periodicity can be detected.
• Fourier Windows can be made discrete or sliding.
• Generates a number of statistics describing the data being procesed.
• Saves lightcurve information in a .plotd file to be read by the PANTHEON programme PlotDemon.
• Saves power spectrum information in a .speca file to be read by the PANTHEON programme SpecAngel.

Arguments can be given with the function call, else they will the user will be prompted to enter them by the software. They are as follows:

• Minimum Channel: the lowest channel (or energy, depending on the data format input) of photons that will be used for analysis.
• Maximum Channel: the highest channel or energy to be used.
• Photon count bin-size: the size of bins to create the full-resolution histogram of photon events over time.
• Time per Fourier Spectrum: the size of the chunks the data will be divided into for Fourier analysis of saved data with SpecAngel.
• Estimate of background: an estimate of the background count rate in cts/s.

specangel.py

The power spectral analysis software for visualising time-domain variability! See in-programme help for detailed instructions on specific commands. Type 'help' to bring up a menu.

• Opens .speca files and allows visualisation of power density spectra of data.
• Can create the average power density spectrum of an observation that has been split into chunks.
• Can display the individual power density spectrum for any given chunk.
• Creates spectrograms to show how the power density spectrum varies in time.
• Allows data to be clipped, renormalised or rebinned.
• Allows manipulation of the scale in the spectrogram to more easily see peaks and troughs.

Arguments can be given with the function call, else they will the user will be prompted to enter them by the software. They are as follows:

• Logarithmic binning Factor: the value of x; two adjacent logarithmic bins in time will have their left-hand edges separated by no less than a multiplicative factor of 10^x.

plotdemon.py

The lightcurve and colour analysis software for hardness and intensity plotting! See in-programme help for detailed instructions on specific commands. Type 'help' to bring up a menu.

• Opens up to 3 .plotd files and allows creation of a large number of plots comparing them.
• Allows plotting and manipulation of lightcurves, colour-colour diagrams and hardness-intensity diagrams.
• Lets users plot lightcurves of multiple different energy bands alongside each other to see how they correlate.
• Allows creation of Lomb-Scargle periodograms to complement Fourier Transforms made with SpecAngel.
• Creates animations of how lightcurves change as the binning is increased.
• Allows folding of data over a period of the user's selection.
• Exports data to ASCII text files for compatibility with, for example, GnuPlot.

Arguments can be given with the function call, else they will the user will be prompted to enter them by the software. They are as follows:

• Binsize: the size of the binning, in time, for lightcurves and colour curves.

datafairy.py

Creates fake data, the form of which can be changed by the user, which is readable by PlotDemon.

• The form of the data output is determined by functions in the DataFairy code which can be edited by the user.
• Output data is in the form of three PlotDemon .plotd files.
• Coming soon: output .speca files.

mode_get.py

Produces a list of all .FITS files in a directory, along with their DATAMODEs, start times and and times.

pan_lib.py

Contains useful mission-independent functions used in the other scripts. See documentation in Pan_Lib for details on individual functions.

xteevex.sh

When run in a directory, locates all event files saved in a .evt format and copies these into a new subdirectory named event0.

xtegxex.sh

When run in a directory, locates both parts of all possible Good Xenon files, and then produces these combined Good Xenon files. Copies these resultant files into a new subdirectory named gx0.

xtepan_lib.py

Contains useful XTE-specific functions used in the other scripts. See documentation in XTEPan_Lib for details on individual functions.

szkpan_lib.py

Contains useful Suzaku-specific functions used in the other scripts. See documentation in XTEPan_Lib for details on individual functions.

FITSGenie is a piece of software required to take raw GoodXenon or Event files from HEASARC and extract them into formats readable by SpecAngel and PlotDemon.

Coming soon!

##4 . PlotDemon Manual

Coming soon!

Coming soon! (maybe)

Have fun using PANTHEON!