https://github.com/ruizca/ecfxa

Energy Conversion Factors for X-ray Astronomy
https://github.com/ruizca/ecfxa

Last synced: about 1 month ago
JSON representation

Energy Conversion Factors for X-ray Astronomy

• Host: GitHub
• URL: https://github.com/ruizca/ecfxa
• Owner: ruizca
• License: bsd-3-clause-clear
• Created: 2024-06-14T14:18:08.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-06-15T11:24:26.000Z (6 months ago)
• Last Synced: 2024-09-19T07:19:27.408Z (3 months ago)
• Language: Jupyter Notebook
• Homepage: https://ruizca.github.io/ecfxa/
• Size: 12.2 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Energy Conversion Factors for X-ray Astronomy

`ecfxa` is a Python package providing tools for the estimation

of ECFs for different astronomical X-ray missions. Currently 

we include XMM-Newton/EPIC, Swift/XRT and eROSITA. ECFs where

calculated consistently for the different missions using the most

updated calibration files at the date of the package release.

X-ray sources detected through photon counter cameras are characterized 

by count-rates at a given energy band. These count-rates (CR) can be 

converted into physical fluxes using the calibrated response of the

detector and assuming an specific spectral model via:

```math

FLUX = CR / ECF

```

where the ECF (Energy Conversion Factor) encapsulate the information

about the response and spectral model for the given energy band. 

For an in-depth explanation of ECF and how they are calculated see

[Mateos et al. 2009](https://doi.org/10.1051/0004-6361/200811409) 

or the [eROSITA ECF tutorial](https://erosita.mpe.mpg.de/dr1/eSASS4DR1/eSASS4DR1_arfrmf/eROSITA_ECF_tutorial.pdf).

Details about our ECF calculations for the different missions can 

be found in the [corresponding Jupyter notebooks](https://github.com/ruizca/ecfxa/tree/main/calc) included 

in the `ecfxa` GitHub repository.

Installation

------------

    > pip install ecfxa

Examples

--------

    >>> import ecfxa

    >>> ero_ecfs = ecfxa.eROSITA(eband="SOFT")

    >>> ero_ecfs(nh=3e20, gamma=2.0)

    

We provide a [Jupyter notebook with examples](https://github.com/ruizca/ecfxa/tree/main/docs/examples.ipynb) 

on how to use `ecfxa` for different X-ray missions. Check the full 

documentation [here](https://ruizca.github.io/ecfxa/ecfxa/ecfs.html).