def create_energy_dispersion_hdu(
energy_dispersion,
true_energy_bins,
migration_bins,
fov_offset_bins,
point_like=True,
extname="EDISP",
**header_cards,
):
"""
Create a fits binary table HDU in GADF format for the energy dispersion.
See the specification at
https://gamma-astro-data-formats.readthedocs.io/en/latest/irfs/full_enclosure/aeff/index.html
Parameters
----------
energy_dispersion: numpy.ndarray
Energy dispersion array, must have shape
(n_energy_bins, n_migra_bins, n_source_offset_bins)
true_energy_bins: astropy.units.Quantity[energy]
Bin edges in true energy
migration_bins: numpy.ndarray
Bin edges for the relative energy migration (``reco_energy / true_energy``)
fov_offset_bins: astropy.units.Quantity[angle]
Bin edges in the field of view offset.
For Point-Like IRFs, only giving a single bin is appropriate.
point_like: bool
If the provided effective area was calculated after applying a direction cut,
pass ``True``, else ``False`` for a full-enclosure effective area.
extname: str
Name for BinTableHDU
**header_cards
Additional metadata to add to the header, use this to set e.g. TELESCOP or
INSTRUME.
"""
edisp = QTable()
edisp["ENERG_LO"], edisp["ENERG_HI"] = binning.split_bin_lo_hi(
true_energy_bins[np.newaxis, :].to(u.TeV))
edisp["MIGRA_LO"], edisp["MIGRA_HI"] = binning.split_bin_lo_hi(
migration_bins[np.newaxis, :])
edisp["THETA_LO"], edisp["THETA_HI"] = binning.split_bin_lo_hi(
fov_offset_bins[np.newaxis, :].to(u.deg))
# transpose as FITS uses opposite dimension order
edisp["MATRIX"] = u.Quantity(energy_dispersion.T[np.newaxis,
...]).to(u.one)
# required header keywords
header = DEFAULT_HEADER.copy()
header["HDUCLAS1"] = "RESPONSE"
header["HDUCLAS2"] = "EDISP"
header["HDUCLAS3"] = "POINT-LIKE" if point_like else "FULL-ENCLOSURE"
header["HDUCLAS4"] = "EDISP_2D"
header["DATE"] = Time.now().utc.iso
_add_header_cards(header, **header_cards)
return BinTableHDU(edisp, header=header, name=extname)
def create_psf_table_hdu(
psf,
true_energy_bins,
source_offset_bins,
fov_offset_bins,
extname="PSF",
**header_cards,
):
"""
Create a fits binary table HDU in GADF format for the PSF table.
See the specification at
https://gamma-astro-data-formats.readthedocs.io/en/latest/irfs/full_enclosure/psf/psf_table/index.html
Parameters
----------
psf: astropy.units.Quantity[(solid angle)^-1]
Point spread function array, must have shape
(n_energy_bins, n_fov_offset_bins, n_source_offset_bins)
true_energy_bins: astropy.units.Quantity[energy]
Bin edges in true energy
source_offset_bins: astropy.units.Quantity[angle]
Bin edges in the source offset.
fov_offset_bins: astropy.units.Quantity[angle]
Bin edges in the field of view offset.
For Point-Like IRFs, only giving a single bin is appropriate.
extname: str
Name for BinTableHDU
**header_cards
Additional metadata to add to the header, use this to set e.g. TELESCOP or
INSTRUME.
"""
psf_ = QTable()
psf_["ENERG_LO"], psf_["ENERG_HI"] = binning.split_bin_lo_hi(
true_energy_bins[np.newaxis, :].to(u.TeV))
psf_["THETA_LO"], psf_["THETA_HI"] = binning.split_bin_lo_hi(
fov_offset_bins[np.newaxis, :].to(u.deg))
psf_["RAD_LO"], psf_["RAD_HI"] = binning.split_bin_lo_hi(
source_offset_bins[np.newaxis, :].to(u.deg))
# transpose as FITS uses opposite dimension order
psf_["RPSF"] = psf.T[np.newaxis, ...].to(1 / u.sr)
# required header keywords
header = DEFAULT_HEADER.copy()
header["HDUCLAS1"] = "RESPONSE"
header["HDUCLAS2"] = "PSF"
header["HDUCLAS3"] = "FULL-ENCLOSURE"
header["HDUCLAS4"] = "PSF_TABLE"
header["DATE"] = Time.now().utc.iso
_add_header_cards(header, **header_cards)
return BinTableHDU(psf_, header=header, name=extname)
def create_rad_max_hdu(
rad_max,
reco_energy_bins,
fov_offset_bins,
point_like=True,
extname="RAD_MAX",
**header_cards,
):
"""
Create a fits binary table HDU in GADF format for the directional cut.
See the specification at
https://gamma-astro-data-formats.readthedocs.io/en/latest/irfs/full_enclosure/aeff/index.html
Parameters
----------
rad_max: astropy.units.Quantity[angle]
Array of the directional (theta) cut.
Must have shape (n_reco_energy_bins, n_fov_offset_bins)
reco_energy_bins: astropy.units.Quantity[energy]
Bin edges in reconstructed energy
fov_offset_bins: astropy.units.Quantity[angle]
Bin edges in the field of view offset.
For Point-Like IRFs, only giving a single bin is appropriate.
extname: str
Name for BinTableHDU
**header_cards
Additional metadata to add to the header, use this to set e.g. TELESCOP or
INSTRUME.
"""
rad_max_table = QTable()
rad_max_table["ENERG_LO"], rad_max_table[
"ENERG_HI"] = binning.split_bin_lo_hi(
reco_energy_bins[np.newaxis, :].to(u.TeV))
rad_max_table["THETA_LO"], rad_max_table[
"THETA_HI"] = binning.split_bin_lo_hi(
fov_offset_bins[np.newaxis, :].to(u.deg))
# transpose as FITS uses opposite dimension order
rad_max_table["RAD_MAX"] = rad_max.T[np.newaxis, ...].to(u.deg)
# required header keywords
header = DEFAULT_HEADER.copy()
header["HDUCLAS1"] = "RESPONSE"
header["HDUCLAS2"] = "RAD_MAX"
header["HDUCLAS3"] = "POINT-LIKE"
header["HDUCLAS4"] = "RAD_MAX_2D"
header["DATE"] = Time.now().utc.iso
_add_header_cards(header, **header_cards)
return BinTableHDU(rad_max_table, header=header, name=extname)
def create_aeff2d_hdu(
effective_area,
true_energy_bins,
fov_offset_bins,
extname="EFFECTIVE AREA",
point_like=True,
**header_cards,
):
"""
Create a fits binary table HDU in GADF format for effective area.
See the specification at
https://gamma-astro-data-formats.readthedocs.io/en/latest/irfs/full_enclosure/aeff/index.html
Parameters
----------
effective_area: astropy.units.Quantity[area]
Effective area array, must have shape (n_energy_bins, n_fov_offset_bins)
true_energy_bins: astropy.units.Quantity[energy]
Bin edges in true energy
fov_offset_bins: astropy.units.Quantity[angle]
Bin edges in the field of view offset.
For Point-Like IRFs, only giving a single bin is appropriate.
point_like: bool
If the provided effective area was calculated after applying a direction cut,
pass ``True``, else ``False`` for a full-enclosure effective area.
extname: str
Name for BinTableHDU
**header_cards
Additional metadata to add to the header, use this to set e.g. TELESCOP or
INSTRUME.
"""
aeff = QTable()
aeff["ENERG_LO"], aeff["ENERG_HI"] = binning.split_bin_lo_hi(
true_energy_bins[np.newaxis, :].to(u.TeV))
aeff["THETA_LO"], aeff["THETA_HI"] = binning.split_bin_lo_hi(
fov_offset_bins[np.newaxis, :].to(u.deg))
# transpose because FITS uses opposite dimension order than numpy
aeff["EFFAREA"] = effective_area.T[np.newaxis, ...].to(u.m**2)
# required header keywords
header = DEFAULT_HEADER.copy()
header["HDUCLAS1"] = "RESPONSE"
header["HDUCLAS2"] = "EFF_AREA"
header["HDUCLAS3"] = "POINT-LIKE" if point_like else "FULL-ENCLOSURE"
header["HDUCLAS4"] = "AEFF_2D"
header["DATE"] = Time.now().utc.iso
_add_header_cards(header, **header_cards)
return BinTableHDU(aeff, header=header, name=extname)
def create_background_2d_hdu(
background_2d,
reco_energy_bins,
fov_offset_bins,
extname="BACKGROUND",
**header_cards,
):
"""
Create a fits binary table HDU in GADF format for the background 2d table.
See the specification at
https://gamma-astro-data-formats.readthedocs.io/en/latest/irfs/full_enclosure/bkg/index.html#bkg-2d
Parameters
----------
background_2d: astropy.units.Quantity[(MeV s sr)^-1]
Background rate, must have shape
(n_energy_bins, n_fov_offset_bins)
reco_energy_bins: astropy.units.Quantity[energy]
Bin edges in reconstructed energy
fov_offset_bins: astropy.units.Quantity[angle]
Bin edges in the field of view offset.
extname: str
Name for BinTableHDU
**header_cards
Additional metadata to add to the header, use this to set e.g. TELESCOP or
INSTRUME.
"""
bkg = QTable()
bkg["ENERG_LO"], bkg["ENERG_HI"] = binning.split_bin_lo_hi(
reco_energy_bins[np.newaxis, :].to(u.TeV))
bkg["THETA_LO"], bkg["THETA_HI"] = binning.split_bin_lo_hi(
fov_offset_bins[np.newaxis, :].to(u.deg))
# transpose as FITS uses opposite dimension order
bkg["BKG"] = background_2d.T[np.newaxis, ...].to(GADF_BACKGROUND_UNIT)
# required header keywords
header = DEFAULT_HEADER.copy()
header["HDUCLAS1"] = "RESPONSE"
header["HDUCLAS2"] = "BKG"
header["HDUCLAS3"] = "FULL-ENCLOSURE"
header["HDUCLAS4"] = "BKG_2D"
header["DATE"] = Time.now().utc.iso
_add_header_cards(header, **header_cards)
return BinTableHDU(bkg, header=header, name=extname)
def test_split_bin_lo_hi():
"""Test split_bin_lo_hi function."""
bins = np.array([np.logspace(-1,3, 20)*u.TeV])
bins_lo_true = bins[:,:-1]
bins_hi_true = bins[:,1:]
bin_lo, bin_hi = binning.split_bin_lo_hi(bins)
assert np.allclose(bin_lo, bins_lo_true, rtol=1.e-5)
assert np.allclose(bin_hi, bins_hi_true, rtol=1.e-5)