Skip to content

Commit c6bfc94

Browse files
lcorcodiloslcorcodilos
committed
Update docs for Beta 2.0
1 parent 8448eba commit c6bfc94

308 files changed

Lines changed: 9102 additions & 2224 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎TIMBER/Framework/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Notes to developers
44

55
Adding C++ modules for use in TIMBER is relatively simple but the code makes several
6-
assumptions about the structure of the module if you'd like to use it as a @ref TIMBER.Analyzer.Correction.
6+
assumptions about the structure of the module if you'd like to use it as a `TIMBER.Analyzer.Correction`.
77

88
A correction module should be built as a class so that the initializer can be used to book
99
objects like files, histograms, etc that we want to load before looping over the RDataFrame.

‎TIMBER/Framework/include/common.h‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ namespace hardware {
5252
*
5353
* @param v1
5454
* @param v2
55-
* @param inTIMBER If file is in TIMBERPATH. Defaults to true.
5655
* @return RVec<float>
5756
*/
5857
RVec<float> HadamardProduct(RVec<float> v1, RVec<float> v2);

‎docs/_b_tag_calibration_standalone_8h_source.html‎

Lines changed: 167 additions & 11 deletions
Large diffs are not rendered by default.

‎docs/_collection_8h_source.html‎

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
22
<html xmlns="http://www.w3.org/1999/xhtml">
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6-
<meta name="generator" content="Doxygen 1.8.13"/>
6+
<meta name="generator" content="Doxygen 1.8.17"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>TIMBER: TIMBER/Framework/include/Collection.h Source File</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -17,7 +17,8 @@
1717
extensions: ["tex2jax.js"],
1818
jax: ["input/TeX","output/HTML-CSS"],
1919
});
20-
</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>
20+
</script>
21+
<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>
2122
<link href="doxygen.css" rel="stylesheet" type="text/css" />
2223
<link href="doxygen-styles.css" rel="stylesheet" type="text/css"/>
2324
</head>
@@ -39,18 +40,21 @@
3940
</table>
4041
</div>
4142
<!-- end header part -->
42-
<!-- Generated by Doxygen 1.8.13 -->
43+
<!-- Generated by Doxygen 1.8.17 -->
4344
<script type="text/javascript">
45+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
4446
var searchBox = new SearchBox("searchBox", "search",false,'Search');
47+
/* @license-end */
4548
</script>
4649
<script type="text/javascript" src="menudata.js"></script>
4750
<script type="text/javascript" src="menu.js"></script>
4851
<script type="text/javascript">
52+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
4953
$(function() {
5054
initMenu('',true,false,'search.php','Search');
5155
$(document).ready(function() { init_search(); });
5256
});
53-
</script>
57+
/* @license-end */</script>
5458
<div id="main-nav"></div>
5559
<!-- window showing the filter options -->
5660
<div id="MSearchSelectWindow"
@@ -76,19 +80,34 @@
7680
<div class="title">Collection.h</div> </div>
7781
</div><!--header-->
7882
<div class="contents">
79-
<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>
80-
<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>
81-
<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>
82-
<div class="ttc" id="namespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div></div>
83-
<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>
84-
<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>
85-
<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>
83+
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef _TIMBER_COLLECTION</span></div>
84+
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define _TIMBER_COLLECTION</span></div>
85+
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div>
86+
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
87+
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &lt;ROOT/RVec.hxx&gt;</span></div>
88+
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
89+
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="keyword">using namespace </span>ROOT::VecOps;</div>
90+
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="keyword">using namespace </span>std;</div>
91+
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
92+
<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>
93+
<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>
94+
<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>
95+
<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>
96+
<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>
97+
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;};</div>
98+
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
99+
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#endif</span></div>
86100
</div><!-- fragment --></div><!-- contents -->
101+
<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>
102+
<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>
103+
<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>
104+
<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>
105+
<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>
87106
<!-- start footer part -->
88107
<hr class="footer"/><address class="footer"><small>
89108
Generated by &#160;<a href="http://www.doxygen.org/index.html">
90109
<img class="footer" src="doxygen.png" alt="doxygen"/>
91-
</a> 1.8.13
110+
</a> 1.8.17
92111
</small></address>
93112
</body>
94113
</html>

0 commit comments

Comments
 (0)