Skip to content

Commit

Permalink
Update docs for release
Browse files Browse the repository at this point in the history
  • Loading branch information
lcorcodilos committed Jan 6, 2021
1 parent 7ac0637 commit ac151e7
Show file tree
Hide file tree
Showing 77 changed files with 1,513 additions and 186 deletions.
8 changes: 7 additions & 1 deletion TIMBER/Framework/include/common.h
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,13 @@ namespace hardware {
while (result <= -TMath::Pi()) result += 2*TMath::Pi();
return result;
}

/**
* @brief Calculate \f$\Delta R\f$ between two vectors.
*
* @param v1
* @param v2
* @return float
*/
float DeltaR(ROOT::Math::PtEtaPhiMVector v1, ROOT::Math::PtEtaPhiMVector v2) {
float deta = v1.Eta()-v2.Eta();
float dphi = DeltaPhi(v1.Phi(),v2.Phi());
Expand Down
11 changes: 11 additions & 0 deletions TIMBER/Tools/Common.py
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,17 @@ def FindCommonString(string_list):
return to_match[:-2]

def GetStandardFlags():
'''List of the following recommended flags as of Jan. 6th, 2021.
Returns:
["Flag_goodVertices",
"Flag_globalTightHalo2016Filter",
"Flag_eeBadScFilter",
"Flag_HBHENoiseFilter",
"Flag_HBHENoiseIsoFilter",
"Flag_ecalBadCalibFilter",
"Flag_EcalDeadCellTriggerPrimitiveFilter"]
'''
flags = ["Flag_goodVertices",
"Flag_globalTightHalo2016Filter",
"Flag_eeBadScFilter",
Expand Down
1 change: 0 additions & 1 deletion TIMBER/Tools/Plot.py
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,6 @@ def MakeSoverB(stack_of_bkgs,signal):
to the left of the peak and forwards to the right of the peak.
Args:
pad (TPad): TPad that's already built
stack_of_bkgs (THStack): Stack of backgrounds, already normalized
together, and as a sum normalized to 1.
signal (TH1): One histogram for signal. Can only calculate
Expand Down
2 changes: 1 addition & 1 deletion docs/_gen_matching_8h_source.html

Large diffs are not rendered by default.

89 changes: 89 additions & 0 deletions docs/_jet_m_e_tinfo_8h_source.html

Large diffs are not rendered by default.

87 changes: 87 additions & 0 deletions docs/_jet_recalib_8h_source.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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="viewport" content="width=device-width, initial-scale=1"/>
<title>TIMBER: TIMBER/Framework/include/JetRecalib.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-styles.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo_small.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">TIMBER
&#160;<span id="projectnumber">beta</span>
</div>
<div id="projectbrief">Tree Interface for Making Binned Events with RDataFrame</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d6d9562795f317eab1196869323d45a8.html">TIMBER</a></li><li class="navelem"><a class="el" href="dir_16d9e443a39e4d4bfc6fd05dcfa96ec2.html">Framework</a></li><li class="navelem"><a class="el" href="dir_ac73f0278e065ab7918de78d30844c9a.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">JetRecalib.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"></div><!-- fragment --></div><!-- contents -->
<!-- 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
</small></address>
</body>
</html>
91 changes: 91 additions & 0 deletions docs/_jet_smearer_8h_source.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/_lumi_filter_8h_source.html

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion docs/_pythonic_8h_source.html

Large diffs are not rendered by default.

21 changes: 12 additions & 9 deletions docs/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,15 +84,18 @@
<tr id="row_0_0_5_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_t_i_m_b_e_r_1_1_analyzer_1_1_node.html" target="_self">Node</a></td><td class="desc">Class to represent nodes in the DataFrame processing graph </td></tr>
<tr id="row_0_0_6_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_t_i_m_b_e_r_1_1_analyzer_1_1_var_group.html" target="_self">VarGroup</a></td><td class="desc">Stores Define actions </td></tr>
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_collection.html" target="_self">Collection</a></td><td class="desc">Structure to store maps of the various types of objects in a collection. UChar not considered. Use by building each map as &lt;branchName, branchValue&gt; and then assigning to the correct struct member </td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_gen_particle_objs.html" target="_self">GenParticleObjs</a></td><td class="desc">Object that stores and manipulates the information for gen particles. Stores all gen particles in the event and member functions can be used to access the gen particles by index </td></tr>
<tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_gen_particle_tree.html" target="_self">GenParticleTree</a></td><td class="desc">Constructs tree by adding particles. Establish relationships between particles (parent, child) and allows you to search for a chain of decays </td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_hist_loader.html" target="_self">HistLoader</a></td><td class="desc">Generic histogram loader with methods to return bin values </td></tr>
<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_lumi_filter.html" target="_self">LumiFilter</a></td><td class="desc">Tool to filter luminosity block/run based on golden JSONs. Golden JSONs are provided in TIMBER but a custom one can be provided </td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_particle.html" target="_self">Particle</a></td><td class="desc">Stores identifying features of a particle in the GenPart collection </td></tr>
<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_p_d_fweight__uncert.html" target="_self">PDFweight_uncert</a></td><td class="desc">PDF weight uncertainty lookup class </td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_j_btag___s_f.html" target="_self">SJBtag_SF</a></td><td class="desc">Subjet b tagging scale factor lookup </td></tr>
<tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_top_pt__weight.html" target="_self">TopPt_weight</a></td><td class="desc">Handles the top \(p_T\) reweighting value for \(t\bar{t}\) simulation based on doing gen particle matching. The weight is calculated as </td></tr>
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_trigger__weight.html" target="_self">Trigger_weight</a></td><td class="desc">Specializes in the construction of trigger efficiency weights. Uncertainties are calculated as one half of the trigger inefficiency (ie. (1-eff)/2) </td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_eff_loader.html" target="_self">EffLoader</a></td><td class="desc">Generic histogram loader with methods to return bin values </td></tr>
<tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfat_jet_uncertainties.html" target="_self">fatJetUncertainties</a></td><td class="desc"></td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_gen_particle_objs.html" target="_self">GenParticleObjs</a></td><td class="desc">Object that stores and manipulates the information for gen particles. Stores all gen particles in the event and member functions can be used to access the gen particles by index </td></tr>
<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_gen_particle_tree.html" target="_self">GenParticleTree</a></td><td class="desc">Constructs tree by adding particles. Establish relationships between particles (parent, child) and allows you to search for a chain of decays </td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_hist_loader.html" target="_self">HistLoader</a></td><td class="desc">Generic histogram loader with methods to return bin values </td></tr>
<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_jet_smearer.html" target="_self">JetSmearer</a></td><td class="desc"></td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_lumi_filter.html" target="_self">LumiFilter</a></td><td class="desc">Tool to filter luminosity block/run based on golden JSONs. Golden JSONs are provided in TIMBER but a custom one can be provided </td></tr>
<tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_particle.html" target="_self">Particle</a></td><td class="desc">Stores identifying features of a particle in the GenPart collection </td></tr>
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_p_d_fweight__uncert.html" target="_self">PDFweight_uncert</a></td><td class="desc">PDF weight uncertainty lookup class </td></tr>
<tr id="row_11_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_j_btag___s_f.html" target="_self">SJBtag_SF</a></td><td class="desc">Subjet b tagging scale factor lookup </td></tr>
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_top_pt__weight.html" target="_self">TopPt_weight</a></td><td class="desc">Handles the top \(p_T\) reweighting value for \(t\bar{t}\) simulation based on doing gen particle matching. The weight is calculated as </td></tr>
<tr id="row_13_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_trigger__weight.html" target="_self">Trigger_weight</a></td><td class="desc">Specializes in the construction of trigger efficiency weights. Uncertainties are calculated as one half of the trigger inefficiency (ie. (1-eff)/2) </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
91 changes: 91 additions & 0 deletions docs/class_eff_loader-members.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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="viewport" content="width=device-width, initial-scale=1"/>
<title>TIMBER: Member List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-styles.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo_small.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">TIMBER
&#160;<span id="projectnumber">beta</span>
</div>
<div id="projectbrief">Tree Interface for Making Binned Events with RDataFrame</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">EffLoader Member List</div> </div>
</div><!--header-->
<div class="contents">

<p>This is the complete list of members for <a class="el" href="class_eff_loader.html">EffLoader</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_eff_loader.html#af839abf1fc3ac508b0dc8fbc187d6690">EffLoader</a>()</td><td class="entry"><a class="el" href="class_eff_loader.html">EffLoader</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_eff_loader.html#ae7501000359cccbe0c5a912b9dffa239">EffLoader</a>(std::string filename, std::string histname)</td><td class="entry"><a class="el" href="class_eff_loader.html">EffLoader</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_eff_loader.html#a3dfc7ef86f8106535b10cbbe000318b0">eval</a>(float xval, float yval=0, float zval=0)</td><td class="entry"><a class="el" href="class_eff_loader.html">EffLoader</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_eff_loader.html#a2acf43283607d1bd97a4fa685a3f48b5">eval_bybin</a>(int binx, int biny=0, int binz=0)</td><td class="entry"><a class="el" href="class_eff_loader.html">EffLoader</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_eff_loader.html#a3afbe21ea66123f16e08b2718b017535">eval_byglobal</a>(int globalbin)</td><td class="entry"><a class="el" href="class_eff_loader.html">EffLoader</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- 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
</small></address>
</body>
</html>
Loading

0 comments on commit ac151e7

Please sign in to comment.