diff --git a/Response-Tools-Data-Guide-v1.pdf b/Response-Tools-Data-Guide-v1.pdf deleted file mode 100644 index 5612588..0000000 Binary files a/Response-Tools-Data-Guide-v1.pdf and /dev/null differ diff --git a/Response-Tools-Data-Guide-v2.pdf b/Response-Tools-Data-Guide-v2.pdf new file mode 100644 index 0000000..e81ee12 Binary files /dev/null and b/Response-Tools-Data-Guide-v2.pdf differ diff --git a/docs/code_tips.md b/docs/code_tips.md index 5b5e6a1..893ad35 100644 --- a/docs/code_tips.md +++ b/docs/code_tips.md @@ -58,6 +58,7 @@ There are a number of fields common to all data-class types used in the package. | `response_type` | Describes whether the response in the data-class is an ARF, RMF, or SRM. | | `telescope` | Details the telescope to which the data, or components of the data, belongs. | | `times` | A unit aware list (likely in seconds) of the times at which the data was evaluated and then processed. | +| `times_utc` | An Astropy Times list of the times at which the data was evaluated and then processed. | | `transmissions` | A unit aware array (likely dimensionless) of the attenuator’s transmission. | Inspecting a returned output and observing a subset of these fields should make it extra clear to a user as to exactly what they are handling when it comes to the output of the function. diff --git a/docs/instrument.rst b/docs/instrument.rst index 16a6121..8247a90 100644 --- a/docs/instrument.rst +++ b/docs/instrument.rst @@ -43,17 +43,17 @@ should you use? This table may help you make up your mind: +-----------+--------------------+------------------+-----------------+------------------------------+---------------------+-------------------+---------------------------+ | Telescope | Detector | Optics | Collimator | Attenuation | Energy range | Energy resolution | Spatial resolution (FWHM) | +===========+====================+==================+=================+==============================+=====================+===================+===========================+ -| **0** | CMOS | MSFC 2-shell | AR = 1:290 | OBF + Prefilter | 0.8–10 keV | 0.4 @ 10 keV | 3.4" | +| **0** | CMOS 1 | MSFC 2-shell | AR = 1:290 | OBF + Prefilter | 0.8–10 keV | 0.4 @ 10 keV | 3.4" | +-----------+--------------------+------------------+-----------------+------------------------------+---------------------+-------------------+---------------------------+ -| **1** | CMOS | Nagoya 1-shell | AR = 1:200 | OBF + Prefilter | 0.8–10 keV | 0.4 @ 10 keV | 1.5" | +| **1** | CMOS 2 | Nagoya 1-shell | AR = 1:200 | OBF + Prefilter | 0.8–10 keV | 0.4 @ 10 keV | 1.5" | +-----------+--------------------+------------------+-----------------+------------------------------+---------------------+-------------------+---------------------------+ -| **2** | CdTe DSD | MSFC 10-shell | --- | 381 µm Al | 4–20 keV | 0.8 @ 14 keV | 7.2–11.4" | +| **2** | CdTe DSD 4 | MSFC 10-shell | --- | 381 µm Al | 4–20 keV | 0.8 @ 14 keV | 7.2–11.4" | +-----------+--------------------+------------------+-----------------+------------------------------+---------------------+-------------------+---------------------------+ -| **3** | CdTe DSD | MSFC 2-shell | --- | Pixelated attenuator + Mylar | 4–20 keV | 0.8 @ 14 keV | 6.1–10.8" | +| **3** | CdTe DSD 2 | MSFC 2-shell | --- | Pixelated attenuator + Mylar | 4–20 keV | 0.8 @ 14 keV | 6.1–10.8" | +-----------+--------------------+------------------+-----------------+------------------------------+---------------------+-------------------+---------------------------+ -| **4** | CdTe DSD | Nagoya 1-shell | --- | 127 µm Al | 4–20 keV | 0.8 @ 14 keV | 5.3–10.3" | +| **4** | CdTe DSD 3 | Nagoya 1-shell | --- | 127 µm Al | 4–20 keV | 0.8 @ 14 keV | 5.3–10.3" | +-----------+--------------------+------------------+-----------------+------------------------------+---------------------+-------------------+---------------------------+ -| **5** | CdTe DSD | MSFC 10-shell | --- | Pixelated attenuator + Mylar | 4–20 keV | 0.8 @ 14 keV | 7.2–11.4" | +| **5** | CdTe DSD 1 | MSFC 10-shell | --- | Pixelated attenuator + Mylar | 4–20 keV | 0.8 @ 14 keV | 7.2–11.4" | +-----------+--------------------+------------------+-----------------+------------------------------+---------------------+-------------------+---------------------------+ | **6** | Timepix [1]_ | MSFC 2-shell | --- | Mylar | 5–20 keV | 6 @ 60 keV | 6.9"" | +-----------+--------------------+------------------+-----------------+------------------------------+---------------------+-------------------+---------------------------+