# Licensed under a 3-clause BSD style license - see LICENSE.rst
import logging
import numpy as np
from astropy.coordinates import Angle
from gammapy.datasets import MapDataset
from gammapy.irf import EffectiveAreaTable
from gammapy.maps import Map, MapCoord
__all__ = ["SafeMaskMaker"]
log = logging.getLogger(__name__)
[docs]class SafeMaskMaker:
"""Make safe data range mask for a given observation.
Parameters
----------
methods : {"aeff-default", "aeff-max", "edisp-bias", "offset-max", "bkg-peak"}
Method to use for the safe energy range. Can be a
list with a combination of those. Resulting masks
are combined with logical `and`. "aeff-default"
uses the energy ranged specified in the DL3 data
files, if available.
aeff_percent : float
Percentage of the maximal effective area to be used
as lower energy threshold for method "aeff-max".
bias_percent : float
Percentage of the energy bias to be used as lower
energy threshold for method "edisp-bias"
position : `~astropy.coordinates.SkyCoord`
Position at which the `aeff_percent` or `bias_percent` are computed. By default,
it uses the position of the center of the map.
offset_max : str or `~astropy.units.Quantity`
Maximum offset cut.
"""
available_methods = {
"aeff-default",
"aeff-max",
"edisp-bias",
"offset-max",
"bkg-peak",
}
def __init__(
self,
methods=("aeff-default",),
aeff_percent=10,
bias_percent=10,
position=None,
offset_max="3 deg",
):
methods = set(methods)
if not methods.issubset(self.available_methods):
difference = methods.difference(self.available_methods)
raise ValueError(f"{difference} is not a valid method.")
self.methods = methods
self.aeff_percent = aeff_percent
self.bias_percent = bias_percent
self.position = position
self.offset_max = Angle(offset_max)
[docs] def make_mask_offset_max(self, dataset, observation):
"""Make maximum offset mask.
Parameters
----------
dataset : `~gammapy.datasets.MapDataset` or `~gammapy.datasets.SpectrumDataset`
Dataset to compute mask for.
observation: `~gammapy.data.Observation`
Observation to compute mask for.
Returns
-------
mask_safe : `~numpy.ndarray`
Maximum offset mask.
"""
separation = dataset._geom.separation(observation.pointing_radec)
return separation < self.offset_max
[docs] @staticmethod
def make_mask_energy_aeff_default(dataset, observation):
"""Make safe energy mask from aeff default.
Parameters
----------
dataset : `~gammapy.datasets.MapDataset` or `~gammapy.datasets.SpectrumDataset`
Dataset to compute mask for.
observation: `~gammapy.data.Observation`
Observation to compute mask for.
Returns
-------
mask_safe : `~numpy.ndarray`
Safe data range mask.
"""
try:
e_max = observation.aeff.high_threshold
e_min = observation.aeff.low_threshold
except KeyError:
log.warning(f"No thresholds defined for obs {observation}")
e_min, e_max = None, None
return dataset.counts.geom.energy_mask(emin=e_min, emax=e_max)
[docs] def make_mask_energy_aeff_max(self, dataset):
"""Make safe energy mask from effective area maximum value.
Parameters
----------
dataset : `~gammapy.datasets.MapDataset` or `~gammapy.datasets.SpectrumDataset`
Dataset to compute mask for.
Returns
-------
mask_safe : `~numpy.ndarray`
Safe data range mask.
"""
geom = dataset._geom
if isinstance(dataset, MapDataset):
position = self.position
if position is None:
position = dataset.counts.geom.center_skydir
exposure = dataset.exposure
energy = exposure.geom.get_axis_by_name("energy_true")
coord = MapCoord.create(
{"skycoord": position, "energy_true": energy.center}
)
exposure_1d = exposure.interp_by_coord(coord)
aeff = EffectiveAreaTable(
energy_lo=energy.edges[:-1],
energy_hi=energy.edges[1:],
data=exposure_1d,
)
else:
aeff = dataset.aeff
aeff_thres = (self.aeff_percent / 100) * aeff.max_area
e_min = aeff.find_energy(aeff_thres)
return geom.energy_mask(emin=e_min)
[docs] def make_mask_energy_edisp_bias(self, dataset):
"""Make safe energy mask from energy dispersion bias.
Parameters
----------
dataset : `~gammapy.datasets.MapDataset` or `~gammapy.datasets.SpectrumDataset`
Dataset to compute mask for.
Returns
-------
mask_safe : `~numpy.ndarray`
Safe data range mask.
"""
edisp, geom = dataset.edisp, dataset._geom
if isinstance(dataset, MapDataset):
position = self.position
if position is None:
position = dataset.counts.geom.center_skydir
e_reco = dataset.counts.geom.get_axis_by_name("energy").edges
edisp = edisp.get_edisp_kernel(position, e_reco)
e_min = edisp.get_bias_energy(self.bias_percent / 100)
return geom.energy_mask(emin=e_min)
[docs] @staticmethod
def make_mask_energy_bkg_peak(dataset):
"""Make safe energy mask based on the binned background.
The energy threshold is defined as the upper edge of the energy
bin with the highest predicted background rate. This method is motivated
by its use in the HESS DL3 validation paper: https://arxiv.org/pdf/1910.08088.pdf
Parameters
----------
dataset : `~gammapy.datasets.MapDataset` or `~gammapy.datasets.SpectrumDataset`
Dataset to compute mask for.
Returns
-------
mask_safe : `~numpy.ndarray`
Safe data range mask.
"""
geom = dataset.counts.geom
if isinstance(dataset, MapDataset):
background_spectrum = dataset.background_model.map.get_spectrum()
else:
background_spectrum = dataset.background
idx = np.argmax(background_spectrum.data, axis=0)
energy_axis = geom.get_axis_by_name("energy")
e_min = energy_axis.pix_to_coord(idx)
return geom.energy_mask(emin=e_min)
[docs] def run(self, dataset, observation=None):
"""Make safe data range mask.
Parameters
----------
dataset : `~gammapy.datasets.MapDataset` or `~gammapy.datasets.SpectrumDataset`
Dataset to compute mask for.
observation: `~gammapy.data.Observation`
Observation to compute mask for.
Returns
-------
dataset : `Dataset`
Dataset with defined safe range mask.
"""
mask_safe = np.ones(dataset._geom.data_shape, dtype=bool)
if "offset-max" in self.methods:
mask_safe &= self.make_mask_offset_max(dataset, observation)
if "aeff-default" in self.methods:
mask_safe &= self.make_mask_energy_aeff_default(dataset, observation)
if "aeff-max" in self.methods:
mask_safe &= self.make_mask_energy_aeff_max(dataset)
if "edisp-bias" in self.methods:
mask_safe &= self.make_mask_energy_edisp_bias(dataset)
if "bkg-peak" in self.methods:
mask_safe &= self.make_mask_energy_bkg_peak(dataset)
dataset.mask_safe = Map.from_geom(dataset._geom, data=mask_safe)
return dataset