This is a fixed-text formatted version of a Jupyter notebook

Low level API¶

Prerequisites:¶

• Understanding the gammapy data workflow, in particular what are DL3 events and instrument response functions (IRF).

• Understanding of the data reduction and modeling fitting process as shown in the analysis with the high level interface tutorial

Context¶

This notebook is an introduction to gammapy analysis this time using the lower level classes and functions the library. This allows to understand what happens during two main gammapy analysis steps, data reduction and modeling/fitting.

Objective: Create a 3D dataset of the Crab using the H.E.S.S. DL3 data release 1 and perform a simple model fitting of the Crab nebula using the lower level gammapy API.

Proposed approach:¶

Here, we have to interact with the data archive (with the gammapy.data.DataStore) to retrieve a list of selected observations (gammapy.data.Observations). Then, we define the geometry of the gammapy.datasets.MapDataset object we want to produce and the maker object that reduce an observation to a dataset.

We can then proceed with data reduction with a loop over all selected observations to produce datasets in the relevant geometry and stack them together (i.e. sum them all).

In practice, we have to: - Create a gammapy.data.DataStore poiting to the relevant data - Apply an observation selection to produce a list of observations, a gammapy.data.Observations object. - Define a geometry of the Map we want to produce, with a sky projection and an energy range. - Create a gammapy.maps.MapAxis for the energy - Create a gammapy.maps.WcsGeom for the geometry - Create the necessary makers : - the map dataset maker : gammapy.makers.MapDatasetMaker - the background normalization maker, here a gammapy.makers.FoVBackgroundMaker - and usually the safe range maker : gammapy.makers.SafeRangeMaker - Perform the data reduction loop. And for every observation: - Apply the makers sequentially to produce the current gammapy.datasets.MapDataset - Stack it on the target one. - Define the gammapy.modeling.models.SkyModel to apply to the dataset. - Create a gammapy.modeling.Fit object and run it to fit the model parameters - Apply a gammapy.estimators.FluxPointsEstimator to compute flux points for the spectral part of the fit.

Setup¶

First, we setup the analysis by performing required imports.

:
%matplotlib inline
import matplotlib.pyplot as plt
:
from pathlib import Path
from astropy import units as u
from astropy.coordinates import SkyCoord
from regions import CircleSkyRegion
:
from gammapy.data import DataStore
from gammapy.datasets import MapDataset
from gammapy.maps import WcsGeom, MapAxis
from gammapy.makers import MapDatasetMaker, SafeMaskMaker, FoVBackgroundMaker
from gammapy.modeling.models import (
SkyModel,
PowerLawSpectralModel,
PointSpatialModel,
FoVBackgroundModel,
)
from gammapy.modeling import Fit
from gammapy.estimators import FluxPointsEstimator

Defining the datastore and selecting observations¶

We first use the gammapy.data.DataStore object to access the observations we want to analyse. Here the H.E.S.S. DL3 DR1.

:
data_store = DataStore.from_dir("\$GAMMAPY_DATA/hess-dl3-dr1")

We can now define an observation filter to select only the relevant observations. Here we use a cone search which we define with a python dict.

We then filter the ObservationTable with gammapy.data.ObservationTable.select_observations().

:
selection = dict(
type="sky_circle",
frame="icrs",
lon="83.633 deg",
lat="22.014 deg",
)
selected_obs_table = data_store.obs_table.select_observations(selection)

We can now retrieve the relevant observations by passing their obs_id to thegammapy.data.DataStore.get_observations() method.

:
observations = data_store.get_observations(selected_obs_table["OBS_ID"])
No HDU found matching: OBS_ID = 23523, HDU_TYPE = rad_max, HDU_CLASS = None
No HDU found matching: OBS_ID = 23526, HDU_TYPE = rad_max, HDU_CLASS = None
No HDU found matching: OBS_ID = 23559, HDU_TYPE = rad_max, HDU_CLASS = None
No HDU found matching: OBS_ID = 23592, HDU_TYPE = rad_max, HDU_CLASS = None

Preparing reduced datasets geometry¶

Now we define a reference geometry for our analysis, We choose a WCS based geometry with a binsize of 0.02 deg and also define an energy axis:

:
energy_axis = MapAxis.from_energy_bounds(1.0, 10.0, 4, unit="TeV")

geom = WcsGeom.create(
skydir=(83.633, 22.014),
binsz=0.02,
width=(2, 2),
frame="icrs",
proj="CAR",
axes=[energy_axis],
)

# Reduced IRFs are defined in true energy (i.e. not measured energy).
energy_axis_true = MapAxis.from_energy_bounds(
0.5, 20, 10, unit="TeV", name="energy_true"
)

Now we can define the target dataset with this geometry.

:
stacked = MapDataset.create(
geom=geom, energy_axis_true=energy_axis_true, name="crab-stacked"
)

Data reduction¶

Create the maker classes to be used¶

The gammapy.datasets.MapDatasetMaker object is initialized as well as the gammapy.makers.SafeMaskMaker that carries here a maximum offset selection.

:
offset_max = 2.5 * u.deg
maker = MapDatasetMaker()
methods=["offset-max", "aeff-max"], offset_max=offset_max
)
:
circle = CircleSkyRegion(
center=SkyCoord("83.63 deg", "22.14 deg"), radius=0.2 * u.deg
)

Perform the data reduction loop¶

:
%%time

for obs in observations:
# First a cutout of the target map is produced
cutout = stacked.cutout(
)
# A MapDataset is filled in this cutout geometry
dataset = maker.run(cutout, obs)
# The data quality cut is applied
# fit background model
dataset = maker_fov.run(dataset)
print(
f"Background norm obs {obs.obs_id}: {dataset.background_model.spectral_model.norm.value:.2f}"
)
# The resulting dataset cutout is stacked onto the final one
stacked.stack(dataset)
Background norm obs 23523: 0.99
Background norm obs 23526: 1.08
Background norm obs 23559: 0.99
Background norm obs 23592: 1.10
CPU times: user 4.64 s, sys: 178 ms, total: 4.82 s
Wall time: 4.82 s
:
print(stacked)
MapDataset
----------

Name                            : crab-stacked

Total counts                    : 2479
Total background counts         : 2112.97
Total excess counts             : 366.03

Predicted counts                : 2112.97
Predicted background counts     : 2112.97
Predicted excess counts         : nan

Exposure min                    : 3.75e+08 m2 s
Exposure max                    : 3.48e+09 m2 s

Number of total bins            : 40000
Number of fit bins              : 40000

Fit statistic type              : cash
Fit statistic value (-2 log(L)) : nan

Number of models                : 0
Number of parameters            : 0
Number of free parameters       : 0

Inspect the reduced dataset¶

:
stacked.counts.sum_over_axes().smooth(0.05 * u.deg).plot(
); Save dataset to disk¶

It is common to run the preparation step independent of the likelihood fit, because often the preparation of maps, PSF and energy dispersion is slow if you have a lot of data. We first create a folder:

:
path = Path("analysis_2")
path.mkdir(exist_ok=True)

And then write the maps and IRFs to disk by calling the dedicated gammapy.datasets.MapDataset.write() method:

:
filename = path / "crab-stacked-dataset.fits.gz"
stacked.write(filename, overwrite=True)

Define the model¶

We first define the model, a SkyModel, as the combination of a point source SpatialModel with a powerlaw SpectralModel:

:
target_position = SkyCoord(ra=83.63308, dec=22.01450, unit="deg")
spatial_model = PointSpatialModel(
lon_0=target_position.ra, lat_0=target_position.dec, frame="icrs"
)

spectral_model = PowerLawSpectralModel(
index=2.702,
amplitude=4.712e-11 * u.Unit("1 / (cm2 s TeV)"),
reference=1 * u.TeV,
)

sky_model = SkyModel(
spatial_model=spatial_model, spectral_model=spectral_model, name="crab"
)

bkg_model = FoVBackgroundModel(dataset_name="crab-stacked")

Now we assign this model to our reduced dataset:

:
stacked.models = [sky_model, bkg_model]

Fit the model¶

The gammapy.modeling.Fit class is orchestrating the fit, connecting the stats method of the dataset to the minimizer. By default, it uses iminuit.

Its constructor takes a list of dataset as argument.

:
%%time
fit = Fit(optimize_opts={"print_level": 1})
result = fit.run([stacked])
CPU times: user 7.12 s, sys: 349 ms, total: 7.47 s
Wall time: 7.48 s

The FitResult contains information about the optimization and parameter error calculation.

:
print(result)
OptimizeResult

backend    : minuit
success    : True
message    : Optimization terminated successfully.
nfev       : 141
total stat : 16240.97

OptimizeResult

backend    : minuit
success    : True
message    : Optimization terminated successfully.
nfev       : 141
total stat : 16240.97

The fitted parameters are visible from the ~astropy.modeling.models.Models object.

:
stacked.models.to_parameters_table()
:
Table length=8
str16str8str9float64str14float64float64float64boolstr1
crabspectralindex2.6000e+001.004e-01nannanFalse
crabspectralamplitude4.5910e-11cm-2 s-1 TeV-13.705e-12nannanFalse
crabspectralreference1.0000e+00TeV0.000e+00nannanTrue
crabspatiallon_08.3619e+01deg3.104e-03nannanFalse
crabspatiallat_02.2024e+01deg2.949e-03-9.000e+019.000e+01False
crab-stacked-bkgspectralnorm9.3478e-012.192e-02nannanFalse
crab-stacked-bkgspectraltilt0.0000e+000.000e+00nannanTrue
crab-stacked-bkgspectralreference1.0000e+00TeV0.000e+00nannanTrue

Inspecting residuals¶

For any fit it is useful to inspect the residual images. We have a few options on the dataset object to handle this. First we can use .plot_residuals_spatial() to plot a residual image, summed over all energies:

:
stacked.plot_residuals_spatial(method="diff/sqrt(model)", vmin=-0.5, vmax=0.5);
/usr/share/miniconda/envs/gammapy-dev/lib/python3.7/site-packages/astropy/visualization/wcsaxes/core.py:211: MatplotlibDeprecationWarning: Passing parameters norm and vmin/vmax simultaneously is deprecated since 3.3 and will become an error two minor releases later. Please pass vmin/vmax directly to the norm when creating it.
return super().imshow(X, *args, origin=origin, **kwargs) In addition, we can also specify a region in the map to show the spectral residuals:

:
region = CircleSkyRegion(
center=SkyCoord("83.63 deg", "22.14 deg"), radius=0.5 * u.deg
)
:
stacked.plot_residuals(
kwargs_spatial=dict(method="diff/sqrt(model)", vmin=-0.5, vmax=0.5),
kwargs_spectral=dict(region=region),
);
/usr/share/miniconda/envs/gammapy-dev/lib/python3.7/site-packages/astropy/visualization/wcsaxes/core.py:211: MatplotlibDeprecationWarning: Passing parameters norm and vmin/vmax simultaneously is deprecated since 3.3 and will become an error two minor releases later. Please pass vmin/vmax directly to the norm when creating it.
return super().imshow(X, *args, origin=origin, **kwargs) We can also directly access the .residuals() to get a map, that we can plot interactively:

:
residuals = stacked.residuals(method="diff")
residuals.smooth("0.08 deg").plot_interactive(
);

Plot the fitted spectrum¶

Making a butterfly plot¶

The SpectralModel component can be used to produce a, so-called, butterfly plot showing the envelope of the model taking into account parameter uncertainties:

:
spec = sky_model.spectral_model

Now we can actually do the plot using the plot_error method:

:
energy_bounds = [1, 10] * u.TeV
spec.plot(energy_bounds=energy_bounds, energy_power=2)
ax = spec.plot_error(energy_bounds=energy_bounds, energy_power=2) Computing flux points¶

We can now compute some flux points using the gammapy.estimators.FluxPointsEstimator.

Besides the list of datasets to use, we must provide it the energy intervals on which to compute flux points as well as the model component name.

:
energy_edges = [1, 2, 4, 10] * u.TeV
fpe = FluxPointsEstimator(energy_edges=energy_edges, source="crab")
:
%%time
flux_points = fpe.run(datasets=[stacked])
CPU times: user 2.43 s, sys: 128 ms, total: 2.56 s
Wall time: 2.56 s
:
ax = spec.plot_error(energy_bounds=energy_bounds, energy_power=2)
flux_points.plot(ax=ax, energy_power=2)
:
<AxesSubplot:xlabel='Energy [TeV]', ylabel='dnde (TeV / (cm2 s))'> [ ]: