Index: contrib/contribs/RecursiveTools/tags/2.0.1/TODO
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.1/TODO (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.1/TODO (revision 1283)
@@ -0,0 +1,26 @@
+For v2.0
+--------
+
+- CHECK: lines 100-102 of RecursiveSymmetryCutBase.hh: this was
+ initially setting the structure members to 0. I think it's highly
+ preferable to set them to their default of -1, signalling the
+ absence of substructure. [0 dR might happen with a perfectly
+ collinear splitting]
+
+- CHECK: are we happy with how the structure info is stored and the
+ recursive_soft_drop_prongs(...) function in RecursiveSoftDrop.hh?
+
+- QUESTION: do we move set_min_deltaR_squared in the base class?
+
+- Add option to define z wrt to original jet?
+
+For future releases?
+--------------------
+- JDT: In Recluster, change "single" to an enum for user clarity?
+ [do we have any other option that "sungle" or "subjets"]
+- JDT: Should we have a FASTJET_CONTRIB_BEGIN_NAMESPACE? It would
+ help those of us who use XCode to edit, which is aggressive about
+ auto-indenting. [Consider this for the full contrib??]
+- More generic kinematic cuts?
+- KZ: common base class for IteratedSoftDrop and RecursiveSoftDrop?
+- KZ: make IteratedSoftDrop use Recluster
\ No newline at end of file
Index: contrib/contribs/RecursiveTools/tags/2.0.1/Recluster.hh
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.1/Recluster.hh (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.1/Recluster.hh (revision 1283)
@@ -0,0 +1,183 @@
+#ifndef __FASTJET_CONTRIB_TOOLS_RECLUSTER_HH__
+#define __FASTJET_CONTRIB_TOOLS_RECLUSTER_HH__
+
+// $Id$
+//
+// Copyright (c) 2014-, Matteo Cacciari, Gavin P. Salam and Gregory Soyez
+//
+//----------------------------------------------------------------------
+// This file is part of FastJet contrib.
+//
+// It is free software; you can redistribute it and/or modify it under
+// the terms of the GNU General Public License as published by the
+// Free Software Foundation; either version 2 of the License, or (at
+// your option) any later version.
+//
+// It is distributed in the hope that it will be useful, but WITHOUT
+// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+// or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
+// License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this code. If not, see .
+//----------------------------------------------------------------------
+
+#include
+#include // to derive the ReclusterStructure from CompositeJetStructure
+#include // to derive Recluster from Transformer
+#include
+#include
+
+FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh
+
+namespace contrib{
+
+//----------------------------------------------------------------------
+/// \class Recluster
+/// Class that helps reclustering a jet with a new jet definition
+///
+/// The result of the reclustering is returned as a single PseudoJet
+/// with a CompositeJet structure. The pieces of that PseudoJet will
+/// be the individual subjets
+///
+/// When constructed from a JetDefinition, that definition will be
+/// used to obtain the subjets. When constructed from a JetAlgorithm
+/// and parameters (0 parameters for e+e-, just R or R and an extra
+/// parameter for others) the recombination scheme will be taken as
+/// the same one used to initially cluster the original jet.
+///
+/// The result of this transformer depends on its usage. There are two
+/// typical use-cases: either we recluster one fat jet into subjets,
+/// OR, we recluster the jet with a different jet alg. When Recluster
+/// is created from a full jet definition. The last parameter of the
+/// constructors below dicatate that behaviour: if "single" is true
+/// (the default), a single jet, issued from a regular clustering is
+/// returned (if there are more than one, the hardest is taken);
+/// otherwise (single==false), the result will be a composite jet with
+/// each subjet as pieces
+///
+/// Open points for discussion:
+///
+/// - do we add an option to force area support? [could be useful
+/// e.g. for the filter with a subtractor where area support is
+/// mandatory]
+///
+class Recluster : public Transformer {
+public:
+ /// define a recluster that decomposes a jet into subjets using a
+ /// generic JetDefinition
+ ///
+ /// \param subjet_def the jet definition applied to obtain the subjets
+ /// \param single when true, cluster the jet in a single jet (the
+ /// hardest one) with an associated ClusterSequence,
+ /// otherwise return a composite jet with subjets
+ /// as pieces.
+ Recluster(const JetDefinition & subjet_def, bool single=true)
+ : _subjet_def(subjet_def), _use_full_def(true), _single(single) {}
+
+ /// define a recluster that decomposes a jet into subjets using a
+ /// JetAlgorithm and its parameters
+ ///
+ /// \param subjet_alg the jet algorithm applied to obtain the subjets
+ /// \param subjet_radius the jet radius if required
+ /// \param subjet_extra optional extra parameters for the jet algorithm (only when needed)
+ /// \param single when true, cluster the jet in a single jet (the
+ /// hardest one) with an associated ClusterSequence,
+ /// otherwise return a composite jet with subjets
+ /// as pieces.
+ ///
+ /// Typically, for e+e- algoriothm you should use the third version
+ /// below with no parameters, for "standard" pp algorithms, just the
+ /// clustering radius has to be specified and for genkt-type of
+ /// algorithms, both the radius and the extra parameter have to be
+ /// specified.
+ Recluster(JetAlgorithm subjet_alg, double subjet_radius, double subjet_extra,
+ bool single=true)
+ : _subjet_alg(subjet_alg), _use_full_def(false),
+ _subjet_radius(subjet_radius), _has_subjet_radius(true),
+ _subjet_extra(subjet_extra), _has_subjet_extra(true), _single(single) {}
+ Recluster(JetAlgorithm subjet_alg, double subjet_radius, bool single=true)
+ : _subjet_alg(subjet_alg), _use_full_def(false),
+ _subjet_radius(subjet_radius), _has_subjet_radius(true),
+ _has_subjet_extra(false), _single(single) {}
+ Recluster(JetAlgorithm subjet_alg, bool single=true)
+ : _subjet_alg(subjet_alg), _use_full_def(false),
+ _has_subjet_radius(false), _has_subjet_extra(false), _single(single) {}
+
+ /// default dtor
+ virtual ~Recluster(){};
+
+ //----------------------------------------------------------------------
+ // standard Transformer behaviour inherited from the base class
+ // (i.e. result(), description() and structural info)
+
+ /// runs the reclustering and sets kept and rejected to be the jets of interest
+ /// (with non-zero rho, they will have been subtracted).
+ ///
+ /// \param jet the jet that gets reclustered
+ /// \return the reclustered jet
+ virtual PseudoJet result(const PseudoJet & jet) const;
+
+ /// class description
+ virtual std::string description() const;
+
+ // the type of the associated structure
+ typedef CompositeJetStructure StructureType;
+
+private:
+ /// set the reclustered elements in the simple case of C/A+C/A
+ void _recluster_cafilt(const std::vector & all_pieces,
+ std::vector & subjets,
+ double Rfilt) const;
+
+ /// set the reclustered elements in the generic re-clustering case
+ void _recluster_generic(const PseudoJet & jet,
+ std::vector & subjets,
+ const JetDefinition & subjet_def,
+ bool do_areas) const;
+
+ // a series of checks
+ //--------------------------------------------------------------------
+ /// get the pieces down to the fundamental pieces
+ bool _get_all_pieces(const PseudoJet &jet, std::vector &all_pieces) const;
+
+ /// get the common recombiner to all pieces (NULL if none)
+ const JetDefinition::Recombiner* _get_common_recombiner(const std::vector &all_pieces) const;
+
+ /// construct the proper jet definition ensuring that the recombiner
+ /// is taken from the underlying pieces (an error is thrown if the
+ /// pieces do no share a common recombiner)
+ void _build_jet_def_with_recombiner(const std::vector &all_pieces,
+ JetDefinition &subjet_def) const;
+
+ /// check if one can apply the simplified trick for C/A subjets
+ bool _check_ca(const std::vector &all_pieces,
+ const JetDefinition &subjet_def) const;
+
+ /// check if the jet (or all its pieces) have explicit ghosts
+ /// (assuming the jet has area support
+ ///
+ /// Note that if the jet has an associated cluster sequence that is no
+ /// longer valid, an error will be thrown
+ bool _check_explicit_ghosts(const std::vector &all_pieces) const;
+
+ JetDefinition _subjet_def; ///< the jet definition to use to extract the subjets
+ JetAlgorithm _subjet_alg; ///< the jet algorithm to be used
+ bool _use_full_def; ///< true when the full JetDefinition is supplied to the ctor
+ double _subjet_radius; ///< the jet radius (only if needed for the jet alg)
+ bool _has_subjet_radius; ///< the subjet radius has been specified
+ double _subjet_extra; ///< the jet alg extra param (only if needed)
+ bool _has_subjet_extra; ///< the extra param has been specified
+
+ bool _single; ///< (true) return a single jet with a
+ ///< regular clustering or (false) a
+ ///< composite jet with subjets as pieces
+
+ static LimitedWarning _explicit_ghost_warning;
+};
+
+} // namespace contrib
+
+FASTJET_END_NAMESPACE // defined in fastjet/internal/base.hh
+
+#endif // __FASTJET_CONTRIB_TOOLS_RECLUSTER_HH__
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.1/Recluster.hh
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.1/IteratedSoftDrop.cc
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.1/IteratedSoftDrop.cc (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.1/IteratedSoftDrop.cc (revision 1283)
@@ -0,0 +1,128 @@
+// $Id$
+//
+// Copyright (c) 2017-, Jesse Thaler, Kevin Zhou, Gavin P. Salam
+// andGregory Soyez
+//
+// based on arXiv:1704.06266 by Christopher Frye, Andrew J. Larkoski,
+// Jesse Thaler, Kevin Zhou
+//
+//----------------------------------------------------------------------
+// This file is part of FastJet contrib.
+//
+// It is free software; you can redistribute it and/or modify it under
+// the terms of the GNU General Public License as published by the
+// Free Software Foundation; either version 2 of the License, or (at
+// your option) any later version.
+//
+// It is distributed in the hope that it will be useful, but WITHOUT
+// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+// or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
+// License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this code. If not, see .
+//----------------------------------------------------------------------
+
+#include "IteratedSoftDrop.hh"
+#include
+#include
+#include
+
+using namespace std;
+
+FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh
+
+namespace contrib{
+
+//========================================================================
+// implementation of IteratedSoftDropInfo
+//========================================================================
+
+// returns the angularity with angular exponent alpha and z
+// exponent kappa calculated on the zg's and thetag's found by
+// iterated SoftDrop
+//
+// returns 0 if no substructure was found
+double IteratedSoftDropInfo::angularity(double alpha, double kappa) const{
+ double sum = 0.0;
+ for (unsigned int i=0; i< _all_zg_thetag.size(); ++i)
+ sum += pow(_all_zg_thetag[i].first, kappa) * pow(_all_zg_thetag[i].second, alpha);
+ return sum;
+}
+
+//========================================================================
+// implementation of IteratedSoftDrop
+//========================================================================
+
+// Constructor. Takes in the standard Soft Drop parameters, an angular cut \f$\theta_{\rm cut}\f$,
+// and a choice of angular and symmetry measure.
+//
+// - beta the Soft Drop beta parameter
+// - symmetry_cut the Soft Drop symmetry cut
+// - angular_cut the angular cutoff to halt Iterated Soft Drop
+// - R0 the angular distance normalization
+IteratedSoftDrop::IteratedSoftDrop(double beta, double symmetry_cut, double angular_cut, double R0,
+ const FunctionOfPseudoJet * subtractor) :
+ _rsd(beta, symmetry_cut, -1, R0, subtractor){
+ _rsd.set_hardest_branch_only(true);
+ if (angular_cut>0)
+ _rsd.set_min_deltaR_squared(angular_cut*angular_cut);
+}
+
+
+// Full constructor, which takes the following parameters:
+//
+// \param beta the value of the beta parameter
+// \param symmetry_cut the value of the cut on the symmetry measure
+// \param symmetry_measure the choice of measure to use to estimate the symmetry
+// \param angular_cut the angular cutoff to halt Iterated Soft Drop
+// \param R0 the angular distance normalisation [1 by default]
+// \param mu_cut the maximal allowed value of mass drop variable mu = m_heavy/m_parent
+// \param recursion_choice the strategy used to decide which subjet to recurse into
+// \param subtractor an optional pointer to a pileup subtractor (ignored if zero)
+IteratedSoftDrop::IteratedSoftDrop(double beta,
+ double symmetry_cut,
+ RecursiveSoftDrop::SymmetryMeasure symmetry_measure,
+ double angular_cut,
+ double R0,
+ double mu_cut,
+ RecursiveSoftDrop::RecursionChoice recursion_choice,
+ const FunctionOfPseudoJet * subtractor)
+ : _rsd(beta, symmetry_cut, symmetry_measure, -1, R0, mu_cut, recursion_choice, subtractor){
+ _rsd.set_hardest_branch_only(true);
+ if (angular_cut>0)
+ _rsd.set_min_deltaR_squared(angular_cut*angular_cut);
+}
+
+
+// returns vector of ISD symmetry factors and splitting angles
+IteratedSoftDropInfo IteratedSoftDrop::result(const PseudoJet& jet) const{
+ PseudoJet rsd_jet = _rsd(jet);
+ if (! rsd_jet.has_structure_of())
+ return IteratedSoftDropInfo();
+ return IteratedSoftDropInfo(rsd_jet.structure_of().sorted_zg_and_thetag());
+}
+
+
+std::string IteratedSoftDrop::description() const{
+ std::ostringstream oss;
+ oss << "IteratedSoftDrop with beta =" << _rsd.beta()
+ << ", symmetry_cut=" << _rsd.symmetry_cut()
+ << ", R0=" << _rsd.R0();
+
+ if (_rsd.min_deltaR_squared() >= 0){
+ oss << " and angular_cut=" << sqrt(_rsd.min_deltaR_squared());
+ } else {
+ oss << " and no angular_cut";
+ }
+
+ if (_rsd.subtractor()){
+ oss << ", and with internal subtraction using [" << _rsd.subtractor()->description() << "]";
+ }
+ return oss.str();
+}
+
+
+} // namespace contrib
+
+FASTJET_END_NAMESPACE
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.1/IteratedSoftDrop.cc
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.1/ModifiedMassDropTagger.cc
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.1/ModifiedMassDropTagger.cc (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.1/ModifiedMassDropTagger.cc (revision 1283)
@@ -0,0 +1,43 @@
+// $Id$
+//
+// Copyright (c) 2014-, Gavin P. Salam
+//
+//----------------------------------------------------------------------
+// This file is part of FastJet contrib.
+//
+// It is free software; you can redistribute it and/or modify it under
+// the terms of the GNU General Public License as published by the
+// Free Software Foundation; either version 2 of the License, or (at
+// your option) any later version.
+//
+// It is distributed in the hope that it will be useful, but WITHOUT
+// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+// or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
+// License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this code. If not, see .
+//----------------------------------------------------------------------
+
+#include "ModifiedMassDropTagger.hh"
+#include "fastjet/JetDefinition.hh"
+#include "fastjet/ClusterSequenceAreaBase.hh"
+#include
+#include
+
+using namespace std;
+
+FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh
+
+namespace contrib{
+
+//----------------------------------------------------------------------
+string ModifiedMassDropTagger::symmetry_cut_description() const {
+ ostringstream ostr;
+ ostr << _symmetry_cut << " [ModifiedMassDropTagger]";
+ return ostr.str();
+}
+
+} // namespace contrib
+
+FASTJET_END_NAMESPACE
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.1/ModifiedMassDropTagger.cc
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.1/COPYING
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.1/COPYING (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.1/COPYING (revision 1283)
@@ -0,0 +1,360 @@
+The RecursiveTools contrib to FastJet is released
+under the terms of the GNU General Public License v2 (GPLv2).
+
+A copy of the GPLv2 is to be found at the end of this file.
+
+While the GPL license grants you considerable freedom, please bear in
+mind that this code's use falls under guidelines similar to those that
+are standard for Monte Carlo event generators
+(http://www.montecarlonet.org/GUIDELINES). In particular, if you use
+this code as part of work towards a scientific publication, whether
+directly or contained within another program you should include a
+citation to
+
+ arXiv:1307.0007
+ arXiv:1402.2657
+ arXiv:1704.06266
+
+======================================================================
+======================================================================
+======================================================================
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+
+ Copyright (C)
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ , 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Library General
+Public License instead of this License.
Index: contrib/contribs/RecursiveTools/tags/2.0.1/example_mmdt_ee.cc
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.1/example_mmdt_ee.cc (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.1/example_mmdt_ee.cc (revision 1283)
@@ -0,0 +1,142 @@
+//----------------------------------------------------------------------
+/// \file example_ee.cc
+///
+/// This example program is meant to illustrate how to use
+/// RecursiveTools for e+e- events. It is done using the
+/// ModifiedMassDropTagger class but the same strategy would work as
+/// well for SoftDrop, RecursiveSoftDrop and IteratedSoftDrop
+///
+/// Run this example with
+///
+/// \verbatim
+/// ./example_ee < ../data/single-ee-event.dat
+/// \endverbatim
+//----------------------------------------------------------------------
+
+// $Id$
+//
+// Copyright (c) 2017-, Gavin P. Salam, Gregory Soyez, Jesse Thaler,
+// Kevin Zhou, Frederic Dreyer
+//
+//----------------------------------------------------------------------
+// This file is part of FastJet contrib.
+//
+// It is free software; you can redistribute it and/or modify it under
+// the terms of the GNU General Public License as published by the
+// Free Software Foundation; either version 2 of the License, or (at
+// your option) any later version.
+//
+// It is distributed in the hope that it will be useful, but WITHOUT
+// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+// or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
+// License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this code. If not, see .
+//----------------------------------------------------------------------
+
+#include
+#include
+
+#include
+#include
+#include
+#include "fastjet/ClusterSequence.hh"
+#include "fastjet/tools/Filter.hh"
+#include "ModifiedMassDropTagger.hh" // In external code, this should be fastjet/contrib/ModifiedMassDropTagger.hh
+
+using namespace std;
+using namespace fastjet;
+
+// forward declaration to make things clearer
+void read_event(vector &event);
+ostream & operator<<(ostream &, const PseudoJet &);
+
+//----------------------------------------------------------------------
+int main(){
+
+ //----------------------------------------------------------
+ // read in input particles
+ vector event;
+ read_event(event);
+ cout << "# read an event with " << event.size() << " particles" << endl;
+
+ // first get some Cambridge/Aachen jets
+ double R = 1.0;
+ JetDefinition jet_def(ee_genkt_algorithm, R, 0.0);
+ ClusterSequence cs(event, jet_def);
+
+ double Emin = 10.0;
+ Selector sel_jets = SelectorEMin(Emin);
+ vector jets = sorted_by_E(sel_jets(cs.inclusive_jets()));
+
+ // give the tagger a short name
+ typedef contrib::ModifiedMassDropTagger MMDT;
+
+ // This version uses the following setup:
+ // - use energy for the symmetry measure
+ // Note: since the mMDT does not require angular information,
+ // here we could use either theta_E or cos_theta_E (it would
+ // only change the value of DeltaR). For
+ // SoftDrop/RecursiveSoftDrop/IteratedSoftDrop, this would make
+ // a difference and we have
+ // DeltaR_{ij}^2 = theta_{ij}^2 (theta_E)
+ // DeltaR_{ij}^2 = 2 [1-cos(theta_{ij}^2)] (cos_theta_E)
+ //
+ // - recurse into the branch with the largest energy
+ //
+ // - use a symmetry cut, with no mass-drop requirement
+ double z_cut = 0.20;
+ MMDT tagger(z_cut,
+ MMDT::cos_theta_E,
+ std::numeric_limits::infinity(),
+ MMDT::larger_E);
+ cout << "tagger is: " << tagger.description() << endl;
+
+ for (unsigned ijet = 0; ijet < jets.size(); ijet++) {
+ // first run MMDT and examine the output
+ PseudoJet tagged_jet = tagger(jets[ijet]);
+ cout << endl;
+ cout << "original jet: " << jets[ijet] << endl;
+ cout << "tagged jet: " << tagged_jet << endl;
+ if (tagged_jet == 0) continue; // If symmetry condition not satisified, jet is not tagged
+ cout << " delta_R between subjets: " << tagged_jet.structure_of().delta_R() << endl;
+ cout << " symmetry measure(z): " << tagged_jet.structure_of().symmetry() << endl;
+ cout << " mass drop(mu): " << tagged_jet.structure_of().mu() << endl;
+
+ cout << endl;
+ }
+
+ return 0;
+}
+
+//----------------------------------------------------------------------
+/// read in input particles
+void read_event(vector &event){
+ string line;
+ while (getline(cin, line)) {
+ istringstream linestream(line);
+ // take substrings to avoid problems when there are extra "pollution"
+ // characters (e.g. line-feed).
+ if (line.substr(0,4) == "#END") {return;}
+ if (line.substr(0,1) == "#") {continue;}
+ double px,py,pz,E;
+ linestream >> px >> py >> pz >> E;
+ PseudoJet particle(px,py,pz,E);
+
+ // push event onto back of full_event vector
+ event.push_back(particle);
+ }
+}
+
+//----------------------------------------------------------------------
+/// overloaded jet info output
+ostream & operator<<(ostream & ostr, const PseudoJet & jet) {
+ if (jet == 0) {
+ ostr << " 0 ";
+ } else {
+ ostr << " E = " << jet.pt()
+ << " m = " << jet.m();
+ }
+ return ostr;
+}
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.1/example_mmdt_ee.cc
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.1/RecursiveSoftDrop.cc
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.1/RecursiveSoftDrop.cc (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.1/RecursiveSoftDrop.cc (revision 1283)
@@ -0,0 +1,475 @@
+// $Id$
+//
+// Copyright (c) 2017-, Gavin P. Salam, Gregory Soyez, Jesse Thaler,
+// Kevin Zhou, Frederic Dreyer
+//
+//----------------------------------------------------------------------
+// This file is part of FastJet contrib.
+//
+// It is free software; you can redistribute it and/or modify it under
+// the terms of the GNU General Public License as published by the
+// Free Software Foundation; either version 2 of the License, or (at
+// your option) any later version.
+//
+// It is distributed in the hope that it will be useful, but WITHOUT
+// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+// or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
+// License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this code. If not, see .
+//----------------------------------------------------------------------
+
+#include "RecursiveSoftDrop.hh"
+#include "fastjet/ClusterSequence.hh"
+
+using namespace std;
+
+FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh
+
+namespace contrib{
+
+namespace internal_recursive_softdrop{
+
+//========================================================================
+/// \class RSDHistoryElement
+/// a helper class to help keeping track od the RSD tree
+///
+/// The element is created at the top of a branch and updated each
+/// time one grooms something away.
+class RSDHistoryElement{
+public:
+ RSDHistoryElement(const PseudoJet &jet, const RecursiveSoftDrop* rsd_ptr, double R0sqr) :
+ R0_squared(R0sqr),
+ child1_in_history(-1), child2_in_history(-1), symmetry(-1.0), mu2(-1.0){
+ reset(jet, rsd_ptr);
+ }
+
+ void reset(const PseudoJet &jet, const RecursiveSoftDrop* rsd_ptr){
+ current_in_ca_tree = jet.cluster_hist_index();
+ PseudoJet piece1, piece2;
+ theta_squared = (jet.has_parents(piece1, piece2))
+ ? rsd_ptr->squared_geometric_distance(piece1,piece2) : 0.0;
+ }
+
+ int current_in_ca_tree; ///< (history) index of the current particle in the C/A tree
+ double theta_squared; ///< squared angle at which this decays
+ double R0_squared; ///< squared angle at the top of the branch
+ ///< (used for RSD with dynamic_R0)
+ int child1_in_history; ///< hardest of the 2 decay products (-1 if untagged)
+ int child2_in_history; ///< softest of the 2 decay products (-1 if untagged)
+
+ // info about what has been dropped and the local substructure
+ vector dropped_delta_R;
+ vector dropped_symmetry;
+ vector dropped_mu;
+ double symmetry, mu2;
+};
+
+
+/// \class OrderRSDHistoryElements
+/// angular ordering of (pointers to) the history elements
+///
+/// our priority queue will use pointers to these elements that are
+/// ordered in angle (of the objects they point to)
+class OrderRSDHistoryElements{
+public:
+ bool operator()(const RSDHistoryElement *e1, const RSDHistoryElement *e2) const {
+ return e1->theta_squared < e2->theta_squared;
+ }
+};
+
+} // internal_recursive_softdrop
+
+//========================================================================
+
+// initialise all the flags and parameters to their default value
+void RecursiveSoftDrop::set_defaults(){
+ set_fixed_depth_mode(false);
+ set_dynamical_R0(false);
+ set_hardest_branch_only(false);
+ set_min_deltaR_squared(-1.0);
+}
+
+// description of the tool
+string RecursiveSoftDrop::description() const{
+ ostringstream res;
+ res << "recursive application of ["
+ << RecursiveSymmetryCutBase::description()
+ << "]";
+
+ if (_fixed_depth){
+ res << ", recursively applied down to a maximal depth of N=";
+ if (_n==-1) res << "infinity"; else res << _n;
+ } else {
+ res << ", applied N=";
+ if (_n==-1) res << "infinity"; else res << _n;
+ res << " times";
+ }
+
+ if (_dynamical_R0)
+ res << ", with R0 dynamically scaled";
+ else
+ res << ", with R0 kept fixed";
+
+ if (_hardest_branch_only)
+ res << ", following only the hardest branch";
+
+ if (_min_dR2>0)
+ res << ", with minimal angle (squared) = " << _min_dR2;
+
+ return res.str();
+}
+
+
+// action on a single jet with RecursiveSoftDrop.
+//
+// uses "result_fixed_tags" by default (i.e. recurse from R0 to
+// smaller angles until n SD conditions have been met), or
+// "result_fixed_depth" where each of the previous SD branches are
+// recirsed into down to a depth of n.
+PseudoJet RecursiveSoftDrop::result(const PseudoJet &jet) const{
+ return _fixed_depth ? result_fixed_depth(jet) : result_fixed_tags(jet);
+}
+
+// this routine applies the Soft Drop criterion recursively on the
+// CA tree until we find n subjets (or until it converges), and
+// adds them together into a groomed PseudoJet
+PseudoJet RecursiveSoftDrop::result_fixed_tags(const PseudoJet &jet) const {
+ // start by reclustering jet with C/A algorithm
+ PseudoJet ca_jet = _recluster_if_needed(jet);
+
+ if (! ca_jet.has_valid_cluster_sequence()){
+ throw Error("RecursiveSoftDrop can only be applied to jets associated to a (valid) cluster sequence");
+ }
+
+ const ClusterSequence *cs = ca_jet.validated_cluster_sequence();
+ const vector &cs_history = cs->history();
+ const vector &cs_jets = cs->jets();
+
+ // initialise counter to 1 subjet (i.e. the full ca_jet)
+ int n_tagged = 0;
+ int max_njet = ca_jet.constituents().size();
+
+ // create the list of branches
+ unsigned int max_history_size = 2*max_njet;
+ if ((_n>0) && (_n history;
+ history.reserve(max_history_size); // could be one shorter
+ history.push_back(internal_recursive_softdrop::RSDHistoryElement(ca_jet, this, _R0sqr));
+
+ // create a priority queue containing the subjets and a comparison definition
+ priority_queue, internal_recursive_softdrop::OrderRSDHistoryElements> active_branches;
+ active_branches.push(& (history[0]));
+
+ PseudoJet parent, piece1, piece2;
+ double sym, mu2;
+
+ // loop over C/A tree until we reach the appropriate number of subjets
+ while ((continue_grooming(n_tagged)) && (active_branches.size())) {
+ // get the element corresponding to the max dR and the associated PJ
+ internal_recursive_softdrop::RSDHistoryElement * elm = active_branches.top();
+ PseudoJet parent = cs_jets[cs_history[elm->current_in_ca_tree].jetp_index];
+
+ // do one step of SD
+ RecursionStatus status = recurse_one_step(parent, piece1, piece2, sym, mu2, &elm->R0_squared);
+
+ // check if we passed the SD condition
+ if (status==recursion_success){
+ // check for the optional angular cut
+ if ((_min_dR2 > 0) && (squared_geometric_distance(piece1,piece2) < _min_dR2))
+ break;
+
+ // both subjets are kept in the list for potential further de-clustering
+ elm->child1_in_history = history.size();
+ elm->child2_in_history = history.size()+1;
+ elm->symmetry = sym;
+ elm->mu2 = mu2;
+ active_branches.pop();
+
+ // update the history
+ double next_R0_squared = (_dynamical_R0)
+ ? piece1.squared_distance(piece2) : elm->R0_squared;
+
+ internal_recursive_softdrop::RSDHistoryElement elm1(piece1, this, next_R0_squared);
+ history.push_back(elm1);
+ active_branches.push(&(history.back()));
+ internal_recursive_softdrop::RSDHistoryElement elm2(piece2, this, next_R0_squared);
+ history.push_back(elm2);
+ if (!_hardest_branch_only){
+ active_branches.push(&(history.back()));
+ }
+
+ ++n_tagged;
+ } else if (status==recursion_dropped){
+ // check for the optional angular cut
+ if ((_min_dR2 > 0) && (squared_geometric_distance(piece1,piece2) < _min_dR2))
+ break;
+
+ active_branches.pop();
+ // tagging failed and the softest branch should be dropped
+ // keep track of what has been groomed away
+ max_njet -= piece2.constituents().size();
+ elm->dropped_delta_R .push_back((elm->theta_squared >= 0) ? sqrt(elm->theta_squared) : -sqrt(elm->theta_squared));
+ elm->dropped_symmetry.push_back(sym);
+ elm->dropped_mu .push_back((mu2>=0) ? sqrt(mu2) : -sqrt(mu2));
+
+ // keep the hardest branch in the recursion
+ elm->reset(piece1, this);
+ active_branches.push(elm);
+ } else if (status==recursion_no_parents){
+ if (_min_dR2 > 0) break;
+ active_branches.pop();
+ // nothing specific to do: we just keep the curent jet as a "leaf"
+ } else { // recursion_issue
+ active_branches.pop();
+ // we've met an issue
+ // if the piece2 is null as well, it means we've had a critical problem.
+ // In that case, return an empty PseudoJet
+ if (piece2 == 0) return PseudoJet();
+
+ // otherwise, we should consider "piece2" as a final particle
+ // not to be recursed into
+ if (_min_dR2 > 0) break;
+ max_njet -= (piece2.constituents().size()-1);
+ break;
+ }
+
+ // If the missing number of tags is exactly the number of objects
+ // we have left in the recursion, stop
+ if (n_tagged == max_njet) break;
+ }
+
+ // now we have a bunch of history elements that we can use to build the final jet
+ vector mapped_to_history(history.size());
+ unsigned int history_index = history.size();
+ do {
+ --history_index;
+ const internal_recursive_softdrop::RSDHistoryElement & elm = history[history_index];
+
+ // two kinds of events: either just a final leave, potentially with grooming
+ // or a brandhing (also with potential grooming at the end)
+ if (elm.child1_in_history<0){
+ // this is a leaf, i.e. with no further substructure
+ PseudoJet & subjet = mapped_to_history[history_index]
+ = cs_jets[cs_history[elm.current_in_ca_tree].jetp_index];
+
+ StructureType * structure = new StructureType(subjet);
+ if (has_verbose_structure()){
+ structure->set_verbose(true);
+ structure->set_dropped_delta_R (elm.dropped_delta_R);
+ structure->set_dropped_symmetry(elm.dropped_symmetry);
+ structure->set_dropped_mu (elm.dropped_mu);
+ }
+ subjet.set_structure_shared_ptr(SharedPtr(structure));
+ } else {
+ PseudoJet & subjet = mapped_to_history[history_index]
+ = join(mapped_to_history[elm.child1_in_history], mapped_to_history[elm.child2_in_history]);
+ StructureType * structure = new StructureType(subjet, sqrt(elm.theta_squared), elm.symmetry, sqrt(elm.mu2));
+ if (has_verbose_structure()){
+ structure->set_verbose(true);
+ structure->set_dropped_delta_R (elm.dropped_delta_R);
+ structure->set_dropped_symmetry(elm.dropped_symmetry);
+ structure->set_dropped_mu (elm.dropped_mu);
+ }
+ subjet.set_structure_shared_ptr(SharedPtr(structure));
+ }
+ } while (history_index>0);
+
+ return mapped_to_history[0];
+}
+
+// this routine applies the Soft Drop criterion recursively on the
+// CA tree, recursing into all the branches found during the previous iteration
+// until n layers have been found (or until it converges)
+PseudoJet RecursiveSoftDrop::result_fixed_depth(const PseudoJet &jet) const {
+ // start by reclustering jet with C/A algorithm
+ PseudoJet ca_jet = _recluster_if_needed(jet);
+
+ if (! ca_jet.has_valid_cluster_sequence()){
+ throw Error("RecursiveSoftDrop can only be applied to jets associated to a (valid) cluster sequence");
+ }
+
+ const ClusterSequence *cs = ca_jet.validated_cluster_sequence();
+ const vector &cs_history = cs->history();
+ const vector &cs_jets = cs->jets();
+
+ // initialise counter to 1 subjet (i.e. the full ca_jet)
+ int n_depth = 0;
+ int max_njet = ca_jet.constituents().size();
+
+ // create the list of branches
+ unsigned int max_history_size = 2*max_njet;
+ //if ((_n>0) && (_n history;
+ history.reserve(max_history_size); // could be one shorter
+ history.push_back(internal_recursive_softdrop::RSDHistoryElement(ca_jet, this, _R0sqr));
+ history.back().theta_squared = _R0sqr;
+
+ // create a priority queue containing the subjets and a comparison definition
+ list active_branches;
+ active_branches.push_back(& (history[0]));
+
+ PseudoJet parent, piece1, piece2;
+
+ while ((continue_grooming(n_depth)) && (active_branches.size())) {
+ // loop over all the branches and look for substructure
+ list::iterator hist_it=active_branches.begin();
+ while (hist_it!=active_branches.end()){
+ // get the element corresponding to the max dR and the associated PJ
+ internal_recursive_softdrop::RSDHistoryElement * elm = (*hist_it);
+ PseudoJet parent = cs_jets[cs_history[elm->current_in_ca_tree].jetp_index];
+
+ // we need to iterate this branch until we find some substructure
+ PseudoJet result_sd;
+ if (_dynamical_R0){
+ SoftDrop sd(_beta, _symmetry_cut, symmetry_measure(), sqrt(elm->theta_squared),
+ mu_cut(), recursion_choice(), subtractor());
+ sd.set_reclustering(false);
+ sd.set_verbose_structure(has_verbose_structure());
+ result_sd = sd(parent);
+ } else {
+ result_sd = SoftDrop::result(parent);
+ }
+
+ // if we had an empty PJ, that means we ran into some problems.
+ // just return an empty PJ ourselves
+ if (result_sd == 0) return PseudoJet();
+
+ // update the history element to reflect our iteration
+ elm->current_in_ca_tree = result_sd.cluster_hist_index();
+
+ if (has_verbose_structure()){
+ elm->dropped_delta_R = result_sd.structure_of().dropped_delta_R();
+ elm->dropped_symmetry = result_sd.structure_of().dropped_symmetry();
+ elm->dropped_mu = result_sd.structure_of().dropped_mu();
+ }
+
+ // if some substructure was found:
+ if (result_sd.structure_of().has_substructure()){
+ // update the history element to reflect our iteration
+ elm->child1_in_history = history.size();
+ elm->child2_in_history = history.size()+1;
+ elm->theta_squared = result_sd.structure_of().delta_R();
+ elm->theta_squared *= elm->theta_squared;
+ elm->symmetry = result_sd.structure_of().symmetry();
+ elm->mu2 = result_sd.structure_of().mu();
+ elm->mu2 *= elm->mu2;
+
+ // the next iteration will have to handle 2 new history
+ // elements (the R0squared argument here is unused)
+ result_sd.has_parents(piece1, piece2);
+ internal_recursive_softdrop::RSDHistoryElement elm1(piece1, this, _R0sqr);
+ history.push_back(elm1);
+ // insert it in the active branches if needed
+ if (elm1.theta_squared>0)
+ active_branches.insert(hist_it,&(history.back())); // insert just before
+
+ internal_recursive_softdrop::RSDHistoryElement elm2(piece2, this, _R0sqr);
+ history.push_back(elm2);
+ if ((!_hardest_branch_only) && (elm2.theta_squared>0)){
+ active_branches.insert(hist_it,&(history.back())); // insert just before
+ }
+ }
+ // otherwise we've just reached the end of the recursion the
+ // history information has been updated above
+ //
+ // we just need to make sure that we do not recurse into that
+ // element any longer
+
+ list::iterator current = hist_it;
+ ++hist_it;
+ active_branches.erase(current);
+ } // loop over branches at current depth
+ ++n_depth;
+ } // loop over depth
+
+ // now we have a bunch of history elements that we can use to build the final jet
+ vector mapped_to_history(history.size());
+ unsigned int history_index = history.size();
+ do {
+ --history_index;
+ const internal_recursive_softdrop::RSDHistoryElement & elm = history[history_index];
+
+ // two kinds of events: either just a final leave, poteitially with grooming
+ // or a brandhing (also with potential grooming at the end)
+ if (elm.child1_in_history<0){
+ // this is a leaf, i.e. with no further sustructure
+ PseudoJet & subjet = mapped_to_history[history_index]
+ = cs_jets[cs_history[elm.current_in_ca_tree].jetp_index];
+
+ StructureType * structure = new StructureType(subjet);
+ if (has_verbose_structure()){
+ structure->set_verbose(true);
+ }
+ subjet.set_structure_shared_ptr(SharedPtr(structure));
+ } else {
+ PseudoJet & subjet = mapped_to_history[history_index]
+ = join(mapped_to_history[elm.child1_in_history], mapped_to_history[elm.child2_in_history]);
+ StructureType * structure = new StructureType(subjet, sqrt(elm.theta_squared), elm.symmetry, sqrt(elm.mu2));
+ if (has_verbose_structure()){
+ structure->set_verbose(true);
+ structure->set_dropped_delta_R (elm.dropped_delta_R);
+ structure->set_dropped_symmetry(elm.dropped_symmetry);
+ structure->set_dropped_mu (elm.dropped_mu);
+ }
+ subjet.set_structure_shared_ptr(SharedPtr(structure));
+ }
+ } while (history_index>0);
+
+ return mapped_to_history[0];
+}
+
+
+//========================================================================
+// implementation of the helpers
+//========================================================================
+
+// helper to get all the prongs in a jet that has been obtained using
+// RecursiveSoftDrop (instead of recursively parsing the 1->2
+// composite jet structure)
+vector recursive_soft_drop_prongs(const PseudoJet & rsd_jet){
+ // make sure that the jet has the appropriate RecursiveSoftDrop structure
+ if (!rsd_jet.has_structure_of())
+ return vector();
+
+ // if this jet has no substructure, just return a 1-prong object
+ if (!rsd_jet.structure_of().has_substructure())
+ return vector(1, rsd_jet);
+
+ // otherwise fill a vector with all the prongs (no specific ordering)
+ vector prongs;
+
+ // parse the list of PseudoJet we still need to deal with
+ vector to_parse = rsd_jet.pieces(); // valid both for a C/A recombination step or a RSD join
+ unsigned int i_parse = 0;
+ while (i_parse()) &&
+ (current.structure_of().has_substructure())){
+ // if this has some deeper substructure, add it to the list of
+ // things to further process
+ vector pieces = current.pieces();
+ assert(pieces.size() == 2);
+ to_parse[i_parse] = pieces[0];
+ to_parse.push_back(pieces[1]);
+ } else {
+ // no further substructure, just add this as a branch
+ prongs.push_back(current);
+ ++i_parse;
+ }
+ }
+
+ return prongs;
+}
+
+}
+
+FASTJET_END_NAMESPACE
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.1/RecursiveSoftDrop.cc
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.1/example_recursive_softdrop.ref
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.1/example_recursive_softdrop.ref (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.1/example_recursive_softdrop.ref (revision 1283)
@@ -0,0 +1,83 @@
+# read an event with 354 particles
+#--------------------------------------------------------------------------
+# FastJet release 3.3.1-devel
+# M. Cacciari, G.P. Salam and G. Soyez
+# A software package for jet finding and analysis at colliders
+# http://fastjet.fr
+#
+# Please cite EPJC72(2012)1896 [arXiv:1111.6097] if you use this package
+# for scientific work and optionally PLB641(2006)57 [hep-ph/0512210].
+#
+# FastJet is provided without warranty under the terms of the GNU GPLv2.
+# It uses T. Chan's closest pair algorithm, S. Fortune's Voronoi code
+# and 3rd party plugin jet algorithms. See COPYING file for details.
+#--------------------------------------------------------------------------
+RecursiveSoftDrop groomer is: recursive application of [Recursive Groomer with a symmetry cut scalar_z > 0.2 (theta/1)^0.5 [SoftDrop], no mass-drop requirement, recursion into the subjet with larger pt], applied N=4 times, with R0 dynamically scaled
+
+original jet: pt = 983.387 m = 39.9912 y = -0.867307 phi = 2.90511
+RecursiveSoftDropped jet: pt = 811.261 m = 6.45947 y = -0.87094 phi = 2.9083
+
+Prongs with clustering information
+----------------------------------
+ branch branch N_groomed max loc substructure
+ pt mass loc tot zdrop zg thetag
+ +--> 811.261 6.45947 13 13 0.0294298 0.154333 0.0200353
+ +--> 669.635 1.98393 2 2 0
+ +--> 141.627 0.765329 0 0 0 0.199906 0.00734861
+ +--> 113.316 0.462946 0 0 0 0.208947 0.00550512
+ | +--> 89.6387 0.211913 0 0 0
+ | +--> 23.6769 0.13957 0 0 0
+ +--> 28.3123 0.170026 0 0 0 0.248173 0.00447786
+ +--> 21.286 0.13957 0 0 0
+ +--> 7.02636 -3.21461e-05 0 0 0
+
+Prongs without clustering information
+-------------------------------------
+(Raw) list of prongs:
+ pt mass
+ 0 669.635 1.98393
+ 1 89.6387 0.211913
+ 2 21.286 0.13957
+ 3 23.6769 0.13957
+ 4 7.02636 -3.21461e-05
+
+Groomed prongs information:
+index zg thetag
+ 1 0.154333 0.0200353
+ 2 0.199906 0.00734861
+ 3 0.208947 0.00550512
+ 4 0.248173 0.00447786
+
+original jet: pt = 908.098 m = 87.7124 y = 0.219482 phi = 6.03487
+RecursiveSoftDropped jet: pt = 830.517 m = 4.91035 y = 0.223054 phi = 6.02995
+
+Prongs with clustering information
+----------------------------------
+ branch branch N_groomed max loc substructure
+ pt mass loc tot zdrop zg thetag
+ +--> 830.517 4.91035 12 13 0.0232056 0.060784 0.0153863
+ +--> 778.731 3.66481 0 1 0 0.235041 0.0101382
+ | +--> 599.106 0.403809 1 1 0
+ | +--> 179.628 0.853363 0 1 0 0.25773 0.00871739
+ | +--> 131.15 0.378456 1 1 0.0606587 0.315246 0.00417298
+ | | +--> 89.8058 0.107191 0 0 0
+ | | +--> 41.3448 0.13957 0 0 0
+ | +--> 48.4785 0.13957 0 0 0
+ +--> 51.7916 0.13957 0 0 0
+
+Prongs without clustering information
+-------------------------------------
+(Raw) list of prongs:
+ pt mass
+ 0 599.106 0.403809
+ 1 51.7916 0.13957
+ 2 89.8058 0.107191
+ 3 48.4785 0.13957
+ 4 41.3448 0.13957
+
+Groomed prongs information:
+index zg thetag
+ 1 0.060784 0.0153863
+ 2 0.235041 0.0101382
+ 3 0.25773 0.00871739
+ 4 0.315246 0.00417298
Index: contrib/contribs/RecursiveTools/tags/2.0.1/BottomUpSoftDrop.cc
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.1/BottomUpSoftDrop.cc (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.1/BottomUpSoftDrop.cc (revision 1283)
@@ -0,0 +1,324 @@
+// $Id$
+//
+// Copyright (c) 2017-, Gavin P. Salam, Gregory Soyez, Jesse Thaler,
+// Kevin Zhou, Frederic Dreyer
+//
+//----------------------------------------------------------------------
+// This file is part of FastJet contrib.
+//
+// It is free software; you can redistribute it and/or modify it under
+// the terms of the GNU General Public License as published by the
+// Free Software Foundation; either version 2 of the License, or (at
+// your option) any later version.
+//
+// It is distributed in the hope that it will be useful, but WITHOUT
+// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+// or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
+// License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this code. If not, see .
+//----------------------------------------------------------------------
+
+#include "BottomUpSoftDrop.hh"
+#include
+#include
+#include
+#include
+#include "fastjet/ClusterSequenceActiveAreaExplicitGhosts.hh"
+#include "fastjet/Selector.hh"
+#include "fastjet/config.h"
+
+
+using namespace std;
+
+
+FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh
+
+namespace contrib{
+
+//----------------------------------------------------------------------
+// BottomUpSoftDrop class
+//----------------------------------------------------------------------
+
+// action on a single jet
+PseudoJet BottomUpSoftDrop::result(const PseudoJet &jet) const{
+ // soft drop can only be applied to jets that have constituents
+ if (!jet.has_constituents()){
+ throw Error("BottomUpSoftDrop: trying to apply the Soft Drop transformer to a jet that has no constituents");
+ }
+
+ // if the jet has area support and there are explicit ghosts, we can
+ // transfer that support to the internal re-clustering
+ //
+ // Note that this is just meant to maintain the information since
+ // all the jes will have a 0 area
+ bool do_areas = jet.has_area() && _check_explicit_ghosts(jet);
+
+ // build the soft drop plugin
+ BottomUpSoftDropPlugin * softdrop_plugin;
+
+ // for some constructors, we get the recombiner from the
+ // input jet -- some acrobatics are needed
+ if (_get_recombiner_from_jet) {
+ JetDefinition jet_def = _jet_def;
+
+ // if all the pieces have a shared recombiner, we'll use that
+ // one. Otherwise, use the one from _jet_def as a fallback.
+ JetDefinition jet_def_for_recombiner;
+ if (_check_common_recombiner(jet, jet_def_for_recombiner)){
+#if FASTJET_VERSION_NUMBER >= 30100
+ // Note that this is better than the option directly passing the
+ // recombiner (for cases where th ejet def own its recombiner)
+ // but it's only available in FJ>=3.1
+ jet_def.set_recombiner(jet_def_for_recombiner);
+#else
+ jet_def.set_recombiner(jet_def_for_recombiner.recombiner());
+#endif
+ }
+ softdrop_plugin = new BottomUpSoftDropPlugin(jet_def, _beta, _symmetry_cut, _R0);
+ } else {
+ softdrop_plugin = new BottomUpSoftDropPlugin(_jet_def, _beta, _symmetry_cut, _R0);
+ }
+
+ // now recluster the constituents of the jet with that plugin
+ JetDefinition internal_jet_def(softdrop_plugin);
+ // flag the plugin for automatic deletion _before_ we make
+ // copies (so that as long as the copies are also present
+ // it doesn't get deleted).
+ internal_jet_def.delete_plugin_when_unused();
+
+ ClusterSequence * cs;
+ if (do_areas){
+ vector particles, ghosts;
+ SelectorIsPureGhost().sift(jet.constituents(), ghosts, particles);
+ // determine the ghost area from the 1st ghost (if none, any value
+ // will do, as the area will be 0 and subtraction will have
+ // no effect!)
+ double ghost_area = (ghosts.size()) ? ghosts[0].area() : 0.01;
+ cs = new ClusterSequenceActiveAreaExplicitGhosts(particles, internal_jet_def,
+ ghosts, ghost_area);
+ } else {
+ cs = new ClusterSequence(jet.constituents(), internal_jet_def);
+ }
+
+ PseudoJet result_local = SelectorNHardest(1)(cs->inclusive_jets())[0];
+ BottomUpSoftDropStructure * s = new BottomUpSoftDropStructure(result_local);
+ s->_beta = _beta;
+ s->_symmetry_cut = _symmetry_cut;
+ s->_R0 = _R0;
+ result_local.set_structure_shared_ptr(SharedPtr(s));
+
+ // make sure things remain persistent -- i.e. tell the jet definition
+ // and the cluster sequence that it is their responsibility to clean
+ // up memory once the "result" reaches the end of its life in the user's
+ // code. (The CS deletes itself when the result goes out of scope and
+ // that also triggers deletion of the plugin)
+ cs->delete_self_when_unused();
+
+ return result_local;
+}
+
+// global grooming on a full event
+// note: does not support jet areas
+vector BottomUpSoftDrop::global_grooming(const vector & event) const {
+ // start by reclustering the event into one very large jet
+ ClusterSequence cs(event, _jet_def);
+ std::vector global_jet = SelectorNHardest(1)(cs.inclusive_jets());
+ // if the event is empty, do nothing
+ if (global_jet.size() == 0) return vector();
+
+ // apply the groomer to the large jet
+ PseudoJet result = this->result(global_jet[0]);
+ return result.constituents();
+}
+
+// check if the jet has explicit_ghosts (knowing that there is an
+// area support)
+bool BottomUpSoftDrop::_check_explicit_ghosts(const PseudoJet &jet) const {
+ // if the jet comes from a Clustering check explicit ghosts in that
+ // clustering
+ if (jet.has_associated_cluster_sequence())
+ return jet.validated_csab()->has_explicit_ghosts();
+
+ // if the jet has pieces, recurse in the pieces
+ if (jet.has_pieces()){
+ vector pieces = jet.pieces();
+ for (unsigned int i=0;ijet_def().has_same_recombiner(jet_def_for_recombiner);
+
+ // otherwise, assign it.
+ jet_def_for_recombiner = jet.validated_cs()->jet_def();
+ assigned = true;
+ return true;
+ }
+
+ // if the jet has pieces, recurse in the pieces
+ if (jet.has_pieces()){
+ vector pieces = jet.pieces();
+ if (pieces.size() == 0) return false;
+ for (unsigned int i=0;i kept(internal_hist.size(), true);
+ const vector &sd_rej = softdrop_recombiner.rejected();
+ for (unsigned int i=0;i internal2input(internal_hist.size());
+ for (unsigned int i=0; i ... \endif and \cond
+# ... \endcond blocks.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
+# initial value of a variable or macro / define can have for it to appear in the
+# documentation. If the initializer consists of more lines than specified here
+# it will be hidden. Use a value of 0 to hide initializers completely. The
+# appearance of the value of individual variables and macros / defines can be
+# controlled using \showinitializer or \hideinitializer command in the
+# documentation regardless of this setting.
+# Minimum value: 0, maximum value: 10000, default value: 30.
+
+MAX_INITIALIZER_LINES = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
+# the bottom of the documentation of classes and structs. If set to YES the list
+# will mention the files that were used to generate the documentation.
+# The default value is: YES.
+
+SHOW_USED_FILES = YES
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
+# will remove the Files entry from the Quick Index and from the Folder Tree View
+# (if specified).
+# The default value is: YES.
+
+SHOW_FILES = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
+# page. This will remove the Namespaces entry from the Quick Index and from the
+# Folder Tree View (if specified).
+# The default value is: YES.
+
+SHOW_NAMESPACES = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from
+# the version control system). Doxygen will invoke the program by executing (via
+# popen()) the command command input-file, where command is the value of the
+# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
+# by doxygen. Whatever the program writes to standard output is used as the file
+# version. For an example see the documentation.
+
+FILE_VERSION_FILTER =
+
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
+# by doxygen. The layout file controls the global structure of the generated
+# output files in an output format independent way. To create the layout file
+# that represents doxygen's defaults, run doxygen with the -l option. You can
+# optionally specify a file name after the option, if omitted DoxygenLayout.xml
+# will be used as the name of the layout file.
+#
+# Note that if you run doxygen from a directory containing a file called
+# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
+# tag is left empty.
+
+LAYOUT_FILE =
+
+# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
+# the reference definitions. This must be a list of .bib files. The .bib
+# extension is automatically appended if omitted. This requires the bibtex tool
+# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
+# For LaTeX the style of the bibliography can be controlled using
+# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
+# search path. Do not use file names with spaces, bibtex cannot handle them. See
+# also \cite for info how to create references.
+
+CITE_BIB_FILES =
+
+#---------------------------------------------------------------------------
+# Configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated to
+# standard output by doxygen. If QUIET is set to YES this implies that the
+# messages are off.
+# The default value is: NO.
+
+QUIET = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
+# this implies that the warnings are on.
+#
+# Tip: Turn warnings on while writing the documentation.
+# The default value is: YES.
+
+WARNINGS = YES
+
+# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
+# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
+# will automatically be disabled.
+# The default value is: YES.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some parameters
+# in a documented function, or documenting parameters that don't exist or using
+# markup commands wrongly.
+# The default value is: YES.
+
+WARN_IF_DOC_ERROR = YES
+
+# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
+# are documented, but have no documentation for their parameters or return
+# value. If set to NO doxygen will only warn about wrong or incomplete parameter
+# documentation, but not about the absence of documentation.
+# The default value is: NO.
+
+WARN_NO_PARAMDOC = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that doxygen
+# can produce. The string should contain the $file, $line, and $text tags, which
+# will be replaced by the file and line number from which the warning originated
+# and the warning text. Optionally the format may contain $version, which will
+# be replaced by the version of the file (if it could be obtained via
+# FILE_VERSION_FILTER)
+# The default value is: $file:$line: $text.
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning and error
+# messages should be written. If left blank the output is written to standard
+# error (stderr).
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag is used to specify the files and/or directories that contain
+# documented source files. You may enter file names like myfile.cpp or
+# directories like /usr/src/myproject. Separate the files or directories with
+# spaces.
+# Note: If this tag is empty the current directory is searched.
+
+INPUT =
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
+# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
+# documentation (see: http://www.gnu.org/software/libiconv) for the list of
+# possible encodings.
+# The default value is: UTF-8.
+
+INPUT_ENCODING = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
+# *.h) to filter out the source-files in the directories. If left blank the
+# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
+# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
+# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
+# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
+# *.qsf, *.as and *.js.
+
+FILE_PATTERNS =
+
+# The RECURSIVE tag can be used to specify whether or not subdirectories should
+# be searched for input files as well.
+# The default value is: NO.
+
+RECURSIVE = NO
+
+# The EXCLUDE tag can be used to specify files and/or directories that should be
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+#
+# Note that relative paths are relative to the directory from which doxygen is
+# run.
+
+EXCLUDE =
+
+# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
+# directories that are symbolic links (a Unix file system feature) are excluded
+# from the input.
+# The default value is: NO.
+
+EXCLUDE_SYMLINKS = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories.
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories for example use the pattern */test/*
+
+EXCLUDE_PATTERNS =
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories use the pattern */test/*
+
+EXCLUDE_SYMBOLS =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or directories
+# that contain example code fragments that are included (see the \include
+# command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
+# *.h) to filter out the source-files in the directories. If left blank all
+# files are included.
+
+EXAMPLE_PATTERNS =
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude commands
+# irrespective of the value of the RECURSIVE tag.
+# The default value is: NO.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or directories
+# that contain images that are to be included in the documentation (see the
+# \image command).
+
+IMAGE_PATH =
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command:
+#
+#
+#
+# where is the value of the INPUT_FILTER tag, and is the
+# name of an input file. Doxygen will then use the output that the filter
+# program writes to standard output. If FILTER_PATTERNS is specified, this tag
+# will be ignored.
+#
+# Note that the filter must not add or remove lines; it is applied before the
+# code is scanned, but not when the output code is generated. If lines are added
+# or removed, the anchors will not be placed correctly.
+
+INPUT_FILTER =
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis. Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match. The filters are a list of the form: pattern=filter
+# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
+# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
+# patterns match the file name, INPUT_FILTER is applied.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER ) will also be used to filter the input files that are used for
+# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
+# The default value is: NO.
+
+FILTER_SOURCE_FILES = NO
+
+# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
+# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
+# it is also possible to disable source filtering for a specific pattern using
+# *.ext= (so without naming a filter).
+# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
+
+FILTER_SOURCE_PATTERNS =
+
+# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
+# is part of the input, its contents will be placed on the main page
+# (index.html). This can be useful if you have a project on for instance GitHub
+# and want to reuse the introduction page also for the doxygen output.
+
+USE_MDFILE_AS_MAINPAGE =
+
+#---------------------------------------------------------------------------
+# Configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
+# generated. Documented entities will be cross-referenced with these sources.
+#
+# Note: To get rid of all source code in the generated output, make sure that
+# also VERBATIM_HEADERS is set to NO.
+# The default value is: NO.
+
+SOURCE_BROWSER = YES
+
+# Setting the INLINE_SOURCES tag to YES will include the body of functions,
+# classes and enums directly into the documentation.
+# The default value is: NO.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
+# special comment blocks from generated source code fragments. Normal C, C++ and
+# Fortran comments will always remain visible.
+# The default value is: YES.
+
+STRIP_CODE_COMMENTS = NO
+
+# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
+# function all documented functions referencing it will be listed.
+# The default value is: NO.
+
+REFERENCED_BY_RELATION = NO
+
+# If the REFERENCES_RELATION tag is set to YES then for each documented function
+# all documented entities called/used by that function will be listed.
+# The default value is: NO.
+
+REFERENCES_RELATION = NO
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
+# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
+# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
+# link to the documentation.
+# The default value is: YES.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
+# source code will show a tooltip with additional information such as prototype,
+# brief description and links to the definition and documentation. Since this
+# will make the HTML file larger and loading of large files a bit slower, you
+# can opt to disable this feature.
+# The default value is: YES.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+SOURCE_TOOLTIPS = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code will
+# point to the HTML generated by the htags(1) tool instead of doxygen built-in
+# source browser. The htags tool is part of GNU's global source tagging system
+# (see http://www.gnu.org/software/global/global.html). You will need version
+# 4.8.6 or higher.
+#
+# To use it do the following:
+# - Install the latest version of global
+# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
+# - Make sure the INPUT points to the root of the source tree
+# - Run doxygen as normal
+#
+# Doxygen will invoke htags (and that will in turn invoke gtags), so these
+# tools must be available from the command line (i.e. in the search path).
+#
+# The result: instead of the source browser generated by doxygen, the links to
+# source code will now point to the output of htags.
+# The default value is: NO.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
+# verbatim copy of the header file for each class for which an include is
+# specified. Set to NO to disable this.
+# See also: Section \class.
+# The default value is: YES.
+
+VERBATIM_HEADERS = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
+# compounds will be generated. Enable this if the project contains a lot of
+# classes, structs, unions or interfaces.
+# The default value is: YES.
+
+ALPHABETICAL_INDEX = YES
+
+# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
+# which the alphabetical index list will be split.
+# Minimum value: 1, maximum value: 20, default value: 5.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all classes will
+# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
+# can be used to specify a prefix (or a list of prefixes) that should be ignored
+# while generating the index headers.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
+# The default value is: YES.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_OUTPUT = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
+# generated HTML page (for example: .htm, .php, .asp).
+# The default value is: .html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
+# each generated HTML page. If the tag is left blank doxygen will generate a
+# standard header.
+#
+# To get valid HTML the header file that includes any scripts and style sheets
+# that doxygen needs, which is dependent on the configuration options used (e.g.
+# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
+# default header using
+# doxygen -w html new_header.html new_footer.html new_stylesheet.css
+# YourConfigFile
+# and then modify the file new_header.html. See also section "Doxygen usage"
+# for information on how to generate the default header that doxygen normally
+# uses.
+# Note: The header is subject to change so you typically have to regenerate the
+# default header when upgrading to a newer version of doxygen. For a description
+# of the possible markers and block names see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
+# generated HTML page. If the tag is left blank doxygen will generate a standard
+# footer. See HTML_HEADER for more information on how to generate a default
+# footer and what special commands can be used inside the footer. See also
+# section "Doxygen usage" for information on how to generate the default footer
+# that doxygen normally uses.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FOOTER =
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
+# sheet that is used by each HTML page. It can be used to fine-tune the look of
+# the HTML output. If left blank doxygen will generate a default style sheet.
+# See also section "Doxygen usage" for information on how to generate the style
+# sheet that doxygen normally uses.
+# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
+# it is more robust and this tag (HTML_STYLESHEET) will in the future become
+# obsolete.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_STYLESHEET =
+
+# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
+# defined cascading style sheet that is included after the standard style sheets
+# created by doxygen. Using this option one can overrule certain style aspects.
+# This is preferred over using HTML_STYLESHEET since it does not replace the
+# standard style sheet and is therefor more robust against future updates.
+# Doxygen will copy the style sheet file to the output directory. For an example
+# see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_STYLESHEET =
+
+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the HTML output directory. Note
+# that these files will be copied to the base HTML output directory. Use the
+# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
+# files will be copied as-is; there are no commands or markers available.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_FILES =
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
+# will adjust the colors in the stylesheet and background images according to
+# this color. Hue is specified as an angle on a colorwheel, see
+# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
+# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
+# purple, and 360 is red again.
+# Minimum value: 0, maximum value: 359, default value: 220.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_HUE = 220
+
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
+# in the HTML output. For a value of 0 the output will use grayscales only. A
+# value of 255 will produce the most vivid colors.
+# Minimum value: 0, maximum value: 255, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_SAT = 100
+
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
+# luminance component of the colors in the HTML output. Values below 100
+# gradually make the output lighter, whereas values above 100 make the output
+# darker. The value divided by 100 is the actual gamma applied, so 80 represents
+# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
+# change the gamma.
+# Minimum value: 40, maximum value: 240, default value: 80.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_GAMMA = 80
+
+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
+# page will contain the date and time when the page was generated. Setting this
+# to NO can help when comparing the output of multiple runs.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_TIMESTAMP = YES
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_DYNAMIC_SECTIONS = NO
+
+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
+# shown in the various tree structured indices initially; the user can expand
+# and collapse entries dynamically later on. Doxygen will expand the tree to
+# such a level that at most the specified number of entries are visible (unless
+# a fully collapsed tree already exceeds this amount). So setting the number of
+# entries 1 will produce a full collapsed tree by default. 0 is a special value
+# representing an infinite number of entries and will result in a full expanded
+# tree by default.
+# Minimum value: 0, maximum value: 9999, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_INDEX_NUM_ENTRIES = 100
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files will be
+# generated that can be used as input for Apple's Xcode 3 integrated development
+# environment (see: http://developer.apple.com/tools/xcode/), introduced with
+# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
+# Makefile in the HTML output directory. Running make will produce the docset in
+# that directory and running make install will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
+# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
+# for more information.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_DOCSET = NO
+
+# This tag determines the name of the docset feed. A documentation feed provides
+# an umbrella under which multiple documentation sets from a single provider
+# (such as a company or product suite) can be grouped.
+# The default value is: Doxygen generated docs.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_FEEDNAME = "Doxygen generated docs"
+
+# This tag specifies a string that should uniquely identify the documentation
+# set bundle. This should be a reverse domain-name style string, e.g.
+# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_BUNDLE_ID = org.doxygen.Project
+
+# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
+# the documentation publisher. This should be a reverse domain-name style
+# string, e.g. com.mycompany.MyDocSet.documentation.
+# The default value is: org.doxygen.Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_ID = org.doxygen.Publisher
+
+# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
+# The default value is: Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_NAME = Publisher
+
+# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
+# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
+# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
+# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
+# Windows.
+#
+# The HTML Help Workshop contains a compiler that can convert all HTML output
+# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
+# files are now used as the Windows 98 help format, and will replace the old
+# Windows help format (.hlp) on all Windows platforms in the future. Compressed
+# HTML files also contain an index, a table of contents, and you can search for
+# words in the documentation. The HTML workshop also contains a viewer for
+# compressed HTML files.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_HTMLHELP = NO
+
+# The CHM_FILE tag can be used to specify the file name of the resulting .chm
+# file. You can add a path in front of the file if the result should not be
+# written to the html output directory.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+CHM_FILE =
+
+# The HHC_LOCATION tag can be used to specify the location (absolute path
+# including file name) of the HTML help compiler ( hhc.exe). If non-empty
+# doxygen will try to run the HTML help compiler on the generated index.hhp.
+# The file has to be specified with full path.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+HHC_LOCATION =
+
+# The GENERATE_CHI flag controls if a separate .chi index file is generated (
+# YES) or that it should be included in the master .chm file ( NO).
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+GENERATE_CHI = NO
+
+# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
+# and project file content.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+CHM_INDEX_ENCODING =
+
+# The BINARY_TOC flag controls whether a binary table of contents is generated (
+# YES) or a normal table of contents ( NO) in the .chm file.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members to
+# the table of contents of the HTML help documentation and to the tree view.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+TOC_EXPAND = NO
+
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
+# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
+# (.qch) of the generated HTML documentation.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_QHP = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
+# the file name of the resulting .qch file. The path specified is relative to
+# the HTML output folder.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QCH_FILE =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
+# Project output. For more information please see Qt Help Project / Namespace
+# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_NAMESPACE = org.doxygen.Project
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
+# Help Project output. For more information please see Qt Help Project / Virtual
+# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
+# folders).
+# The default value is: doc.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_VIRTUAL_FOLDER = doc
+
+# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
+# filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_CUST_FILTER_NAME =
+
+# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_CUST_FILTER_ATTRS =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's filter section matches. Qt Help Project / Filter Attributes (see:
+# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_SECT_FILTER_ATTRS =
+
+# The QHG_LOCATION tag can be used to specify the location of Qt's
+# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
+# generated .qhp file.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHG_LOCATION =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
+# generated, together with the HTML files, they form an Eclipse help plugin. To
+# install this plugin and make it available under the help contents menu in
+# Eclipse, the contents of the directory containing the HTML and XML files needs
+# to be copied into the plugins directory of eclipse. The name of the directory
+# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
+# After copying Eclipse needs to be restarted before the help appears.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_ECLIPSEHELP = NO
+
+# A unique identifier for the Eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have this
+# name. Each documentation set should have its own identifier.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
+
+ECLIPSE_DOC_ID = org.doxygen.Project
+
+# If you want full control over the layout of the generated HTML pages it might
+# be necessary to disable the index and replace it with your own. The
+# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
+# of each HTML page. A value of NO enables the index and the value YES disables
+# it. Since the tabs in the index contain the same information as the navigation
+# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+DISABLE_INDEX = NO
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information. If the tag
+# value is set to YES, a side panel will be generated containing a tree-like
+# index structure (just like the one that is generated for HTML Help). For this
+# to work a browser that supports JavaScript, DHTML, CSS and frames is required
+# (i.e. any modern browser). Windows users are probably better off using the
+# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
+# further fine-tune the look of the index. As an example, the default style
+# sheet generated by doxygen has an example that shows how to put an image at
+# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
+# the same information as the tab index, you could consider setting
+# DISABLE_INDEX to YES when enabling this option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_TREEVIEW = NO
+
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
+# doxygen will group on one line in the generated HTML documentation.
+#
+# Note that a value of 0 will completely suppress the enum values from appearing
+# in the overview section.
+# Minimum value: 0, maximum value: 20, default value: 4.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+ENUM_VALUES_PER_LINE = 4
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
+# to set the initial width (in pixels) of the frame in which the tree is shown.
+# Minimum value: 0, maximum value: 1500, default value: 250.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+TREEVIEW_WIDTH = 250
+
+# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
+# external symbols imported via tag files in a separate window.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+EXT_LINKS_IN_WINDOW = NO
+
+# Use this tag to change the font size of LaTeX formulas included as images in
+# the HTML documentation. When you change the font size after a successful
+# doxygen run you need to manually remove any form_*.png images from the HTML
+# output directory to force them to be regenerated.
+# Minimum value: 8, maximum value: 50, default value: 10.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FORMULA_FONTSIZE = 10
+
+# Use the FORMULA_TRANPARENT tag to determine whether or not the images
+# generated for formulas are transparent PNGs. Transparent PNGs are not
+# supported properly for IE 6.0, but are supported on all modern browsers.
+#
+# Note that when changing this option you need to delete any form_*.png files in
+# the HTML output directory before the changes have effect.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FORMULA_TRANSPARENT = YES
+
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
+# http://www.mathjax.org) which uses client side Javascript for the rendering
+# instead of using prerendered bitmaps. Use this if you do not have LaTeX
+# installed or if you want to formulas look prettier in the HTML output. When
+# enabled you may also need to install MathJax separately and configure the path
+# to it using the MATHJAX_RELPATH option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+USE_MATHJAX = NO
+
+# When MathJax is enabled you can set the default output format to be used for
+# the MathJax output. See the MathJax site (see:
+# http://docs.mathjax.org/en/latest/output.html) for more details.
+# Possible values are: HTML-CSS (which is slower, but has the best
+# compatibility), NativeMML (i.e. MathML) and SVG.
+# The default value is: HTML-CSS.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_FORMAT = HTML-CSS
+
+# When MathJax is enabled you need to specify the location relative to the HTML
+# output directory using the MATHJAX_RELPATH option. The destination directory
+# should contain the MathJax.js script. For instance, if the mathjax directory
+# is located at the same level as the HTML output directory, then
+# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
+# Content Delivery Network so you can quickly see the result without installing
+# MathJax. However, it is strongly recommended to install a local copy of
+# MathJax from http://www.mathjax.org before deployment.
+# The default value is: http://cdn.mathjax.org/mathjax/latest.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
+
+# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
+# extension names that should be enabled during MathJax rendering. For example
+# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_EXTENSIONS =
+
+# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
+# of code that will be used on startup of the MathJax code. See the MathJax site
+# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
+# example see the documentation.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_CODEFILE =
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
+# the HTML output. The underlying search engine uses javascript and DHTML and
+# should work on any modern browser. Note that when using HTML help
+# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
+# there is already a search function so this one should typically be disabled.
+# For large projects the javascript based search engine can be slow, then
+# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
+# search using the keyboard; to jump to the search box use + S
+# (what the is depends on the OS and browser, but it is typically
+# , /