search

USRA-STI / gdt-fermi

Gamma-ray Data Tools - Fermi mission components
Apache License 2.0
2 stars 3 forks source link

Added DoL documentation with new method to convert DoL output to GbmHealPix #32

Closed joshuarwood closed 2 months ago

joshuarwood commented 2 months ago

I added documentation for the Daughter of Locburst (DoL) modules to the following files:

docs/missions/fermi/gbm/localization/localization.rst docs/missions/fermi/gbm/localization/dol/dol.rst docs/missions/fermi/gbm/localization/dol/legacy_dol.rst docs/missions/fermi/gbm/localization/dol/legacy_functions.rst docs/missions/fermi/gbm/localization/dol/legacy_spectral_models.rst

The dol.rst file contains a tutorial for how to perform a typical ground localization. The tutorial required two notable changes to the code:

  1. The addition of a new to_GbmHealPix() method for the legacy_DoL class. This allows users to easily convert between the legacy chi2 grid format and the modern GbmHealPix probability maps.
  2. Clean-up of the GbmHealPix.from_chi2grid method to remove projection of the significance field, which is no longer used in the current GDT. This field was being directly overwritten by the probability in the existing main branch. I also added two options for nearest pixel interpolation to help reduce pixel artifacts. These are documented at the end of dol/legacy_dol.rst.

This update also contains a number of small fixes to the dol code:

  1. fixed a module path bug in dol4.exe
  2. added the missing "legacy_spectral_functions" string to the __all__ list in dol/__init__.py
  3. filled out the help descriptors for command line options in legacy_dol.py
  4. re-worked some of the comments and library imports in legacy_dol.py, legacy_functions.py to fix missing/problematic Sphinx doc stubs
  5. added an __init__.py file to tests/missions/fermi/gbm to fix a pathing bug from import tests when running the dol unit tests
  6. fixed some minor typos in the README.rst related to compiling the Sphinx documentation