EDispKernelMap#

class gammapy.irf.EDispKernelMap[source]#

Bases: IRFMap

Energy dispersion kernel map.

Parameters:
edisp_kernel_mapMap

The input energy dispersion kernel map. Should be a Map with 2 non-spatial axes. Reconstructed and true energy axes should be given in this specific order.

exposure_mapMap, optional

Associated exposure map. Needs to have a consistent map geometry.

Attributes Summary

edisp_map

required_axes

tag

Methods Summary

from_diagonal_response(energy_axis, ...[, geom])

Create an energy dispersion map with diagonal response.

from_edisp_kernel(edisp[, geom])

Create an energy dispersion map from the input 1D kernel.

from_gauss(energy_axis, energy_axis_true, ...)

Create an energy dispersion map from the input 1D kernel.

from_geom(geom)

Create energy dispersion map from geometry.

get_edisp_kernel([position, energy_axis])

Get energy dispersion at a given position.

peek([figsize])

Quick-look summary plots.

read(filename[, format, hdu, checksum])

Read an EDispKernelMap from file and create corresponding object.

resample_energy_axis(energy_axis[, weights])

Return a resampled EDispKernelMap.

to_image([weights])

Return a 2D EdispKernelMap by summing over the reconstructed energy axis.

Attributes Documentation

edisp_map#
required_axes = ['energy', 'energy_true']#
tag = 'edisp_kernel_map'#

Methods Documentation

classmethod from_diagonal_response(energy_axis, energy_axis_true, geom=None)[source]#

Create an energy dispersion map with diagonal response.

Parameters:
energy_axisMapAxis

Energy axis.

energy_axis_trueMapAxis

True energy axis

geomGeom, optional

The (2D) geometry object to use. If None, an all sky geometry with 2 bins is created. Default is None.

Returns:
edisp_mapEDispKernelMap

Energy dispersion kernel map.

classmethod from_edisp_kernel(edisp, geom=None)[source]#

Create an energy dispersion map from the input 1D kernel.

The kernel will be duplicated over all spatial bins.

Parameters:
edispEDispKernel

The input 1D kernel.

geomGeom, optional

The (2D) geometry object to use. If None, an all sky geometry with 2 bins is created. Default is None.

Returns:
edisp_mapEDispKernelMap

Energy dispersion kernel map.

classmethod from_gauss(energy_axis, energy_axis_true, sigma, bias, pdf_threshold=1e-06, geom=None)[source]#

Create an energy dispersion map from the input 1D kernel.

The kernel will be duplicated over all spatial bins.

Parameters:
energy_axis_trueQuantity

Bin edges of true energy axis.

energy_axisQuantity

Bin edges of reconstructed energy axis.

biasfloat or ndarray

Center of Gaussian energy dispersion, bias.

sigmafloat or ndarray

RMS width of Gaussian energy dispersion, resolution.

pdf_thresholdfloat, optional

Zero suppression threshold. Default is 1e-6.

geomGeom, optional

The (2D) geometry object to use. If None, an all sky geometry with 2 bins is created. Default is None.

Returns:
edisp_mapEDispKernelMap

Energy dispersion kernel map.

classmethod from_geom(geom)[source]#

Create energy dispersion map from geometry.

By default, a diagonal energy dispersion matrix is created.

Parameters:
geomGeom

Energy dispersion map geometry.

Returns:
edisp_mapEDispKernelMap

Energy dispersion kernel map.

get_edisp_kernel(position=None, energy_axis=None)[source]#

Get energy dispersion at a given position.

Parameters:
positionSkyCoord or SkyRegion, optional

The target position. Should be a single coordinates. Default is None.

energy_axisMapAxis, optional

Reconstructed energy axis, only used for checking. Default is None.

Returns:
edispEnergyDispersion

The energy dispersion (i.e. rmf object).

peek(figsize=(15, 5))[source]#

Quick-look summary plots.

Plots corresponding to the center of the map.

This method creates a figure with two subplots:

  • Bias plot : reconstruction bias as a function of true energy

  • Energy dispersion matrix plot : probability density function matrix

Parameters:
figsizetuple, optional

Size of the figure. Default is (15, 5).

classmethod read(filename, format='gadf', hdu=None, checksum=False)[source]#

Read an EDispKernelMap from file and create corresponding object.

Parameters:
filenamestr or Path

File name.

format{“gadf”, “gtdrm”}, optional

File format. Default is “gadf”. Format “gtdrm” creates an EDispKernelMap including a single EDispKernel.

hdustr or int

HDU location. Default is None.

checksumbool

If True checks both DATASUM and CHECKSUM cards in the file headers. Default is False.

Returns:
edispEDispKernelMap

Energy dispersion kernel map.

resample_energy_axis(energy_axis, weights=None)[source]#

Return a resampled EDispKernelMap.

Bins are grouped according to the edges of the reconstructed energy axis provided. The true energy is left unchanged.

Parameters:
energy_axisMapAxis

The reconstructed energy axis to use for the grouping.

weights: `~gammapy.maps.Map`, optional

Weights to be applied. Default is None.

Returns:
edispEDispKernelMap

Energy dispersion kernel map.

to_image(weights=None)[source]#

Return a 2D EdispKernelMap by summing over the reconstructed energy axis.

Parameters:
weights: `~gammapy.maps.Map`, optional

Weights to be applied. Default is None.

Returns:
edispEDispKernelMap

Energy dispersion kernel map.

__init__(edisp_kernel_map, exposure_map=None)[source]#
classmethod __new__(*args, **kwargs)#