Update documentation to inform also about INTEGRAL/SPI

Jürgen Knödlseder
1 parent ee693cad
Showing 8 changed files with 64 additions and 9 deletions
doc/source/_templates/index.html
doc/source/about.rst
doc/source/users/user_manual/inst/com/index.rst
doc/source/users/user_manual/inst/index.rst
doc/source/users/user_manual/inst/spi/index.rst
doc/source/users/user_manual/inst/spi/uml_spi.png
doc/source/users/user_manual/overview.rst
doc/source/users/user_manual/structure.png
@@ -12,8 +12,8 @@ functions, are implemented as isolated and well defined modules sharing
 an identical abstract interface. This enables a joint multi-instrument
 analysis of data, allowing for consistent broad-band spectral fitting
 or imaging. So far, GammaLib supports analysis of data obtained with
-COMPTEL, Fermi/LAT, and Cherenkov telescopes (CTA, H.E.S.S., MAGIC,
-VERITAS). {%endtrans%}</p>
+COMPTEL, Fermi/LAT, INTEGRAL/SPI and Cherenkov telescopes (CTA, H.E.S.S.,
+MAGIC, VERITAS). {%endtrans%}</p>
  
 <p>{%trans%} Except for HEASARC's cfitsio library that is used to implement
 the FITS interface, GammaLib does not rely on any third-party 
@@ -13,8 +13,8 @@ functions, are implemented as isolated and well defined modules sharing
 an identical abstract interface. This enables a joint multi-instrument
 analysis of data, allowing for consistent broad-band spectral fitting
 or imaging. So far, GammaLib supports analysis of data obtained with
-COMPTEL, Fermi/LAT, and Cherenkov telescopes (CTA, H.E.S.S., MAGIC,
-VERITAS).
+COMPTEL, Fermi/LAT, INTEGRAL/SPI and Cherenkov telescopes (CTA, H.E.S.S.,
+MAGIC, VERITAS).
  
 Except for HEASARC's cfitsio library that is used to implement
 the FITS interface, GammaLib does not rely on any third-party 
@@ -6,6 +6,10 @@ COMPTEL interface
 Overview
 ~~~~~~~~
  
+The COMPTEL module provides an instrument interface for the COMPTEL 
+telescope that has been operated on the Compton Gamma-Ray Observatory 
+(CGRO) from 1991 to 2000.
+
 The following figure presents an overview over the C++ classes of the COMPTEL
 module and their relations.
  
@@ -17,10 +21,6 @@ module and their relations.
  
    *COMPTEL module*
  
-The COMPTEL module provides an instrument interface for the COMPTEL 
-telescope that has been operated on the Compton Gamma-Ray Observatory 
-(CGRO) from 1991 to 2000.
-
 The central object is a COMPTEL observation, implemented by the
 :doxy:`GCOMObservation` class. The class either holds a COMPTEL event cube,
 implemented by the :doxy:`GCOMEventCube` class, or an event list, implemented
@@ -9,4 +9,5 @@ Instrument modules
    cta/index
    lat/index
    com/index
+   spi/index
    mwl/index
+.. um_com:
+
+INTEGRAL/SPI interface
+----------------------
+
+Overview
+~~~~~~~~
+
+The SPI module supports the Spectrometre on INTEGRAL, an instrument for
+low-energy gamma-ray astronomy that currently flies on ESA's INTEGRAL
+satellite. The satellite was launched on 17 October 2002 and operates since
+then in an elliptical orbit of about three days. The SPI telescope operates
+between 20 keV and 8 MeV and is equipped with 19 high-resolution Germanium
+detectors. It uses a coded mask to image sources in a field-of-view of about
+16 deg in diameter (fully coded). The angular resolution is about 2 deg, the
+spectral resolution is about 2 keV.
+
+The following figure presents an overview over the C++ classes of the SPI
+module and their relations.
+
+.. _fig_uml_spi:
+
+.. figure:: uml_spi.png
+   :width: 70%
+   :align: center
+
+   *SPI module*
+
+The central object is a SPI observation, implemented by the
+:doxy:`GSPIObservation` class.
+The class holds a SPI event cube that is implemented by the
+:doxy:`GSPIEventCube` class.
+The event cube spans the full SPI data space which is 3-dimensional and
+spanned by a time axis (defined as the pointing sequence of the telescope),
+a detector axis and an energy axis.
+A single bin of the event cube is implemented by the :doxy:`GSPIEventBin`
+class.
+Each event bin contains the instrument direction, implemented by the
+:doxy:`GSPIInstDir` class, that is defined by the pointing direction of
+the telescope at the time that the event was recorded and the detector
+number in which the event occured.
+In addition, the event bin contains the energy and trigger time of the
+event.
+
+The :doxy:`GSPIObservation` class holds furthermore the Instrument Response
+Function (IRF) that is implemented by the :doxy:`GSPIResponse` class.
+Internally, :doxy:`GSPIResponse` stores the IRF as a multi-dimensional
+sky map.
+
+To model the instrumental background the :doxy:`GSPIModelDataSpace` class
+exists which defines scaling factors of a model factor for various data space
+sub regions.
+Sub regions can be defined in all three data space dimensions.
@@ -73,7 +73,8 @@ correspond to the folders in the source code distribution):
  
    GammaLib support the analysis of data from the Cherenkov Telescope Array
    (cta), the Fermi/LAT telescope (lat), the COMPTEL telescope (com),
-   and any multi-wavelength information in form of spectral data points (mwl).
+   the INTEGRAL/SPI telescope (spi), and any multi-wavelength information
+   in form of spectral data points (mwl).
  
 .. _fig_structure: