Background3D¶
-
class
gammapy.irf.
Background3D
(energy_axis, fov_lon_axis, fov_lat_axis, data, meta=None, interp_kwargs=None)[source]¶ Bases:
object
Background 3D.
Data format specification: BKG_3D
- Parameters
- energy_axis
MapAxis
Energy axis
- fov_lon_axis: `MapAxis`
FOV coordinate X-axis
- fov_lat_axis
MapAxis
FOV coordinate Y-axis.
- data
Quantity
Background rate (usually:
s^-1 MeV^-1 sr^-1
)
- energy_axis
Examples
Here’s an example you can use to learn about this class:
>>> from gammapy.irf import Background3D >>> filename = '$GAMMAPY_DATA/cta-1dc/caldb/data/cta/1dc/bcf/South_z20_50h/irf_file.fits' >>> bkg_3d = Background3D.read(filename, hdu='BACKGROUND') >>> print(bkg_3d) Background3D NDDataArray summary info energy : size = 21, min = 0.016 TeV, max = 158.489 TeV fov_lon : size = 36, min = -5.833 deg, max = 5.833 deg fov_lat : size = 36, min = -5.833 deg, max = 5.833 deg Data : size = 27216, min = 0.000 1 / (MeV s sr), max = 0.421 1 / (MeV s sr)
Attributes Summary
Default Interpolation kwargs for
NDDataArray
.Methods Summary
evaluate
(fov_lon, fov_lat, energy_reco[, method])Evaluate at given FOV position and energy.
evaluate_integrate
(fov_lon, fov_lat, energy_reco)Integrate in a given energy band.
from_hdulist
(hdulist[, hdu])Create from
HDUList
.from_table
(table)Read from
Table
.peek
([figsize])read
(filename[, hdu])Read from file.
to_2d
()Convert to
Background2D
.to_table
()Convert to
Table
.to_table_hdu
([name])Convert to
BinTableHDU
.Attributes Documentation
-
default_interp_kwargs
= {'bounds_error': False, 'fill_value': None, 'values_scale': 'log'}¶ Default Interpolation kwargs for
NDDataArray
. Extrapolate.
-
tag
= 'bkg_3d'¶
Methods Documentation
-
evaluate
(fov_lon, fov_lat, energy_reco, method='linear', **kwargs)[source]¶ Evaluate at given FOV position and energy.
- Parameters
- fov_lon, fov_lat
Angle
FOV coordinates expecting in AltAz frame.
- energy_reco
Quantity
energy on which you want to interpolate. Same dimension than fov_lat and fov_lat
- methodstr {‘linear’, ‘nearest’}, optional
Interpolation method
- kwargsdict
option for interpolation for
RegularGridInterpolator
- fov_lon, fov_lat
- Returns
- array
Quantity
Interpolated values, axis order is the same as for the NDData array
- array
-
evaluate_integrate
(fov_lon, fov_lat, energy_reco, method='linear', **kwargs)[source]¶ Integrate in a given energy band.
-
to_2d
()[source]¶ Convert to
Background2D
.This takes the values at Y = 0 and X >= 0.
-
to_table_hdu
(name='BACKGROUND')[source]¶ Convert to
BinTableHDU
.