Background2D#
- class gammapy.irf.Background2D(axes, data=0, unit='', is_pointlike=False, fov_alignment=FoVAlignment.RADEC, meta=None, interp_kwargs=None)[source]#
Bases:
gammapy.irf.background.BackgroundIRF
Background 2D.
Data format specification: BKG_2D
- Parameters
- axeslist of
MapAxis
orMapAxes
object Required data axes: [“energy”, “offset”] in the given order.
- data
ndarray
Data array.
- unitstr or
Unit
Data unit usually
s^-1 MeV^-1 sr^-1
- metadict
Meta data
- axeslist of
Attributes Summary
MapAxes
Default Interpolation kwargs to extrapolate.
Alignment of the field of view coordinate axes, see
FoVAlignment
Whether the IRF explicitly depends on offset
Whether the IRF is pointlike of full containment.
Map unit (
Unit
)Methods Summary
cumsum
(axis_name)Compute cumsum along a given axis
evaluate
([method])Evaluate IRF
from_hdulist
(hdulist[, hdu, format])Create from
HDUList
.from_table
(table[, format])Read from
Table
.integral
(axis_name, **kwargs)Compute integral along a given axis
integrate_log_log
(axis_name, **kwargs)Integrate along a given axis.
interp_missing_data
(axis_name)Interpolate missing data along a given axis
is_allclose
(other[, rtol_axes, atol_axes])Compare two data IRFs for equivalency
normalize
(axis_name)Normalise data in place along a given axis.
pad
(pad_width, axis_name, **kwargs)Pad irf along a given axis.
peek
([figsize])Quick-look summary plots.
plot
([ax, add_cbar])Plot energy offset dependence of the background model.
plot_at_energy
([energy, add_cbar, ncols, ...])Plot the background rate in Field of view coordinates at a given energy.
plot_energy_dependence
([ax, offset])Plot background rate versus energy for a given offset.
plot_offset_dependence
([ax, energy])Plot background rate versus offset for a given energy.
plot_spectrum
([ax])Plot angle integrated background rate versus energy.
read
(filename[, hdu, format])Read from file.
slice_by_idx
(slices)Slice sub IRF from IRF object.
to_3d
()"Convert to Background3D
to_hdulist
([format])to_table
([format])Convert to table
to_table_hdu
([format])Convert to
BinTableHDU
.to_unit
(unit)Convert irf to different unit
write
(filename, *args, **kwargs)Write IRF to fits.
Attributes Documentation
- axes#
MapAxes
- data#
- default_interp_kwargs = {'bounds_error': False, 'fill_value': 0.0, 'values_scale': 'log'}#
Default Interpolation kwargs to extrapolate.
- default_unit = Unit("1 / (MeV s sr)")#
- fov_alignment#
Alignment of the field of view coordinate axes, see
FoVAlignment
- has_offset_axis#
Whether the IRF explicitly depends on offset
- is_pointlike#
Whether the IRF is pointlike of full containment.
- required_axes = ['energy', 'offset']#
- tag = 'bkg_2d'#
Methods Documentation
- cumsum(axis_name)#
Compute cumsum along a given axis
- Parameters
- axis_namestr
Along which axis to integrate.
- Returns
- irf
IRF
Cumsum IRF
- irf
- evaluate(method=None, **kwargs)#
Evaluate IRF
- Parameters
- **kwargsdict
Coordinates at which to evaluate the IRF
- methodstr {‘linear’, ‘nearest’}, optional
Interpolation method
- Returns
- array
Quantity
Interpolated values
- array
- classmethod from_hdulist(hdulist, hdu=None, format='gadf-dl3')#
Create from
HDUList
.- Parameters
- hdulist
HDUList
HDU list
- hdustr
HDU name
- format{“gadf-dl3”}
Format specification
- hdulist
- Returns
- irf
IRF
IRF class
- irf
- classmethod from_table(table, format='gadf-dl3')#
Read from
Table
.- Parameters
- table
Table
Table with background data
- format{“gadf-dl3”}
Format specification
- table
- Returns
- bkg
Background2D
orBackground2D
Background IRF class.
- bkg
- integral(axis_name, **kwargs)#
Compute integral along a given axis
This method uses interpolation of the cumulative sum.
- Parameters
- axis_namestr
Along which axis to integrate.
- **kwargsdict
Coordinates at which to evaluate the IRF
- Returns
- array
Quantity
Returns 2D array with axes offset
- array
- integrate_log_log(axis_name, **kwargs)#
Integrate along a given axis.
This method uses log-log trapezoidal integration.
- Parameters
- axis_namestr
Along which axis to integrate.
- **kwargsdict
Coordinates at which to evaluate the IRF
- Returns
- array
Quantity
Returns 2D array with axes offset
- array
- interp_missing_data(axis_name)#
Interpolate missing data along a given axis
- is_allclose(other, rtol_axes=0.001, atol_axes=1e-06, **kwargs)#
Compare two data IRFs for equivalency
- Parameters
- other
gammapy.irfs.IRF
The irf to compare against
- rtol_axesfloat
Relative tolerance for the axes comparison.
- atol_axesfloat
Relative tolerance for the axes comparison.
- **kwargsdict
keywords passed to
numpy.allclose
- other
- Returns
- is_allclosebool
Whether the IRF is all close.
- normalize(axis_name)#
Normalise data in place along a given axis.
- Parameters
- axis_namestr
Along which axis to normalize.
- pad(pad_width, axis_name, **kwargs)#
Pad irf along a given axis.
- Parameters
- pad_width{sequence, array_like, int}
Number of pixels padded to the edges of each axis.
- axis_namestr
Which axis to downsample. By default spatial axes are padded.
- **kwargsdict
Keyword argument forwarded to
pad
- Returns
- irf
IRF
Padded irf
- irf
- plot(ax=None, add_cbar=True, **kwargs)[source]#
Plot energy offset dependence of the background model.
- plot_at_energy(energy=None, add_cbar=True, ncols=3, figsize=None, **kwargs)[source]#
Plot the background rate in Field of view coordinates at a given energy.
- Parameters
- energy
Quantity
list of Energy
- add_cbarbool
Add color bar?
- ncolsint
Number of columns to plot
- figsizetuple
Figure size
- **kwargsdict
Keyword arguments passed to
pcolormesh
.
- energy
- plot_energy_dependence(ax=None, offset=None, **kwargs)[source]#
Plot background rate versus energy for a given offset.
- plot_offset_dependence(ax=None, energy=None, **kwargs)[source]#
Plot background rate versus offset for a given energy.
- classmethod read(filename, hdu=None, format='gadf-dl3')#
Read from file.
- Parameters
- filenamestr or
Path
Filename
- hdustr
HDU name
- format{“gadf-dl3”}
Format specification
- filenamestr or
- Returns
- irf
IRF
IRF class
- irf
- slice_by_idx(slices)#
Slice sub IRF from IRF object.
- Parameters
- slicesdict
Dict of axes names and
slice
object pairs. Contains one element for each non-spatial dimension. Axes not specified in the dict are kept unchanged.
- Returns
- sliced
IRF
Sliced IRF object.
- sliced
- to_hdulist(format='gadf-dl3')#
- to_table(format='gadf-dl3')#
Convert to table
- Parameters
- format{“gadf-dl3”}
Format specification
- Returns
- table
Table
IRF data table
- table
- to_table_hdu(format='gadf-dl3')#
Convert to
BinTableHDU
.- Parameters
- format{“gadf-dl3”}
Format specification
- Returns
- hdu
BinTableHDU
IRF data table hdu
- hdu
- to_unit(unit)#
Convert irf to different unit
- Parameters
- unit
Unit
or str New unit
- unit
- Returns
- irf
IRF
IRF with new unit and converted data
- irf