The sherpa.astro.instrument module

Models of common Astronomical models, particularly in X-rays.

The models in this module include support for instrument models that describe how X-ray photons are converted to measurable properties, such as Pulse-Height Amplitudes (PHA) or Pulse-Invariant channels. These ‘responses’ are assumed to follow OGIP standards, such as [1].

References

[1]OGIP Calibration Memo CAL/GEN/92-002, “The Calibration Requirements for Spectral Analysis (Definition of RMF and ARF file formats)”, Ian M. George1, Keith A. Arnaud, Bill Pence, Laddawan Ruamsuwan and Michael F. Corcoran, https://heasarc.gsfc.nasa.gov/docs/heasarc/caldb/docs/memos/cal_gen_92_002/cal_gen_92_002.html

Classes

ARF1D(arf[, pha, rmf])
PileupResponse1D(pha, pileup_model)
RMF1D(rmf[, pha, arf])
Response1D(pha)
MultipleResponse1D(pha)
PSFModel([name, kernel])
ARFModel(arf, model) Base class for expressing ARF convolution in model expressions.
ARFModelNoPHA(arf, model) ARF convolution model without associated PHA data set.
ARFModelPHA(arf, pha, model) ARF convolution model with associated PHA data set.
RMFModel(rmf, model) Base class for expressing RMF convolution in model expressions.
RMFModelNoPHA(rmf, model) RMF convolution model without an associated PHA data set.
RMFModelPHA(rmf, pha, model) RMF convolution model with associated PHA data set.
RSPModel(arf, rmf, model) Base class for expressing RMF + ARF convolution in model expressions
RSPModelNoPHA(arf, rmf, model) RMF + ARF convolution model without associated PHA data set.
RSPModelPHA(arf, rmf, pha, model) RMF + ARF convolution model with associated PHA.
MultiResponseSumModel(source, pha)
PileupRMFModel(rmf, model[, pha])

Functions

create_arf(elo, ehi[, specresp, exposure, …]) Create an ARF.
create_delta_rmf(rmflo, rmfhi[, offset, …]) Create an ideal RMF.
create_non_delta_rmf(rmflo, rmfhi, fname[, …]) Create a RMF using a matrix from a file.

Class Inheritance Diagram

Inheritance diagram of ARF1D, PileupResponse1D, RMF1D, Response1D, MultipleResponse1D, PSFModel, ARFModel, ARFModelNoPHA, ARFModelPHA, RMFModel, RMFModelNoPHA, RMFModelPHA, RSPModel, RSPModelNoPHA, RSPModelPHA, MultiResponseSumModel, PileupRMFModel