docs

Author: roytsmart

docs/reports/level-1.ipynb

@@ -110,7 +110,7 @@
   },
   {
    "cell_type": "raw",
-   "id": "7369e636",
+   "id": "818c23c9",
    "metadata": {
     "raw_mimetype": "text/restructuredtext"
    },
@@ -121,7 +121,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "98dcbf39",
+   "id": "18aee5c9",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -336,21 +336,21 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "0aad43b0",
+   "id": "30c267ae4450663f",
    "metadata": {},
    "outputs": [],
    "source": [
-    "unbiased.shape"
+    "active = unbiased.active"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "30c267ae4450663f",
+   "id": "0aad43b0",
    "metadata": {},
    "outputs": [],
    "source": [
-    "active = unbiased.active"
+    "unbiased.shape"
    ]
   },
   {
@@ -390,21 +390,21 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "c66f78b3",
+   "id": "2ba62cc5",
    "metadata": {},
    "outputs": [],
    "source": [
-    "active.outputs.mean(axis_txy).ndarray"
+    "electrons = active.electrons"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "2ba62cc5",
+   "id": "c66f78b3",
    "metadata": {},
    "outputs": [],
    "source": [
-    "electrons = active.electrons"
+    "active.outputs.mean(axis_txy).ndarray"
    ]
   },
   {
@@ -417,6 +417,17 @@
     "electrons.outputs.mean(axis_txy).ndarray"
    ]
   },
+  {
+   "cell_type": "raw",
+   "id": "f7058cdf",
+   "metadata": {
+    "raw_mimetype": "text/restructuredtext"
+   },
+   "source": [
+    "By printing the means of the `active` and `electrons` variables,\n",
+    "we can see that the units are now in terms of electrons."
+   ]
+  },
   {
    "cell_type": "raw",
    "id": "dfe39c45",
@@ -428,14 +439,14 @@
     "----------------\n",
     "To calculate the master dark frame,\n",
     "we'll remove the cosmic rays from the dark frames using the\n",
-    ":attr:`~esis.data.Level_0.despiked` property. \n",
+    ":attr:`~esis.data.Level_0.despiked` property,\n",
     "and then take the mean along the time axis."
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "ae119c16",
+   "id": "a449ef9e",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -536,7 +547,7 @@
   },
   {
    "cell_type": "raw",
-   "id": "af9d7f9b",
+   "id": "585a78d7",
    "metadata": {
     "raw_mimetype": "text/restructuredtext"
    },
@@ -547,7 +558,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "114b63a8",
+   "id": "08464613",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -643,7 +654,7 @@
   },
   {
    "cell_type": "raw",
-   "id": "b3106d95",
+   "id": "00f7a57a",
    "metadata": {
     "raw_mimetype": "text/restructuredtext"
    },
@@ -655,7 +666,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "e2cd6e2f",
+   "id": "99b18ed4",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -718,7 +729,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "cee0d8b6",
+   "id": "f8d50a4d",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -727,7 +738,7 @@
   },
   {
    "cell_type": "raw",
-   "id": "a3b32bfc",
+   "id": "ac8493ef",
    "metadata": {
     "raw_mimetype": "text/restructuredtext"
    },
@@ -738,7 +749,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "636f6651",
+   "id": "fb4d5988",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -756,7 +767,7 @@
   },
   {
    "cell_type": "raw",
-   "id": "cf6bcf41",
+   "id": "9d4a66db",
    "metadata": {
     "raw_mimetype": "text/restructuredtext"
    },
@@ -769,7 +780,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "4cacaeb0",
+   "id": "67550b13",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -779,7 +790,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "f1b21e8c",
+   "id": "51302e0b",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -792,7 +803,7 @@
   },
   {
    "cell_type": "raw",
-   "id": "9d0721c2",
+   "id": "1cda4f3f",
    "metadata": {
     "raw_mimetype": "text/restructuredtext"
    },
@@ -803,7 +814,7 @@
   },
   {
    "cell_type": "raw",
-   "id": "e7ed326b",
+   "id": "5e090187",
    "metadata": {
     "raw_mimetype": "text/restructuredtext"
    },
@@ -815,7 +826,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "08a02b21",
+   "id": "baa1562d",
    "metadata": {},
    "outputs": [],
    "source": [

esis/data/__init__.py

@@ -7,6 +7,7 @@
 Level 0
 -------
 The raw data gathered by the ESIS instrument, saved as FITS files.
+
 * Loaded into memory as a subclass of :class:`named_arrays.FunctionArray`.
 * Temperatures and voltages are converted to physical units.
 
@@ -18,7 +19,7 @@
 DN to photons incident on the front surface of the sensor.
 
 The following steps are applied to the Level-0 dataset to create the Level-1
-dataset.
+dataset:
 
 * Bias subtraction
 * Non-active pixel removal