Skip to content

Latest commit

 

History

History
91 lines (73 loc) · 5.86 KB

dataformats.rst

File metadata and controls

91 lines (73 loc) · 5.86 KB
Raw

Data Formats

Note

Since November 2015 there is the gadf:main-page project. This page contains extra information about which formats we support in Gammapy and which class corresponds to which format.

Where available and useful existing standards are used, e.g. for spectral data the X-ray community has developed the PHA, ARF and RMF file formats and they have developed powerful tools to work with data in that format.

Overview

Here's an overview of the file formats supported by Gammapy and Gammalib:

Type Format Name Gammapy Gammalib
Events EVENTS ~gammapy.data.EventList GEventList
----------------- -------------------- ------------------------------------------------- ----------------------------
Effective area AEFF_2D ~gammapy.irf.EffectiveAreaTable2D GCTAAeff2D
Effective area ARF ~gammapy.irf.EffectiveAreaTable GCTAAeffArf
----------------- -------------------- ------------------------------------------------- ----------------------------
Energy dispersion EDISP_2D ~gammapy.irf.EnergyDispersion2D GCTAEdisp2D
Energy dispersion RMF ~gammapy.irf.EnergyDispersion GCTAEdispRMF
----------------- -------------------- ------------------------------------------------- ----------------------------
PSF PSF_2D_GAUSS ~gammapy.irf.EnergyDependentMultiGaussPSF GCTAPsf2D
PSF PSF_2D_KING ~gammapy.irf.PSFKing GCTAPsfKing
PSF no spec available ~gammapy.irf.TablePSF GCTAPsfVector
PSF gtpsf output ~gammapy.irf.EnergyDependentTablePSF N/A
PSF psf_table ~gammapy.irf.PSF3D GCTAPsfTable
PSF no spec available N/A GCTACubePsf
----------------- -------------------- ------------------------------------------------- ----------------------------
Background BACKGROUND_3D ~gammapy.irf.Background3D GCTABackground3D
Background BACKGROUND_2D ~gammapy.irf.Background2D N/A
Background no spec available N/A GCTAModelRadialAcceptance
Background no spec available N/A GCTACubeBackground
----------------- -------------------- ------------------------------------------------- ----------------------------
Exposure EXPOSURE_3D ~gammapy.maps.Map GCTACubeExposure
----------------- -------------------- ------------------------------------------------- ----------------------------
Counts 3D ~gammapy.maps.Map GCTAEventCube
Counts Image ~gammapy.maps.Map GSkyMap
Counts PHA ~gammapy.spectrum.CountsSpectrum GPha

Notes

  • The Gammalib docs contain a nice overview of IRFs here and detailed explanations of some IRF here.
  • We probably should unify / shorten the IRF class names in Gammapy.
  • There's quite a few classes in Gammapy that don't have a well-defined format. We should add a way to serialise every class and document the format for easier interop.
  • Maybe add info which format is used by Fermi, HESS HD/PA, CTA?
  • For every format there should be one or several test data files. This could even be in a repo that's shared by Gammalib / Gammapy.