IRFMap

class gammapy.irf.IRFMap(irf_map, exposure_map)

Bases: object

IRF map base class for DL4 instrument response functions

Attributes Summary

mask_safe_image	Mask safe for the map
required_axes
tag

Methods Summary

copy()	Copy IRF map
cutout(position, width[, mode])	Cutout IRF map.
downsample(factor[, axis_name, weights])	Downsample the spatial dimension by a given factor.
from_hdulist(hdulist[, hdu, hdu_bands, ...])	Create from HDUList.
read(filename[, format, hdu])	Read an IRF_map from file and create corresponding object"
slice_by_idx(slices)	Slice sub dataset.
stack(other[, weights, nan_to_num])	Stack IRF map with another one in place.
to_hdulist([format])	Convert to HDUList.
to_region_nd_map(region)	Extract IRFMap in a given region or position
write(filename[, overwrite, format])	Write IRF map to fits

Attributes Documentation

mask_safe_image

Mask safe for the map

required_axes

tag

Methods Documentation

copy()

Copy IRF map

cutout(position, width, mode='trim')

Cutout IRF map.

Parameters

positionSkyCoord

Center position of the cutout region.

widthtuple of Angle

Angular sizes of the region in (lon, lat) in that specific order. If only one value is passed, a square region is extracted.

mode{‘trim’, ‘partial’, ‘strict’}

Mode option for Cutout2D, for details see Cutout2D.

Returns

cutoutIRFMap

Cutout IRF map.

downsample(factor, axis_name=None, weights=None)

Downsample the spatial dimension by a given factor.

Parameters

factorint

Downsampling factor.

axis_namestr

Which axis to downsample. By default spatial axes are downsampled.

weightsMap

Map with weights downsampling.

Returns

mapIRFMap

Downsampled irf map.

classmethod from_hdulist(hdulist, hdu=None, hdu_bands=None, exposure_hdu=None, exposure_hdu_bands=None, format='gadf')

Create from HDUList.

Parameters

hdulistHDUList

HDU list.

hdustr

Name or index of the HDU with the IRF map.

hdu_bandsstr

Name or index of the HDU with the IRF map BANDS table.

exposure_hdustr

Name or index of the HDU with the exposure map data.

exposure_hdu_bandsstr

Name or index of the HDU with the exposure map BANDS table.

format{“gadf”, “gtpsf”}

File format

Returns

irf_mapIRFMap

IRF map.

classmethod read(filename, format='gadf', hdu=None)

Read an IRF_map from file and create corresponding object”

Parameters

filenamestr or Path

File name

format{“gadf”, “gtpsf”}

File format

hdustr or int

HDU location

Returns

irf_mapPSFMap, EDispMap or EDispKernelMap

IRF map

slice_by_idx(slices)

Slice sub dataset.

The slicing only applies to the maps that define the corresponding axes.

Parameters

slicesdict

Dict of axes names and integers or slice object pairs. Contains one element for each non-spatial dimension. For integer indexing the corresponding axes is dropped from the map. Axes not specified in the dict are kept unchanged.

Returns

map_outIRFMap

Sliced irf map object.

stack(other, weights=None, nan_to_num=True)

Stack IRF map with another one in place.

Parameters

otherIRFMap

IRF map to be stacked with this one.

weightsMap

Map with stacking weights.

nan_to_num: bool

Non-finite values are replaced by zero if True (default).

to_hdulist(format='gadf')

Convert to HDUList.

Parameters

format{“gadf”, “gtpsf”}

File format

Returns

hdu_listHDUList

HDU list.

to_region_nd_map(region)

Extract IRFMap in a given region or position

If a region is given a mean IRF is computed, if a position is given the IRF is interpolated.

Parameters

regionSkyRegion or SkyCoord

Region or position where to get the map.

Returns

irfIRFMap

IRF map with region geometry.

write(filename, overwrite=False, format='gadf')

Write IRF map to fits

Parameters

filenamestr or Path

Filename to write to

overwritebool

Whether to overwrite

format{“gadf”, “gtpsf”}

File format