fake_pha

sherpa.astro.fake.fake_pha(data, model, is_source=True, pileup_model=None, add_bkgs=False, bkg_models={}, id=None)[source] [edit on github]

Simulate a PHA data set from a model.

This function replaces the counts in a PHA dataset with simulated counts drawn from a model with Poisson noise. For the simulations, all the details already set up in the PHA dataset will be used, including the exposure time, one or more ARFs and RMFs, area and background scalings, grouping, and data quality arrys.

Including a background component is optional; if requested, the background will be a Poisson draw from the average of all backgrounds that have been set for the input sherpa.astro.data.DataPHA. For each background component, the method can use either the PHA distribution in that background component or a model that is evaluated using the response set for that background component. The later case avoids adding extra noise from a Poisson draw from a distribution that might already have very few counts in the first place.

The backgrounds itself are not changed by this function. To simulate backgrounds as well as the source spectrum, call this function on the source PHA dataset and the background PHA dataset(s) independently.

Parameters

  • data (sherpa.astro.data.DataPHA) – The dataset (may be a background dataset).

  • model (sherpa.models.model.ArithmeticModel instance) – The model that will be used for simulations.

  • is_source (bool) – True means that the model does not contain response or background components and that these need to be added based on the ARF, RMF, and backgrounds set up for the data set. If False, then the model contains any components to describe the instrument already.

  • pileup_model (None or sherpa.astro.models.JDPileup instance) – Pileup Model for the source spectrum

  • add_bkgs (bool) – If True backgrounds are added to the source counts.

  • bkg_srcs (dict) –

    Keys in the dictionary need to be the background ids in the dataset data, and the values are the corresponsing source models. For all background datasets that are listed in this dictionary, the background counts will be simulated based on the model, appropriately scaled (for area etc.) and added to the source. The same is_source setting as for the source model applies here, i.e. if the source model already contains the ARF and the RMF, then the background models should do so, too. This setting has no effect if add_bkgs=False.

    For all background ids not listed in this dictionary, the counts will be drawn from the PHA data of the background data set.

  • id (str) – String with id number if called from UI layer. This is only used for certain error messages.

Examples

Estimate the signal from a 5000 second observation using the ARF and RMF from “src.arf” and “src.rmf” respectively:

>>> set_source(1, xsphabs.gal * xsapec.clus)
>>> gal.nh = 0.12
>>> clus.kt, clus.abundanc = 4.5, 0.3
>>> clus.redshift = 0.187
>>> clus.norm = 1.2e-3
>>> fake_pha(1, 'src.arf', 'src.rmf', 5000)

Simulate a 1 mega second observation for the data and model from the default data set. The simulated data will include an estimated background component based on scaling the existing background observations for the source. The simulated data set, which has the same grouping as the default set, for easier comparison, is created with the ‘sim’ label and then written out to the file ‘sim.pi’:

>>> arf = get_arf()
>>> rmf = get_rmf()
>>> bkg = get_bkg()
>>> bscal = get_backscal()
>>> grp = get_grouping()
>>> qual = get_quality()
>>> texp = 1e6
>>> set_source('sim', get_source())
>>> fake_pha('sim', arf, rmf, texp, backscal=bscal, bkg=bkg,
...          grouping=grp, quality=qual, grouped=True)
>>> save_pha('sim', 'sim.pi')