Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/observation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ FOXSI-4 was launched from the Poker Flat Research Range in Alaska on April 17, 2

*Relevant for functions with inputs like: `time_range`.*

The time range is important for calculating the atmospheric transmission, which is a key component of the ARF. Depending on the objectives of the analysis, the user may select the appropriate time range using the information provided below:
The time range is important for calculating the atmospheric transmission (see the [Time ranges and the atmospheric response](https://foxsi.github.io/response-tools/auto_examples/plot_atmospheric_response.html#sphx-glr-auto-examples-plot-atmospheric-response-py) example), which is a key component of the ARF. Depending on the objectives of the analysis, the user may select the appropriate time range using the information provided below:

**Observation time intervals with stable pointing for more than a few seconds:**

Expand Down
2 changes: 1 addition & 1 deletion docs/response_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ For a coded runthrough of creating an ARF, see the [Create an ARF from scratch](

## What is a redistribution matrix function/file (RMF)?

The RMF is a matrix that contains the energy redistribution information of the detector, this is the photon-to-count conversion probability. An incoming photon of energy $\epsilon$ can be detected by the telescope's sensor as a count with an energy $\lesssim\epsilon$ (say, $E$) due to scattering, detection efficiency, and energy resolution. Therefore, the energies we are interested in are the ones defined for the RMF creation. I.e., the defined photon energies (input axis) controls the energies the ARF and photon models should be evaluated and the defined count bin energies (observable bins or output axis) controls the binning of the observed data.
The RMF is a matrix that contains the energy redistribution information of the detector, this is the photon-to-count conversion probability. An incoming photon of energy $\epsilon$ can be detected by the telescope's sensor as a count with an energy $\lesssim\epsilon$ (say, $E$) due to scattering, detection efficiency, and energy resolution. Therefore, the energies we are interested in are the ones defined for the RMF creation. I.e., the defined photon energies (input axis) control the energies of the ARF and are also the energies at which to evaluate any photon models; whereas, the defined count bin energies (observable bins or output axis) control the binning of the observed data.

Example RMFs for the CdTe and CMOS can be seen below (see the [Example FOXSI-4 RMFs](https://foxsi.github.io/response-tools/auto_examples/plot_rmf_examples.html#sphx-glr-auto-examples-plot-rmf-examples-py) example in the example gallery) which show the conversion probability of a photon being recorded as detector observable (i.e., either a count with a calibrated energy or DN). The units of a response matrix will be observable/photon (e.g., counts/photon or DN/photon).

Expand Down
39 changes: 39 additions & 0 deletions docs/versions_and_releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,32 @@ import response_tools
print(response_tools.__version__)
```

## Version `1.0.3`

[5 Nov. 2025] Updates to the thermal blanketing transmission files and the atmospheric attenuation file.

### Attenuation

- att_thermal_blanket:
- No longer exists.
- att_early_cmos_prefilter
- `v1`: attenuation-data/F4_Blanket_transmission_v1.dat
- Was att_thermal_blanket.
- att_modeled_thermal_blanket
- `v1`: attenuation-data/FOXSI4_theoretical_thermal_blanket_transmission_v1.fits
- Modeled attenuation for the thermal blanket.
- att_measured_thermal_blanket
- `v1`: attenuation-data/FOXSI4_measured_thermal_blanket_transmission_v1.fits
- Measured attenuation for the thermal blanket.
- att_foxsi4_atmosphere:
- `v2`: attenuation-data/FOXSI4_atmospheric_transmission_v2.fits
- Times can now be selected via seconds from launch or in UTC.

### Example gallery

- Time ranges and the atmospheric response
- Example added showing how to choose a time range in the code for atmospheric transmissions.

## Version `1.0.2`

[30 Oct. 2025] CdTe detector response files now share the same filename format across different versions and are now all supported in the codebase.
Expand Down Expand Up @@ -147,3 +173,16 @@ print(response_tools.__version__)
- qe_cmos_telescope-1:
- `v1`: quantum-efficiency-data/foxsi4_telescope-1_BASIC_sensor_quantum_efficiency_v1.fits
- CMOS team prepared detector quantum efficiencies for telescope 1.

### Example gallery

- Functions & Outputs
- Shows how to use the functions and their outputs in the package.
- Create an ARF from scratch
- Shows how to compile a telescope ARF from individual components.
- Example FOXSI-4 RMFs
- Shows how to obtain and work with a detector's RMF data-class.
- Generating and plotting ARFs, RMFs, and SRMs
- Shows how to obtain and plot the ARF, RMF, and SRM for Telescope 2.
- Telescope ARFs, RMFs, and SRMs
- Shows a test ``asset`` function to produce a response plot for all of FOXSI-4's telescopes.
5 changes: 5 additions & 0 deletions examples/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ Data handling examples
* File: ``plot_rmf_examples.py``.
* Shows how to obtain and work with a detector's RMF data-class.

* **Time ranges and the atmospheric response**

* File: ``plot_atmospheric_response.py``.
* Shows how to choose a time range in the code for atmospheric transmissions.

Plotting examples
-----------------

Expand Down
Loading
Loading