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

CTA data analysis with Gammapy

Introduction

This notebook shows an example how to make a sky image and spectrum for simulated CTA data with Gammapy.

The dataset we will use is three observation runs on the Galactic center. This is a tiny (and thus quick to process and play with and learn) subset of the simulated CTA dataset that was produced for the first data challenge in August 2017.

Setup

As usual, we’ll start with some setup …

[1]:

%matplotlib inline
import matplotlib.pyplot as plt

[2]:

!gammapy info --no-envvar --no-system


Gammapy package:

        version                : 0.16
        path                   : /Users/adonath/github/adonath/gammapy/gammapy


Other packages:

        numpy                  : 1.18.1
        scipy                  : 1.3.1
        astropy                : 4.1.dev27293
        regions                : 0.4
        click                  : 7.0
        yaml                   : 5.2
        IPython                : 7.10.2
        jupyterlab             : 1.2.4
        matplotlib             : 3.1.2
        pandas                 : 0.25.3
        healpy                 : 1.13.0
        iminuit                : 1.3.8
        sherpa                 : 4.11.1
        naima                  : 0.9.0
        emcee                  : 2.2.1
        corner                 : 2.0.1
        parfive                : 1.0.0


[3]:

import numpy as np
import astropy.units as u
from astropy.coordinates import SkyCoord
from astropy.convolution import Gaussian2DKernel
from regions import CircleSkyRegion
from gammapy.modeling import Fit, Datasets
from gammapy.data import DataStore
from gammapy.modeling.models import PowerLawSpectralModel, SkyModel
from gammapy.spectrum import (
    SpectrumDatasetMaker,
    SpectrumDataset,
    FluxPointsEstimator,
    FluxPointsDataset,
    ReflectedRegionsBackgroundMaker,
    plot_spectrum_datasets_off_regions,
)
from gammapy.maps import MapAxis, WcsNDMap, WcsGeom
from gammapy.cube import MapDatasetMaker, MapDataset, SafeMaskMaker
from gammapy.detect import TSMapEstimator, find_peaks

[4]:

# Configure the logger, so that the spectral analysis
# isn't so chatty about what it's doing.
import logging

logging.basicConfig()
log = logging.getLogger("gammapy.spectrum")
log.setLevel(logging.ERROR)

Select observations

A Gammapy analysis usually starts by creating a gammapy.data.DataStore and selecting observations.

This is shown in detail in the other notebook, here we just pick three observations near the galactic center.

[5]:

data_store = DataStore.from_dir("$GAMMAPY_DATA/cta-1dc/index/gps")

[6]:

# Just as a reminder: this is how to select observations
# from astropy.coordinates import SkyCoord
# table = data_store.obs_table
# pos_obs = SkyCoord(table['GLON_PNT'], table['GLAT_PNT'], frame='galactic', unit='deg')
# pos_target = SkyCoord(0, 0, frame='galactic', unit='deg')
# offset = pos_target.separation(pos_obs).deg
# mask = (1 < offset) & (offset < 2)
# table = table[mask]
# table.show_in_browser(jsviewer=True)

[7]:

obs_id = [110380, 111140, 111159]
observations = data_store.get_observations(obs_id)

[8]:

obs_cols = ["OBS_ID", "GLON_PNT", "GLAT_PNT", "LIVETIME"]
data_store.obs_table.select_obs_id(obs_id)[obs_cols]

[8]:
ObservationTable length=3
OBS_IDGLON_PNTGLAT_PNTLIVETIME
degdegs
int64float64float64float64
110380359.9999912037958-1.2999959379053661764.0
111140358.49998338300741.30000202119542841764.0
1111591.50000565682677411.2999404683352941764.0

Make sky images

Define map geometry

Select the target position and define an ON region for the spectral analysis

[9]:

axis = MapAxis.from_edges(
    np.logspace(-1.0, 1.0, 10), unit="TeV", name="energy", interp="log"
)
geom = WcsGeom.create(
    skydir=(0, 0), npix=(500, 400), binsz=0.02, frame="galactic", axes=[axis]
)
geom

[9]:

WcsGeom

        axes       : ['lon', 'lat', 'energy']
        shape      : (500, 400, 9)
        ndim       : 3
        frame   : galactic
        projection : CAR
        center     : 0.0 deg, 0.0 deg
        width      : 10.0 deg x 8.0 deg

Compute images

Exclusion mask currently unused. Remove here or move to later in the tutorial?

[10]:

target_position = SkyCoord(0, 0, unit="deg", frame="galactic")
on_radius = 0.2 * u.deg
on_region = CircleSkyRegion(center=target_position, radius=on_radius)

[11]:

exclusion_mask = geom.to_image().region_mask([on_region], inside=False)
exclusion_mask = WcsNDMap(geom.to_image(), exclusion_mask)
exclusion_mask.plot();
../_images/notebooks_cta_data_analysis_16_0.png 
[12]:

%%time
stacked = MapDataset.create(geom=geom)
maker = MapDatasetMaker(selection=["counts", "background", "exposure"])
maker_safe_mask = SafeMaskMaker(methods=["offset-max"], offset_max=2.5 * u.deg)

for obs in observations:
    cutout = stacked.cutout(obs.pointing_radec, width="5 deg")
    dataset = maker.run(cutout, obs)
    dataset = maker_safe_mask.run(dataset, obs)
    stacked.stack(dataset)

CPU times: user 2.03 s, sys: 431 ms, total: 2.46 s
Wall time: 2.5 s

[13]:

# The maps are cubes, with an energy axis.
# Let's also make some images:
dataset_image = stacked.to_image()

images = {
    "counts": dataset_image.counts.get_image_by_idx((0,)),
    "exposure": dataset_image.exposure.get_image_by_idx((0,)),
    "background": dataset_image.background_model.map.get_image_by_idx((0,)),
}

images["excess"] = images["counts"] - images["background"]

/Users/adonath/github/adonath/gammapy/gammapy/cube/psf_map.py:483: RuntimeWarning: invalid value encountered in true_divide
  psf_data = exp_weighed.data * self.psf_map.data / exposure.data

Show images

Let’s have a quick look at the images we computed …

[14]:

images["counts"].smooth(2).plot(vmax=5);
../_images/notebooks_cta_data_analysis_20_0.png 
[15]:

images["background"].plot(vmax=5);
../_images/notebooks_cta_data_analysis_21_0.png 
[16]:

images["excess"].smooth(3).plot(vmax=2);
../_images/notebooks_cta_data_analysis_22_0.png

Source Detection

Use the class gammapy.detect.TSMapEstimator and gammapy.detect.find_peaks to detect sources on the images:

[17]:

kernel = Gaussian2DKernel(1, mode="oversample").array
plt.imshow(kernel);
../_images/notebooks_cta_data_analysis_24_0.png 
[18]:

%%time
ts_image_estimator = TSMapEstimator()
images_ts = ts_image_estimator.run(dataset_image, kernel)
print(images_ts.keys())

/Users/adonath/github/adonath/astropy/astropy/units/quantity.py:481: RuntimeWarning: invalid value encountered in true_divide
  result = super().__array_ufunc__(function, method, *arrays, **kwargs)

dict_keys(['ts', 'sqrt_ts', 'flux', 'flux_err', 'flux_ul', 'niter'])
CPU times: user 11.7 s, sys: 250 ms, total: 12 s
Wall time: 12.1 s

[19]:

sources = find_peaks(images_ts["sqrt_ts"], threshold=8)
sources

[19]:
Table length=2
valuexyradec
degdeg
float32int64int64float64float64
26.8252197266.42400-29.00490
10.284207204266.82019-28.16314
[20]:

source_pos = SkyCoord(sources["ra"], sources["dec"])
source_pos

[20]:

<SkyCoord (ICRS): (ra, dec) in deg
    [(266.42399798, -29.00490483), (266.82018801, -28.16313964)]>

[21]:

# Plot sources on top of significance sky image
images_ts["sqrt_ts"].plot(add_cbar=True)

plt.gca().scatter(
    source_pos.ra.deg,
    source_pos.dec.deg,
    transform=plt.gca().get_transform("icrs"),
    color="none",
    edgecolor="white",
    marker="o",
    s=200,
    lw=1.5,
);
../_images/notebooks_cta_data_analysis_28_0.png

Spatial analysis

See other notebooks for how to run a 3D cube or 2D image based analysis.

Spectrum

We’ll run a spectral analysis using the classical reflected regions background estimation method, and using the on-off (often called WSTAT) likelihood function.

[22]:

e_reco = np.logspace(-1, np.log10(40), 40) * u.TeV
e_true = np.logspace(np.log10(0.05), 2, 200) * u.TeV

dataset_empty = SpectrumDataset.create(
    e_reco=e_reco, e_true=e_true, region=on_region
)

[23]:

dataset_maker = SpectrumDatasetMaker(
    containment_correction=False, selection=["counts", "aeff", "edisp"]
)
bkg_maker = ReflectedRegionsBackgroundMaker(exclusion_mask=exclusion_mask)
safe_mask_masker = SafeMaskMaker(methods=["aeff-max"], aeff_percent=10)

[24]:

%%time
datasets = []

for observation in observations:
    dataset = dataset_maker.run(dataset_empty.copy(), observation)
    dataset_on_off = bkg_maker.run(dataset, observation)
    dataset_on_off = safe_mask_masker.run(dataset_on_off, observation)
    datasets.append(dataset_on_off)

CPU times: user 5.19 s, sys: 203 ms, total: 5.39 s
Wall time: 5.46 s

[25]:

plt.figure(figsize=(8, 8))
_, ax, _ = images["counts"].smooth("0.03 deg").plot(vmax=8)

on_region.to_pixel(ax.wcs).plot(ax=ax, edgecolor="white")
plot_spectrum_datasets_off_regions(datasets, ax=ax)
../_images/notebooks_cta_data_analysis_34_0.png

Model fit

The next step is to fit a spectral model, using all data (i.e. a “global” fit, using all energies).

[26]:

%%time
spectral_model = PowerLawSpectralModel(
    index=2, amplitude=1e-11 * u.Unit("cm-2 s-1 TeV-1"), reference=1 * u.TeV
)
model = SkyModel(spectral_model=spectral_model)
for dataset in datasets:
    dataset.models = model

fit = Fit(datasets)
result = fit.run()
print(result)

OptimizeResult

        backend    : minuit
        method     : minuit
        success    : True
        message    : Optimization terminated successfully.
        nfev       : 108
        total stat : 75.81

CPU times: user 415 ms, sys: 4.46 ms, total: 419 ms
Wall time: 424 ms

Spectral points

Finally, let’s compute spectral points. The method used is to first choose an energy binning, and then to do a 1-dim likelihood fit / profile to compute the flux and flux error.

[27]:

# Flux points are computed on stacked observation
stacked_dataset = Datasets(datasets).stack_reduce()

print(stacked_dataset)

SpectrumDatasetOnOff
--------------------

  Name                            : hPVrILrU

  Total counts                    : 441
  Total predicted counts          : 1118.93
  Total off counts                : 2278.00

  Total background counts         : 91.22

  Effective area min              : 1.88e+08 cm2
  Effective area max              : 4.64e+10 cm2

  Livetime                        : 5.29e+03 s

  Acceptance mean:                : 1.0

  Number of total bins            : 39
  Number of fit bins              : 29

  Fit statistic type              : wstat
  Fit statistic value (-2 log(L)) : 29.87

  Number of parameters            : 3
  Number of free parameters       : 2

  Component 0: SkyModel

    Name                      : ogMo8zh2
    Spectral model type       : PowerLawSpectralModel
    Spatial  model type       : None
    Temporal model type       :
    Parameters:
      index                   :   2.423
      amplitude               :   3.38e-12  1 / (cm2 s TeV)
      reference    (frozen)   :   1.000  TeV



[28]:

e_edges = np.logspace(0, 1.5, 5) * u.TeV

stacked_dataset.model = model

fpe = FluxPointsEstimator(datasets=[stacked_dataset], e_edges=e_edges)
flux_points = fpe.run()
flux_points.table_formatted

/Users/adonath/github/adonath/astropy/astropy/units/quantity.py:481: RuntimeWarning: invalid value encountered in true_divide
  result = super().__array_ufunc__(function, method, *arrays, **kwargs)

[28]:
Table length=4
e_refe_mine_maxref_dnderef_fluxref_efluxref_e2dndenormstatnorm_errcounts [1]norm_errpnorm_errnnorm_ulsqrt_tstsnorm_scan [11]stat_scan [11]dndednde_uldnde_errdnde_errpdnde_errn
TeVTeVTeV1 / (cm2 s TeV)1 / (cm2 s)TeV / (cm2 s)TeV / (cm2 s)1 / (cm2 s TeV)1 / (cm2 s TeV)1 / (cm2 s TeV)1 / (cm2 s TeV)1 / (cm2 s TeV)
float64float64float64float64float64float64float64float64float64float64int64float64float64float64float64float64float64float64float64float64float64float64float64
1.5881.0022.5181.101e-121.731e-122.578e-122.779e-120.8905.8440.0991240.1030.0951.10013.995195.8490.200 .. 5.00092.974 .. 547.6849.798e-131.212e-121.089e-131.131e-131.050e-13
3.6972.5185.4291.422e-134.242e-131.499e-121.943e-121.0611.2310.145720.1510.1391.37412.304151.3820.200 .. 5.00072.896 .. 256.6231.509e-131.954e-132.058e-142.145e-141.973e-14
8.6075.42913.6471.835e-141.562e-131.261e-121.359e-121.05311.9890.206350.2180.1951.5138.48371.9680.200 .. 5.00046.156 .. 137.6221.932e-142.777e-143.788e-154.008e-153.575e-15
20.03713.64729.4192.368e-153.829e-147.334e-139.506e-130.7183.6120.31870.3590.2801.5223.73213.9280.200 .. 5.0008.322 .. 49.6741.700e-153.605e-157.532e-168.494e-166.628e-16

Plot

Let’s plot the spectral model and points. You could do it directly, but there is a helper class. Note that a spectral uncertainty band, a “butterfly” is drawn, but it is very thin, i.e. barely visible.

[29]:

model.spectral_model.parameters.covariance = result.parameters.covariance
flux_points_dataset = FluxPointsDataset(data=flux_points, models=model)

[30]:

plt.figure(figsize=(8, 6))
flux_points_dataset.peek();
../_images/notebooks_cta_data_analysis_42_0.png

Exercises

  • Re-run the analysis above, varying some analysis parameters, e.g.

    • Select a few other observations

    • Change the energy band for the map

    • Change the spectral model for the fit

    • Change the energy binning for the spectral points

  • Change the target. Make a sky image and spectrum for your favourite source.

    • If you don’t know any, the Crab nebula is the “hello world!” analysis of gamma-ray astronomy.

[31]:

# print('hello world')
# SkyCoord.from_name('crab')

What next?

  • This notebook showed an example of a first CTA analysis with Gammapy, using simulated 1DC data.

  • Let us know if you have any question or issues!