Update docs for Beta 2.0

lcorcodilos · Jun 15, 2021 · c6bfc94 · c6bfc94
1 parent 8448eba
commit c6bfc94
Show file tree

Hide file tree

Showing 308 changed files with 9,102 additions and 2,224 deletions.
diff --git a/TIMBER/Framework/README.md b/TIMBER/Framework/README.md
@@ -3,7 +3,7 @@
 ## Notes to developers
 
 Adding C++ modules for use in TIMBER is relatively simple but the code makes several
-assumptions about the structure of the module if you'd like to use it as a @ref TIMBER.Analyzer.Correction.
+assumptions about the structure of the module if you'd like to use it as a `TIMBER.Analyzer.Correction`.
 
 A correction module should be built as a class so that the initializer can be used to book
 objects like files, histograms, etc that we want to load before looping over the RDataFrame.

diff --git a/TIMBER/Framework/include/common.h b/TIMBER/Framework/include/common.h
@@ -52,7 +52,6 @@ namespace hardware {
      * 
      * @param v1 
      * @param v2 
-     * @param inTIMBER If file is in TIMBERPATH. Defaults to true.
      * @return RVec<float> 
      */
     RVec<float> HadamardProduct(RVec<float> v1, RVec<float> v2);

diff --git a/docs/_b_tag_calibration_standalone_8h_source.html b/docs/_b_tag_calibration_standalone_8h_source.html
diff --git a/docs/_collection_8h_source.html b/docs/_collection_8h_source.html
@@ -1,9 +1,9 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
-<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="generator" content="Doxygen 1.8.17"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>TIMBER: TIMBER/Framework/include/Collection.h Source File</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -17,7 +17,8 @@
     extensions: ["tex2jax.js"],
     jax: ["input/TeX","output/HTML-CSS"],
 });
-</script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML/MathJax.js"></script>
+</script>
+<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML/MathJax.js"></script>
 <link href="doxygen.css" rel="stylesheet" type="text/css" />
 <link href="doxygen-styles.css" rel="stylesheet" type="text/css"/>
 </head>
@@ -39,18 +40,21 @@
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.8.13 -->
+<!-- Generated by Doxygen 1.8.17 -->
 <script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
 var searchBox = new SearchBox("searchBox", "search",false,'Search');
+/* @license-end */
 </script>
 <script type="text/javascript" src="menudata.js"></script>
 <script type="text/javascript" src="menu.js"></script>
 <script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
 $(function() {
   initMenu('',true,false,'search.php','Search');
   $(document).ready(function() { init_search(); });
 });
-</script>
+/* @license-end */</script>
 <div id="main-nav"></div>
 <!-- window showing the filter options -->
 <div id="MSearchSelectWindow"
@@ -76,19 +80,34 @@
 <div class="title">Collection.h</div>  </div>
 </div><!--header-->
 <div class="contents">
-<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#ifndef _TIMBER_COLLECTION</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor">#define _TIMBER_COLLECTION</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#include &lt;ROOT/RVec.hxx&gt;</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;</div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="keyword">using namespace </span><a class="code" href="namespace_r_o_o_t_1_1_vec_ops.html">ROOT::VecOps</a>;</div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="keyword">using namespace </span><a class="code" href="namespacestd.html">std</a>;</div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="struct_collection.html">   16</a></span>&#160;<span class="keyword">struct </span><a class="code" href="struct_collection.html">Collection</a> {</div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="struct_collection.html#abfd172928bf450593b9496d28dcabcab">   17</a></span>&#160;    map&lt;string,int*&gt; <a class="code" href="struct_collection.html#abfd172928bf450593b9496d28dcabcab">Int</a>; </div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="struct_collection.html#aa9e72f68afd920ce5c651ac5ab055f0a">   18</a></span>&#160;    map&lt;string,bool*&gt; <a class="code" href="struct_collection.html#aa9e72f68afd920ce5c651ac5ab055f0a">Bool</a>; </div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="struct_collection.html#aa99b31ef8d2531c6ea052a482f95c06e">   19</a></span>&#160;    map&lt;string,RVec&lt;float&gt;*&gt; <a class="code" href="struct_collection.html#aa99b31ef8d2531c6ea052a482f95c06e">RVecFloat</a>; </div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="struct_collection.html#afaab1969951afe78b5ad759bdc1e1e0e">   20</a></span>&#160;    map&lt;string,RVec&lt;int&gt;*&gt; <a class="code" href="struct_collection.html#afaab1969951afe78b5ad759bdc1e1e0e">RVecInt</a>; </div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;};</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="struct_collection_html_afaab1969951afe78b5ad759bdc1e1e0e"><div class="ttname"><a href="struct_collection.html#afaab1969951afe78b5ad759bdc1e1e0e">Collection::RVecInt</a></div><div class="ttdeci">map&lt; string, RVec&lt; int &gt; * &gt; RVecInt</div><div class="ttdef"><b>Definition:</b> Collection.h:20</div></div>
-<div class="ttc" id="struct_collection_html"><div class="ttname"><a href="struct_collection.html">Collection</a></div><div class="ttdoc">C++ structure to store maps of the various types of objects in a collection. OUTDATED BY analyzer...</div><div class="ttdef"><b>Definition:</b> Collection.h:16</div></div>
-<div class="ttc" id="struct_collection_html_aa99b31ef8d2531c6ea052a482f95c06e"><div class="ttname"><a href="struct_collection.html#aa99b31ef8d2531c6ea052a482f95c06e">Collection::RVecFloat</a></div><div class="ttdeci">map&lt; string, RVec&lt; float &gt; * &gt; RVecFloat</div><div class="ttdef"><b>Definition:</b> Collection.h:19</div></div>
-<div class="ttc" id="namespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div></div>
-<div class="ttc" id="struct_collection_html_abfd172928bf450593b9496d28dcabcab"><div class="ttname"><a href="struct_collection.html#abfd172928bf450593b9496d28dcabcab">Collection::Int</a></div><div class="ttdeci">map&lt; string, int * &gt; Int</div><div class="ttdef"><b>Definition:</b> Collection.h:17</div></div>
-<div class="ttc" id="struct_collection_html_aa9e72f68afd920ce5c651ac5ab055f0a"><div class="ttname"><a href="struct_collection.html#aa9e72f68afd920ce5c651ac5ab055f0a">Collection::Bool</a></div><div class="ttdeci">map&lt; string, bool * &gt; Bool</div><div class="ttdef"><b>Definition:</b> Collection.h:18</div></div>
-<div class="ttc" id="namespace_r_o_o_t_1_1_vec_ops_html"><div class="ttname"><a href="namespace_r_o_o_t_1_1_vec_ops.html">VecOps</a></div></div>
+<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#ifndef _TIMBER_COLLECTION</span></div>
+<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor">#define _TIMBER_COLLECTION</span></div>
+<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div>
+<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
+<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#include &lt;ROOT/RVec.hxx&gt;</span></div>
+<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160; </div>
+<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="keyword">using namespace </span>ROOT::VecOps;</div>
+<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="keyword">using namespace </span>std;</div>
+<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160; </div>
+<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="struct_collection.html">   16</a></span>&#160;<span class="keyword">struct </span><a class="code" href="struct_collection.html">Collection</a> {</div>
+<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="struct_collection.html#abfd172928bf450593b9496d28dcabcab">   17</a></span>&#160;    map&lt;string,int*&gt; <a class="code" href="struct_collection.html#abfd172928bf450593b9496d28dcabcab">Int</a>; </div>
+<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="struct_collection.html#aa9e72f68afd920ce5c651ac5ab055f0a">   18</a></span>&#160;    map&lt;string,bool*&gt; <a class="code" href="struct_collection.html#aa9e72f68afd920ce5c651ac5ab055f0a">Bool</a>; </div>
+<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="struct_collection.html#aa99b31ef8d2531c6ea052a482f95c06e">   19</a></span>&#160;    map&lt;string,RVec&lt;float&gt;*&gt; <a class="code" href="struct_collection.html#aa99b31ef8d2531c6ea052a482f95c06e">RVecFloat</a>; </div>
+<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="struct_collection.html#afaab1969951afe78b5ad759bdc1e1e0e">   20</a></span>&#160;    map&lt;string,RVec&lt;int&gt;*&gt; <a class="code" href="struct_collection.html#afaab1969951afe78b5ad759bdc1e1e0e">RVecInt</a>; </div>
+<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;};</div>
+<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160; </div>
+<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#endif</span></div>
 </div><!-- fragment --></div><!-- contents -->
+<div class="ttc" id="astruct_collection_html_aa99b31ef8d2531c6ea052a482f95c06e"><div class="ttname"><a href="struct_collection.html#aa99b31ef8d2531c6ea052a482f95c06e">Collection::RVecFloat</a></div><div class="ttdeci">map&lt; string, RVec&lt; float &gt; * &gt; RVecFloat</div><div class="ttdef"><b>Definition:</b> Collection.h:19</div></div>
+<div class="ttc" id="astruct_collection_html_aa9e72f68afd920ce5c651ac5ab055f0a"><div class="ttname"><a href="struct_collection.html#aa9e72f68afd920ce5c651ac5ab055f0a">Collection::Bool</a></div><div class="ttdeci">map&lt; string, bool * &gt; Bool</div><div class="ttdef"><b>Definition:</b> Collection.h:18</div></div>
+<div class="ttc" id="astruct_collection_html_afaab1969951afe78b5ad759bdc1e1e0e"><div class="ttname"><a href="struct_collection.html#afaab1969951afe78b5ad759bdc1e1e0e">Collection::RVecInt</a></div><div class="ttdeci">map&lt; string, RVec&lt; int &gt; * &gt; RVecInt</div><div class="ttdef"><b>Definition:</b> Collection.h:20</div></div>
+<div class="ttc" id="astruct_collection_html_abfd172928bf450593b9496d28dcabcab"><div class="ttname"><a href="struct_collection.html#abfd172928bf450593b9496d28dcabcab">Collection::Int</a></div><div class="ttdeci">map&lt; string, int * &gt; Int</div><div class="ttdef"><b>Definition:</b> Collection.h:17</div></div>
+<div class="ttc" id="astruct_collection_html"><div class="ttname"><a href="struct_collection.html">Collection</a></div><div class="ttdoc">C++ structure to store maps of the various types of objects in a collection. OUTDATED BY analyzer....</div><div class="ttdef"><b>Definition:</b> Collection.h:16</div></div>
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/>
-</a> 1.8.13
+</a> 1.8.17
 </small></address>
 </body>
 </html>