deploy: a103287

_sources/usage.rst.txt

@@ -9,4 +9,5 @@ Usage
    usage/sites.rst
    usage/plans.rst
    usage/simulations.rst
+   usage/tods.rst
    usage/mapping.rst

_sources/usage/mapping.rst.txt

@@ -1,36 +1,8 @@
-#######
+=======
 Mapping
-#######
+=======
 
-We can map a ``TOD`` (or several of them) with a ``Mapper``. The simplest possible mapper just bins the data:
+.. toctree::
+   :maxdepth: 2
 
-.. code-block:: python
-
-    from maria.map.mappers import BinMapper
-
-    mapper = BinMapper(center=(150, 10),
-                       frame="ra_dec",
-                       width=1e0,
-                       height=1e0,
-                       resolution=5e-3,
-                       tod_preprocessing={
-                            "window": {"tukey": {"alpha": 0.1}},
-                            "remove_modes": {"n": 1},
-                            "filter": {"f_lower": 0.01},
-                            "despline": {"knot_spacing": 5},
-                                        },
-                        map_postprocessing={
-                            "gaussian_filter": {"sigma": 1},
-                            "median_filter": {"size": 1},
-                                        },
-                       units="K_RJ",
-                       tods=[tod],
-                       )
-
-    output_map = mapper.run()
-
-where we define the preprocessing to be done on the ``TOD``. We can see the output with
-
-.. code-block:: python
-
-    output_map.plot()
+   mapping/index.rst

_sources/usage/mapping/index.rst.txt

@@ -0,0 +1,36 @@
+#######
+Mapping
+#######
+
+We can map a ``TOD`` (or several of them) with a ``Mapper``. The simplest possible mapper just bins the data:
+
+.. code-block:: python
+
+    from maria.map.mappers import BinMapper
+
+    mapper = BinMapper(center=(150, 10),
+                       frame="ra_dec",
+                       width=1e0,
+                       height=1e0,
+                       resolution=5e-3,
+                       tod_preprocessing={
+                            "window": {"tukey": {"alpha": 0.1}},
+                            "remove_modes": {"n": 1},
+                            "filter": {"f_lower": 0.01},
+                            "despline": {"knot_spacing": 5},
+                                        },
+                        map_postprocessing={
+                            "gaussian_filter": {"sigma": 1},
+                            "median_filter": {"size": 1},
+                                        },
+                       units="K_RJ",
+                       tods=[tod],
+                       )
+
+    output_map = mapper.run()
+
+where we define the preprocessing to be done on the ``TOD``. We can see the output with
+
+.. code-block:: python
+
+    output_map.plot()

_sources/usage/simulations.rst.txt

@@ -6,7 +6,6 @@ Simulations
    :maxdepth: 2
 
    simulations/index.rst
-   simulations/tods.rst
    simulations/atmosphere.rst
    simulations/cmb.rst
    simulations/maps.rst

_sources/usage/tods.rst.txt

@@ -0,0 +1,8 @@
+====
+TODs
+====
+
+.. toctree::
+   :maxdepth: 2
+
+   tods/index.rst

_sources/usage/tods/index.rst.txt

@@ -0,0 +1,47 @@
+####
+TODs
+####
+
+The result of a simulation is a ``TOD``, which encapsulates the generated time-ordered data (and all metadata, like the pointing coordinates).
+The overall signal in the
+
+
+.. code-block:: python
+
+    tod.plot()
+
+It has a few useful features. We can see what our data looks like with
+
+.. code-block:: python
+
+    tod.plot()
+
+==========
+Components
+==========
+
+The total signal in each detector can be accessed as
+
+.. code-block:: python
+
+    tod.signal # returns an array
+
+which is the sum of all of the simulated fields (e.g. noise, atmosphere, CMB) separately, contributing to the incident power. For convenience, we can also access the individual fields as
+
+.. code-block:: python
+
+    tod.get_field("atmosphere") # returns an array
+
+We can see all the available fields with ``tod.fields``.
+
+
+=====
+Units
+=====
+
+TODs are by default in units of picowatts, but we can convert to any unit that is a combination of an SI prefix and a base unit (one of `K_RJ`, `K_CMB`, or `W`).
+
+.. code-block:: python
+
+    tod_in_rj_units = tod.to(units="mK_RJ")
+    tod_in_cmb_units = tod.to(units="uK_CMB")

genindex.html

@@ -212,16 +212,22 @@
 <li class="toctree-l2"><a class="reference internal" href="usage/plans.html">Plans</a></li>
 <li class="toctree-l2 has-children"><a class="reference internal" href="usage/simulations.html">Simulations</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of Simulations</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l3"><a class="reference internal" href="usage/simulations/index.html">Overview</a></li>
-<li class="toctree-l3"><a class="reference internal" href="usage/simulations/tods.html">TODs</a></li>
 <li class="toctree-l3"><a class="reference internal" href="usage/simulations/atmosphere.html">Atmosphere</a></li>
 <li class="toctree-l3"><a class="reference internal" href="usage/simulations/cmb.html">Simulations</a></li>
 <li class="toctree-l3"><a class="reference internal" href="usage/simulations/maps.html">Maps</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="usage/mapping.html">Mapping</a></li>
+<li class="toctree-l2 has-children"><a class="reference internal" href="usage/tods.html">TODs</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of TODs</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l3"><a class="reference internal" href="usage/tods/index.html">TODs</a></li>
 </ul>
 </li>
-<li class="toctree-l1 has-children"><a class="reference internal" href="tutorials.html">Tutorials</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of Tutorials</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l2 has-children"><a class="reference internal" href="usage/mapping.html">Mapping</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of Mapping</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l3"><a class="reference internal" href="usage/mapping/index.html">Mapping</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="tutorials.html">Tutorials</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of Tutorials</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="tutorials/custom-map-simulations.html">Custom map simulations</a></li>
 <li class="toctree-l2"><a class="reference internal" href="tutorials/MUSTANG-2_cluster.html">Mock Observations with MUSTANG-2</a></li>
 </ul>

index.html

@@ -214,16 +214,22 @@
 <li class="toctree-l2"><a class="reference internal" href="usage/plans.html">Plans</a></li>
 <li class="toctree-l2 has-children"><a class="reference internal" href="usage/simulations.html">Simulations</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of Simulations</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l3"><a class="reference internal" href="usage/simulations/index.html">Overview</a></li>
-<li class="toctree-l3"><a class="reference internal" href="usage/simulations/tods.html">TODs</a></li>
 <li class="toctree-l3"><a class="reference internal" href="usage/simulations/atmosphere.html">Atmosphere</a></li>
 <li class="toctree-l3"><a class="reference internal" href="usage/simulations/cmb.html">Simulations</a></li>
 <li class="toctree-l3"><a class="reference internal" href="usage/simulations/maps.html">Maps</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="usage/mapping.html">Mapping</a></li>
+<li class="toctree-l2 has-children"><a class="reference internal" href="usage/tods.html">TODs</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of TODs</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l3"><a class="reference internal" href="usage/tods/index.html">TODs</a></li>
 </ul>
 </li>
-<li class="toctree-l1 has-children"><a class="reference internal" href="tutorials.html">Tutorials</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of Tutorials</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l2 has-children"><a class="reference internal" href="usage/mapping.html">Mapping</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of Mapping</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l3"><a class="reference internal" href="usage/mapping/index.html">Mapping</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="tutorials.html">Tutorials</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of Tutorials</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="tutorials/custom-map-simulations.html">Custom map simulations</a></li>
 <li class="toctree-l2"><a class="reference internal" href="tutorials/MUSTANG-2_cluster.html">Mock Observations with MUSTANG-2</a></li>
 </ul>

installation.html

@@ -214,16 +214,22 @@
 <li class="toctree-l2"><a class="reference internal" href="usage/plans.html">Plans</a></li>
 <li class="toctree-l2 has-children"><a class="reference internal" href="usage/simulations.html">Simulations</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of Simulations</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l3"><a class="reference internal" href="usage/simulations/index.html">Overview</a></li>
-<li class="toctree-l3"><a class="reference internal" href="usage/simulations/tods.html">TODs</a></li>
 <li class="toctree-l3"><a class="reference internal" href="usage/simulations/atmosphere.html">Atmosphere</a></li>
 <li class="toctree-l3"><a class="reference internal" href="usage/simulations/cmb.html">Simulations</a></li>
 <li class="toctree-l3"><a class="reference internal" href="usage/simulations/maps.html">Maps</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="usage/mapping.html">Mapping</a></li>
+<li class="toctree-l2 has-children"><a class="reference internal" href="usage/tods.html">TODs</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of TODs</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l3"><a class="reference internal" href="usage/tods/index.html">TODs</a></li>
 </ul>
 </li>
-<li class="toctree-l1 has-children"><a class="reference internal" href="tutorials.html">Tutorials</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of Tutorials</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l2 has-children"><a class="reference internal" href="usage/mapping.html">Mapping</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of Mapping</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l3"><a class="reference internal" href="usage/mapping/index.html">Mapping</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="tutorials.html">Tutorials</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of Tutorials</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="tutorials/custom-map-simulations.html">Custom map simulations</a></li>
 <li class="toctree-l2"><a class="reference internal" href="tutorials/MUSTANG-2_cluster.html">Mock Observations with MUSTANG-2</a></li>
 </ul>

papers.html

@@ -214,16 +214,22 @@
 <li class="toctree-l2"><a class="reference internal" href="usage/plans.html">Plans</a></li>
 <li class="toctree-l2 has-children"><a class="reference internal" href="usage/simulations.html">Simulations</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of Simulations</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l3"><a class="reference internal" href="usage/simulations/index.html">Overview</a></li>
-<li class="toctree-l3"><a class="reference internal" href="usage/simulations/tods.html">TODs</a></li>
 <li class="toctree-l3"><a class="reference internal" href="usage/simulations/atmosphere.html">Atmosphere</a></li>
 <li class="toctree-l3"><a class="reference internal" href="usage/simulations/cmb.html">Simulations</a></li>
 <li class="toctree-l3"><a class="reference internal" href="usage/simulations/maps.html">Maps</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="usage/mapping.html">Mapping</a></li>
+<li class="toctree-l2 has-children"><a class="reference internal" href="usage/tods.html">TODs</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of TODs</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l3"><a class="reference internal" href="usage/tods/index.html">TODs</a></li>
 </ul>
 </li>
-<li class="toctree-l1 has-children"><a class="reference internal" href="tutorials.html">Tutorials</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of Tutorials</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l2 has-children"><a class="reference internal" href="usage/mapping.html">Mapping</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of Mapping</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l3"><a class="reference internal" href="usage/mapping/index.html">Mapping</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="tutorials.html">Tutorials</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of Tutorials</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="tutorials/custom-map-simulations.html">Custom map simulations</a></li>
 <li class="toctree-l2"><a class="reference internal" href="tutorials/MUSTANG-2_cluster.html">Mock Observations with MUSTANG-2</a></li>
 </ul>