Page MenuHomeHEPForge
Files F7878617

No OneTemporary
Actions

View Options

This file is larger than 256 KB, so syntax highlighting was skipped.
Index: contrib/contribs/RecursiveTools/tags/2.0.3/Recluster.cc
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/Recluster.cc (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/Recluster.cc (revision 1431)
@@ -0,0 +1,390 @@
+// $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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#include "Recluster.hh"
+#include <fastjet/ClusterSequenceActiveAreaExplicitGhosts.hh>
+#include <sstream>
+#include <typeinfo>
+
+using namespace std;
+
+// Comments:
+//
+// - If the jet comes from a C/A clustering (or is a composite jet
+// made of C/A clusterings) and we recluster it with a C/A
+// algorithm, we just use exclusive jets instead of doing the
+// clustering explicitly. In this specific case, we need to make
+// sure that all the pieces share the same cluster sequence.
+//
+// - If the recombiner has to be taken from the original jet and that
+// jet is composite, we need to check that all the pieces were
+// obtained with the same recombiner.
+//
+// TODO:
+//
+// - check this actually works!!!
+
+FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh
+
+namespace contrib{
+
+LimitedWarning Recluster::_explicit_ghost_warning;
+
+// class description
+string Recluster::description() const {
+ ostringstream ostr;
+ ostr << "Recluster with subjet_def = ";
+ if (_use_full_def) {
+ ostr << _subjet_def.description();
+ } else {
+ if (_subjet_alg == kt_algorithm) {
+ ostr << "Longitudinally invariant kt algorithm with R = " << _subjet_radius;
+ } else if (_subjet_alg == cambridge_algorithm) {
+ ostr << "Longitudinally invariant Cambridge/Aachen algorithm with R = " << _subjet_radius;
+ } else if (_subjet_alg == antikt_algorithm) {
+ ostr << "Longitudinally invariant anti-kt algorithm with R = " << _subjet_radius;
+ } else if (_subjet_alg == genkt_algorithm) {
+ ostr << "Longitudinally invariant generalised kt algorithm with R = " << _subjet_radius
+ << ", p = " << _subjet_extra;
+ } else if (_subjet_alg == cambridge_for_passive_algorithm) {
+ ostr << "Longitudinally invariant Cambridge/Aachen algorithm with R = " << _subjet_radius
+ << " and a special hack whereby particles with kt < "
+ << _subjet_extra << "are treated as passive ghosts";
+ } else if (_subjet_alg == ee_kt_algorithm) {
+ ostr << "e+e- kt (Durham) algorithm";
+ } else if (_subjet_alg == ee_genkt_algorithm) {
+ ostr << "e+e- generalised kt algorithm with R = " << _subjet_radius
+ << ", p = " << _subjet_extra;
+ } else if (_subjet_alg == undefined_jet_algorithm) {
+ ostr << "uninitialised JetDefinition (jet_algorithm=undefined_jet_algorithm)" ;
+ } else {
+ ostr << "unrecognized jet_algorithm";
+ }
+ ostr << ", a recombiner obtained from the jet being reclustered";
+ }
+
+ if (_single)
+ ostr << " and keeping the hardest subjet";
+ else
+ ostr << " and joining all subjets in a composite jet";
+
+ return ostr.str();
+}
+
+// return a vector of subjets, which are the ones that would be kept
+// by the filtering
+PseudoJet Recluster::result(const PseudoJet &jet) const {
+ // generic sanity checks
+ //-------------------------------------------------------------------
+ // make sure that the jet has constituents
+ if (! jet.has_constituents())
+ throw Error("Filter can only be applied on jets having constituents");
+
+ // tests particular to certain configurations
+ //-------------------------------------------------------------------
+
+ // for a whole variety of checks, we shall need the "recursive"
+ // pieces of the jet (the jet itself or recursing down to its most
+ // fundamental pieces). So we do compute these once and for all.
+ //
+ // Note that the pieces are always needed (either for C/A or for the
+ // area checks)
+ vector<PseudoJet> all_pieces; //.clear();
+ if ((!_get_all_pieces(jet, all_pieces)) || (all_pieces.size()==0)){
+ throw Error("Recluster: failed to retrieve all the pieces composing the jet.");
+ }
+
+ // decide which jet definition to use
+ //-------------------------------------------------------------------
+ JetDefinition subjet_def;
+ if (_use_full_def){
+ subjet_def = _subjet_def;
+ } else {
+ _build_jet_def_with_recombiner(all_pieces, subjet_def);
+ }
+
+
+ // the vector that will ultimately hold the subjets
+ vector<PseudoJet> subjets;
+
+ // check if we can apply the simplification for C/A jets reclustered
+ // with C/A
+ //
+ // we apply C/A clustering iff
+ // - the request subjet_def is C/A
+ // - the jet is either directly coming from C/A or if it is a
+ // superposition of C/A jets from the same cluster sequence
+ // - the pieces agree with the recombination scheme of subjet_def
+ //
+ // Note that in this case area support will be automatically
+ // inherted so we can only worry about this later
+ //-------------------------------------------------------------------
+ if (_check_ca(all_pieces, subjet_def)){
+ _recluster_cafilt(all_pieces, subjets, subjet_def.R());
+ subjets = sorted_by_pt(subjets);
+ return _single
+ ? subjets[0]
+ : join(subjets, *(subjet_def.recombiner()));
+ }
+
+ // decide if area support has to be kept
+ //-------------------------------------------------------------------
+ bool include_area_support = jet.has_area();
+ if ((include_area_support) && (!_check_explicit_ghosts(all_pieces))){
+ _explicit_ghost_warning.warn("Recluster: the original cluster sequence is lacking explicit ghosts; area support will no longer be available after re-clustering");
+ include_area_support = false;
+ }
+
+ // extract the subjets
+ //-------------------------------------------------------------------
+ _recluster_generic(jet, subjets, subjet_def, include_area_support);
+ subjets = sorted_by_pt(subjets);
+
+ return _single
+ ? subjets[0]
+ : join(subjets, *(subjet_def.recombiner()));
+}
+
+//----------------------------------------------------------------------
+// the parts that really do the reclustering
+//----------------------------------------------------------------------
+
+// get the subjets in the simple case of C/A+C/A
+void Recluster::_recluster_cafilt(const vector<PseudoJet> & all_pieces,
+ vector<PseudoJet> & subjets,
+ double Rfilt) const{
+ subjets.clear();
+
+ // each individual piece should have a C/A cluster sequence
+ // associated to it. So a simple loop would do the job
+ for (vector<PseudoJet>::const_iterator piece_it = all_pieces.begin();
+ piece_it!=all_pieces.end(); piece_it++){
+ // just extract the exclusive subjets of 'jet'
+ const ClusterSequence *cs = piece_it->associated_cluster_sequence();
+ vector<PseudoJet> local_subjets;
+
+ double dcut = Rfilt / cs->jet_def().R();
+ if (dcut>=1.0){
+ local_subjets.push_back(*piece_it);
+ } else {
+ local_subjets = piece_it->exclusive_subjets(dcut*dcut);
+ }
+
+ copy(local_subjets.begin(), local_subjets.end(), back_inserter(subjets));
+ }
+}
+
+
+// set the filtered elements in the generic re-clustering case (w/o
+// subtraction)
+void Recluster::_recluster_generic(const PseudoJet & jet,
+ vector<PseudoJet> & subjets,
+ const JetDefinition & subjet_def,
+ bool do_areas) const{
+ // create a new, internal, ClusterSequence from the jet constituents
+ // get the subjets directly from there
+ //
+ // If the jet has area support then we separate the ghosts from the
+ // "regular" particles so the subjets will also have area
+ // support. Note that we do this regardless of whether rho is zero
+ // or not.
+ //
+ // Note that to be able to separate the ghosts, one needs explicit
+ // ghosts!!
+ // ---------------------------------------------------------------
+ if (do_areas){
+ vector<PseudoJet> all_constituents = jet.constituents();
+ vector<PseudoJet> regular_constituents, ghosts;
+
+ for (vector<PseudoJet>::iterator it = all_constituents.begin();
+ it != all_constituents.end(); it++){
+ if (it->is_pure_ghost())
+ ghosts.push_back(*it);
+ else
+ regular_constituents.push_back(*it);
+ }
+
+ // figure out the ghost area from the 1st ghost (if none, any value
+ // would probably do as the area will be 0 and subtraction will have
+ // no effect!)
+ double ghost_area = (ghosts.size()) ? ghosts[0].area() : 0.01;
+ ClusterSequenceActiveAreaExplicitGhosts * csa
+ = new ClusterSequenceActiveAreaExplicitGhosts(regular_constituents,
+ subjet_def,
+ ghosts, ghost_area);
+
+ subjets = csa->inclusive_jets();
+
+ // allow the cs to be deleted when it's no longer used
+ //
+ // Note that there is at least one constituent in the jet so there
+ // is in principle at least one subjet But one may have used a
+ // nasty recombiner that left an empty set of subjets, so we'd
+ // rather play it safe
+ if (subjets.size())
+ csa->delete_self_when_unused();
+ else
+ delete csa;
+ } else {
+ ClusterSequence * cs = new ClusterSequence(jet.constituents(), subjet_def);
+ subjets = cs->inclusive_jets();
+ // allow the cs to be deleted when it's no longer used (again, we
+ // add an extra safety check)
+ if (subjets.size())
+ cs->delete_self_when_unused();
+ else
+ delete cs;
+ }
+}
+
+
+//----------------------------------------------------------------------
+// various checks and internal constructs
+//----------------------------------------------------------------------
+
+// fundamental info for CompositeJets
+//----------------------------------------------------------------------
+
+// get the pieces down to the fundamental pieces
+//
+// Note that this just checks that there is an associated CS to the
+// fundamental pieces, not that it is still valid
+bool Recluster::_get_all_pieces(const PseudoJet &jet, vector<PseudoJet> &all_pieces) const{
+ if (jet.has_associated_cluster_sequence()){
+ all_pieces.push_back(jet);
+ return true;
+ }
+
+ if (jet.has_pieces()){
+ const vector<PseudoJet> pieces = jet.pieces();
+ for (vector<PseudoJet>::const_iterator it=pieces.begin(); it!=pieces.end(); it++)
+ if (!_get_all_pieces(*it, all_pieces)) return false;
+ return true;
+ }
+
+ return false;
+}
+
+// treatment of recombiners
+//----------------------------------------------------------------------
+// get the common recombiner to all pieces (NULL if none)
+//
+// Note that if the jet has an associated cluster sequence that is no
+// longer valid, an error will be thrown (needed since it could be the
+// 1st check called after the enumeration of the pieces)
+const JetDefinition::Recombiner* Recluster::_get_common_recombiner(const vector<PseudoJet> &all_pieces) const{
+ const JetDefinition & jd_ref = all_pieces[0].validated_cs()->jet_def();
+ for (unsigned int i=1; i<all_pieces.size(); i++)
+ if (!all_pieces[i].validated_cs()->jet_def().has_same_recombiner(jd_ref)) return NULL;
+
+ return jd_ref.recombiner();
+}
+
+void Recluster::_build_jet_def_with_recombiner(const vector<PseudoJet> &all_pieces,
+ JetDefinition &subjet_def) const{
+ // the recombiner has to be guessed from the pieces
+ const JetDefinition::Recombiner * common_recombiner = _get_common_recombiner(all_pieces);
+ if (common_recombiner) {
+ if (typeid(*common_recombiner) == typeid(JetDefinition::DefaultRecombiner)) {
+ RecombinationScheme scheme =
+ static_cast<const JetDefinition::DefaultRecombiner *>(common_recombiner)->scheme();
+ if (_has_subjet_extra)
+ subjet_def = JetDefinition(_subjet_alg, _subjet_radius, _subjet_extra, scheme);
+ else if (_has_subjet_radius)
+ subjet_def = JetDefinition(_subjet_alg, _subjet_radius, scheme);
+ else
+ subjet_def = JetDefinition(_subjet_alg, scheme);
+ } else {
+ if (_has_subjet_extra)
+ subjet_def = JetDefinition(_subjet_alg, _subjet_radius, _subjet_extra, common_recombiner);
+ else if (_has_subjet_radius)
+ subjet_def = JetDefinition(_subjet_alg, _subjet_radius, common_recombiner);
+ else
+ subjet_def = JetDefinition(_subjet_alg, common_recombiner);
+ }
+ } else {
+ throw Error("Recluster: requested to guess the recombination scheme (or recombiner) from the original jet but an inconsistency was found between the pieces constituing that jet.");
+ }
+}
+
+// area support
+//----------------------------------------------------------------------
+
+// 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 (needed since it could be the
+// 1st check called after the enumeration of the pieces)
+bool Recluster::_check_explicit_ghosts(const vector<PseudoJet> &all_pieces) const{
+ for (vector<PseudoJet>::const_iterator it=all_pieces.begin(); it!=all_pieces.end(); it++)
+ if (! it->validated_csab()->has_explicit_ghosts()) return false;
+ return true;
+}
+
+// C/A specific tests
+//----------------------------------------------------------------------
+
+// check if one can apply the simplification for C/A subjets
+//
+// This includes:
+// - the subjet definition asks for C/A subjets
+// - all the pieces share the same CS
+// - that CS is C/A with the same recombiner as the subjet def
+// - the filtering radius is not larger than any of the pairwise
+// distance between the pieces
+//
+// Note that if the jet has an associated cluster sequence that is no
+// longer valid, an error will be thrown (needed since it could be the
+// 1st check called after the enumeration of the pieces)
+bool Recluster::_check_ca(const vector<PseudoJet> &all_pieces,
+ const JetDefinition &subjet_def) const{
+ if (subjet_def.jet_algorithm() != cambridge_algorithm) return false;
+
+ // check that the 1st of all the pieces (we're sure there is at
+ // least one) is coming from a C/A clustering. Then check that all
+ // the following pieces share the same ClusterSequence
+ const ClusterSequence * cs_ref = all_pieces[0].validated_cs();
+ if (cs_ref->jet_def().jet_algorithm() != cambridge_algorithm) return false;
+ for (unsigned int i=1; i<all_pieces.size(); i++)
+ if (all_pieces[i].validated_cs() != cs_ref) return false;
+
+ // check that the 1st peice has the same recombiner as the one used
+ // for the subjet clustering
+ // Note that since they share the same CS, checking the 1st one is enough
+ if (!cs_ref->jet_def().has_same_recombiner(subjet_def)) return false;
+
+ // we also have to make sure that the reclustering radius is not larger
+ // than any of the inter-pieces distance
+ double Rsub2 = subjet_def.R();
+ Rsub2 *= Rsub2;
+ for (unsigned int i=0; i<all_pieces.size()-1; i++){
+ for (unsigned int j=i+1; j<all_pieces.size(); j++){
+ if (all_pieces[i].squared_distance(all_pieces[j]) < Rsub2) return false;
+ }
+ }
+
+ return true;
+}
+
+} // contrib namespace
+
+FASTJET_END_NAMESPACE // defined in fastjet/internal/base.hh
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.3/Recluster.cc
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/SoftDrop.hh
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/SoftDrop.hh (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/SoftDrop.hh (revision 1431)
@@ -0,0 +1,149 @@
+// $Id$
+//
+// Copyright (c) 2014-, Gregory Soyez, Jesse Thaler
+// based on arXiv:1402.2657 by Andrew J. Larkoski, Simone Marzani,
+// Gregory Soyez, Jesse Thaler
+//
+//----------------------------------------------------------------------
+// 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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#ifndef __FASTJET_CONTRIB_SOFTDROP_HH__
+#define __FASTJET_CONTRIB_SOFTDROP_HH__
+
+#include "RecursiveSymmetryCutBase.hh"
+
+FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh
+
+
+namespace contrib{
+
+//------------------------------------------------------------------------
+/// \class SoftDrop
+/// An implementation of the SoftDrop from arXiv:1402.2657.
+///
+/// For the basic functionalities, we refer the reader to the
+/// documentation of the RecursiveSymmetryCutBase from which SoftDrop
+/// inherits. Here, we mostly put the emphasis on things specific to
+/// SoftDrop:
+///
+/// - the cut applied recursively is
+/// \f[
+/// z > z_{\rm cut} (\theta/R0)^\beta
+/// \f]
+/// with z the asymmetry measure and \f$\theta\f$ the geometrical
+/// distance between the two subjets. R0 is set to 1 by default.
+///
+/// - by default, we work in "grooming mode" i.s. if no substructure
+/// is found, we return a jet made of a single parton. Note that
+/// this behaviour differs from the mMDT (and can be a source of
+/// differences when running SoftDrop with beta=0.)
+///
+class SoftDrop : public RecursiveSymmetryCutBase {
+public:
+ /// Simplified constructor. This takes the value of the "beta"
+ /// parameter and the symmetry cut (applied by default on the
+ /// scalar_z variable, as for the mMDT). It also takes an optional
+ /// subtractor.
+ ///
+ /// If the (optional) pileup subtractor can be supplied, then see
+ /// also the documentation for the set_input_jet_is_subtracted() member
+ /// function.
+ ///
+ /// \param beta the value of the beta parameter
+ /// \param symmetry_cut the value of the cut on the symmetry measure
+ /// \param R0 the angular distance normalisation [1 by default]
+ SoftDrop(double beta,
+ double symmetry_cut,
+ double R0 = 1,
+ const FunctionOfPseudoJet<PseudoJet> * subtractor = 0) :
+ RecursiveSymmetryCutBase(scalar_z, // the default SymmetryMeasure
+ std::numeric_limits<double>::infinity(), // default is no mass drop
+ larger_pt, // the default RecursionChoice
+ subtractor),
+ _beta(beta), _symmetry_cut(symmetry_cut), _R0sqr(R0*R0) {
+ // change the default: use grooming mode
+ set_grooming_mode();
+ }
+
+ /// 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 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)
+ ///
+ /// The default values provided for this constructor are suited to
+ /// obtain the SoftDrop as discussed in arXiv:1402.2657:
+ /// - no mass drop is requested
+ /// - recursion follows the branch with the largest pt
+ /// The symmetry measure has to be specified (scalar_z is the recommended value)
+ ///
+ /// Notes:
+ ///
+ /// - by default, SoftDrop will recluster the jet with the
+ /// Cambridge/Aachen algorithm if it is not already the case. This
+ /// behaviour can be changed using the "set_reclustering" method
+ /// defined below
+ ///
+ SoftDrop(double beta,
+ double symmetry_cut,
+ SymmetryMeasure symmetry_measure,
+ double R0 = 1.0,
+ double mu_cut = std::numeric_limits<double>::infinity(),
+ RecursionChoice recursion_choice = larger_pt,
+ const FunctionOfPseudoJet<PseudoJet> * subtractor = 0) :
+ RecursiveSymmetryCutBase(symmetry_measure, mu_cut, recursion_choice, subtractor),
+ _beta(beta), _symmetry_cut(symmetry_cut), _R0sqr(R0*R0)
+ {
+ // change the default: use grooming mode
+ set_grooming_mode();
+ }
+
+ /// default destructor
+ virtual ~SoftDrop(){}
+
+ //----------------------------------------------------------------------
+ // access to class info
+ double beta() const { return _beta; }
+ double symmetry_cut() const { return _symmetry_cut; }
+ double R0() const { return sqrt(_R0sqr); }
+
+protected:
+
+ // Unlike MMDT, the SoftDrop symmetry_cut_fn depends on the subjet kinematics
+ // since the symmetry condition depends on the DeltaR between subjets.
+ virtual double symmetry_cut_fn(const PseudoJet & p1,
+ const PseudoJet & p2,
+ void * optional_R0sqr_ptr = 0) const;
+ virtual std::string symmetry_cut_description() const;
+
+ //private:
+ double _beta; ///< the power of the angular distance to be used
+ ///< in the symmetry condition
+ double _symmetry_cut; ///< the value of zcut (the prefactor in the asymmetry cut)
+ double _R0sqr; ///< normalisation of the angular distance
+ ///< (typically set to the jet radius, 1 by default)
+};
+
+} // namespace contrib
+
+FASTJET_END_NAMESPACE
+
+#endif // __FASTJET_CONTRIB_SOFTDROP_HH__
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.3/SoftDrop.hh
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/example_recluster.ref
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/example_recluster.ref (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/example_recluster.ref (revision 1431)
@@ -0,0 +1,64 @@
+# read an event with 354 particles
+--------------------------------------------------
+#--------------------------------------------------------------------------
+# FastJet release 3.1.0-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,
+# CGAL and 3rd party plugin jet algorithms. See COPYING file for details.
+#--------------------------------------------------------------------------
+Starting from a jet obtained from: Longitudinally invariant anti-kt algorithm with R = 1 and E scheme recombination
+ pt = 983.387 m = 39.9912 y = -0.867307 phi = 2.90511 ClusSeq = yes
+
+Reclustering with: Recluster with subjet_def = Longitudinally invariant Cambridge/Aachen algorithm with R = 1000, a recombiner obtained from the jet being reclustered and keeping the hardest subjet
+ pt = 983.387 m = 39.9912 y = -0.867307 phi = 2.90511 ClusSeq = yes
+
+Reclustering with: Recluster with subjet_def = Longitudinally invariant Cambridge/Aachen algorithm with R = 0.3, a recombiner obtained from the jet being reclustered and joining all subjets in a composite jet
+ pt = 983.387 m = 39.9912 y = -0.867307 phi = 2.90511 ClusSeq = no
+ subjets:
+ pt = 980.937 m = 27.6178 y = -0.86753 phi = 2.90527 ClusSeq = yes
+ pt = 1.34048 m = 0.13498 y = -0.448775 phi = 2.76161 ClusSeq = yes
+ pt = 0.461349 m = 0.13957 y = -1.31787 phi = 3.17806 ClusSeq = yes
+ pt = 0.362421 m = 0.0359117 y = -0.593531 phi = 3.08425 ClusSeq = yes
+ pt = 0.241708 m = -3.12684e-06 y = -1.16407 phi = 2.42725 ClusSeq = yes
+ pt = 0.115239 m = 0.13957 y = -1.6844 phi = 2.54038 ClusSeq = yes
+
+Reclustering with: Recluster with subjet_def = Longitudinally invariant kt algorithm with R = 0.3, a recombiner obtained from the jet being reclustered and joining all subjets in a composite jet
+ pt = 983.387 m = 39.9912 y = -0.867307 phi = 2.90511 ClusSeq = no
+ subjets:
+ pt = 982.621 m = 32.8883 y = -0.866837 phi = 2.90514 ClusSeq = yes
+ pt = 0.461349 m = 0.13957 y = -1.31787 phi = 3.17806 ClusSeq = yes
+ pt = 0.241708 m = -3.12684e-06 y = -1.16407 phi = 2.42725 ClusSeq = yes
+ pt = 0.115239 m = 0.13957 y = -1.6844 phi = 2.54038 ClusSeq = yes
+
+--------------------------------------------------
+Starting from a jet obtained from: Longitudinally invariant Cambridge/Aachen algorithm with R = 1 and E scheme recombination
+ pt = 983.387 m = 39.9912 y = -0.867307 phi = 2.90511 ClusSeq = yes
+
+Reclustering with: Recluster with subjet_def = Longitudinally invariant Cambridge/Aachen algorithm with R = 1000, a recombiner obtained from the jet being reclustered and keeping the hardest subjet
+ pt = 983.387 m = 39.9912 y = -0.867307 phi = 2.90511 ClusSeq = yes
+
+Reclustering with: Recluster with subjet_def = Longitudinally invariant Cambridge/Aachen algorithm with R = 0.3, a recombiner obtained from the jet being reclustered and joining all subjets in a composite jet
+ pt = 983.387 m = 39.9912 y = -0.867307 phi = 2.90511 ClusSeq = no
+ subjets:
+ pt = 980.937 m = 27.6178 y = -0.86753 phi = 2.90527 ClusSeq = yes
+ pt = 1.34048 m = 0.13498 y = -0.448775 phi = 2.76161 ClusSeq = yes
+ pt = 0.461349 m = 0.13957 y = -1.31787 phi = 3.17806 ClusSeq = yes
+ pt = 0.362421 m = 0.0359117 y = -0.593531 phi = 3.08425 ClusSeq = yes
+ pt = 0.241708 m = -3.12684e-06 y = -1.16407 phi = 2.42725 ClusSeq = yes
+ pt = 0.115239 m = 0.13957 y = -1.6844 phi = 2.54038 ClusSeq = yes
+
+Reclustering with: Recluster with subjet_def = Longitudinally invariant kt algorithm with R = 0.3, a recombiner obtained from the jet being reclustered and joining all subjets in a composite jet
+ pt = 983.387 m = 39.9912 y = -0.867307 phi = 2.90511 ClusSeq = no
+ subjets:
+ pt = 982.621 m = 32.8883 y = -0.866837 phi = 2.90514 ClusSeq = yes
+ pt = 0.461349 m = 0.13957 y = -1.31787 phi = 3.17806 ClusSeq = yes
+ pt = 0.241708 m = -3.12684e-06 y = -1.16407 phi = 2.42725 ClusSeq = yes
+ pt = 0.115239 m = 0.13957 y = -1.6844 phi = 2.54038 ClusSeq = yes
+
Index: contrib/contribs/RecursiveTools/tags/2.0.3/IteratedSoftDrop.cc
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/IteratedSoftDrop.cc (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/IteratedSoftDrop.cc (revision 1431)
@@ -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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#include "IteratedSoftDrop.hh"
+#include <sstream>
+#include <cmath>
+#include <fastjet/ClusterSequence.hh>
+
+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<PseudoJet> * 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<PseudoJet> * 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<RecursiveSoftDrop>())
+ return IteratedSoftDropInfo();
+ return IteratedSoftDropInfo(rsd_jet.structure_of<RecursiveSoftDrop>().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.3/IteratedSoftDrop.cc
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/ModifiedMassDropTagger.cc
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/ModifiedMassDropTagger.cc (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/ModifiedMassDropTagger.cc (revision 1431)
@@ -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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#include "ModifiedMassDropTagger.hh"
+#include "fastjet/JetDefinition.hh"
+#include "fastjet/ClusterSequenceAreaBase.hh"
+#include <algorithm>
+#include <cstdlib>
+
+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.3/ModifiedMassDropTagger.cc
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/example_recluster.cc
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/example_recluster.cc (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/example_recluster.cc (revision 1431)
@@ -0,0 +1,177 @@
+//----------------------------------------------------------------------
+/// \file example_recluster.cc
+///
+/// This example program is meant to illustrate how the
+/// fastjet::contrib::Recluster class is used.
+///
+/// Run this example with
+///
+/// \verbatim
+/// ./example_recluster < ../data/single-event.dat
+/// \endverbatim
+///
+/// Note that fastjet::contrib::Recluster is deprecated and you
+/// are advised to use fastjet::Recluster instead, which can be
+/// obtained by include "fastjet/tools/Recluster.hh".
+//----------------------------------------------------------------------
+
+// $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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#include <iostream>
+#include <sstream>
+
+#include <sstream>
+#include <iomanip>
+#include <cmath>
+#include "fastjet/ClusterSequence.hh"
+
+#include "Recluster.hh" // In external code, this should be fastjet/contrib/Recluster.hh
+
+using namespace std;
+using namespace fastjet;
+
+// forward declaration to make things clearer
+void read_event(vector<PseudoJet> &event);
+ostream & operator<<(ostream &, const PseudoJet &);
+
+//----------------------------------------------------------------------
+int main(){
+
+ //----------------------------------------------------------
+ // read in input particles
+ vector<PseudoJet> event;
+ read_event(event);
+ cout << "# read an event with " << event.size() << " particles" << endl;
+
+ double R = 1.0;
+ double ptmin = 20.0;
+ double Rsub = 0.3;
+
+ //----------------------------------------------------------
+ // start with an example from anti-kt jets
+ cout << "--------------------------------------------------" << endl;
+ JetDefinition jet_def_akt(antikt_algorithm, R);
+ ClusterSequence cs_akt(event, jet_def_akt);
+ vector<PseudoJet> jets_akt = sorted_by_pt(cs_akt.inclusive_jets(ptmin));
+ PseudoJet jet_akt = jets_akt[0];
+ cout << "Starting from a jet obtained from: " << jet_def_akt.description() << endl
+ << " " << jet_akt << endl << endl;
+
+ // recluster with C/A ("infinite" radius)
+ contrib::Recluster recluster_ca_inf(cambridge_algorithm, JetDefinition::max_allowable_R);
+ PseudoJet rec_jet_ca_inf = recluster_ca_inf(jet_akt);
+ cout << "Reclustering with: " << recluster_ca_inf.description() << endl
+ << " " << rec_jet_ca_inf << endl << endl;;
+
+ // recluster with C/A (small radius), keeping all subjets
+ contrib::Recluster recluster_ca_sub(cambridge_algorithm, Rsub, false);
+ PseudoJet rec_jet_ca_sub = recluster_ca_sub(jet_akt);
+ cout << "Reclustering with: " << recluster_ca_sub.description() << endl
+ << " " << rec_jet_ca_sub << endl;
+ vector<PseudoJet> pieces = rec_jet_ca_sub.pieces();
+ cout << " subjets: " << endl;
+ for (unsigned int i=0;i<pieces.size();i++)
+ cout << " " << pieces[i] << endl;
+ cout << endl;
+
+ // recluster with kt (small radius), keeping all subjets
+ contrib::Recluster recluster_kt_sub(kt_algorithm, Rsub, false);
+ PseudoJet rec_jet_kt_sub = recluster_kt_sub(jet_akt);
+ cout << "Reclustering with: " << recluster_kt_sub.description() << endl
+ << " " << rec_jet_kt_sub << endl;
+ pieces = rec_jet_kt_sub.pieces();
+ cout << " subjets: " << endl;
+ for (unsigned int i=0;i<pieces.size();i++)
+ cout << " " << pieces[i] << endl;
+ cout << endl;
+
+ //----------------------------------------------------------
+ // now an example starting from C/A jets
+ cout << "--------------------------------------------------" << endl;
+ JetDefinition jet_def_ca(cambridge_algorithm, R);
+ ClusterSequence cs_ca(event, jet_def_ca);
+ vector<PseudoJet> jets_ca = sorted_by_pt(cs_ca.inclusive_jets(ptmin));
+ PseudoJet jet_ca = jets_ca[0];
+ cout << "Starting from a jet obtained from: " << jet_def_ca.description() << endl
+ << " " << jet_ca << endl << endl;
+
+ // recluster with C/A ("infinite" radius)
+ rec_jet_ca_inf = recluster_ca_inf(jet_ca);
+ cout << "Reclustering with: " << recluster_ca_inf.description() << endl
+ << " " << rec_jet_ca_inf << endl << endl;
+
+ // recluster with C/A (small radius), keeping all subjets
+ rec_jet_ca_sub = recluster_ca_sub(jet_ca);
+ cout << "Reclustering with: " << recluster_ca_sub.description() << endl
+ << " " << rec_jet_ca_sub << endl;
+ pieces = rec_jet_ca_sub.pieces();
+ cout << " subjets: " << endl;
+ for (unsigned int i=0;i<pieces.size();i++)
+ cout << " " << pieces[i] << endl;
+ cout << endl;
+
+ // recluster with kt (small radius), keeping all subjets
+ rec_jet_kt_sub = recluster_kt_sub(jet_ca);
+ cout << "Reclustering with: " << recluster_kt_sub.description() << endl
+ << " " << rec_jet_kt_sub << endl;
+ pieces = rec_jet_kt_sub.pieces();
+ cout << " subjets: " << endl;
+ for (unsigned int i=0;i<pieces.size();i++)
+ cout << " " << pieces[i] << endl;
+ cout << endl;
+
+ return 0;
+}
+
+//----------------------------------------------------------------------
+/// read in input particles
+void read_event(vector<PseudoJet> &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 << " pt = " << jet.pt()
+ << " m = " << jet.m()
+ << " y = " << jet.rap()
+ << " phi = " << jet.phi()
+ << " ClusSeq = " << (jet.has_associated_cs() ? "yes" : "no");
+ }
+ return ostr;
+}
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.3/example_recluster.cc
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/COPYING
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/COPYING (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/COPYING (revision 1431)
@@ -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.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ 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.
+
+ <signature of Ty Coon>, 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.3/NEWS
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/NEWS (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/NEWS (revision 1431)
@@ -0,0 +1,16 @@
+2024/10/04: release of version 2.0.3, resolving use of wrong Recluster.hh in RecursiveSoftDrop.hh
+2024/02/22: release of version 2.0.2, addressing rounding issue in recursive soft drop example
+2021/08/21: release of version 2.0.1, addressing rare divide-by-zero in calculation of mu2
+2020/03/03: release of version 2.0.0 with updated readme
+
+2018/05/31: release of version 2.0.0-beta2 with corrected syntax
+
+2017/10/10: release of version 2.0.0-beta1 including implementations of
+
+* RecursiveSoftDrop (see example_rsd.hh for usage)
+* IteratedSoftDrop (see example_isd.hh for usage)
+* e+e- version of the recursive tools (see example_mmdt_ee.hh for usage)
+* BottomUpSoftDrop (see example_bottomup_softdrop.cc for usage)
+
+2014/07/09: release of version 1.0.0 of RecursiveTools including
+ ModifiedMassDropTagger and SoftDrop (as well as Recluster)
Index: contrib/contribs/RecursiveTools/tags/2.0.3/Makefile
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/Makefile (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/Makefile (revision 1431)
@@ -0,0 +1,109 @@
+# If you are using this Makefile standalone and fastjet-config is not
+# in your path, edit this line to specify the full path
+FASTJETCONFIG=fastjet-config
+PREFIX=`$(FASTJETCONFIG) --prefix`
+CXX=g++
+CXXFLAGS= -O3 -Wall -g
+install_script = $(SHELL) ../utils/install-sh
+check_script = ../utils/check.sh
+
+# global contrib-wide Makefile include may override some of the above
+# variables (leading "-" means don't give an error if you can't find
+# the file)
+-include ../.Makefile.inc
+
+#------------------------------------------------------------------------
+# things that are specific to this contrib
+NAME=RecursiveTools
+SRCS=Recluster.cc RecursiveSymmetryCutBase.cc ModifiedMassDropTagger.cc SoftDrop.cc IteratedSoftDrop.cc RecursiveSoftDrop.cc BottomUpSoftDrop.cc
+EXAMPLES=example_mmdt example_mmdt_sub example_mmdt_ee example_recluster example_softdrop example_recursive_softdrop example_advanced_usage example_isd example_bottomup_softdrop
+INSTALLED_HEADERS=Recluster.hh RecursiveSymmetryCutBase.hh ModifiedMassDropTagger.hh SoftDrop.hh IteratedSoftDrop.hh RecursiveSoftDrop.hh BottomUpSoftDrop.hh
+#------------------------------------------------------------------------
+
+CXXFLAGS+= $(shell $(FASTJETCONFIG) --cxxflags)
+LDFLAGS += $(shell $(FASTJETCONFIG) --libs)
+
+OBJS = $(SRCS:.cc=.o)
+EXAMPLES_SRCS = $(EXAMPLES:=.cc)
+
+install_HEADER = $(install_script) -c -m 644
+install_LIB = $(install_script) -c -m 644
+install_DIR = $(install_script) -d
+install_DATA = $(install_script) -c -m 644
+install_PROGRAM = $(install_script) -c -s
+install_SCRIPT = $(install_script) -c
+
+.PHONY: clean distclean examples check install
+
+# compilation of the code (default target)
+all: lib$(NAME).a
+
+lib$(NAME).a: $(OBJS)
+ ar cru lib$(NAME).a $(OBJS)
+ ranlib lib$(NAME).a
+
+# building the examples
+examples: $(EXAMPLES)
+
+# the following construct makes it possible to automatically build
+# each of the examples listed in $EXAMPLES
+$(EXAMPLES): % : %.o all
+ $(CXX) -o $@ $< -L. -l$(NAME) $(LDFLAGS)
+
+# check that everything went fine
+check: examples
+ @$(check_script) example_mmdt ../data/single-event.dat || exit 1
+ @$(check_script) example_mmdt_sub ../data/Pythia-Zp2jets-lhc-pileup-1ev.dat || exit 1
+ @$(check_script) example_mmdt_ee ../data/single-ee-event.dat || exit 1
+ @$(check_script) example_recluster ../data/single-event.dat || exit 1
+ @$(check_script) example_softdrop ../data/single-event.dat || exit 1
+ @$(check_script) example_advanced_usage ../data/single-event.dat || exit 1
+ @$(check_script) example_recursive_softdrop ../data/single-event.dat || exit 1
+ @$(check_script) example_bottomup_softdrop ../data/single-event.dat || exit 1
+ @$(check_script) example_isd ../data/single-event.dat || exit 1
+# @for prog in $(EXAMPLES); do\
+# $(check_script) $${prog} ../data/single-event.dat || exit 1; \
+# done
+ @echo "All tests successful"
+
+# cleaning the directory
+clean:
+ rm -f *~ *.o
+
+distclean: clean
+ rm -f lib$(NAME).a $(EXAMPLES)
+
+# install things in PREFIX/...
+install: all
+ $(install_DIR) $(PREFIX)/include/fastjet/contrib
+ for header in $(INSTALLED_HEADERS); do\
+ $(install_HEADER) $$header $(PREFIX)/include/fastjet/contrib/;\
+ done
+ $(install_DIR) $(PREFIX)/lib
+ $(install_LIB) lib$(NAME).a $(PREFIX)/lib
+
+depend:
+ makedepend -Y -- -- $(SRCS) $(EXAMPLES_SRCS)
+# DO NOT DELETE
+
+Recluster.o: Recluster.hh
+RecursiveSymmetryCutBase.o: RecursiveSymmetryCutBase.hh Recluster.hh
+ModifiedMassDropTagger.o: ModifiedMassDropTagger.hh
+ModifiedMassDropTagger.o: RecursiveSymmetryCutBase.hh Recluster.hh
+SoftDrop.o: SoftDrop.hh RecursiveSymmetryCutBase.hh Recluster.hh
+IteratedSoftDrop.o: IteratedSoftDrop.hh
+RecursiveSoftDrop.o: RecursiveSoftDrop.hh Recluster.hh SoftDrop.hh
+RecursiveSoftDrop.o: RecursiveSymmetryCutBase.hh
+BottomUpSoftDrop.o: BottomUpSoftDrop.hh
+example_mmdt.o: ModifiedMassDropTagger.hh RecursiveSymmetryCutBase.hh
+example_mmdt.o: Recluster.hh
+example_mmdt_sub.o: ModifiedMassDropTagger.hh RecursiveSymmetryCutBase.hh
+example_mmdt_sub.o: Recluster.hh
+example_recluster.o: Recluster.hh
+example_softdrop.o: SoftDrop.hh RecursiveSymmetryCutBase.hh Recluster.hh
+example_recursive_softdrop.o: RecursiveSoftDrop.hh Recluster.hh SoftDrop.hh
+example_recursive_softdrop.o: RecursiveSymmetryCutBase.hh
+example_bottomup_softdrop.o: BottomUpSoftDrop.hh
+example_advanced_usage.o: SoftDrop.hh RecursiveSymmetryCutBase.hh
+example_advanced_usage.o: Recluster.hh
+example_isd.o: IteratedSoftDrop.hh
Index: contrib/contribs/RecursiveTools/tags/2.0.3/example_isd.cc
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/example_isd.cc (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/example_isd.cc (revision 1431)
@@ -0,0 +1,170 @@
+//----------------------------------------------------------------------
+/// \file example_isd.cc
+///
+/// This example program is meant to illustrate how the
+/// fastjet::contrib::IteratedSoftDrop class is used.
+///
+/// Run this example with
+///
+/// \verbatim
+/// ./example_isd < ../data/single-event.dat
+/// \endverbatim
+//----------------------------------------------------------------------
+
+// $Id$
+//
+// Copyright (c) 2017, Jesse Thaler, Kevin Zhou
+// 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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#include <iostream>
+#include <sstream>
+
+#include <sstream>
+#include <iomanip>
+#include <cmath>
+#include "fastjet/ClusterSequence.hh"
+
+#include "IteratedSoftDrop.hh" // In external code, this should be fastjet/contrib/IteratedSoftDrop.hh
+
+using namespace std;
+using namespace fastjet;
+
+// forward declaration to make things clearer
+void read_event(vector<PseudoJet> &event);
+
+//----------------------------------------------------------------------
+int main(){
+
+ //----------------------------------------------------------
+ // read in input particles
+ vector<PseudoJet> event;
+ read_event(event);
+ cout << "# read an event with " << event.size() << " particles" << endl;
+
+ // first get some anti-kt jets
+ double R = 0.5;
+ JetDefinition jet_def(antikt_algorithm, R);
+ double ptmin = 200.0;
+ Selector pt_min_selector = SelectorPtMin(ptmin);
+
+ ClusterSequence cs(event,jet_def);
+ vector<PseudoJet> jets = pt_min_selector(sorted_by_pt(cs.inclusive_jets()));
+
+ // Determine optimal scale from 1704.06266 for beta = -1
+ double expected_jet_pt = 1000; // in GeV
+ double NP_scale = 1; // approximately Lambda_QCD in GeV
+ double optimal_z_cut = (NP_scale / expected_jet_pt / R);
+
+ // set up iterated soft drop objects
+ double z_cut = optimal_z_cut;
+ double beta = -1.0;
+ double theta_cut = 0.0;
+
+ contrib::IteratedSoftDrop isd(beta, z_cut, theta_cut, R);
+ contrib::IteratedSoftDrop isd_ee(beta, z_cut, contrib::RecursiveSoftDrop::theta_E,
+ theta_cut, R, std::numeric_limits<double>::infinity(),
+ contrib::RecursiveSoftDrop::larger_E);
+
+ cout << "---------------------------------------------------" << endl;
+ cout << "Iterated Soft Drop" << endl;
+ cout << "---------------------------------------------------" << endl;
+
+ cout << endl;
+ cout << "Computing with:" << endl;
+ cout << " " << isd.description() << endl;
+ cout << " " << isd_ee.description() << endl;
+ cout << endl;
+
+ for (unsigned ijet = 0; ijet < jets.size(); ijet++) {
+
+ cout << "---------------------------------------------------" << endl;
+ cout << "Processing Jet " << ijet << endl;
+ cout << "---------------------------------------------------" << endl;
+
+
+ cout << endl;
+ cout << "Jet pT: " << jets[ijet].pt() << " GeV" << endl;
+ cout << endl;
+
+
+ // Run full iterated soft drop
+ //
+ // Instead of asking for an IteratedSoftDropInfo which contains
+ // all the information to calculate physics observables, one can
+ // use
+ // isd.all_zg_thetag(jet) for the list of symmetry factors and angles
+ // isd.multiplicity(jet) for the ISD multiplicity
+ // isd.angularity(jet,alpha) for the angularity obtained from the (zg, thetag)
+ //
+ contrib::IteratedSoftDropInfo syms = isd(jets[ijet]);
+
+ cout << "Soft Drop Multiplicity (pt_R measure, beta=" << beta << ", z_cut=" << z_cut << "):" << endl;
+ cout << syms.multiplicity() << endl;
+ cout << endl;
+
+ cout << "Symmetry Factors (pt_R measure, beta=" << beta << ", z_cut=" << z_cut << "):" << endl;
+ for (unsigned i = 0; i < syms.size(); i++){
+ cout << syms[i].first << " ";
+ }
+ cout << endl;
+ cout << endl;
+
+ cout << "Soft Drop Angularities (pt_R measure, beta=" << beta << ", z_cut=" << z_cut << "):" << endl;
+ cout << " alpha = 0, kappa = 0 : " << syms.angularity(0.0, 0.0) << endl;
+ cout << " alpha = 0, kappa = 2 : " << syms.angularity(0.0, 2.0) << endl;
+ cout << " alpha = 0.5, kappa = 1 : " << syms.angularity(0.5) << endl;
+ cout << " alpha = 1, kappa = 1 : " << syms.angularity(1.0) << endl;
+ cout << " alpha = 2, kappa = 1 : " << syms.angularity(2.0) << endl;
+ cout << endl;
+
+ // Alternative version with e+e- measure
+ contrib::IteratedSoftDropInfo syms_ee = isd_ee(jets[ijet]);
+ cout << "Symmetry Factors (E_theta measure, beta=" << beta << ", z_cut=" << z_cut << "):" << endl;
+ for (unsigned i = 0; i < syms_ee.size(); i++){
+ cout << syms_ee[i].first << " ";
+ }
+ cout << endl;
+ cout << endl;
+
+
+ }
+
+ return 0;
+}
+
+//----------------------------------------------------------------------
+/// read in input particles
+void read_event(vector<PseudoJet> &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);
+ }
+}
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.3/example_isd.cc
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/BottomUpSoftDrop.cc
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/BottomUpSoftDrop.cc (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/BottomUpSoftDrop.cc (revision 1431)
@@ -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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#include "BottomUpSoftDrop.hh"
+#include <cassert>
+#include <algorithm>
+#include <sstream>
+#include <typeinfo>
+#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<PseudoJet> 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<PseudoJetStructureBase>(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<PseudoJet> BottomUpSoftDrop::global_grooming(const vector<PseudoJet> & event) const {
+ // start by reclustering the event into one very large jet
+ ClusterSequence cs(event, _jet_def);
+ std::vector<PseudoJet> global_jet = SelectorNHardest(1)(cs.inclusive_jets());
+ // if the event is empty, do nothing
+ if (global_jet.size() == 0) return vector<PseudoJet>();
+
+ // 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<PseudoJet> pieces = jet.pieces();
+ for (unsigned int i=0;i<pieces.size(); i++)
+ if (!_check_explicit_ghosts(pieces[i])) return false;
+ // never returned false, so we're OK.
+ return true;
+ }
+
+ // return false for any other (unknown) structure
+ return false;
+}
+
+// see if there is a common recombiner among the pieces; if there
+// is return true and set jet_def_for_recombiner so that the
+// recombiner can be taken from that JetDefinition. Otherwise,
+// return false. 'assigned' is initially false; when true, each
+// time we meet a new jet definition, we'll check it shares the
+// same recombiner as jet_def_for_recombiner.
+bool BottomUpSoftDrop::_check_common_recombiner(const PseudoJet &jet,
+ JetDefinition &jet_def_for_recombiner,
+ bool assigned) const {
+ if (jet.has_associated_cluster_sequence()){
+ // if the jet def for recombination has already been assigned, check if we have the same
+ if (assigned)
+ return jet.validated_cs()->jet_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<PseudoJet> pieces = jet.pieces();
+ if (pieces.size() == 0) return false;
+ for (unsigned int i=0;i<pieces.size(); i++)
+ if (!_check_common_recombiner(pieces[i], jet_def_for_recombiner, assigned)) return false;
+ // never returned false, so we're OK.
+ return true;
+ }
+ // return false for any other (unknown) structure
+ return false;
+}
+
+
+// description
+string BottomUpSoftDrop::description() const{
+ ostringstream oss;
+ oss << "BottomUpSoftDrop with jet_definition = (" << _jet_def.description() << ")"
+ << ", symmetry_cut = " << _symmetry_cut << ", beta = " << _beta << ", R0 = " << _R0;
+ return oss.str();
+}
+
+//----------------------------------------------------------------------
+// BottomUpSoftDropRecombiner class
+//----------------------------------------------------------------------
+
+// perform a recombination taking into account the Soft Drop
+// conditions
+void BottomUpSoftDropRecombiner::recombine(const PseudoJet &pa,
+ const PseudoJet &pb,
+ PseudoJet &pab) const {
+ PseudoJet p;
+ _recombiner->recombine(pa, pb, p);
+
+ // calculate symmetry parameter
+ double symmetry_cut_fn =_symmetry_cut * pow(pa.squared_distance(pb)/_R0sqr, 0.5*_beta);
+ double pta = pa.pt();
+ double ptb = pb.pt();
+ // make sure denominator is non-zero
+ double sym = pta + ptb;
+ if (sym == 0){
+ pab = p;
+ return;
+ }
+ sym = min(pta, ptb) / sym;
+
+ // if the 2 particles pass the soft drop condition, do the
+ // recombination
+ if (sym > symmetry_cut_fn){
+ pab=p;
+ return;
+ }
+
+ // if the soft drop condition is not passed, return the particle
+ // with largest pt
+ if (pta < ptb) {
+ pab = pb;
+ _rejected.push_back(pa.cluster_hist_index());
+ } else {
+ pab = pa;
+ _rejected.push_back(pb.cluster_hist_index());
+ }
+}
+
+//----------------------------------------------------------------------
+// BottomUpSoftDropPlugin class
+//----------------------------------------------------------------------
+
+// the actual clustering work for the plugin
+void BottomUpSoftDropPlugin::run_clustering(ClusterSequence &input_cs) const {
+ // declare a soft drop recombiner
+ BottomUpSoftDropRecombiner softdrop_recombiner(_beta, _symmetry_cut, _R0, _jet_def.recombiner());
+ JetDefinition jet_def = _jet_def;
+ jet_def.set_recombiner(&softdrop_recombiner);
+
+ // cluster the particles using that recombiner
+ ClusterSequence internal_cs(input_cs.jets(), jet_def);
+ const vector<ClusterSequence::history_element> & internal_hist = internal_cs.history();
+
+ // transfer the list of "childless" elements into a bool vector
+ vector<bool> kept(internal_hist.size(), true);
+ const vector<unsigned int> &sd_rej = softdrop_recombiner.rejected();
+ for (unsigned int i=0;i<sd_rej.size(); i++) kept[sd_rej[i]]=false;
+
+ // browse the history, keeping only the elements that have not been
+ // vetoed.
+ //
+ // In the process we build a map for the history indices
+ vector<unsigned int> internal2input(internal_hist.size());
+ for (unsigned int i=0; i<input_cs.jets().size(); i++)
+ internal2input[i] = i;
+
+ for (unsigned int i=input_cs.jets().size(); i<internal_hist.size(); i++){
+ const ClusterSequence::history_element &he = internal_hist[i];
+
+ // deal with recombinations with the beam
+ if (he.parent2 == ClusterSequence::BeamJet){
+ int internal_jetp_index = internal_hist[he.parent1].jetp_index;
+ int internal_hist_index = internal_cs.jets()[internal_jetp_index].cluster_hist_index();
+
+ int input_jetp_index = input_cs.history()[internal2input[internal_hist_index]].jetp_index;
+
+ // cout << "Beam recomb for internal " << internal_hist_index
+ // << " (input jet index=" << input_jetp_index << endl;
+
+ input_cs.plugin_record_iB_recombination(input_jetp_index, he.dij);
+ continue;
+ }
+
+ // now, deal with two-body recombinations
+ if (!kept[he.parent1]){ // 1 is rejected, we keep only 2
+ internal2input[i]=internal2input[he.parent2];
+ // cout << "rejecting internal " << he.parent1
+ // << ", mapping internal " << i
+ // << " to internal " << he.parent2
+ // << " i.e. " << internal2input[i] << endl;
+ } else if (!kept[he.parent2]){ // 2 is rejected, we keep only 1
+ internal2input[i]=internal2input[he.parent1];
+ // cout << "rejecting internal " << he.parent2
+ // << ", mapping internal " << i
+ // << " to internal " << he.parent1
+ // << " i.e. " << internal2input[i] << endl;
+ } else { // do the recombination
+ int new_index;
+ input_cs.plugin_record_ij_recombination(input_cs.history()[internal2input[he.parent1]].jetp_index,
+ input_cs.history()[internal2input[he.parent2]].jetp_index,
+ he.dij, internal_cs.jets()[he.jetp_index], new_index);
+ internal2input[i]=input_cs.jets()[new_index].cluster_hist_index();
+ // cout << "merging " << internal2input[he.parent1] << " (int: " << he.parent1 << ")"
+ // << " and " << internal2input[he.parent2] << " (int: " << he.parent2 << ")"
+ // << " into " << internal2input[i] << " (int: " << i << ")" << endl;
+ }
+ }
+}
+
+// description of the plugin
+string BottomUpSoftDropPlugin::description() const {
+ ostringstream oss;
+ oss << "BottomUpSoftDropPlugin with jet_definition = (" << _jet_def.description()
+ <<"), symmetry_cut = " << _symmetry_cut << ", beta = "
+ << _beta << ", R0 = " << _R0;
+ return oss.str();
+}
+
+
+}
+
+FASTJET_END_NAMESPACE
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.3/BottomUpSoftDrop.cc
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/example_bottomup_softdrop.ref
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/example_bottomup_softdrop.ref (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/example_bottomup_softdrop.ref (revision 1431)
@@ -0,0 +1,21 @@
+# 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.
+#--------------------------------------------------------------------------
+BottomUpSoftDrop groomer is: BottomUpSoftDrop with jet_definition = (Longitudinally invariant Cambridge/Aachen algorithm with R = 1000 and E scheme recombination), symmetry_cut = 0.2, beta = 1, R0 = 1
+
+original jet: pt = 983.387 m = 39.9912 y = -0.867307 phi = 2.90511
+BottomUpSoftDropped jet: pt = 962.379 m = 19.9368 y = -0.868399 phi = 2.90497
+
+original jet: pt = 908.098 m = 87.7124 y = 0.219482 phi = 6.03487
+BottomUpSoftDropped jet: pt = 872.286 m = 7.04265 y = 0.223045 phi = 6.03083
Index: contrib/contribs/RecursiveTools/tags/2.0.3/SoftDrop.cc
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/SoftDrop.cc (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/SoftDrop.cc (revision 1431)
@@ -0,0 +1,74 @@
+// $Id$
+//
+// Copyright (c) 2014-, Gregory Soyez, Jesse. Thaler
+// based on arXiv:1402.2657 by Andrew J. Larkoski, Simone Marzani,
+// Gregory Soyez, Jesse Thaler
+//
+//----------------------------------------------------------------------
+// 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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#include "SoftDrop.hh"
+#include <cmath>
+#include <sstream>
+
+using namespace std;
+
+FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh
+
+namespace contrib{
+
+//----------------------------------------------------------------------
+// TODO:
+//
+// - implement reclustering (at the moment we assume it's C/A as for mMDT
+//
+// - what is returned if no substructure is found? [and for negativeve
+// pt, m2 or other situations where mMDT currentlty returns an empty
+// PseudoJet]
+//
+// GS.: mMDT seeks substructure so it makes sense for it to return
+// an empry PseudoJet when no substructure is found (+ it is the
+// original behaviour). For SoftDrop, in grooming mode (beta>0), if
+// would make sense to return a jet with a single particle. In
+// tagging mode (beta<0), the situation is less clear. At the level
+// of the implementation, having a virtual function could work
+// (with a bit of care to cover the -ve pt or m2 cases)
+//
+// - Do we include Andrew and Simone in the "contrib-author" list
+// since they are on the paper? Do we include Gavin in the author's
+// list since he started this contrib?
+//
+//----------------------------------------------------------------------
+
+//----------------------------------------------------------------------
+double SoftDrop::symmetry_cut_fn(const PseudoJet & p1,
+ const PseudoJet & p2,
+ void *optional_R0sqr_ptr) const{
+ double R0sqr = (optional_R0sqr_ptr == 0) ? _R0sqr : *((double*) optional_R0sqr_ptr);
+ return _symmetry_cut * pow(squared_geometric_distance(p1,p2)/R0sqr, 0.5*_beta);
+}
+
+//----------------------------------------------------------------------
+string SoftDrop::symmetry_cut_description() const {
+ ostringstream ostr;
+ ostr << _symmetry_cut << " (theta/" << sqrt(_R0sqr) << ")^" << _beta << " [SoftDrop]";
+ return ostr.str();
+}
+
+} // namespace contrib
+
+FASTJET_END_NAMESPACE
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.3/SoftDrop.cc
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/example_softdrop.ref
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/example_softdrop.ref (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/example_softdrop.ref (revision 1431)
@@ -0,0 +1,33 @@
+# read an event with 354 particles
+#--------------------------------------------------------------------------
+# FastJet release 3.0.6
+# 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.
+#--------------------------------------------------------------------------
+SoftDrop groomer is: Recursive Groomer with a symmetry cut scalar_z > 0.1 (theta/1)^2 [SoftDrop], no mass-drop requirement, recursion into the subjet with larger pt
+
+original jet: pt = 983.387 m = 39.9912 y = -0.867307 phi = 2.90511
+SoftDropped jet: pt = 980.44 m = 27.1382 y = -0.867485 phi = 2.90532
+ delta_R between subjets: 0.209158
+ symmetry measure(z): 0.0047049
+ mass drop(mu): 0.835262
+
+original jet: pt = 908.098 m = 87.7124 y = 0.219482 phi = 6.03487
+SoftDropped jet: pt = 887.935 m = 11.3171 y = 0.223247 phi = 6.03034
+ delta_R between subjets: 0.111631
+ symmetry measure(z): 0.00440752
+ mass drop(mu): 0.791013
+
+original jet: pt = 72.9429 m = 23.4022 y = -1.19083 phi = 6.1199
+SoftDropped jet: pt = 71.5847 m = 20.0943 y = -1.1761 phi = 6.12539
+ delta_R between subjets: 0.680305
+ symmetry measure(z): 0.0730158
+ mass drop(mu): 0.56265
Index: contrib/contribs/RecursiveTools/tags/2.0.3/RecursiveSymmetryCutBase.hh
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/RecursiveSymmetryCutBase.hh (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/RecursiveSymmetryCutBase.hh (revision 1431)
@@ -0,0 +1,387 @@
+// $Id$
+//
+// Copyright (c) 2014-, Gavin P. Salam, Gregory Soyez, Jesse Thaler
+//
+//----------------------------------------------------------------------
+// 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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#ifndef __FASTJET_CONTRIB_RECURSIVESYMMETRYCUTBASE_HH__
+#define __FASTJET_CONTRIB_RECURSIVESYMMETRYCUTBASE_HH__
+
+#include <limits>
+#include <cassert>
+#include <fastjet/internal/base.hh>
+#include "fastjet/tools/Transformer.hh"
+#include "fastjet/WrappedStructure.hh"
+#include "fastjet/CompositeJetStructure.hh"
+
+#include "fastjet/config.h"
+
+// we'll use the native FJ class for reculstering if available
+#if FASTJET_VERSION_NUMBER >= 30100
+#include "fastjet/tools/Recluster.hh"
+#else
+#include "Recluster.hh"
+#endif
+
+/** \mainpage RecursiveTools contrib
+
+ The RecursiveTools contrib provides a set of tools for
+ recursive investigation jet substructure. Currently it includes:
+ - fastjet::contrib::ModifiedMassDropTagger
+ - fastjet::contrib::SoftDrop
+ - fastjet::contrib::RecursiveSymmetryCutBase (from which the above two classes derive)
+ - fastjet::contrib::IteratedSoftDropSymmetryFactors (defines ISD procedure)
+ - fastjet::contrib::IteratedSoftDropMultiplicity (defines a useful observable using ISD)
+ - example*.cc provides usage examples
+ */
+
+
+FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh
+
+namespace contrib{
+
+//------------------------------------------------------------------------
+/// \class RecursiveSymmetryCutBase
+/// A base class for all the tools that de-cluster a jet until a
+/// sufficiently symmetric configuration if found.
+///
+/// Derived classes (so far, ModifiedMassDropTagger and SoftDrop) have to
+/// implement the symmetry cut and its description
+///
+/// Note that by default, the jet will be reculstered with
+/// Cambridge/Aachen before applying the de-clustering procedure. This
+/// behaviour can be changed using set_clustering (see below).
+///
+/// By default, this class behaves as a tagger, i.e. returns an empty
+/// PseudoJet if no substructure is found. While the derived
+/// ModifiedMassDropTagger is a tagger, the derived SoftDrop is a groomer
+/// (i.e. it returns a non-zero jet even if no substructure is found).
+///
+/// This class provides support for
+/// - an optional mass-drop cut (see ctor)
+/// - options to select which symmetry measure should be used (see ctor)
+/// - options to select how the recursion proceeds (see ctor)
+/// - options for reclustering the jet before running the de-clustering
+/// (see set_reclustering)
+/// - an optional subtractor (see ctor and other methods below)
+class RecursiveSymmetryCutBase : public Transformer {
+public:
+ // ctors and dtors
+ //----------------------------------------------------------------------
+
+ /// an enum of the different (a)symmetry measures that can be used
+ enum SymmetryMeasure{scalar_z, ///< \f$ \min(p_{ti}, p_{tj})/(p_{ti} + p_{tj}) \f$
+ vector_z, ///< \f$ \min(p_{ti}, p_{tj})/p_{t(i+j)} \f$
+ y, ///< \f$ \min(p_{ti}^2,p_{tj}^2) \Delta R_{ij}^2 / m_{ij}^2 \f$
+ theta_E, ///< \f$ \min(E_i,E_j)/(E_i+E_j) \f$ with 3d angle (ee collisions)
+ cos_theta_E ///< \f$ \min(E_i,E_j)/(E_i+E_j) \f$ with
+ /// \f$ \sqrt{2[1-cos(theta)]}\f$ for angles (ee collisions)
+ };
+
+ /// an enum for the options of how to choose which of two subjets to recurse into
+ enum RecursionChoice{larger_pt, ///< choose the subjet with larger \f$ p_t \f$
+ larger_mt, ///< choose the subjet with larger \f$ m_t \equiv (m^2+p_t^2)^{\frac12}] \f$
+ larger_m, ///< choose the subjet with larger mass (deprecated)
+ larger_E ///< choose the subjet with larger energy (meant for ee collisions)
+ };
+
+ /// Full constructor, which takes the following parameters:
+ ///
+ /// \param symmetry_measure the choice of measure to use to estimate the symmetry
+ /// \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)
+ ///
+ /// If the (optional) pileup subtractor is supplied, then, by
+ /// default, the input jet is assumed unsubtracted and the
+ /// RecursiveSymmetryCutBase returns a subtracted 4-vector. [see
+ /// also the set_input_jet_is_subtracted() member function].
+ ///
+ RecursiveSymmetryCutBase(SymmetryMeasure symmetry_measure = scalar_z,
+ double mu_cut = std::numeric_limits<double>::infinity(),
+ RecursionChoice recursion_choice = larger_pt,
+ const FunctionOfPseudoJet<PseudoJet> * subtractor = 0
+ ) :
+ _symmetry_measure(symmetry_measure),
+ _mu_cut(mu_cut),
+ _recursion_choice(recursion_choice),
+ _subtractor(subtractor), _input_jet_is_subtracted(false),
+ _do_reclustering(true), _recluster(0),
+ _grooming_mode(false),
+ _verbose_structure(false) // by default, don't story verbose information
+ {}
+
+ /// default destructor
+ virtual ~RecursiveSymmetryCutBase(){}
+
+ // access to class info
+ //----------------------------------------------------------------------
+ SymmetryMeasure symmetry_measure() const { return _symmetry_measure; }
+ double mu_cut() const { return _mu_cut; }
+ RecursionChoice recursion_choice() const { return _recursion_choice; }
+
+ // internal subtraction configuration
+ //----------------------------------------------------------------------
+
+ /// This tells the tagger whether to assume that the input jet has
+ /// already been subtracted. This is relevant only if a non-null
+ /// subtractor pointer has been supplied, and the default assymption
+ /// is that the input jet is passed unsubtracted.
+ ///
+ /// Note: given that subtractors usually change the momentum of the
+ /// main jet, but not that of the subjets, subjets will continue to
+ /// have subtraction applied to them.
+ void set_input_jet_is_subtracted(bool is_subtracted) {_input_jet_is_subtracted = is_subtracted;}
+
+ /// returns a bool to indicate if the input jet is assumed already subtracted
+ bool input_jet_is_subtracted() const {return _input_jet_is_subtracted;}
+
+ /// an alternative way to set the subtractor
+ ///
+ /// Note that when a subtractor is provided, the result of the
+ /// RecursiveSymmetryCutBase will be a subtracted jet.
+ void set_subtractor(const FunctionOfPseudoJet<PseudoJet> * subtractor_) {_subtractor = subtractor_;}
+
+ /// returns a pointer to the subtractor
+ const FunctionOfPseudoJet<PseudoJet> * subtractor() const {return _subtractor;}
+
+ // reclustering behaviour
+ //----------------------------------------------------------------------
+
+ /// configure the reclustering prior to the recursive de-clustering
+ /// \param do_reclustering recluster the jet or not?
+ /// \param recluster how to recluster the jet
+ /// (only if do_recluster is true;
+ /// Cambridge/Aachen used if NULL)
+ ///
+ /// Note that the ModifiedMassDropTagger and SoftDrop are designed
+ /// to work with a Cambridge/Aachen clustering. Use any other option
+ /// at your own risk!
+ void set_reclustering(bool do_reclustering=true, const Recluster *recluster=0){
+ _do_reclustering = do_reclustering;
+ _recluster = recluster;
+ }
+
+ // what to do when no substructure is found
+ //----------------------------------------------------------------------
+ /// specify the behaviour adopted when no substructure is found
+ /// - in tagging mode, an empty PseudoJet will be returned
+ /// - in grooming mode, a single particle is returned
+ /// for clarity, we provide both function although they are redundant
+ void set_grooming_mode(bool enable=true){ _grooming_mode = enable;}
+ void set_tagging_mode(bool enable=true){ _grooming_mode = !enable;}
+
+
+ /// Allows access to verbose information about recursive declustering,
+ /// in particular values of symmetry, delta_R, and mu of dropped branches
+ void set_verbose_structure(bool enable=true) { _verbose_structure = enable; }
+ bool has_verbose_structure() const { return _verbose_structure; }
+
+
+ // inherited from the Transformer base
+ //----------------------------------------------------------------------
+
+ /// the function that carries out the tagging; if a subtractor is
+ /// being used, then this function assumes that input jet is
+ /// unsubtracted (unless set_input_jet_is_subtracted(true) has been
+ /// explicitly called before) and the result of the MMDT will be a
+ /// subtracted jet.
+ virtual PseudoJet result(const PseudoJet & j) const;
+
+ /// description of the tool
+ virtual std::string description() const;
+
+ /// returns the gepometrical distance between the two particles
+ /// depending on the symmetry measure used
+ double squared_geometric_distance(const PseudoJet &j1,
+ const PseudoJet &j2) const;
+
+
+ class StructureType;
+
+ /// for testing
+ static bool _verbose;
+
+protected:
+ // the methods below have to be defined by deerived classes
+ //----------------------------------------------------------------------
+ /// the cut on the symmetry measure (typically z) that one need to
+ /// apply for a given pair of subjets p1 and p2
+ virtual double symmetry_cut_fn(const PseudoJet & /* p1 */,
+ const PseudoJet & /* p2 */,
+ void *extra_parameters = 0) const = 0;
+ /// the associated dwescription
+ virtual std::string symmetry_cut_description() const = 0;
+
+ //----------------------------------------------------------------------
+ /// this defines status codes when checking for substructure
+ enum RecursionStatus{
+ recursion_success=0, //< found some substructure
+ recursion_dropped, //< dropped softest prong; recursion continues
+ recursion_no_parents, //< down to constituents; bottom of recursion
+ recursion_issue //< something went wrong; recursion stops
+ };
+
+ //----------------------------------------------------------------------
+ /// the method below is the one actually performing one step of the
+ /// recursion.
+ ///
+ /// It returns a status code (defined above)
+ ///
+ /// In case of success, all the information is filled
+ /// In case of "no parents", piee1 is the same subjet
+ /// In case of trouble, piece2 will be a 0 PJ and piece1 is the PJ we
+ /// should return (either 0 itself if the issue was critical, or
+ /// non-wero in case of a minor issue just causing the recursion to
+ /// stop)
+ ///
+ /// The extra_parameter argument allows one to pass extra agruments
+ /// to the symmetry condition
+ RecursionStatus recurse_one_step(const PseudoJet & subjet,
+ PseudoJet &piece1, PseudoJet &piece2,
+ double &sym, double &mu2,
+ void *extra_parameters = 0) const;
+
+ //----------------------------------------------------------------------
+ /// helper for handling the reclustering
+ PseudoJet _recluster_if_needed(const PseudoJet &jet) const;
+
+ //----------------------------------------------------------------------
+ // helpers for selecting between ee and pp cases
+ bool is_ee() const{
+ return ((_symmetry_measure==theta_E) || (_symmetry_measure==cos_theta_E));
+ }
+
+private:
+ SymmetryMeasure _symmetry_measure;
+ double _mu_cut;
+ RecursionChoice _recursion_choice;
+ const FunctionOfPseudoJet<PseudoJet> * _subtractor;
+ bool _input_jet_is_subtracted;
+
+ bool _do_reclustering; ///< start with a reclustering
+ const Recluster *_recluster; ///< how to recluster the jet
+
+ bool _grooming_mode; ///< grooming or tagging mode
+
+ static LimitedWarning _negative_mass_warning;
+ static LimitedWarning _mu2_gt1_warning;
+ //static LimitedWarning _nonca_warning;
+ static LimitedWarning _explicit_ghost_warning;
+
+ // additional verbose structure information
+ bool _verbose_structure;
+
+ /// decide what to return when no substructure has been found
+ PseudoJet _result_no_substructure(const PseudoJet &last_parent) const;
+};
+
+
+
+//----------------------------------------------------------------------
+/// class to hold the structure of a jet tagged by RecursiveSymmetryCutBase.
+class RecursiveSymmetryCutBase::StructureType : public WrappedStructure {
+public:
+ StructureType(const PseudoJet & j) :
+ WrappedStructure(j.structure_shared_ptr()), _delta_R(-1.0), _symmetry(-1.0), _mu(-1.0),
+ _is_composite(false), _has_verbose(false) // by default, do not store verbose structure
+ {}
+
+ /// construct a structure with
+ /// - basic info inherited from the reference jet "j"
+ /// - a given deltaR for substructure
+ /// - a given symmetry for substructure
+ /// - a given mu parameter for substructure
+ /// If j is a "copmposite jet", it means that it has further
+ /// substructure to potentially recurse into
+ StructureType(const PseudoJet & j, double delta_R_in, double symmetry_in, double mu_in=-1.0) :
+ WrappedStructure(j.structure_shared_ptr()), _delta_R(delta_R_in), _symmetry(symmetry_in), _mu(mu_in),
+ _is_composite(dynamic_cast<const CompositeJetStructure*>(j.structure_ptr()) != NULL),
+ _has_verbose(false) // by default, do not store verbose structure
+ {}
+
+ // information about kept branch
+ double delta_R() const {return _delta_R;}
+ double thetag() const {return _delta_R;} // alternative name
+ double symmetry() const {return _symmetry;}
+ double zg() const {return _symmetry;} // alternative name
+ double mu() const {return _mu;}
+
+ // additional verbose information about dropped branches
+ bool has_verbose() const { return _has_verbose;}
+ void set_verbose(bool value) { _has_verbose = value;}
+
+ /// returns true if the current jet has some substructure (i.e. has
+ /// been tagged by the resursion) or not
+ ///
+ /// Note that this should include deltaR==0 (e.g. a perfectly
+ /// collinear branching with SoftDrop)
+ bool has_substructure() const { return _delta_R>=0; }
+
+ /// number of dropped branches
+ int dropped_count(bool global=true) const;
+
+ /// delta_R of dropped branches
+ /// when "global" is set, recurse into possile further substructure
+ std::vector<double> dropped_delta_R(bool global=true) const;
+ void set_dropped_delta_R(const std::vector<double> &v) { _dropped_delta_R = v; }
+
+ /// symmetry values of dropped branches
+ std::vector<double> dropped_symmetry(bool global=true) const;
+ void set_dropped_symmetry(const std::vector<double> &v) { _dropped_symmetry = v; }
+
+ /// mass drop values of dropped branches
+ std::vector<double> dropped_mu(bool global=true) const;
+ void set_dropped_mu(const std::vector<double> &v) { _dropped_mu = v; }
+
+ /// maximum symmetry value dropped
+ double max_dropped_symmetry(bool global=true) const;
+
+ /// (global) list of groomed away elements as zg and thetag
+ /// sorted from largest to smallest anlge
+ std::vector<std::pair<double,double> > sorted_zg_and_thetag() const;
+
+private:
+ double _delta_R, _symmetry, _mu;
+ friend class RecursiveSymmetryCutBase;
+
+ bool _is_composite;
+
+ // additional verbose information
+ bool _has_verbose;
+ // information about dropped values
+ std::vector<double> _dropped_delta_R;
+ std::vector<double> _dropped_symmetry;
+ std::vector<double> _dropped_mu;
+
+ bool check_verbose(const std::string &what) const{
+ if (!_has_verbose){
+ throw Error("RecursiveSymmetryCutBase::StructureType: Verbose structure must be turned on to get "+what+".");
+ return false;
+ }
+ return true;
+ }
+
+
+};
+
+} // namespace contrib
+
+FASTJET_END_NAMESPACE
+
+#endif // __FASTJET_CONTRIB_RECURSIVESYMMETRYCUTBASE_HH__
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.3/RecursiveSymmetryCutBase.hh
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/RecursiveSoftDrop.hh
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/RecursiveSoftDrop.hh (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/RecursiveSoftDrop.hh (revision 1431)
@@ -0,0 +1,214 @@
+// $Id$
+//
+// Copyright (c) 2014-, 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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#ifndef __RECURSIVESOFTDROP_HH__
+#define __RECURSIVESOFTDROP_HH__
+
+#include "fastjet/config.h"
+
+// we'll use the native FJ class for reculstering if available
+#if FASTJET_VERSION_NUMBER >= 30100
+#include "fastjet/tools/Recluster.hh"
+#else
+#include "Recluster.hh"
+#endif
+#include "SoftDrop.hh"
+#include "fastjet/WrappedStructure.hh"
+
+#include <iostream>
+#include <queue>
+#include <vector>
+
+FASTJET_BEGIN_NAMESPACE
+
+namespace contrib{
+
+//------------------------------------------------------------------------
+/// \class RecursiveSoftDrop
+/// An implementation of the RecursiveSoftDrop.
+///
+/// Recursive Soft Drop will recursively groom a jet, removing
+/// particles that fail the criterion
+/// \f[
+/// z > z_{\rm cut} (\theta/R0)^\beta
+/// \f]
+/// until n subjets have been found.
+///
+/// Several variants are supported:
+/// - set_fixed_depth_mode() switches to fixed depth on all branches
+/// of the clustering tree
+/// - set_dynamical_R0() switches to dynamical R0 implementation of
+/// RSD
+/// - set_hardest_branch_only() switches to following only the
+/// hardest branch (e.g. for Iterated Soft Drop)
+/// - set_min_deltaR_square(val) sets a minimum angle considered for
+/// substructure (e.g. for Iterated Soft Drop)
+///
+/// Notes:
+///
+/// - Even though the calls to "set_tagging_mode()" or
+/// "set_grooming_mode(false)" are allowed, they should not be used
+/// with n=-1, and the default grooming_mode has to remain
+/// untouched (except for beta<0 and finite n).
+///
+//----------------------------------------------------------------------
+class RecursiveSoftDrop : public SoftDrop {
+public:
+ /// Simplified constructor. This takes the value of the "beta"
+ /// parameter and the symmetry cut (applied by default on the
+ /// scalar_z variable, as for the mMDT). It also takes an optional
+ /// subtractor.
+ ///
+ /// n is the number of times we require the SoftDrop condition to be
+ /// satisfied. n=-1 means infinity, i.e. we recurse into the jet
+ /// until individual constituents
+ ///
+ /// If the (optional) pileup subtractor can be supplied, then see
+ /// also the documentation for the set_input_jet_is_subtracted() member
+ /// function.
+ ///
+ /// \param beta the value of the beta parameter
+ /// \param symmetry_cut the value of the cut on the symmetry measure
+ /// \param n the requested number of iterations
+ /// \param R0 the angular distance normalisation [1 by default]
+ RecursiveSoftDrop(double beta,
+ double symmetry_cut,
+ int n = -1,
+ double R0 = 1,
+ const FunctionOfPseudoJet<PseudoJet> * subtractor = 0) :
+ SoftDrop(beta, symmetry_cut, R0, subtractor), _n(n) { set_defaults(); }
+
+ /// 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 n the requested number of iterations
+ /// \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)
+ RecursiveSoftDrop(double beta,
+ double symmetry_cut,
+ SymmetryMeasure symmetry_measure,
+ int n = -1,
+ double R0 = 1.0,
+ double mu_cut = std::numeric_limits<double>::infinity(),
+ RecursionChoice recursion_choice = larger_pt,
+ const FunctionOfPseudoJet<PseudoJet> * subtractor = 0) :
+ SoftDrop(beta, symmetry_cut, symmetry_measure, R0, mu_cut, recursion_choice, subtractor),
+ _n(n) { set_defaults(); }
+
+ /// default destructor
+ virtual ~RecursiveSoftDrop(){}
+
+ //----------------------------------------------------------------------
+ // access to class info
+ int n() const { return _n; }
+
+ //----------------------------------------------------------------------
+ // on top of the tweaks that we inherit from SoftDrop (via
+ // RecursiveSymmetryBase):
+ // - set_verbose_structure()
+ // - set_subtractor()
+ // - set_input_jet_is_subtracted()
+ // we provide several other knobs, given below
+
+ /// initialise all the flags below to their default value
+ void set_defaults();
+
+ /// switch to using the "same depth" variant where instead of
+ /// recursing from large to small angles and requiring n SD
+ /// conditions to be met (our default), we recurse simultaneously in
+ /// all the branches found during the previous iteration, up to a
+ /// maximum depth of n.
+ /// default: false
+ void set_fixed_depth_mode(bool value=true) { _fixed_depth = value; }
+ bool fixed_depth_mode() const { return _fixed_depth; }
+
+ /// switch to using a dynamical R0 (used for the normalisation of
+ /// the symmetry measure) set by the last deltaR at which some
+ /// substructure was found.
+ /// default: false
+ void set_dynamical_R0(bool value=true) { _dynamical_R0 = value; }
+ bool use_dynamical_R0() const { return _dynamical_R0; }
+
+ /// when finding some substructure, only follow the hardest branch
+ /// for the recursion
+ /// default: false (i.e. recurse in both branches)
+ void set_hardest_branch_only(bool value=true) { _hardest_branch_only = value; }
+ bool use_hardest_branch_only() const { return _hardest_branch_only; }
+
+ /// set the minimum angle (squared) that we should consider for
+ /// substructure
+ /// default: -1.0 (i.e. no minimum)
+ void set_min_deltaR_squared(double value=-1.0) { _min_dR2 = value; }
+ double min_deltaR_squared() const { return _min_dR2; }
+
+ /// description of the tool
+ virtual std::string description() const;
+
+ //----------------------------------------------------------------------
+ /// 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.
+ virtual PseudoJet result(const PseudoJet &jet) const;
+
+ /// 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 result_fixed_tags(const PseudoJet &jet) const;
+
+ /// 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 result_fixed_depth(const PseudoJet &jet) const;
+
+protected:
+ /// return false if we reached desired layer of grooming _n
+ bool continue_grooming(int current_n) const {
+ return ((_n < 0) or (current_n < _n));
+ }
+
+private:
+ int _n; ///< the value of n
+
+ // behaviour tweaks
+ bool _fixed_depth; ///< look in parallel into each all branches until depth n
+ bool _dynamical_R0; ///< when true, use the last deltaR with substructure as D0
+ bool _hardest_branch_only; ///< recurse only in the hardest branch
+ /// when substructure is found
+ double _min_dR2; ///< the min allowed angle to search for substructure
+};
+
+// helper to get the (linear) list of prongs inside a jet resulting
+// from RecursiveSoftDrop. This would avoid having amnually to go
+// through the successive pairwise compositeness
+std::vector<PseudoJet> recursive_soft_drop_prongs(const PseudoJet & rsd_jet);
+
+}
+
+FASTJET_END_NAMESPACE // defined in fastjet/internal/base.hh
+#endif // __RECURSIVESOFTDROP_HH__
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.3/RecursiveSoftDrop.hh
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/example_recursive_softdrop.cc
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/example_recursive_softdrop.cc (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/example_recursive_softdrop.cc (revision 1431)
@@ -0,0 +1,240 @@
+//----------------------------------------------------------------------
+/// \file example_recursive_softdrop.cc
+///
+/// This example program is meant to illustrate how the
+/// fastjet::contrib::RecursiveSoftDrop class is used.
+///
+/// Run this example with
+///
+/// \verbatim
+/// ./example_recursive_softdrop < ../data/single-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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#include <iostream>
+#include <sstream>
+
+#include <iomanip>
+#include <cmath>
+#include "fastjet/ClusterSequence.hh"
+#include "RecursiveSoftDrop.hh" // In external code, this should be fastjet/contrib/RecursiveSoftDrop.hh
+
+using namespace std;
+using namespace fastjet;
+
+// forward declaration to make things clearer
+void read_event(vector<PseudoJet> &event);
+
+void print_prongs_with_clustering_info(const PseudoJet &jet, const string &pprefix);
+void print_raw_prongs(const PseudoJet &jet);
+
+ostream & operator<<(ostream &, const PseudoJet &);
+
+//----------------------------------------------------------------------
+int main(){
+
+ //----------------------------------------------------------
+ // read in input particles
+ vector<PseudoJet> event;
+ read_event(event);
+ cout << "# read an event with " << event.size() << " particles" << endl;
+
+ // first get some anti-kt jets
+ double R = 1.0, ptmin = 100.0;
+ JetDefinition jet_def(antikt_algorithm, R);
+ ClusterSequence cs(event, jet_def);
+ vector<PseudoJet> jets = sorted_by_pt(cs.inclusive_jets(ptmin));
+
+ //----------------------------------------------------------------------
+ // give the soft drop groomer a short name
+ // Use a symmetry cut z > z_cut R^beta
+ // By default, there is no mass-drop requirement
+ double z_cut = 0.2;
+ double beta = 0.5;
+ int n=4; // number of layers (-1 <> infinite)
+ contrib::RecursiveSoftDrop rsd(beta, z_cut, n, R);
+
+ // keep addittional structure info (used below)
+ rsd.set_verbose_structure(true);
+
+ // (optionally) use the same-depth variant
+ //
+ // instead of recursing into the largest Delta R branch until "n+1"
+ // branches hav ebeen found, the same-depth variant recurses n times
+ // into all the branches found in the previous iteration
+ //
+ //rsd.set_fixed_depth_mode();
+
+ // (optionally) use a dynamical R0
+ //
+ // Instead of being normalised by the initial jet radios R0, angles
+ // are notrmalised by the delta R of the previous iteration
+ //
+ rsd.set_dynamical_R0();
+
+ // (optionally) recurse only in the hardest branch
+ //
+ // Instead of recursing into both branches found by the previous
+ // iteration, only keep recursing into the hardest one
+ //
+ //rsd.set_hardest_branch_only();
+
+
+ //----------------------------------------------------------------------
+ cout << "RecursiveSoftDrop groomer is: " << rsd.description() << endl;
+
+ for (unsigned ijet = 0; ijet < jets.size(); ijet++) {
+ // Run SoftDrop and examine the output
+ PseudoJet rsd_jet = rsd(jets[ijet]);
+ cout << endl;
+ cout << "original jet: " << jets[ijet] << endl;
+ cout << "RecursiveSoftDropped jet: " << rsd_jet << endl;
+
+ assert(rsd_jet != 0); //because soft drop is a groomer (not a tagger), it should always return a soft-dropped jet
+
+ // print the prong structure of the jet
+ //
+ // This can be done in 2 ways:
+ //
+ // - either keeping the clustering information and get the
+ // branches as a succession of 2->1 recombinations (this is
+ // done calling "pieces" recursively)
+ cout << endl
+ << "Prongs with clustering information" << endl
+ << "----------------------------------" << endl;
+ print_prongs_with_clustering_info(rsd_jet, " ");
+ //
+ // - or getting all the branches in a single go (done directly
+ // through the jet associated structure)
+ cout << endl
+ << "Prongs without clustering information" << endl
+ << "-------------------------------------" << endl;
+ print_raw_prongs(rsd_jet);
+
+ cout << "Groomed prongs information:" << endl;
+ cout << "index zg thetag" << endl;
+ vector<pair<double, double> > ztg = rsd_jet.structure_of<contrib::RecursiveSoftDrop>().sorted_zg_and_thetag();
+ for (unsigned int i=0; i<ztg.size();++i)
+ cout << setw(5) << i+1
+ << setw(14) << ztg[i].first << setw(14) << ztg[i].second << endl;
+
+ }
+
+ return 0;
+}
+
+//----------------------------------------------------------------------
+// print the prongs inside the jet, showing the clustering info
+void print_prongs_with_clustering_info(const PseudoJet &jet, const string &prefix){
+ if (prefix.size() == 1){
+ cout << fixed << setprecision(4) << " " << setw(14) << " "
+ << setw(8) << "branch" << setw(14) << "branch"
+ << setw(10) << "N_groomed"
+ << setw(11) << "max loc"
+ << setw(22) << "substructure" << endl;
+ cout << " " << setw(14) << " "
+ << setw(8) << "pt" << setw(14) << "mass"
+ << setw(5) << "loc"
+ << setw(5) << "tot"
+ << setw(11) << "zdrop"
+ << setw(11) << "zg"
+ << setw(11) << "thetag"<< endl;
+ }
+ const contrib::RecursiveSoftDrop::StructureType &structure = jet.structure_of<contrib::RecursiveSoftDrop>();
+ double dR = structure.delta_R();
+ cout << " " << left << setw(14) << (prefix.substr(0, prefix.size()-1)+"+--> ") << right
+ << setw(8) << jet.pt() << setw(14) << jet.m()
+ << setw(5) << structure.dropped_count(false)
+ << setw(5) << structure.dropped_count()
+ << setw(11) << structure.max_dropped_symmetry(false);
+
+ if (structure.has_substructure()){
+ cout << setw(11) << structure.symmetry()
+ << setw(11) << structure.delta_R();
+ }
+ cout << endl;
+
+ if (dR>=0){
+ vector<PseudoJet> pieces = jet.pieces();
+ assert(pieces.size()==2);
+ print_prongs_with_clustering_info(pieces[0], prefix+" |");
+ print_prongs_with_clustering_info(pieces[1], prefix+" ");
+ }
+}
+
+//----------------------------------------------------------------------
+// print all the prongs inside the jet (no clustering info)
+void print_raw_prongs(const PseudoJet &jet){
+ cout << "(Raw) list of prongs:" << endl;
+ if (!jet.has_structure_of<contrib::RecursiveSoftDrop>()){
+ cout << " None (bad structure)" << endl;
+ return;
+ }
+
+ cout << setw(5) << " " << setw(11) << "pt" << setw(14) << "mass" << endl;
+
+ vector<PseudoJet> prongs = contrib::recursive_soft_drop_prongs(jet);
+ for (unsigned int iprong=0; iprong<prongs.size(); ++iprong){
+ const PseudoJet & prong = prongs[iprong];
+ const contrib::RecursiveSoftDrop::StructureType &structure = prong.structure_of<contrib::RecursiveSoftDrop>();
+ cout << fixed << setw(5) << iprong << setw(11) << prong.pt() << setw(14) << prong.m() << endl;
+
+ assert(!structure.has_substructure());
+ }
+ cout << endl;
+}
+
+//----------------------------------------------------------------------
+/// read in input particles
+void read_event(vector<PseudoJet> &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 << " pt = " << jet.pt()
+ << " m = " << jet.m()
+ << " y = " << jet.rap()
+ << " phi = " << jet.phi();
+ }
+ return ostr;
+}
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.3/example_recursive_softdrop.cc
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/ChangeLog
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/ChangeLog (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/ChangeLog (revision 1431)
@@ -0,0 +1,738 @@
+2024-10-04 Fri <gavin.salam@physics.ox.ac.uk>
+
+ * VERSION:
+ * NEWS:
+ prepared for release of version 2.0.3
+
+ * RecursiveSoftDrop.hh:
+ added missing #include "fastjet/config.h"; without it the wrong
+ Recluster.hh was being used (contrib rather than fastjet/tools)
+ which was inconsistent with derivation from SoftDrop. This was
+ the cause of a bug reported at https://bugs.gentoo.org/863278
+ and followed up by Eli Schwartz.
+
+ * Recluster.hh:
+ * example_recluster.cc:
+ added comments labelling this contrib/s Recluster.hh as deprecated
+ (but did not explicitly add C++ deprecation warnings yet). Use
+ fastjet::Recluster from "fastjet/tools/Recluster.hh" instead
+ (available since fj 3.1.0).
+
+2024-02-22 Jesse Thaler <jthaler@jthaler.net>
+
+ * Makefile
+ Removing extraneous "-lm"
+
+ * NEWS:
+ * VERSION:
+ Changed version to 2.0.2 in preparation for release.
+
+ * example_recursive_softdrop.cc
+ * example_recursive_softdrop.ref
+ Added "fixed" and "setprecision" to output
+
+2021-08-21 Sat <gavin.salam@physics.ox.ac.uk>
+
+ * NEWS:
+ * VERSION:
+ Changed version to 2.0.1 in preparation for release.
+
+2021-08-16 Mon <gavin.salam@physics.ox.ac.uk>
+
+ * RecursiveSymmetryCutBase.cc:
+ added fix for issue signalled by Pierre-Antoine Delsart
+ (rare divide by zero in calculation of mu2; now mu2 gets set to -1
+ when the parent mass is <= 0)
+
+2018-11-02 Jesse Thaler <jthaler@jthaler.net>
+
+ * AUTHORS: updated journal for RecursiveSoftDrop
+
+2018-10-30 Gregory Soyez <soyez@fastjet.fr>
+
+ * RecursiveSoftDrop.cc:
+ fixed a few typos in comments
+
+ * RecursiveSoftDrop.hh:
+ used the native FJ Recluster tool when available (did create
+ conflicts in some cases)
+
+2018-06-18 Jesse Thaler <jthaler@jthaler.net>
+
+ * README
+ Fixed incorrect order of zcut and beta in the README for SoftDrop example.
+
+2018-05-29 Jesse Thaler <jthaler@jthaler.net>
+
+ * VERSION
+ * NEWS
+ Changed to 2.0.0-beta2, noted in news
+
+2018-04-21 Jesse Thaler <jthaler@jthaler.net>
+
+ * AUTHORS: updated arxiv number for RecursiveSoftDrop
+
+2018-04-21 Gavin Salam <gavin.salam@cern.ch>
+
+ * README: updated arxiv number for RecursiveSoftDrop & Bottom-up
+ Soft Drop.
+
+2018-04-04 Gregory Soyez <soyez@fastjet.fr>
+
+ * RecursiveSoftDrop.cc (contrib):
+ fixed syntax of calls to structure_of<...>
+ (thanks to Attila Krasznahorkay)
+
+2018-01-24 Gregory Soyez <soyez@fastjet.fr>
+
+ * RecursiveSoftDrop.cc:
+ for the (dafault) dynamical R0 implementation, the dynamical R0 is
+ evolved independently in each branch.
+
+2017-10-10 Jesse Thaler <jthaler@jthaler.net>
+ * AUTHORS
+ Added mention of BUSD
+
+ * README
+ Some tweaks to the wording
+
+2017-10-11 Gregory Soyez <soyez@fastjet.fr>
+
+ * IteratedSoftDrop.hh:
+ IteratedSoftDropInfo::size() and multiplicity() now return an
+ unsigned int instead of a double
+
+2017-10-10 Jesse Thaler <jthaler@jthaler.net>
+ * AUTHORS
+ Updated journal reference for ISD
+
+ * example_isd.{cc,ref}:
+ Included soft drop multiplicity in example
+
+ * README
+ Added warning at top that documentation has not been updated
+
+ * VERSION
+ Changed to 2.0.0-beta1
+
+2017-10-10 Gregory Soyez <soyez@fastjet.fr>
+
+ * example_isd.ref:
+ updated to reflect the bugfix below
+
+ * IteratedSoftDrop.cc:
+ fixed issue in description (was taking sqrt of -ve number when
+ there were no angular cut)
+
+ * NEWS:
+ drafted for RecursiveTools-2.0.0-beta1
+
+ * TODO:
+ updated list in view of a beta release
+
+ * example_isd.cc:
+ pointed to the right header for IteratedSoftDrop
+
+ * RecursiveSoftDrop.{hh,cc}:
+ * IteratedSoftDrop.{hh,cc}:
+ moved IteratedSoftDrop to its own file (replacing the old
+ implementation)
+
+ * example_advanced_usage.ref:
+ updated reference file following the fix below.
+
+2017-09-28 Gregory Soyez <soyez@fastjet.fr>
+
+ * RecursiveSymmetryCutBase.cc:
+ when no substructure is found, keep the _symmetry, _delta_R and
+ _mu structure variables at -1. This for example allows one to
+ trigger on substructure by checking if delta_R>=0.
+
+ Note: we could set it to 0 (as it was before) and trigger using
+ _delta_R>0 but there might be some genuine substructure exactly
+ collinear.
+
+2017-09-19 Gregory Soyez <soyez@fastjet.fr>
+
+ * example_isd.ref:
+ updated to the latest version of the example
+
+2017-09-18 Gregory Soyez <soyez@fastjet.fr>
+
+ * Makefile:
+ updating make check to use all the examples (failing on ISD as
+ expected, see below)
+
+ * example_bottomup_softdrop.cc:
+ fixed typo
+
+ * example_bottomup_softdrop.ref:
+ * example_recursive_softdrop.ref:
+ added reference output for this example
+
+ * RecursiveSoftDrop.{hh,cc}:
+ * RecursiveSymmetryCutBase.{cc,hh}:
+ moved the "all_prongs" method from the base structure t oa
+ standalone function in RecursiveSoftDrop.hh
+
+ In practice, this is irrelevant for mMDT and SD (since pieces()
+ gets the job done, and the substructure class does not have (as
+ is) reliable info to get the full structure)
+
+ * RecursiveSymmetryCutBase.cc:
+ revamped a series of requests for substructure info to better
+ handle possible recursion into deeper jet substructure.
+
+ * RecursiveSoftDrop.{hh,cc}:
+ updated "description" to reuse the info from the base class
+
+ * example_isd.cc:
+ updated to use the newer implementation of ISD. Checked that it
+ gives the same results as the former implementation.
+
+ Note: make check still needs fixing because the example now
+ computes a different set of angularities
+
+ * RecursiveSoftDrop.hh:
+ added a few helpers to IteratedSoftDropInfo ([] operator and size,
+ meaning it can be used as a vector<pair<double,double> >)
+
+ * RecursiveSymmetryCutBase.cc:
+ . fixed bugs in the calculation of the geometric distances for ee
+ coordinates
+ . fixed bug in the computation of the (zg,thetag) pairs [it was
+ returning the groomed ones instead of the ones passing the
+ condition]
+
+ * example_recursive_softdrop.cc:
+ set the R0 parameter to the original jet radius
+
+2017-09-13 Gregory Soyez <soyez@fastjet.fr>
+
+ * example_recursive_softdrop.cc:
+ tied up a few comments and the code output
+
+ * RecursiveSymmetryCutBase.{hh,cc}:
+ removed the unneeded _is_composite
+
+ * RecursiveSoftDrop.cc:
+ fixed issue with "verbose" dropped info on branches with no
+ further substructure
+
+2017-09-11 Gregory Soyez <soyez@fastjet.fr>
+
+ * RecursiveSoftDrop.{hh,cc}:
+ have IteratedSoftDDrop returning by default an object of type
+ IteratedSoftDropInfo; added several helpers
+
+2017-09-08 Gregory Soyez <soyez@fastjet.fr>
+
+ * RecursiveSoftDrop.{hh,cc}:
+ updated IteratedSoftDrop to give it the flexibility of
+ RecursiveSoftDrop
+
+ * RecursiveSymmetryCutBase.hh:
+ fixed typo in comment
+
+ * example_mmdt_ee.cc: *** ADDED ***
+ added an example to illustrat usage in ee collisions
+
+ * example_isd.cc:
+ * BottomUpSoftDrop.cc:
+ * IteratedSoftDrop.cc:
+ * RecursiveSoftDrop.cc:
+ Fixed compilation issues with FJ 3.0 (mostly the usage of features
+ introduced only in FJ3.1)
+
+ * RecursiveSymmetryCutBase.{hh,cc}:
+ used the internal Recluster class for FJ<3.1.0 and the FJ antive
+ one for FJ>=3.1.0
+
+ * BottomUpSoftDrop.{hh,cc}:
+ moved the implementation of global_grooming to the source file and
+ fixed a few trivial compilation errors
+
+2017-09-08 Frédéric Dreyer <frederic.dreyer@gmail.com>
+
+ * BottomUpSoftDrop.hh:
+ added the global_grooming method to process full event
+
+2017-09-07 Gregory Soyez <soyez@fastjet.fr>
+
+ * RecursiveSoftDrop.cc:
+ cleaned (mostly by removing older commented-out code)
+
+ * RecursiveSoftDrop.{hh,cc}:
+ * RecursiveSymmetryCutBase.{hh,cc}:
+ * SoftDrop.cc:
+
+ added support for ee coordinates. For that, the symmetry measure
+ has to be set to either theta_E (which uses the 3-vector angle
+ theta) or to cos_theta_E which uses sqrt(2*[1-cos(theta)])
+
+ Accordingly, the recursion_choice can be set to larger_E to
+ recurse into the branch with the largest energy. The larger_m
+ mode, recorsing into the larger-mass branch is also possible but
+ not advised (for the same reason as the pp version).
+
+ * RecursiveSymmetryCutBase.{hh,cc}:
+ switched to the Recluster class provided with FastJet. ASlso
+ included the recluster description to RecursiveSymmetryCutBase
+ when it is user-defined.
+
+2017-09-06 Gregory Soyez <soyez@fastjet.fr>
+
+ * BottomUpSoftDrop.{hh,cc}:
+ . renamed SoftDropStructure -> BottomUpSoftDropStructure
+ SoftDropRecombiner -> BottomUpSoftDropRecombiner
+ SoftDropPlugin -> BottomUpSoftDropPlugin
+ . moved 'description' to source file (instead of header)
+ . kept the "area" information when available (jets will just
+ appear as having a 0 area)
+ . added most class description (main class still missing)
+
+ * RecursiveSoftDrop.cc:
+ . put internal classes to handle CS history in an internal namespace
+ . replaced the "switch" in the mail loop by a series of if (allows
+ us a few simplificatins/cleaning)
+ . more uniform treatment of issues in the presence of an angular cut
+ (as part of the above reorganisation)
+
+ * example_advanced_usage.ref:
+ updated reference output file following the bugfix (missing
+ "grooming mode" initialisation in one of the SoftDrop ctors) on
+ 2017-08-01
+
+ * RecursiveSymmetryCutBase.cc:
+ removed redundent code
+
+2017-08-10 Gregory Soyez <soyez@fastjet.fr>
+
+ * RecursiveSoftDrop.cc:
+ fixed trivial typo in variable name
+
+>>>>>>> .r1071
+2017-08-04 Gregory Soyez <soyez@fastjet.fr>
+
+ * RecursiveSoftDrop.cc:
+ do not impose an angular cut in IterativeSD if it is -ve.
+
+2017-08-01 Gregory Soyez <soyez@fastjet.fr>
+
+ * example_recursive_softdrop.cc:
+ added a series of optional flags
+
+ * RecursiveSoftDrop.cc:
+ fixed a few issues with the fixed depth version
+
+ * RecursiveSymmetryCutBase.hh:
+ a jet is now considered as havig substructure if deltaR>0
+ (coherent with released version)
+
+ * SoftDrop.hh:
+ bugfix: set the "grooming mode" by default in all ctors
+ EDIT: caused issue with make check, fixed on 2017-09-069 (see
+ above)
+
+ * RecursiveSoftDrop.{hh,cc}:
+ added support for the "same depth" variant
+
+ * RecursiveSymmetryCutBase.cc:
+ also associate a RecursiveSymmetryCutBase::StructureType structure
+ to the result jet in case it is just a single particle (in
+ grooming mode)
+
+2017-07-31 Gregory Soyez <soyez@fastjet.fr>
+
+ * RecursiveSymmetryCutBase.{hh,cc}:
+ added the option to pass an extra parameter to the symmetry cut
+ function
+
+ * RecursiveSymmetryCutBase.{hh,cc}:
+ * ModifiedMassDropTagger.hh
+ * SoftDrop.hh:
+ minor adaptions due to the above change + added a few methods to
+ query the class information (symmetry cut, beta, ...)
+
+ * RecursiveSoftDrop.{hh,cc}:
+ Added support for
+ - a dynamical R0
+ - recursing only in the hardest branch
+ - imposing a min deltaR cut
+
+ Added a tentative IterativeSoftDrop class
+
+2017-07-28 Gregory Soyez <soyez@fastjet.fr>
+
+ * RecursiveSoftDrop.cc:
+ adapted to the latest changes in RecursiveSymmetryCutBase
+
+ * RecursiveSymmetryCutBase.{hh,cc}:
+ reorganised the output of the recursion step (recurse_one_step)
+ using an enum to make iot more readable (and to fix issues where
+ the dropped prong is actually 0, e.g. after subtraction)
+
+2017-07-26 Gregory Soyez <soyez@fastjet.fr>
+
+ * example_recursive_softdrop.cc: *** ADDED ***
+ added a draft example for the use of RecursiveSoftDrop
+
+ * RecursiveSoftDrop.{hh,cc}: *** ADDED ***
+ added a first pass at an implementation of RecursiveSoftDrop.
+
+ This is based on Frederic's initial version but keeps the
+ branching structure of the jet. Some of the features, like
+ dynamical R0, direct access to the substructure or the same depth
+ variant, are still unsupported.
+
+ * SoftDrop.hh:
+ declared _beta, _symmetry_cut and _R0sqr as protected (was
+ private) so they ca n be used by RecursiveSoftDrop
+
+ * RecursiveSymmetryCutBase.{hh,cc}:
+ extracted from result() the part that performs one step of the
+ resursion (implemented as recurse_one_step()). This is repeatedly
+ called by result(). It has specific conventions to indicate
+ whether or not some substructure has been found or if one ran into
+ some issue.
+
+2017-04-25 Kevin Zhou <knzhou@mit.edu>
+
+ * IteratedSoftDrop.hh
+ . Added Doxygen documentation
+
+ * RecursiveSymmetryCutBase.hh
+ . Added references to ISD
+
+2017-04-25 Jesse Thaler <jthaler@jthaler.net>
+ * AUTHORS, COPYING:
+ . Added ISD arXiv number
+
+ * example_isd.{cc,ref}
+ . Added ISD arXiv number
+ . Changing z_cut to be optimal value (with Lambda = 1 GeV)
+ . Tweaked formatting
+
+ * IteratedSoftDrop.{hh,cc}
+ . Added ISD arXiv number
+ . Assert added if recluster does not return one jet.
+
+ * README
+ . Added ISD arXiv number and tweaked wording
+
+
+2017-04-20 Kevin Zhou <knzhou@mit.edu>
+
+ * example_isd.{cc,ref} ** ADDED **
+ * IteratedSoftDrop.{cc,hh} ** ADDED **
+
+ * Makefile
+ . Added IteratedSoftDrop (ISD) as appropriate
+
+ * AUTHORS
+ . Added myself to author list
+ . Added placeholder for ISD paper
+
+ * COPYING
+ . Added placeholder for ISD paper
+
+ * README
+ . Added description of ISD
+
+ * TODO
+ . Added tasks to integrate ISD with other classes, e.g. SD,
+ Recluster, and the future RecursiveSoftDrop (RSD)
+
+ * NEWS
+ . Added dummy for release of 1.1.0
+
+ * VERSION:
+ . Switched version number to 1.1.0-dev
+
+ * example_advanced_usage.cc:
+ . Added $Id$ tag, didn't change anything else
+
+2014-07-30 Gregory Soyez <soyez@fastjet.fr>
+
+ * Recluster.hh: fixed the name of the #define for the header
+
+2014-07-09 Gregory Soyez <soyez@fastjet.fr> + Jesse
+
+ * NEWS:
+ release of RecursiveTools v1.0.0
+
+ * VERSION:
+ switched version number to 1.0.0
+
+2014-07-08 Gavin Salam <gavin.salam@cern.ch>
+
+ * README (RecursionChoice):
+ added ref to .hh for constness specs of virtual functions (to
+ reduce risk of failed overloading due to wrong constness).
+
+2014-07-08 Gregory Soyez <soyez@fastjet.fr> + Jesse
+
+ * README:
+ partially rewrote the description of set_subtractor
+
+2014-07-07 Gregory Soyez <soyez@fastjet.fr> + Jesse
+
+ * example_advanced_usage.cc:
+ * example_softdrop.cc:
+ a few small fixed in the header of the files
+
+ * VERSION:
+ switched over to 1.0.0-alpha2-devel
+
+ * README:
+ Reordered a few things and added a few details.
+
+ * Makefile (check):
+ Be quiter during "make check"
+
+ * Recluster.cc (contrib):
+ Documented the "single" ctor argument
+
+ * RecursiveSymmetryCutBase.cc (contrib):
+ If the user sets himself the reclustering, disable the "non-CA"
+ warning (we assume that he knows what he is doing). Mentioned in
+ the comments that non-CA reclustering has to be used at the user's
+ risk. Also throw when th input jet has no constituents or when
+ there is no cluster sequence after reclustering.
+
+ * Recluster.cc (contrib):
+ replaced a remaining mention to "filtering" by reclustering
+
+2014-07-04 Jesse Thaler <jthaler@jthaler.net>
+ * VERSION
+ . Ready for alpha release
+
+2014-06-17 Jesse Thaler <jthaler@jthaler.net>
+ * example_advanced_usage.{cc,ref} ** ADDED **
+ * Makefile
+ . New example file to test a bunch of soft drop options
+ . Put in makefile as well
+ . Fixed nasty memory bug with pointers to Recluster
+
+ * RecursiveSymmetryCutBase.cc
+ * example_softdrop.ref
+ . description() now says Groomer vs. Tagger
+
+ * RecursiveSymmetryCutBase.{cc,hh}
+ . Added optional verbose logging information about
+ kinematics of dropped branches
+
+ * example_softdrop.cc
+ * example_advanced_usage.cc
+ . Fixed
+
+
+2014-06-16 Gregory Soyez <soyez@fastjet.fr>
+
+ * Makefile:
+ also install the RecursiveSymmetryuCutBase.hh header
+
+2014-06-13 Jesse Thaler <jthaler@jthaler.net>
+ * AUTHORS
+ . Added myself to author list
+ . Put complete bibliographic details on papers
+
+ * COPYING
+ . Added boilerplate MC/GPLv2 statement
+
+ * example.cc: ** REMOVED ** renamed to...
+ * example_mmdt.cc ** ADDED **
+ * Makefile
+ . Made name change for consistency
+ . Made corresponding changes in Makefile
+
+ * example_mmdt_sub.cc:
+ * example_mmdt.cc:
+ * example_recluster.cc:
+ . light editing of comments
+
+ * example_softdrop.cc:
+ . light editing of comments
+ . added assert for sdjet != 0, since SoftDrop is a groomer
+
+ * ModifiedMassDropTagger.hh
+ * Recluster.{cc,hh}
+ * RecursiveSymmetryCutBase.{cc,hh}
+ * SoftDrop.hh
+ . Updated some comments
+
+ * README
+ . Updated to include basic usage description and some
+ technical details
+
+ * TODO:
+ . Added some discussion points.
+
+2014-06-13 Gregory Soyez <soyez@fastjet.fr>
+
+ * example_softdrop.{cc,ref}:
+ added an example for SoftDrop
+
+ * SoftDrop.{hh,cc}:
+ * ModifiedMassDropTagger.{hh,cc}:
+ * RecursiveSymmetryCutBase.{hh,cc}: *** ADDED ***
+ . added a base class for both the mMDT and SoftDrop
+ . made mMDT and SoftDrop inherit from RecursiveSymmetryCutBase
+ . moved the reclustering to the base class. By default, both
+ mMDT and SoftDrop now recluster the jet with C/A
+ . added set_grooming_mode and set_tagging_mode methods to the
+ base class
+
+ * Merging the development branch 1.0-beta1-softdrop-addition back
+ into the trunk (will correspond to revision 682)
+
+ * VERSION:
+ switched back to 1.0.0-devel
+
+ * SoftDrop.{hh,cc}:
+ added support for re-clustering through set_reclustering(bool,
+ Recluster*). By default, reclustering is done with
+ Cambridge/Aachen.
+
+ * example_recluster.{cc,ref}: *** ADDED ***
+ added an example of reclustering
+
+ * Recluster.{hh,cc}:
+ added a 'single' ctor argument [true by default]. When true, the
+ hardest jet after reclustering is returned, otherwise, the result
+ is a composite jet with all the subjets as its pieces.
+
+2014-05-15 Gregory Soyez <soyez@fastjet.fr>
+
+ * VERSION:
+ set version number to 1.0-alpha-PUWS14.1 in preparation for a
+ fastjet-contrib release for the pileup-workshop at CERN on May
+ 2014.
+
+2014-04-25 Gregory Soyez <soyez@fastjet.fr>
+
+ * ModifiedMassDropTagger.hh:
+ * ModifiedMassDropTagger.cc:
+ Added comments at various places
+
+ * AUTHORS:
+ * README:
+ Updated info about what is now included in this contrib
+
+ * SoftDrop.hh: *** ADDED ***
+ * SoftDrop.cc: *** ADDED ***
+ * Recluster.hh: *** ADDED ***
+ * Recluster.cc; *** ADDED ***
+ Added tools for reclustering and softDrop
+
+2014-04-25 Gregory Soyez <soyez@fastjet.fr>
+
+ branch started at revision 611 to start including SoftDrop in the
+ Recursivetols contrib
+
+2014-04-24 Gregory Soyez <soyez@fastjet.fr>
+
+ * ModifiedMassDropTagger.hh:
+ added a mention of the fact that when result is called in the
+ presence of a subtractor, then the output is a subtracted
+ PseudoJet.
+
+ * ModifiedMassDropTagger.hh:
+ declared _symmetry_cut as protected (rather than provate) so it
+ can be accessed if symmetry_cut_description() is overloaded.
+
+ * example.cc:
+ trivial typo fixed in a comment
+
+2014-02-04 Gavin Salam <gavin.salam@cern.ch>
+
+ * VERSION:
+ upped it to 1.0-beta1
+
+ * example_mmdt_sub.cc (main):
+ added an #if to make sure FJ3.1 features are only used if FJ3.1
+ is available. (Currently FJ3.1 is only available to FJ developers).
+
+2014-01-26 Gavin Salam <gavin.salam@cern.ch>
+
+ * VERSION:
+ renamed to 1.0-beta0
+
+ * ModifiedMassDropTagger.hh:
+ * README:
+ added info on author names
+
+ * example_mmdt_sub.ref: *** ADDED ***
+ added reference output for the pileup test.
+
+2014-01-25 Gavin Salam <gavin.salam@cern.ch>
+
+ * example_mmdt_sub.cc:
+ * Makefile:
+ added an extra example illustrating functionality with pileup
+ subtraction.
+
+2014-01-24 Gavin Salam <gavin.salam@cern.ch>
+
+ * ModifiedMassDropTagger.cc:
+
+ Reorganised code so that (sub)jet.m2()>0 check is only used when
+ absolutely necessary: so if using a scalar_z symmetry measure,
+ whenever scalar_z < zcut, then there is no point checking the mu
+ condition. This means that there's no issue if the (sub)jet mass
+ is negative, and one simply recurses down into the jet. (Whereas
+ before it would bail out, reducing the tagging efficiency).
+
+ Also removed the verbose code.
+
+2014-01-23 Gavin Salam <gavin.salam@cern.ch>
+
+ * ModifiedMassDropTagger.cc|hh:
+ * example.cc
+ replaced "asymmetry" with "symmetry" in a number of places;
+ implemented the structural information and added it to the example;
+ added a new simplified constructor;
+ improved doxygen documentation;
+ started renaming -> RecursiveTools
+
+ * README
+ some tidying
+
+ * VERSION
+ 1.0-b0
+
+2014-01-22 Gavin Salam <gavin.salam@cern.ch>
+
+ * ModifiedMassDropTagger.cc (contrib):
+ -ve mass now bails out also when using the "y" asymmetry measure.
+ Also, default my is now infinite.
+
+2014-01-20 Gavin Salam <gavin.salam@cern.ch> + Gregory
+
+
+ * ModifiedMassDropTagger.cc|hh:
+ introduced a virtual asymmetry_cut_fn (essentially a
+ dummy function returning a constant), to allow for derived classes
+ to do fancier things.
+
+ added warning about non-C/A clustering.
+ explicitly labelled some (inherited) virtual functions as
+ virtual.
+
+2014-01-20 Gavin Salam <gavin.salam@cern.ch>
+
+ * example.ref:
+ * example.cc (main):
+ got a first working example and make check setup.
+
+ * ModifiedMassDropTagger.cc|hh:
+ improved doxygen comments;
+ added option whereby input jet is assumed already subtracted
+
+2014-01-19 Gavin Salam <gavin.salam@cern.ch>
+
+ * ModifiedMassDropTagger.cc|hh:
+ * many other files
+
+ Initial creation, with basic code for MMDT
+
Index: contrib/contribs/RecursiveTools/tags/2.0.3/example_advanced_usage.cc
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/example_advanced_usage.cc (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/example_advanced_usage.cc (revision 1431)
@@ -0,0 +1,362 @@
+//----------------------------------------------------------------------
+/// \file example_advanced_usage.cc
+///
+/// This example program is meant to illustrate some advanced features
+/// of the fastjet::contrib::SoftDrop class is used.
+///
+/// Run this example with
+///
+/// \verbatim
+/// ./example_advanced_usage < ../data/single-event.dat
+/// \endverbatim
+//----------------------------------------------------------------------
+
+// $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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#include <iostream>
+#include <sstream>
+
+#include <sstream>
+#include <iomanip>
+#include <cmath>
+#include "fastjet/ClusterSequence.hh"
+#include "SoftDrop.hh" // In external code, this should be fastjet/contrib/SoftDrop.hh
+
+#define MY_INF std::numeric_limits<double>::infinity()
+
+using namespace std;
+using namespace fastjet;
+using namespace fastjet::contrib;
+
+// forward declaration to make things clearer
+void read_event(vector<PseudoJet> &event);
+ostream & operator<<(ostream &, const PseudoJet &);
+
+// Simple class to store SoftDrop objects along with display information
+class SoftDropStruct {
+
+private:
+ string _name;
+ double _beta;
+ double _z_cut;
+ SoftDrop::SymmetryMeasure _symmetry_measure;
+ double _R0;
+ double _mu; //mass drop
+ SoftDrop::RecursionChoice _recursion_choice;
+ JetAlgorithm _recluster_algorithm;
+ bool _tagging_mode;
+ SoftDrop _soft_drop;
+ Recluster _reclusterer;
+
+public:
+ SoftDropStruct(string name,
+ double beta,
+ double z_cut,
+ SoftDrop::SymmetryMeasure symmetry_measure,
+ double R0,
+ double mu,
+ SoftDrop::RecursionChoice recursion_choice,
+ JetAlgorithm recluster_algorithm,
+ bool tagging_mode = false)
+ : _name(name),
+ _beta(beta),
+ _z_cut(z_cut),
+ _symmetry_measure(symmetry_measure),
+ _R0(R0),
+ _mu(mu),
+ _recursion_choice(recursion_choice),
+ _recluster_algorithm(recluster_algorithm),
+ _tagging_mode(tagging_mode),
+ _soft_drop(beta,z_cut,symmetry_measure,R0,mu,recursion_choice),
+ _reclusterer(recluster_algorithm,JetDefinition::max_allowable_R)
+ {
+ // no need to recluser if already CA algorithm
+ if (recluster_algorithm != cambridge_algorithm) {
+ _soft_drop.set_reclustering(true,&_reclusterer);
+ }
+
+ // if beta is negative, typically want to use in tagging mode
+ // MMDT behavior is also tagging mode
+ // set this option here
+ if (tagging_mode) {
+ _soft_drop.set_tagging_mode();
+ }
+
+ //turn verbose structure on (off by default)
+ _soft_drop.set_verbose_structure();
+ }
+
+ const SoftDrop& soft_drop() const { return _soft_drop;}
+ string name() const { return _name;}
+ double beta() const { return _beta;}
+ double z_cut() const { return _z_cut;}
+ string symmetry_measure_name() const {
+ switch (_symmetry_measure) {
+ case SoftDrop::scalar_z:
+ return "scalar_z";
+ case SoftDrop::vector_z:
+ return "vector_z";
+ case SoftDrop::y:
+ return "y";
+ default:
+ return "unknown";
+ }
+ }
+ double R0() const { return _R0;}
+ double mu() const { return _mu;}
+
+ string recursion_choice_name() const {
+ switch (_recursion_choice) {
+ case SoftDrop::larger_pt:
+ return "larger_pt";
+ case SoftDrop::larger_mt:
+ return "larger_mt";
+ case SoftDrop::larger_m:
+ return "larger_m";
+ default:
+ return "unknown";
+ }
+ }
+
+ string reclustering_name() const {
+ switch (_recluster_algorithm) {
+ case kt_algorithm:
+ return "KT";
+ case cambridge_algorithm:
+ return "CA";
+ default:
+ return "unknown";
+ }
+ }
+
+ string tag_or_groom() const {
+ return (_tagging_mode ? "tag" : "groom");
+ }
+
+};
+
+
+//----------------------------------------------------------------------
+int main(){
+
+ //----------------------------------------------------------
+ // read in input particles
+ vector<PseudoJet> event;
+ read_event(event);
+ cout << "# read an event with " << event.size() << " particles" << endl;
+
+ // first get some anti-kt jets
+ double R = 1.0, ptmin = 20.0;
+ JetDefinition jet_def(antikt_algorithm, R);
+ ClusterSequence cs(event, jet_def);
+ vector<PseudoJet> jets = sorted_by_pt(cs.inclusive_jets(ptmin));
+
+
+ //----------------------------------------------------------
+ // Make vector of structs to store a bunch of different SoftDrop options
+ // This is a vector of pointers because SoftDropStruct doesn't
+ // have a valid copy constructor
+ vector<SoftDropStruct *> sd_vec;
+
+ // make some standard SoftDrop
+ sd_vec.push_back(new SoftDropStruct("beta=2.0 zcut=.1", 2.0,0.10,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,cambridge_algorithm));
+ sd_vec.push_back(new SoftDropStruct("beta=1.0 zcut=.1", 1.0,0.10,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,cambridge_algorithm));
+ sd_vec.push_back(new SoftDropStruct("beta=0.5 zcut=.1", 0.5,0.10,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,cambridge_algorithm));
+ sd_vec.push_back(new SoftDropStruct("beta=2.0 zcut=.2", 2.0,0.20,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,cambridge_algorithm));
+ sd_vec.push_back(new SoftDropStruct("beta=1.0 zcut=.2", 1.0,0.20,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,cambridge_algorithm));
+ sd_vec.push_back(new SoftDropStruct("beta=0.5 zcut=.2", 0.5,0.20,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,cambridge_algorithm));
+
+ // make a mMDT-like tagger using SoftDrop
+ sd_vec.push_back(new SoftDropStruct("MMDT-like zcut=.1", 0.0,0.10,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,cambridge_algorithm,true));
+ sd_vec.push_back(new SoftDropStruct("MMDT-like zcut=.2", 0.0,0.20,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,cambridge_algorithm,true));
+ sd_vec.push_back(new SoftDropStruct("MMDT-like zcut=.3", 0.0,0.30,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,cambridge_algorithm,true));
+ sd_vec.push_back(new SoftDropStruct("MMDT-like zcut=.4", 0.0,0.40,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,cambridge_algorithm,true));
+
+ // make some tagging SoftDrop (negative beta)
+ sd_vec.push_back(new SoftDropStruct("beta=-2.0 zcut=.05", -2.0,0.05,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,cambridge_algorithm,true));
+ sd_vec.push_back(new SoftDropStruct("beta=-1.0 zcut=.05", -1.0,0.05,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,cambridge_algorithm,true));
+ sd_vec.push_back(new SoftDropStruct("beta=-0.5 zcut=.05", -0.5,0.05,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,cambridge_algorithm,true));
+
+ // make a SoftDrop with R0 parameter
+ sd_vec.push_back(new SoftDropStruct("b=.5 z=.3 R0=1.0", 0.5,0.30,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,cambridge_algorithm));
+ sd_vec.push_back(new SoftDropStruct("b=.5 z=.3 R0=0.5", 0.5,0.30,SoftDrop::scalar_z,0.5,MY_INF,SoftDrop::larger_pt,cambridge_algorithm));
+ sd_vec.push_back(new SoftDropStruct("b=.5 z=.3 R0=0.2", 0.5,0.30,SoftDrop::scalar_z,0.2,MY_INF,SoftDrop::larger_pt,cambridge_algorithm));
+
+ // make a SoftDrop with different symmetry measure
+ sd_vec.push_back(new SoftDropStruct("b=2 z=.4 scalar_z", 2.0,0.4,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,cambridge_algorithm));
+ sd_vec.push_back(new SoftDropStruct("b=2 z=.4 vector_z", 2.0,0.4,SoftDrop::vector_z,1.0,MY_INF,SoftDrop::larger_pt,cambridge_algorithm));
+ sd_vec.push_back(new SoftDropStruct("b=2 z=.4 y", 2.0,0.4,SoftDrop::y, 1.0,MY_INF,SoftDrop::larger_pt,cambridge_algorithm));
+
+ // make a SoftDrop with different recursion choice
+ sd_vec.push_back(new SoftDropStruct("b=3 z=.2 larger_pt", 3.0,0.20,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,cambridge_algorithm));
+ sd_vec.push_back(new SoftDropStruct("b=3 z=.2 larger_mt", 3.0,0.20,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_mt,cambridge_algorithm));
+ sd_vec.push_back(new SoftDropStruct("b=3 z=.2 larger_m", 3.0,0.20,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_m,cambridge_algorithm));
+
+ // make a SoftDrop with mass drop
+ sd_vec.push_back(new SoftDropStruct("b=2 z=.1 mu=1.0", 2.0,0.10,SoftDrop::scalar_z,1.0,1.0,SoftDrop::larger_pt,cambridge_algorithm));
+ sd_vec.push_back(new SoftDropStruct("b=2 z=.1 mu=0.8", 2.0,0.10,SoftDrop::scalar_z,1.0,0.8,SoftDrop::larger_pt,cambridge_algorithm));
+ sd_vec.push_back(new SoftDropStruct("b=2 z=.1 mu=0.5", 2.0,0.10,SoftDrop::scalar_z,1.0,0.5,SoftDrop::larger_pt,cambridge_algorithm));
+
+ // make a SoftDrop with a different clustering scheme (kT instead of default CA)
+ sd_vec.push_back(new SoftDropStruct("b=2.0 z=.2 kT", 2.0,0.20,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,kt_algorithm));
+ sd_vec.push_back(new SoftDropStruct("b=1.0 z=.2 kT", 1.0,0.20,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,kt_algorithm));
+ sd_vec.push_back(new SoftDropStruct("b=0.5 z=.2 kT", 0.5,0.20,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,kt_algorithm));
+ sd_vec.push_back(new SoftDropStruct("b=2.0 z=.4 kT", 2.0,0.40,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,kt_algorithm));
+ sd_vec.push_back(new SoftDropStruct("b=1.0 z=.4 kT", 1.0,0.40,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,kt_algorithm));
+ sd_vec.push_back(new SoftDropStruct("b=0.5 z=.4 kT", 0.5,0.40,SoftDrop::scalar_z,1.0,MY_INF,SoftDrop::larger_pt,kt_algorithm));
+
+ //----------------------------------------------------------
+ // Output information about the various Soft Drop algorithms
+
+
+ // header lines
+ cout << "---------------------------------------------------------------------------------------------" << endl;
+ cout << "Soft Drops to be tested:" << endl;
+ cout << "---------------------------------------------------------------------------------------------" << endl;
+ cout << std::setw(18) << "name"
+ << std::setw(8) << "beta"
+ << std::setw(8) << "z_cut"
+ << std::setw(9) << "sym"
+ << std::setw(8) << "R0"
+ << std::setw(8) << "mu"
+ << std::setw(10)<< "recurse"
+ << std::setw(8) << "reclust"
+ << std::setw(8) << "mode"
+ << endl;
+
+ // set precision for display
+ cout << setprecision(3) << fixed;
+
+ // line for each SoftDrop
+ for (unsigned i_sd = 0; i_sd < sd_vec.size(); i_sd++) {
+ cout << std::setw(18) << sd_vec[i_sd]->name()
+ << std::setw(8) << sd_vec[i_sd]->beta()
+ << std::setw(8) << sd_vec[i_sd]->z_cut()
+ << std::setw(9) << sd_vec[i_sd]->symmetry_measure_name()
+ << std::setw(8) << sd_vec[i_sd]->R0()
+ << std::setw(8) << sd_vec[i_sd]->mu()
+ << std::setw(10)<< sd_vec[i_sd]->recursion_choice_name()
+ << std::setw(8) << sd_vec[i_sd]->reclustering_name()
+ << std::setw(8) << sd_vec[i_sd]->tag_or_groom()
+ << endl;
+ }
+ cout << "---------------------------------------------------------------------------------------------" << endl;
+
+
+
+ for (unsigned ijet = 0; ijet < jets.size(); ijet++) {
+
+ cout << "---------------------------------------------------------------------------------------------" << endl;
+ cout << "Analyzing Jet " << ijet + 1 << ":" << endl;
+ cout << "---------------------------------------------------------------------------------------------" << endl;
+
+ cout << std::setw(18) << "name"
+ << std::setw(10) << "pt"
+ << std::setw(9) << "m"
+ << std::setw(8) << "y"
+ << std::setw(8) << "phi"
+ << std::setw(8) << "constit"
+ << std::setw(8) << "delta_R"
+ << std::setw(8) << "sym"
+ << std::setw(8) << "mu"
+ << std::setw(8) << "mxdropz" // max_dropped_z from verbose logging
+
+ << endl;
+
+ PseudoJet original_jet = jets[ijet];
+
+ // set precision for display
+ cout << setprecision(4) << fixed;
+
+ cout << std::setw(18) << "Original Jet"
+ << std::setw(10) << original_jet.pt()
+ << std::setw(9) << original_jet.m()
+ << std::setw(8) << original_jet.rap()
+ << std::setw(8) << original_jet.phi()
+ << std::setw(8) << original_jet.constituents().size()
+ << endl;
+
+ for (unsigned i_sd = 0; i_sd < sd_vec.size(); i_sd++) {
+ // the current Soft Drop
+ const SoftDrop & sd = (*sd_vec[i_sd]).soft_drop();
+ PseudoJet sd_jet = sd(jets[ijet]);
+
+ cout << std::setw(18) << sd_vec[i_sd]->name();
+ if (sd_jet != 0.0) {
+ cout << std::setw(10) << sd_jet.pt()
+ << std::setw(9) << sd_jet.m()
+ << std::setw(8) << sd_jet.rap()
+ << std::setw(8) << sd_jet.phi()
+ << std::setw(8) << sd_jet.constituents().size()
+ << std::setw(8) << sd_jet.structure_of<contrib::SoftDrop>().delta_R()
+ << std::setw(8) << sd_jet.structure_of<contrib::SoftDrop>().symmetry()
+ << std::setw(8) << sd_jet.structure_of<contrib::SoftDrop>().mu()
+ // the next line is part of the verbose information that is off by default
+ << std::setw(8) << sd_jet.structure_of<contrib::SoftDrop>().max_dropped_symmetry();
+ } else {
+ cout << " ---- untagged jet ----";
+ }
+ cout << endl;
+
+ }
+ }
+
+ // clean up
+ for (unsigned i_sd = 0; i_sd < sd_vec.size(); i_sd++) {
+ delete sd_vec[i_sd];
+ }
+
+ return 0;
+}
+
+//----------------------------------------------------------------------
+/// read in input particles
+void read_event(vector<PseudoJet> &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 << " pt = " << jet.pt()
+ << " m = " << jet.m()
+ << " y = " << jet.rap()
+ << " phi = " << jet.phi();
+ }
+ return ostr;
+}
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.3/example_advanced_usage.cc
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/README
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/README (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/README (revision 1431)
@@ -0,0 +1,358 @@
+------------------------------------------------------------------------
+RecursiveTools FastJet contrib
+------------------------------------------------------------------------
+
+The RecursiveTools FastJet contrib aims to provide a common contrib
+for a number of tools that involve recursive reclustering/declustering
+of a jet for tagging or grooming purposes.
+
+Currently it contains:
+
+- ModifiedMassDropTagger
+ This corresponds to arXiv:1307.0007 by Mrinal Dasgupta, Alessandro
+ Fregoso, Simone Marzani and Gavin P. Salam
+
+- SoftDrop
+ This corresponds to arXiv:1402.2657 by Andrew J. Larkoski, Simone
+ Marzani, Gregory Soyez, Jesse Thaler
+
+- RecursiveSoftDrop
+- BottomUpSoftDrop
+ This corresponds to arXiv:1804.03657 by Frederic Dreyer, Lina
+ Necib, Gregory Soyez and Jesse Thaler
+
+- IteratedSoftDrop
+ This corresponds to arXiv:1704.06266 by Christopher Frye, Andrew J.
+ Larkoski, Jesse Thaler, Kevin Zhou
+
+- Recluster
+ A generic tool to recluster a given jet into subjets
+ Note: a Recluster class is available natively in FastJet since v3.1.
+ Users are therefore encouraged to use the FastJet version
+ rather than this one which is mostly provided for
+ compatibility of this contrib with older versions of FastJet.
+
+The interface for these tools is described in more detail below, with
+all of the available options documented in the header files.
+
+One note about nomenclature. A groomer is a procedure that takes a
+PseudoJet and always returns another (non-zero) PseudoJet. A tagger is
+a procedure that takes a PseudoJet, and either returns another PseudoJet
+(i.e. tags it) or returns an empty PseudoJet (i.e. doesn't tag it).
+
+------------------------------------------------------------------------
+ModifiedMassDropTagger
+------------------------------------------------------------------------
+
+The Modified Mass Drop Tagger (mMDT) recursively declusters a jet,
+following the largest pT subjet until a pair of subjets is found that
+satisfy the symmetry condition on the energy sharing
+
+ z > z_cut
+
+where z_cut is a predetermined value. By default, z is calculated as
+the scalar pT fraction of the softest subjet. Note that larger values
+of z_cut correspond to a more restrictive tagging criteria.
+
+By default, mMDT will first recluster the jet using the CA clustering
+algorithm, which means that mMDT can be called on any jet, regardless
+of the original jet finding measure.
+
+A default mMDT can be created via
+
+ double z_cut = 0.10;
+ ModifiedMassDropTagger mMDT(z_cut);
+
+More options are available in the full constructor. To apply mMDT,
+one simply calls it on the jet of interest.
+
+ PseudoJet tagged_jet = mMDT(original_jet);
+
+Note that mMDT is a tagger, such that tagged_jet will only be non-zero
+if the symmetry cut z > z_cut is satisfied by some branching of the
+clustering tree.
+
+To gain additional information about the mMDT procedure, one can use
+
+ tagged_jet.structure_of<ModifiedMassDropTagger>()
+
+which gives access to information about the delta_R between the tagged
+subjets, their z value, etc.
+
+------------------------------------------------------------------------
+SoftDrop
+------------------------------------------------------------------------
+
+The SoftDrop procedure is very similar to mMDT, albeit with a
+generalised symmetry condition:
+
+ z > z_cut * (R / R0)^beta
+
+Note that larger z_cut and smaller beta correspond to more aggressive
+grooming of the jet.
+
+SoftDrop is intended to be used as a groomer (instead of as a tagger),
+such that if the symmetry condition fails throughout the whole
+clustering tree, SoftDrop will still return a single particle in the
+end. Apart from the tagger/groomer distinction, SoftDrop with beta=0 is
+the same as mMDT.
+
+A default SoftDrop groomer can be created via:
+
+ double beta = 2.0;
+ double z_cut = 0.10;
+ double R0 = 1.0; // this is the default value
+ SoftDrop sd(beta,z_cut,R0);
+
+and acts on a desired jet as
+
+ PseudoJet groomed_jet = sd(original_jet);
+
+and additional information can be obtained via
+
+ groomed_jet.structure_of<SoftDrop>()
+
+SoftDrop is typically called with beta > 0, though beta < 0 is still a
+viable option. Because beta < 0 is infrared-collinear unsafe in
+grooming mode, one probably wants to switch to tagging mode for negative
+beta, via set_tagging_mode().
+
+------------------------------------------------------------------------
+RecursiveSoftDrop
+------------------------------------------------------------------------
+
+The RecursiveSoftDrop procedure applies the Soft Drop procedure N times
+in a jet in order to find up to N+1 prongs. N=0 makes no modification
+to the jet, and N=1 is equivalent to the original SoftDrop.
+
+Once one has more than one prong, one has to decide which will be
+declustered next. At each step of the declustering procedure, one
+undoes the clustering which has the largest declustering angle
+(amongst all the branches that are searched for substructure). [see
+"set_fixed_depth" below for an alternative]
+
+Compared to SoftDrop, RecursiveSoftDrop takes an extra argument N
+specifying the number of times the SoftDrop procedure is recursively
+applied. Negative N means that the procedure is applied until no
+further substructure is found (i.e. corresponds to taking N=infinity).
+
+ double beta = 2.0;
+ double z_cut = 0.10;
+ double R0 = 1.0; // this is the default value
+ int N = -1;
+ RecursiveSoftDrop rsd(beta, z_cut, N, R0);
+
+One then acts on a jet as
+
+ PseudoJet groomed_jet = rsd(jet)
+
+and get additional information via
+
+ groomed_jet.structure_of<RecursiveSoftDrop>()
+
+------------------------------------------------------------------------
+IteratedSoftDrop
+------------------------------------------------------------------------
+
+Iterated Soft Drop (ISD) is a repeated variant of SoftDrop. After
+performing the Soft Drop procedure once, it logs the groomed symmetry
+factor, then recursively performs Soft Drop again on the harder
+branch. This procedure is repeated down to an (optional) angular cut
+theta_cut, yielding a set of symmetry factors from which observables
+can be built.
+
+An IteratedSoftDrop tool can be created as follows:
+
+ double beta = -1.0;
+ double z_cut = 0.005;
+ double theta_cut = 0.0;
+ double R0 = 0.5; // characteristic radius of jet algorithm
+ IteratedSoftDrop isd(beta, z_cut, double theta_cut, R0);
+
+By default, ISD applied on a jet gives a result of type
+IteratedSoftDropInfo that can then be probed to obtain physical
+observables
+
+ IteratedSoftDropInfo isd_info = isd(jet);
+
+ unsigned int multiplicity = isd_info.multiplicity();
+ double kappa = 1.0; // changes angular scale of ISD angularity
+ double isd_width = isd_info.angularity(kappa);
+ vector<pair<double,double> > zg_thetags = isd_info.all_zg_thetag();
+ vector<pair<double,double> > zg_thetags = isd_info();
+ for (unsigned int i=0; i< isd_info.size(); ++i){
+ cout << "(zg, theta_g)_" << i << " = "
+ << isd_info[i].first << " " << isd_info[i].second << endl;
+ }
+
+Alternatively, one can directly get the multiplicity, angularity, and
+(zg,thetag) pairs from the IteratedSoftDrop class, at the expense of
+re-running the declustering procedure:
+
+ unsigned int multiplicity = isd.multiplicity(jet);
+ double isd_width = isd.angularity(jet, 1.0);
+ vector<pair<double,double> > zg_thetags = isd.all_zg_thetag(jet);
+
+
+Note: the iterative declustering procedure is the same as what one
+ would obtain with RecursiveSoftDrop with an (optional) angular cut
+ and recursing only in the hardest branch [see the "Changing
+ behaviour" section below for details], except that it returns some
+ information about the jet instead of a modified jet as RSD does.
+
+
+------------------------------------------------------------------------
+BottomUpSoftDrop
+------------------------------------------------------------------------
+
+This is a bottom-up version of the RecursiveSoftDrop procedure, in a
+similar way as Pruning can be seen as a bottom-up version of Trimming.
+
+In practice, the jet is reclustered and at each step of the clustering
+one checks the SoftDrop condition
+
+ z > z_cut * (R / R0)^beta
+
+If the condition is met, the pair is recombined. If the condition is
+not met, only the hardest of the two objects is kept for further
+clustering and the softest is rejected.
+
+BottomUpSoftDrop takes the same arguments as SoftDrop, and a groomer
+can be created with:
+
+ double beta = 2.0;
+ double z_cut = 0.10;
+ double R0 = 1.0; // this is the default value
+ BottomUpSoftDrop busd(beta,z_cut,R0);
+
+One then acts on a jet as
+
+ PseudoJet groomed_jet = busd(jet)
+
+------------------------------------------------------------------------
+Recluster
+------------------------------------------------------------------------
+
+ *** NOTE: this is provided only for backwards compatibility ***
+ *** with FastJet <3.1. For FastJet >=3.1, the native ***
+ *** fastjet::Recluster is used instead ***
+
+The Recluster class allows the constituents of a jet to be reclustered
+with a different recursive clustering algorithm. This is used
+internally in the mMDT/SoftDrop/RecursiveSoftDrop/IteratedSoftDrop
+code in order to recluster the jet using the CA algorithm. This is
+achieved via
+
+ Recluster ca_reclusterer(cambridge_algorithm,
+ JetDefinition::max_allowable_R);
+ PseudoJet reclustered_jet = ca_reclusterer(original_jet);
+
+Note that reclustered_jet creates a new ClusterSequence that knows to
+delete_self_when_unused.
+
+------------------------------------------------------------------------
+Changing behaviour
+------------------------------------------------------------------------
+
+The behaviour of the all the tools provided here
+(ModifiedMassDropTagger, SoftDrop, RecursiveSoftDrop and
+IteratedSoftDrop) can be tweaked using the following options:
+
+SymmetryMeasure = {scalar_z, vector_z, y, theta_E, cos_theta_E}
+ [constructor argument]
+ : The definition of the energy sharing between subjets, with 0
+ corresponding to the most asymmetric.
+ . scalar_z = min(pt1,pt2)/(pt1+pt2) [default]
+ . vector_z = min(pt1,pt2)/pt_{1+2}
+ . y = min(pt1^2,pt2^2)/m_{12}^2 (original y from MDT)
+ . theta_E = min(E1,E2)/(E1+E2),
+ with angular measure theta_{12}^2
+ . cos_theta_E = min(E1,E2)/(E1+E2),
+ with angular measure 2[1-cos(theta_{12})]
+ The last two variants are meant for use in e+e- collisions,
+ together with the "larger_E" recursion choice (see below)
+
+RecursionChoice = {larger_pt, larger_mt, larger_m, larger_E}
+ [constructor argument]
+ : The path to recurse through the tree after the symmetry condition
+ fails. Options refer to transverse momentum (pt), transverse mass
+ (mt=sqrt(pt^2+m^2), mass (m) or energy (E). the latter is meant
+ for use in e+e- collisions
+
+mu_cut [constructor argument]
+ : An optional mass drop condition
+
+set_subtractor(subtractor*) [or subtractor as a constructor argument]
+ : provide a subtractor. When a subtractor is supplied, the
+ kinematic constraints are applied on subtracted 4-vectors. In
+ this case, the result of the ModifiedMassDropTagger/SoftDrop is a
+ subtracted PseudoJet, and it is assumed that
+ ModifiedMassDropTagger/SoftDrop is applied to an unsubtracted jet.
+ The latter default can be changed by calling
+ set_input_jet_is_subtracted().
+
+set_reclustering(bool, Recluster*)
+ : An optional setting to recluster a jet with a different jet
+ recursive jet algorithm. The code is only designed to give sensible
+ results with the CA algorithm, but other reclustering algorithm
+ (especially kT) may be appropriate in certain contexts.
+ Use at your own risk.
+
+set_grooming_mode()/set_tagging_mode()
+ : In grooming mode, the algorithm will return a single particle if the
+ symmetry condition fails for the whole tree. In tagging mode, the
+ algorithm will return an zero PseudoJet if no symmetry conditions
+ passes. Note that ModifiedMassDropTagger defaults to tagging mode
+ and SoftDrop defaults to grooming mode.
+
+set_verbose_structure(bool)
+ : when set to true, additional information will be stored in the jet
+ structure. This includes in particular values of symmetry,
+ delta_R, and mu of dropped branches
+
+For the specific case of RecursiveSoftDrop, additional tweaking is
+possible via the following methods
+
+set_fixed_depth_mode(bool)
+ : when this is true, RSD will recurse (N times) into all the
+ branches found during the previous iteration [instead of recursing
+ through the largest declustering angle until N prongs have been
+ found]. This yields at most 2^N prong. For infinite N, the two
+ options are equivalent.
+
+set_dynamical_R0(bool)
+ : By default the angles in the SD condition are normalised to the
+ parameter R0. With "dynamical R0", RSD will dynamically adjust R0
+ to be the angle between the two prongs found during the previous
+ iteration.
+
+set_hardest_branch_only(bool)
+ : When substructure is found, only recurse into the hardest of the
+ two branches for further substructure search. This uses the class
+ RecursionChoice.
+
+set_min_deltaR_squared(double):
+ : set a minimal angle (squared) at which we stop the declustering
+ procedure. This cut is ineffective for negative values of the
+ argument.
+
+------------------------------------------------------------------------
+Technical Details
+------------------------------------------------------------------------
+
+Both ModifiedMassDropTagger and SoftDrop inherit from
+RecursiveSymmetryCutBase, which provides a common codebase for recursive
+declustering of a jet with a symmetry cut condition. A generic
+RecursiveSymmetryCutBase depends on the following (virtual) functions
+(see header file for exact full specs, including constness):
+
+double symmetry_cut_fn(PseudoJet &, PseudoJet &)
+ : The function that defines the symmetry cut. This is what actually
+ defines different recursive declustering schemes, and all classes
+ that inherit from RecursiveSymmetryCutBase must define this
+ function.
+
+string symmetry_cut_description()
+ : the string description of the symmetry cut.
+
+------------------------------------------------------------------------
Index: contrib/contribs/RecursiveTools/tags/2.0.3/example_softdrop.cc
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/example_softdrop.cc (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/example_softdrop.cc (revision 1431)
@@ -0,0 +1,122 @@
+//----------------------------------------------------------------------
+/// \file example_softdrop.cc
+///
+/// This example program is meant to illustrate how the
+/// fastjet::contrib::SoftDrop class is used.
+///
+/// Run this example with
+///
+/// \verbatim
+/// ./example_softdrop < ../data/single-event.dat
+/// \endverbatim
+//----------------------------------------------------------------------
+
+// $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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#include <iostream>
+#include <sstream>
+
+#include <sstream>
+#include <iomanip>
+#include <cmath>
+#include "fastjet/ClusterSequence.hh"
+#include "SoftDrop.hh" // In external code, this should be fastjet/contrib/SoftDrop.hh
+
+using namespace std;
+using namespace fastjet;
+
+// forward declaration to make things clearer
+void read_event(vector<PseudoJet> &event);
+ostream & operator<<(ostream &, const PseudoJet &);
+
+//----------------------------------------------------------------------
+int main(){
+
+ //----------------------------------------------------------
+ // read in input particles
+ vector<PseudoJet> event;
+ read_event(event);
+ cout << "# read an event with " << event.size() << " particles" << endl;
+
+ // first get some anti-kt jets
+ double R = 1.0, ptmin = 20.0;
+ JetDefinition jet_def(antikt_algorithm, R);
+ ClusterSequence cs(event, jet_def);
+ vector<PseudoJet> jets = sorted_by_pt(cs.inclusive_jets(ptmin));
+
+ // give the soft drop groomer a short name
+ // Use a symmetry cut z > z_cut R^beta
+ // By default, there is no mass-drop requirement
+ double z_cut = 0.10;
+ double beta = 2.0;
+ contrib::SoftDrop sd(beta, z_cut);
+ cout << "SoftDrop groomer is: " << sd.description() << endl;
+
+ for (unsigned ijet = 0; ijet < jets.size(); ijet++) {
+ // Run SoftDrop and examine the output
+ PseudoJet sd_jet = sd(jets[ijet]);
+ cout << endl;
+ cout << "original jet: " << jets[ijet] << endl;
+ cout << "SoftDropped jet: " << sd_jet << endl;
+
+ assert(sd_jet != 0); //because soft drop is a groomer (not a tagger), it should always return a soft-dropped jet
+
+ cout << " delta_R between subjets: " << sd_jet.structure_of<contrib::SoftDrop>().delta_R() << endl;
+ cout << " symmetry measure(z): " << sd_jet.structure_of<contrib::SoftDrop>().symmetry() << endl;
+ cout << " mass drop(mu): " << sd_jet.structure_of<contrib::SoftDrop>().mu() << endl;
+ }
+
+ return 0;
+}
+
+//----------------------------------------------------------------------
+/// read in input particles
+void read_event(vector<PseudoJet> &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 << " pt = " << jet.pt()
+ << " m = " << jet.m()
+ << " y = " << jet.rap()
+ << " phi = " << jet.phi();
+ }
+ return ostr;
+}
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.3/example_softdrop.cc
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/example_mmdt_sub.ref
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/example_mmdt_sub.ref (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/example_mmdt_sub.ref (revision 1431)
@@ -0,0 +1,78 @@
+# Longitudinally invariant Cambridge/Aachen algorithm with R = 1 and E scheme recombination
+# Active area (explicit ghosts) with ghosts of area 0.00997331 (had requested 0.01), placed according to selector (|rap| <= 5), scattered wrt to perfect grid by (rel) 1, mean_ghost_pt = 1e-100, rel pt_scatter = 0.1, n repetitions of ghost distributions = 1
+# 20 pileup events on top of the hard event
+# read a hard event with 309 particles, centre-of-mass energy = 14000
+# read a full event with 3109 particles
+#--------------------------------------------------------------------------
+# FastJet release 3.1.0-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,
+# CGAL and 3rd party plugin jet algorithms. See COPYING file for details.
+#--------------------------------------------------------------------------
+
+-----------------------------------------
+No pileup, no subtraction
+tagger is: Recursive Tagger with a symmetry cut scalar_z > 0.1 [ModifiedMassDropTagger], no mass-drop requirement, recursion into the subjet with larger pt
+
+original jet pt = 221.812 m = 32.2905 y = -1.05822 phi = 0.0756913
+tagged jet pt = 206.662 m = 6.022 y = -1.07399 phi = 0.074484
+ delta_R between subjets: 0.0625986
+ symmetry measure(z): 0.10081
+ mass drop(mu): 0.629535
+filtered jet: pt = 198.618 m = 5.00366 y = -1.07664 phi = 0.0741277
+
+
+original jet pt = 147.272 m = 32.4736 y = 0.684444 phi = 3.45888
+tagged jet pt = 125.59 m = 9.00653 y = 0.673318 phi = 3.44347
+ delta_R between subjets: 0.0732829
+ symmetry measure(z): 0.348016
+ mass drop(mu): 0.604284
+filtered jet: pt = 72.4046 m = 4.32252 y = 0.668029 phi = 3.44446
+
+
+-----------------------------------------
+Pileup, no subtraction
+tagger is: Recursive Tagger with a symmetry cut scalar_z > 0.1 [ModifiedMassDropTagger], no mass-drop requirement, recursion into the subjet with larger pt
+
+original jet pt = 238.971 m = 82.4889 y = -1.07084 phi = 0.0430975
+tagged jet pt = 206.662 m = 6.022 y = -1.07399 phi = 0.074484
+ delta_R between subjets: 0.0625986
+ symmetry measure(z): 0.10081
+ mass drop(mu): 0.629535
+filtered jet: pt = 198.618 m = 5.00366 y = -1.07664 phi = 0.0741277
+
+
+original jet pt = 173.75 m = 74.6701 y = 0.73638 phi = 3.48392
+tagged jet pt = 133.133 m = 13.4499 y = 0.667906 phi = 3.44217
+ delta_R between subjets: 0.10831
+ symmetry measure(z): 0.107147
+ mass drop(mu): 0.862327
+filtered jet: pt = 109.81 m = 7.14298 y = 0.676746 phi = 3.43921
+
+
+-----------------------------------------
+Pileup, with subtraction
+tagger is: Recursive Tagger with a symmetry cut scalar_z > 0.1 [ModifiedMassDropTagger], no mass-drop requirement, recursion into the subjet with larger pt
+
+original jet pt = 203.782 m = -0.967618 y = -1.05353 phi = 0.0821247
+tagged jet pt = 206.662 m = 6.022 y = -1.07399 phi = 0.074484
+ delta_R between subjets: 0.0625986
+ symmetry measure(z): 0.10081
+ mass drop(mu): 0.629535
+filtered jet: pt = 198.618 m = 5.00366 y = -1.07664 phi = 0.0741277
+
+
+original jet pt = 146.109 m = 51.1929 y = 0.705189 phi = 3.44819
+tagged jet pt = 132.536 m = 13.3758 y = 0.668335 phi = 3.44231
+ delta_R between subjets: 0.107608
+ symmetry measure(z): 0.104244
+ mass drop(mu): 0.866401
+filtered jet: pt = 109.661 m = 7.13553 y = 0.676798 phi = 3.43925
+
Index: contrib/contribs/RecursiveTools/tags/2.0.3/example_mmdt_ee.ref
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/example_mmdt_ee.ref (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/example_mmdt_ee.ref (revision 1431)
@@ -0,0 +1,36 @@
+# read an event with 70 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.
+#--------------------------------------------------------------------------
+tagger is: Recursive Tagger with a symmetry cut cos_theta_E > 0.2 [ModifiedMassDropTagger], no mass-drop requirement, recursion into the subjet with larger energy
+
+original jet: E = 11.7799 m = 19.2957
+tagged jet: E = 6.02018 m = 6.52181
+ delta_R between subjets: 0.270322
+ symmetry measure(z): 0.49629
+ mass drop(mu): 0.403395
+
+
+original jet: E = 15.9528 m = 7.28134
+tagged jet: E = 8.08779 m = 0.992053
+ delta_R between subjets: 0.113801
+ symmetry measure(z): 0.289966
+ mass drop(mu): 0.413689
+
+
+original jet: E = 10.3356 m = 9.53801
+tagged jet: E = 10.3356 m = 9.53801
+ delta_R between subjets: 0.779204
+ symmetry measure(z): 0.35827
+ mass drop(mu): 0.331619
+
Index: contrib/contribs/RecursiveTools/tags/2.0.3/example_mmdt.cc
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/example_mmdt.cc (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/example_mmdt.cc (revision 1431)
@@ -0,0 +1,131 @@
+//----------------------------------------------------------------------
+/// \file example_mmdt.cc
+///
+/// This example program is meant to illustrate how the
+/// fastjet::contrib::ModifiedMassDropTagger class is used.
+///
+/// Run this example with
+///
+/// \verbatim
+/// ./example_mmdt < ../data/single-event.dat
+/// \endverbatim
+///
+/// It also shows operation in conjunction with a Filter.
+//----------------------------------------------------------------------
+
+// $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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#include <iostream>
+#include <sstream>
+
+#include <sstream>
+#include <iomanip>
+#include <cmath>
+#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<PseudoJet> &event);
+ostream & operator<<(ostream &, const PseudoJet &);
+
+//----------------------------------------------------------------------
+int main(){
+
+ //----------------------------------------------------------
+ // read in input particles
+ vector<PseudoJet> event;
+ read_event(event);
+ cout << "# read an event with " << event.size() << " particles" << endl;
+
+ // first get some Cambridge/Aachen jets
+ double R = 1.0, ptmin = 20.0;
+ JetDefinition jet_def(cambridge_algorithm, R);
+ ClusterSequence cs(event, jet_def);
+ vector<PseudoJet> jets = sorted_by_pt(cs.inclusive_jets(ptmin));
+
+ // give the tagger a short name
+ typedef contrib::ModifiedMassDropTagger MMDT;
+ // use just a symmetry cut, with no mass-drop requirement
+ double z_cut = 0.10;
+ MMDT tagger(z_cut);
+ 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<MMDT>().delta_R() << endl;
+ cout << " symmetry measure(z): " << tagged_jet.structure_of<MMDT>().symmetry() << endl;
+ cout << " mass drop(mu): " << tagged_jet.structure_of<MMDT>().mu() << endl;
+
+ // then filter the jet (useful for studies at moderate pt)
+ // with a dynamic Rfilt choice (as in arXiv:0802.2470)
+ double Rfilt = min(0.3, tagged_jet.structure_of<MMDT>().delta_R()*0.5);
+ int nfilt = 3;
+ Filter filter(Rfilt, SelectorNHardest(nfilt));
+ PseudoJet filtered_jet = filter(tagged_jet);
+ cout << "filtered jet: " << filtered_jet << endl;
+ cout << endl;
+ }
+
+ return 0;
+}
+
+//----------------------------------------------------------------------
+/// read in input particles
+void read_event(vector<PseudoJet> &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 << " pt = " << jet.pt()
+ << " m = " << jet.m()
+ << " y = " << jet.rap()
+ << " phi = " << jet.phi();
+ }
+ return ostr;
+}
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.3/example_mmdt.cc
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/TODO
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/TODO (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/TODO (revision 1431)
@@ -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.3/example_isd.ref
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/example_isd.ref (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/example_isd.ref (revision 1431)
@@ -0,0 +1,66 @@
+# read an event with 354 particles
+#--------------------------------------------------------------------------
+# FastJet release 3.2.0
+# 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.
+#--------------------------------------------------------------------------
+---------------------------------------------------
+Iterated Soft Drop
+---------------------------------------------------
+
+Computing with:
+ IteratedSoftDrop with beta =-1, symmetry_cut=0.002, R0=0.5 and no angular_cut
+ IteratedSoftDrop with beta =-1, symmetry_cut=0.002, R0=0.5 and no angular_cut
+
+---------------------------------------------------
+Processing Jet 0
+---------------------------------------------------
+
+Jet pT: 982.342 GeV
+
+Soft Drop Multiplicity (pt_R measure, beta=-1, z_cut=0.002):
+3
+
+Symmetry Factors (pt_R measure, beta=-1, z_cut=0.002):
+0.0294298 0.154333 0.42512
+
+Soft Drop Angularities (pt_R measure, beta=-1, z_cut=0.002):
+ alpha = 0, kappa = 0 : 3
+ alpha = 0, kappa = 2 : 0.205411
+ alpha = 0.5, kappa = 1 : 0.0541032
+ alpha = 1, kappa = 1 : 0.0071635
+ alpha = 2, kappa = 1 : 0.000333819
+
+Symmetry Factors (E_theta measure, beta=-1, z_cut=0.002):
+0.0286322 0.156129
+
+---------------------------------------------------
+Processing Jet 1
+---------------------------------------------------
+
+Jet pT: 899.993 GeV
+
+Soft Drop Multiplicity (pt_R measure, beta=-1, z_cut=0.002):
+4
+
+Symmetry Factors (pt_R measure, beta=-1, z_cut=0.002):
+0.00357435 0.0033004 0.00518061 0.235041
+
+Soft Drop Angularities (pt_R measure, beta=-1, z_cut=0.002):
+ alpha = 0, kappa = 0 : 4
+ alpha = 0, kappa = 2 : 0.0552947
+ alpha = 0.5, kappa = 1 : 0.0307531
+ alpha = 1, kappa = 1 : 0.00657501
+ alpha = 2, kappa = 1 : 0.00151741
+
+Symmetry Factors (E_theta measure, beta=-1, z_cut=0.002):
+0.00367919 0.00338026 0.00506002 0.235347
+
Index: contrib/contribs/RecursiveTools/tags/2.0.3/Recluster.hh
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/Recluster.hh (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/Recluster.hh (revision 1431)
@@ -0,0 +1,186 @@
+#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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#include <fastjet/JetDefinition.hh>
+#include <fastjet/CompositeJetStructure.hh> // to derive the ReclusterStructure from CompositeJetStructure
+#include <fastjet/tools/Transformer.hh> // to derive Recluster from Transformer
+#include <iostream>
+#include <string>
+
+FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh
+
+namespace contrib{
+
+//----------------------------------------------------------------------
+/// \class Recluster
+/// Class that helps reclustering a jet with a new jet definition.
+///
+/// **This class is DEPRECATED and you are advised to use the
+/// fastjet::Recluster class instead, from "fastjet/tools/Recluster.hh".**
+///
+/// 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<PseudoJet> & all_pieces,
+ std::vector<PseudoJet> & subjets,
+ double Rfilt) const;
+
+ /// set the reclustered elements in the generic re-clustering case
+ void _recluster_generic(const PseudoJet & jet,
+ std::vector<PseudoJet> & 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<PseudoJet> &all_pieces) const;
+
+ /// get the common recombiner to all pieces (NULL if none)
+ const JetDefinition::Recombiner* _get_common_recombiner(const std::vector<PseudoJet> &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<PseudoJet> &all_pieces,
+ JetDefinition &subjet_def) const;
+
+ /// check if one can apply the simplified trick for C/A subjets
+ bool _check_ca(const std::vector<PseudoJet> &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<PseudoJet> &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.3/Recluster.hh
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/example_mmdt_sub.cc
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/example_mmdt_sub.cc (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/example_mmdt_sub.cc (revision 1431)
@@ -0,0 +1,211 @@
+// $Id$
+//
+// Copyright (c) 2014, Gavin Salam
+//
+/// \file example_mmdt_sub.cc
+///
+/// An example to illustrate how to use the ModifiedMassDropTagger
+/// together with pileup subtraction.
+///
+/// Usage:
+///
+/// \verbatim
+/// ./example_mmdt_sub < ../data/Pythia-Zp2jets-lhc-pileup-1ev.dat
+/// \endverbatim
+///
+//----------------------------------------------------------------------
+// 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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#include <iostream>
+#include <sstream>
+
+#include <sstream>
+#include <iomanip>
+#include "fastjet/ClusterSequenceArea.hh"
+#include "fastjet/tools/GridMedianBackgroundEstimator.hh"
+#include "fastjet/tools/Subtractor.hh"
+#include "fastjet/tools/Filter.hh"
+#include "fastjet/config.h"
+#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<PseudoJet> &hard_event, vector<PseudoJet> &full_event);
+void do_analysis(const vector<PseudoJet> & jets, const Subtractor * subtractor);
+ostream & operator<<(ostream &, const PseudoJet &);
+
+// give the tagger a short name
+typedef contrib::ModifiedMassDropTagger MMDT;
+
+//----------------------------------------------------------------------
+int main(){
+
+ // Specify our basic jet tools:
+ // jet definition & area definition
+ double R = 1.0, rapmax = 5.0, ghost_area = 0.01;
+ int repeat = 1;
+ JetDefinition jet_def(cambridge_algorithm, R);
+ AreaDefinition area_def(active_area_explicit_ghosts,
+ GhostedAreaSpec(SelectorAbsRapMax(rapmax),repeat,ghost_area));
+ cout << "# " << jet_def.description() << endl;
+ cout << "# " << area_def.description() << endl;
+
+ // then our background estimator: use the (fast) grid-median method,
+ // and manually include reasonable rapidity dependence for
+ // particle-level 14 TeV events.
+ double grid_size = 0.55;
+ GridMedianBackgroundEstimator bge(rapmax, grid_size);
+ BackgroundRescalingYPolynomial rescaling (1.1685397, 0, -0.0246807, 0, 5.94119e-05);
+ bge.set_rescaling_class(&rescaling);
+ // define a corresponding subtractor
+ Subtractor subtractor(&bge);
+
+
+ //----------------------------------------------------------
+ // next read in input particles and get corresponding jets
+ // for the hard event (no pileup) and full event (with pileup)
+ vector<PseudoJet> hard_event, full_event;
+ read_event(hard_event, full_event);
+ cout << "# read a hard event with " << hard_event.size() << " particles" ;
+#if (FASTJET_VERSION_NUMBER >= 30100) // Selector.sum(..) works only for FJ >= 3.1
+ cout << ", centre-of-mass energy = " << SelectorIdentity().sum(hard_event).m();
+#endif
+ cout << endl;
+ cout << "# read a full event with " << full_event.size() << " particles" << endl;
+
+ // then get the CS and jets for both hard and full events
+ ClusterSequenceArea csa_hard(hard_event, jet_def, area_def);
+ ClusterSequenceArea csa_full(full_event, jet_def, area_def);
+ vector<PseudoJet> hard_jets = SelectorNHardest(2)(csa_hard.inclusive_jets());
+ vector<PseudoJet> full_jets = SelectorNHardest(2)(csa_full.inclusive_jets());
+ hard_jets = sorted_by_rapidity(hard_jets);
+ full_jets = sorted_by_rapidity(full_jets);
+
+ // estimate the background (the subtractor is automatically tied to this)
+ bge.set_particles(full_event);
+
+ // then do analyses with and without PU, and with and without subtraction
+ cout << endl << "-----------------------------------------" << endl
+ << "No pileup, no subtraction" << endl;
+ do_analysis(hard_jets, 0);
+ cout << endl << "-----------------------------------------" << endl
+ << "Pileup, no subtraction" << endl;
+ do_analysis(full_jets, 0);
+ cout << endl << "-----------------------------------------" << endl
+ << "Pileup, with subtraction" << endl;
+ do_analysis(full_jets, &subtractor);
+
+ return 0;
+}
+
+
+//----------------------------------------------------------------------
+/// do a simple MMDT + filter analysis, optionally with a subtractor
+void do_analysis(const vector<PseudoJet> & jets, const Subtractor * subtractor) {
+
+ // use just a symmetry cut for the tagger, with no mass-drop requirement
+ double z_cut = 0.10;
+ MMDT tagger(z_cut);
+ cout << "tagger is: " << tagger.description() << endl;
+ // tell the tagger that we will subtract the input jet ourselves
+ tagger.set_subtractor(subtractor);
+ tagger.set_input_jet_is_subtracted(true);
+
+
+ PseudoJet jet;
+ for (unsigned ijet = 0; ijet < jets.size(); ijet++) {
+ if (subtractor) {
+ jet = (*subtractor)(jets[ijet]);
+ } else {
+ jet = jets[ijet];
+ }
+ PseudoJet tagged_jet = tagger(jet);
+ cout << endl;
+ cout << "original jet" << jet << endl;
+ cout << "tagged jet" << tagged_jet << endl;
+ if (tagged_jet != 0) { // get additional informaition about satisified symmetry condition
+ cout << " delta_R between subjets: " << tagged_jet.structure_of<MMDT>().delta_R() << endl;
+ cout << " symmetry measure(z): " << tagged_jet.structure_of<MMDT>().symmetry() << endl;
+ cout << " mass drop(mu): " << tagged_jet.structure_of<MMDT>().mu() << endl;
+ }
+
+ // then filter the jet (useful for studies at moderate pt)
+ // with a dynamic Rfilt choice (as in arXiv:0802.2470)
+ double Rfilt = min(0.3, tagged_jet.structure_of<MMDT>().delta_R()*0.5);
+ int nfilt = 3;
+ Filter filter(Rfilt, SelectorNHardest(nfilt));
+ filter.set_subtractor(subtractor);
+ PseudoJet filtered_jet = filter(tagged_jet);
+ cout << "filtered jet: " << filtered_jet << endl;
+ cout << endl;
+ }
+
+
+}
+
+
+//------------------------------------------------------------------------
+// read the event with and without pileup
+void read_event(vector<PseudoJet> &hard_event, vector<PseudoJet> &full_event){
+ string line;
+ int nsub = 0; // counter to keep track of which sub-event we're reading
+ 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") {break;}
+ if (line.substr(0,9) == "#SUBSTART") {
+ // if more sub events follow, make copy of first one (the hard one) here
+ if (nsub == 1) hard_event = full_event;
+ nsub += 1;
+ }
+ 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
+ full_event.push_back(particle);
+ }
+
+ // if we have read in only one event, copy it across here...
+ if (nsub == 1) hard_event = full_event;
+
+ // if there was nothing in the event
+ if (nsub == 0) {
+ cerr << "Error: read empty event\n";
+ exit(-1);
+ }
+
+ cout << "# " << nsub-1 << " pileup events on top of the hard event" << endl;
+}
+
+//----------------------------------------------------------------------
+/// overloaded jet info output
+ostream & operator<<(ostream & ostr, const PseudoJet & jet) {
+ if (jet == 0) {
+ ostr << " 0 ";
+ } else {
+ ostr << " pt = " << jet.pt()
+ << " m = " << jet.m()
+ << " y = " << jet.rap()
+ << " phi = " << jet.phi();
+ }
+ return ostr;
+}
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.3/example_mmdt_sub.cc
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/example_mmdt_ee.cc
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/example_mmdt_ee.cc (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/example_mmdt_ee.cc (revision 1431)
@@ -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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#include <iostream>
+#include <sstream>
+
+#include <sstream>
+#include <iomanip>
+#include <cmath>
+#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<PseudoJet> &event);
+ostream & operator<<(ostream &, const PseudoJet &);
+
+//----------------------------------------------------------------------
+int main(){
+
+ //----------------------------------------------------------
+ // read in input particles
+ vector<PseudoJet> 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<PseudoJet> 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<double>::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<MMDT>().delta_R() << endl;
+ cout << " symmetry measure(z): " << tagged_jet.structure_of<MMDT>().symmetry() << endl;
+ cout << " mass drop(mu): " << tagged_jet.structure_of<MMDT>().mu() << endl;
+
+ cout << endl;
+ }
+
+ return 0;
+}
+
+//----------------------------------------------------------------------
+/// read in input particles
+void read_event(vector<PseudoJet> &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.3/example_mmdt_ee.cc
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/RecursiveSoftDrop.cc
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/RecursiveSoftDrop.cc (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/RecursiveSoftDrop.cc (revision 1431)
@@ -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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#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<double> dropped_delta_R;
+ vector<double> dropped_symmetry;
+ vector<double> 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<ClusterSequence::history_element> &cs_history = cs->history();
+ const vector<PseudoJet> &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<max_njet-1)){ max_history_size = 2*(_n+1); }
+
+ // we need to pre-allocate the space for the vector so that the
+ // pointers are not invalidated
+ vector<internal_recursive_softdrop::RSDHistoryElement> 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::RSDHistoryElement*, vector<internal_recursive_softdrop::RSDHistoryElement*>, 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<PseudoJet> 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<PseudoJetStructureBase>(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<PseudoJetStructureBase>(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<ClusterSequence::history_element> &cs_history = cs->history();
+ const vector<PseudoJet> &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<max_njet-1)){ max_history_size = 2*(_n+1); }
+
+ // we need to pre-allocate the space for the vector so that the
+ // pointers are not invalidated
+ vector<internal_recursive_softdrop::RSDHistoryElement> 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<internal_recursive_softdrop::RSDHistoryElement*> 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<internal_recursive_softdrop::RSDHistoryElement*>::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<SoftDrop>().dropped_delta_R();
+ elm->dropped_symmetry = result_sd.structure_of<SoftDrop>().dropped_symmetry();
+ elm->dropped_mu = result_sd.structure_of<SoftDrop>().dropped_mu();
+ }
+
+ // if some substructure was found:
+ if (result_sd.structure_of<SoftDrop>().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<SoftDrop>().delta_R();
+ elm->theta_squared *= elm->theta_squared;
+ elm->symmetry = result_sd.structure_of<SoftDrop>().symmetry();
+ elm->mu2 = result_sd.structure_of<SoftDrop>().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<internal_recursive_softdrop::RSDHistoryElement*>::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<PseudoJet> 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<PseudoJetStructureBase>(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<PseudoJetStructureBase>(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<PseudoJet> recursive_soft_drop_prongs(const PseudoJet & rsd_jet){
+ // make sure that the jet has the appropriate RecursiveSoftDrop structure
+ if (!rsd_jet.has_structure_of<RecursiveSoftDrop>())
+ return vector<PseudoJet>();
+
+ // if this jet has no substructure, just return a 1-prong object
+ if (!rsd_jet.structure_of<RecursiveSoftDrop>().has_substructure())
+ return vector<PseudoJet>(1, rsd_jet);
+
+ // otherwise fill a vector with all the prongs (no specific ordering)
+ vector<PseudoJet> prongs;
+
+ // parse the list of PseudoJet we still need to deal with
+ vector<PseudoJet> 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<to_parse.size()){
+ const PseudoJet &current = to_parse[i_parse];
+
+ if ((current.has_structure_of<RecursiveSymmetryCutBase>()) &&
+ (current.structure_of<RecursiveSymmetryCutBase>().has_substructure())){
+ // if this has some deeper substructure, add it to the list of
+ // things to further process
+ vector<PseudoJet> 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.3/RecursiveSoftDrop.cc
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/RecursiveSymmetryCutBase.cc
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/RecursiveSymmetryCutBase.cc (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/RecursiveSymmetryCutBase.cc (revision 1431)
@@ -0,0 +1,647 @@
+// $Id$
+//
+// Copyright (c) 2014-, Gavin P. Salam, Gregory Soyez, Jesse Thaler
+//
+//----------------------------------------------------------------------
+// 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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#include "RecursiveSymmetryCutBase.hh"
+#include "fastjet/JetDefinition.hh"
+#include "fastjet/ClusterSequenceAreaBase.hh"
+#include <cassert>
+#include <algorithm>
+#include <cstdlib>
+
+using namespace std;
+
+FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh
+
+namespace contrib{
+
+LimitedWarning RecursiveSymmetryCutBase::_negative_mass_warning;
+LimitedWarning RecursiveSymmetryCutBase::_mu2_gt1_warning;
+//LimitedWarning RecursiveSymmetryCutBase::_nonca_warning;
+LimitedWarning RecursiveSymmetryCutBase::_explicit_ghost_warning;
+
+bool RecursiveSymmetryCutBase::_verbose = false;
+
+//----------------------------------------------------------------------
+PseudoJet RecursiveSymmetryCutBase::result(const PseudoJet & jet) const {
+ // construct the input jet (by default, recluster with C/A)
+ if (! jet.has_constituents()){
+ throw Error("RecursiveSymmetryCutBase can only be applied to jets with constituents");
+ }
+
+ PseudoJet j = _recluster_if_needed(jet);
+
+ // sanity check: the jet must have a valid CS
+ if (! j.has_valid_cluster_sequence()){
+ throw Error("RecursiveSymmetryCutBase can only be applied to jets associated to a (valid) cluster sequence");
+ }
+
+ // check that area information is there in case we have a subtractor
+ // GS: do we really need this since subtraction may not require areas?
+ if (_subtractor) {
+ const ClusterSequenceAreaBase * csab =
+ dynamic_cast<const ClusterSequenceAreaBase *>(j.associated_cs());
+ if (csab == 0 || (!csab->has_explicit_ghosts()))
+ _explicit_ghost_warning.warn("RecursiveSymmetryCutBase: there is no clustering sequence, or it lacks explicit ghosts: subtraction is not guaranteed to function properly");
+ }
+
+ // establish the first subjet and optionally subtract it
+ PseudoJet subjet = j;
+ if (_subtractor && (!_input_jet_is_subtracted)) {
+ subjet = (*_subtractor)(subjet);
+ }
+
+ // variables for tracking what will happen
+ PseudoJet piece1, piece2;
+
+ // vectors for storing optional verbose structure
+ // these hold the deltaR, symmetry, and mu values of dropped branches
+ std::vector<double> dropped_delta_R;
+ std::vector<double> dropped_symmetry;
+ std::vector<double> dropped_mu;
+
+ double sym, mu2;
+
+ // now recurse into the jet's structure
+ RecursionStatus status;
+ while ((status=recurse_one_step(subjet, piece1, piece2, sym, mu2)) != recursion_success) {
+ // start with sanity checks:
+ if ((status == recursion_issue) || (status == recursion_no_parents)) {
+ // we should return piece1 by our convention for recurse_one_step
+ PseudoJet result;
+ if (status == recursion_issue){
+ result = piece1;
+ if (_verbose) cout << "reached end; returning null jet " << endl;
+ } else {
+ result = _result_no_substructure(piece1);
+ if (_verbose) cout << "no parents found; returning last PJ or empty jet" << endl;
+ }
+
+ if (result != 0) {
+ // if in grooming mode, add dummy structure information
+ StructureType * structure = new StructureType(result);
+ // structure->_symmetry = 0.0;
+ // structure->_mu = 0.0;
+ // structure->_delta_R = 0.0;
+ if (_verbose_structure) { // still want to store verbose information about dropped branches
+ structure->_has_verbose = true;
+ structure->_dropped_symmetry = dropped_symmetry;
+ structure->_dropped_mu = dropped_mu;
+ structure->_dropped_delta_R = dropped_delta_R;
+ }
+ result.set_structure_shared_ptr(SharedPtr<PseudoJetStructureBase>(structure));
+ }
+
+ return result;
+ }
+
+ assert(status == recursion_dropped);
+
+ // if desired, store information about dropped branches before recursing
+ if (_verbose_structure) {
+ dropped_delta_R.push_back(piece1.delta_R(piece2));
+ dropped_symmetry.push_back(sym);
+ dropped_mu.push_back((mu2 >= 0) ? sqrt(mu2) : -sqrt(-mu2));
+ }
+
+ subjet = piece1;
+ }
+
+
+ // we've tagged the splitting, return the jet with its substructure
+ StructureType * structure = new StructureType(subjet);
+ structure->_symmetry = sym;
+ structure->_mu = (mu2 >= 0) ? sqrt(mu2) : -sqrt(-mu2);
+ structure->_delta_R = sqrt(squared_geometric_distance(piece1, piece2));
+ if (_verbose_structure) {
+ structure->_has_verbose = true;
+ structure->_dropped_symmetry = dropped_symmetry;
+ structure->_dropped_mu = dropped_mu;
+ structure->_dropped_delta_R = dropped_delta_R;
+ }
+ subjet.set_structure_shared_ptr(SharedPtr<PseudoJetStructureBase>(structure));
+ return subjet;
+}
+
+
+
+//----------------------------------------------------------------------
+// the method below is the one actually performing one step of the
+// recursion.
+//
+// It returns a status code (defined above)
+//
+// In case of success, all the information is filled
+// In case of "no parents", piee1 is the same subjet
+// In case of trouble, piece2 will be a 0 PJ and piece1 is the PJ we
+// should return (either 0 itself if the issue was critical, or
+// non-wero in case of a minor issue just causing the recursion to
+// stop)
+RecursiveSymmetryCutBase::RecursionStatus
+ RecursiveSymmetryCutBase::recurse_one_step(const PseudoJet & subjet,
+ PseudoJet &piece1, PseudoJet &piece2,
+ double &sym, double &mu2,
+ void *extra_parameters) const {
+ if (!subjet.has_parents(piece1, piece2)){
+ piece1 = subjet;
+ piece2 = PseudoJet();
+ return recursion_no_parents;
+ }
+
+ // first sanity check:
+ // - zero or negative pts are not allowed for the input subjet
+ // - zero or negative masses are not allowed for configurations
+ // in which the mass will effectively appear in a denominator
+ // (The masses will be checked later)
+ if (subjet.pt2() <= 0){ // this is a critical problem, return an empty PJ
+ piece1 = piece2 = PseudoJet();
+ return recursion_issue;
+ }
+
+ if (_subtractor) {
+ piece1 = (*_subtractor)(piece1);
+ piece2 = (*_subtractor)(piece2);
+ }
+
+ // determine the symmetry parameter
+ if (_symmetry_measure == y) {
+ // the original d_{ij}/m^2 choice from MDT
+ // first make sure the mass is sensible
+ if (subjet.m2() <= 0) {
+ _negative_mass_warning.warn("RecursiveSymmetryCutBase: cannot calculate y, because (sub)jet mass is negative; bailing out");
+ // since rounding errors can give -ve masses, be a it more
+ // tolerant and consider that no substructure has been found
+ piece1 = _result_no_substructure(subjet);
+ piece2 = PseudoJet();
+ return recursion_issue;
+ }
+ sym = piece1.kt_distance(piece2) / subjet.m2();
+
+ } else if (_symmetry_measure == vector_z) {
+ // min(pt1, pt2)/(pt), where the denominator is a vector sum
+ // of the two subjets
+ sym = min(piece1.pt(), piece2.pt()) / subjet.pt();
+ } else if (_symmetry_measure == scalar_z) {
+ // min(pt1, pt2)/(pt1+pt2), where the denominator is a scalar sum
+ // of the two subjets
+ double pt1 = piece1.pt();
+ double pt2 = piece2.pt();
+ // make sure denominator is non-zero
+ sym = pt1 + pt2;
+ if (sym == 0){ // this is a critical problem, return an empty PJ
+ piece1 = piece2 = PseudoJet();
+ return recursion_issue;
+ }
+ sym = min(pt1, pt2) / sym;
+ } else if ((_symmetry_measure == theta_E) || (_symmetry_measure == cos_theta_E)){
+ // min(E1, E2)/(E1+E2)
+ double E1 = piece1.E();
+ double E2 = piece2.E();
+ // make sure denominator is non-zero
+ sym = E1 + E2;
+ if (sym == 0){ // this is a critical problem, return an empty PJ
+ piece1 = piece2 = PseudoJet();
+ return recursion_issue;
+ }
+ sym = min(E1, E2) / sym;
+ } else {
+ throw Error ("Unrecognized choice of symmetry_measure");
+ }
+
+ // determine the symmetry cut
+ // (This function is specified in the derived classes)
+ double this_symmetry_cut = symmetry_cut_fn(piece1, piece2, extra_parameters);
+
+ // and make a first tagging decision based on symmetry cut
+ bool tagged = (sym > this_symmetry_cut);
+
+ // if tagged based on symmetry cut, then check the mu cut (if relevant)
+ // and update the tagging decision. Calculate mu^2 regardless, for cases
+ // of users not cutting on mu2, but still interested in its value.
+ bool use_mu_cut = (_mu_cut != numeric_limits<double>::infinity());
+ if (subjet.m2() > 0) {
+ mu2 = max(piece1.m2(), piece2.m2())/subjet.m2();
+ } else {
+ // use this to signal problems
+ mu2 = -1.0;
+ }
+ if (tagged && use_mu_cut) {
+ // first a sanity check -- mu2 won't be sensible if the subjet mass
+ // is negative, so we can't then trust the mu cut - bail out
+ if (subjet.m2() <= 0) {
+ _negative_mass_warning.warn("RecursiveSymmetryCutBase: cannot trust mu, because (sub)jet mass is negative; bailing out");
+ piece1 = piece2 = PseudoJet();
+ return recursion_issue;
+ }
+ if (mu2 > 1) _mu2_gt1_warning.warn("RecursiveSymmetryCutBase encountered mu^2 value > 1");
+ if (mu2 > pow(_mu_cut,2)) tagged = false;
+ }
+
+ // we'll continue unclustering, allowing for the different
+ // ways of choosing which parent to look into
+ if (_recursion_choice == larger_pt) {
+ if (piece1.pt2() < piece2.pt2()) std::swap(piece1, piece2);
+ } else if (_recursion_choice == larger_mt) {
+ if (piece1.mt2() < piece2.mt2()) std::swap(piece1, piece2);
+ } else if (_recursion_choice == larger_m) {
+ if (piece1.m2() < piece2.m2()) std::swap(piece1, piece2);
+ } else if (_recursion_choice == larger_E) {
+ if (piece1.E() < piece2.E()) std::swap(piece1, piece2);
+ } else {
+ throw Error ("Unrecognized value for recursion_choice");
+ }
+
+ return tagged ? recursion_success : recursion_dropped;
+}
+
+
+//----------------------------------------------------------------------
+string RecursiveSymmetryCutBase::description() const {
+ ostringstream ostr;
+ ostr << "Recursive " << (_grooming_mode ? "Groomer" : "Tagger") << " with a symmetry cut ";
+
+ switch(_symmetry_measure) {
+ case y:
+ ostr << "y"; break;
+ case scalar_z:
+ ostr << "scalar_z"; break;
+ case vector_z:
+ ostr << "vector_z"; break;
+ case theta_E:
+ ostr << "theta_E"; break;
+ case cos_theta_E:
+ ostr << "cos_theta_E"; break;
+ default:
+ cerr << "failed to interpret symmetry_measure" << endl; exit(-1);
+ }
+ ostr << " > " << symmetry_cut_description();
+
+ if (_mu_cut != numeric_limits<double>::infinity()) {
+ ostr << ", mass-drop cut mu=max(m1,m2)/m < " << _mu_cut;
+ } else {
+ ostr << ", no mass-drop requirement";
+ }
+
+ ostr << ", recursion into the subjet with larger ";
+ switch(_recursion_choice) {
+ case larger_pt:
+ ostr << "pt"; break;
+ case larger_mt:
+ ostr << "mt(=sqrt(m^2+pt^2))"; break;
+ case larger_m:
+ ostr << "mass"; break;
+ case larger_E:
+ ostr << "energy"; break;
+ default:
+ cerr << "failed to interpret recursion_choice" << endl; exit(-1);
+ }
+
+ if (_subtractor) {
+ ostr << ", subtractor: " << _subtractor->description();
+ if (_input_jet_is_subtracted) {ostr << " (input jet is assumed already subtracted)";}
+ }
+
+ if (_recluster) {
+ ostr << " and reclustering using " << _recluster->description();
+ }
+
+ return ostr.str();
+}
+
+//----------------------------------------------------------------------
+// helper for handling the reclustering
+PseudoJet RecursiveSymmetryCutBase::_recluster_if_needed(const PseudoJet &jet) const{
+ if (! _do_reclustering) return jet;
+ if (_recluster) return (*_recluster)(jet);
+ if (is_ee()){
+#if FASTJET_VERSION_NUMBER >= 30100
+ return Recluster(JetDefinition(ee_genkt_algorithm, JetDefinition::max_allowable_R, 0.0), true)(jet);
+#else
+ return Recluster(JetDefinition(ee_genkt_algorithm, JetDefinition::max_allowable_R, 0.0))(jet);
+#endif
+ }
+
+ return Recluster(cambridge_algorithm, JetDefinition::max_allowable_R)(jet);
+}
+
+//----------------------------------------------------------------------
+// decide what to return when no substructure has been found
+double RecursiveSymmetryCutBase::squared_geometric_distance(const PseudoJet &j1,
+ const PseudoJet &j2) const{
+ if (_symmetry_measure == theta_E){
+ double dot_3d = j1.px()*j2.px() + j1.py()*j2.py() + j1.pz()*j2.pz();
+ double cos_theta = max(-1.0,min(1.0, dot_3d/sqrt(j1.modp2()*j2.modp2())));
+ double theta = acos(cos_theta);
+ return theta*theta;
+ } else if (_symmetry_measure == cos_theta_E){
+ double dot_3d = j1.px()*j2.px() + j1.py()*j2.py() + j1.pz()*j2.pz();
+ return max(0.0, 2*(1-dot_3d/sqrt(j1.modp2()*j2.modp2())));
+ }
+
+ return j1.squared_distance(j2);
+}
+
+//----------------------------------------------------------------------
+PseudoJet RecursiveSymmetryCutBase::_result_no_substructure(const PseudoJet &last_parent) const{
+ if (_grooming_mode){
+ // in grooming mode, return the last parent
+ return last_parent;
+ } else {
+ // in tagging mode, return an empty PseudoJet
+ return PseudoJet();
+ }
+}
+
+
+//========================================================================
+// implementation of the details of the structure
+
+// the number of dropped subjets
+int RecursiveSymmetryCutBase::StructureType::dropped_count(bool global) const {
+ check_verbose("dropped_count()");
+
+ // if this jet has no substructure, just return an empty vector
+ if (!has_substructure()) return _dropped_delta_R.size();
+
+ // deal with the non-global case
+ if (!global) return _dropped_delta_R.size();
+
+ // for the global case, we've unfolded the recursion (likely more
+ // efficient as it requires less copying)
+ unsigned int count = 0;
+ vector<const RecursiveSymmetryCutBase::StructureType*> to_parse;
+ to_parse.push_back(this);
+
+ unsigned int i_parse = 0;
+ while (i_parse<to_parse.size()){
+ const RecursiveSymmetryCutBase::StructureType *current = to_parse[i_parse];
+ count += current->_dropped_delta_R.size();
+
+ // check if we need to recurse deeper in the substructure
+ //
+ // we can have 2 situations here for the underlying structure (the
+ // one we've wrapped around):
+ // - it's of the clustering type
+ // - it's a composite jet
+ // only in the 2nd case do we have to recurse deeper
+ const CompositeJetStructure *css = dynamic_cast<const CompositeJetStructure*>(current->_structure.get());
+ if (css == 0){ ++i_parse; continue; }
+
+ vector<PseudoJet> prongs = css->pieces(PseudoJet()); // argument irrelevant
+ assert(prongs.size() == 2);
+ for (unsigned int i_prong=0; i_prong<2; ++i_prong){
+ if (prongs[i_prong].has_structure_of<RecursiveSymmetryCutBase>()){
+ RecursiveSymmetryCutBase::StructureType* prong_structure
+ = (RecursiveSymmetryCutBase::StructureType*) prongs[i_prong].structure_ptr();
+ if (prong_structure->has_substructure())
+ to_parse.push_back(prong_structure);
+ }
+ }
+
+ ++i_parse;
+ }
+ return count;
+}
+
+// the delta_R of all the dropped subjets
+vector<double> RecursiveSymmetryCutBase::StructureType::dropped_delta_R(bool global) const {
+ check_verbose("dropped_delta_R()");
+
+ // if this jet has no substructure, just return an empty vector
+ if (!has_substructure()) return vector<double>();
+
+ // deal with the non-global case
+ if (!global) return _dropped_delta_R;
+
+ // for the global case, we've unfolded the recursion (likely more
+ // efficient as it requires less copying)
+ vector<double> all_dropped;
+ vector<const RecursiveSymmetryCutBase::StructureType*> to_parse;
+ to_parse.push_back(this);
+
+ unsigned int i_parse = 0;
+ while (i_parse<to_parse.size()){
+ const RecursiveSymmetryCutBase::StructureType *current = to_parse[i_parse];
+ all_dropped.insert(all_dropped.end(), current->_dropped_delta_R.begin(), current->_dropped_delta_R.end());
+
+ // check if we need to recurse deeper in the substructure
+ //
+ // we can have 2 situations here for the underlying structure (the
+ // one we've wrapped around):
+ // - it's of the clustering type
+ // - it's a composite jet
+ // only in the 2nd case do we have to recurse deeper
+ const CompositeJetStructure *css = dynamic_cast<const CompositeJetStructure*>(current->_structure.get());
+ if (css == 0){ ++i_parse; continue; }
+
+ vector<PseudoJet> prongs = css->pieces(PseudoJet()); // argument irrelevant
+ assert(prongs.size() == 2);
+ for (unsigned int i_prong=0; i_prong<2; ++i_prong){
+ if (prongs[i_prong].has_structure_of<RecursiveSymmetryCutBase>()){
+ RecursiveSymmetryCutBase::StructureType* prong_structure
+ = (RecursiveSymmetryCutBase::StructureType*) prongs[i_prong].structure_ptr();
+ if (prong_structure->has_substructure())
+ to_parse.push_back(prong_structure);
+ }
+ }
+
+ ++i_parse;
+ }
+ return all_dropped;
+}
+
+// the symmetry of all the dropped subjets
+vector<double> RecursiveSymmetryCutBase::StructureType::dropped_symmetry(bool global) const {
+ check_verbose("dropped_symmetry()");
+
+ // if this jet has no substructure, just return an empty vector
+ if (!has_substructure()) return vector<double>();
+
+ // deal with the non-global case
+ if (!global) return _dropped_symmetry;
+
+ // for the global case, we've unfolded the recursion (likely more
+ // efficient as it requires less copying)
+ vector<double> all_dropped;
+ vector<const RecursiveSymmetryCutBase::StructureType*> to_parse;
+ to_parse.push_back(this);
+
+ unsigned int i_parse = 0;
+ while (i_parse<to_parse.size()){
+ const RecursiveSymmetryCutBase::StructureType *current = to_parse[i_parse];
+ all_dropped.insert(all_dropped.end(), current->_dropped_symmetry.begin(), current->_dropped_symmetry.end());
+
+ // check if we need to recurse deeper in the substructure
+ //
+ // we can have 2 situations here for the underlying structure (the
+ // one we've wrapped around):
+ // - it's of the clustering type
+ // - it's a composite jet
+ // only in the 2nd case do we have to recurse deeper
+ const CompositeJetStructure *css = dynamic_cast<const CompositeJetStructure*>(current->_structure.get());
+ if (css == 0){ ++i_parse; continue; }
+
+ vector<PseudoJet> prongs = css->pieces(PseudoJet()); // argument irrelevant
+ assert(prongs.size() == 2);
+ for (unsigned int i_prong=0; i_prong<2; ++i_prong){
+ if (prongs[i_prong].has_structure_of<RecursiveSymmetryCutBase>()){
+ RecursiveSymmetryCutBase::StructureType* prong_structure
+ = (RecursiveSymmetryCutBase::StructureType*) prongs[i_prong].structure_ptr();
+ if (prong_structure->has_substructure())
+ to_parse.push_back(prong_structure);
+ }
+ }
+
+ ++i_parse;
+ }
+ return all_dropped;
+}
+
+// the mu of all the dropped subjets
+vector<double> RecursiveSymmetryCutBase::StructureType::dropped_mu(bool global) const {
+ check_verbose("dropped_mu()");
+
+ // if this jet has no substructure, just return an empty vector
+ if (!has_substructure()) return vector<double>();
+
+ // deal with the non-global case
+ if (!global) return _dropped_mu;
+
+ // for the global case, we've unfolded the recursion (likely more
+ // efficient as it requires less copying)
+ vector<double> all_dropped;
+ vector<const RecursiveSymmetryCutBase::StructureType*> to_parse;
+ to_parse.push_back(this);
+
+ unsigned int i_parse = 0;
+ while (i_parse<to_parse.size()){
+ const RecursiveSymmetryCutBase::StructureType *current = to_parse[i_parse];
+ all_dropped.insert(all_dropped.end(), current->_dropped_mu.begin(), current->_dropped_mu.end());
+
+ // check if we need to recurse deeper in the substructure
+ //
+ // we can have 2 situations here for the underlying structure (the
+ // one we've wrapped around):
+ // - it's of the clustering type
+ // - it's a composite jet
+ // only in the 2nd case do we have to recurse deeper
+ const CompositeJetStructure *css = dynamic_cast<const CompositeJetStructure*>(current->_structure.get());
+ if (css == 0){ ++i_parse; continue; }
+
+ vector<PseudoJet> prongs = css->pieces(PseudoJet()); // argument irrelevant
+ assert(prongs.size() == 2);
+ for (unsigned int i_prong=0; i_prong<2; ++i_prong){
+ if (prongs[i_prong].has_structure_of<RecursiveSymmetryCutBase>()){
+ RecursiveSymmetryCutBase::StructureType* prong_structure
+ = (RecursiveSymmetryCutBase::StructureType*) prongs[i_prong].structure_ptr();
+ if (prong_structure->has_substructure())
+ to_parse.push_back(prong_structure);
+ }
+ }
+
+ ++i_parse;
+ }
+ return all_dropped;
+}
+
+// the maximum of the symmetry over the dropped subjets
+double RecursiveSymmetryCutBase::StructureType::max_dropped_symmetry(bool global) const {
+ check_verbose("max_dropped_symmetry()");
+
+ // if there is no substructure, just exit
+ if (!has_substructure()){ return 0.0; }
+
+ // local value of the max_dropped_symmetry
+ double local_max = (_dropped_symmetry.size() == 0)
+ ? 0.0 : *max_element(_dropped_symmetry.begin(),_dropped_symmetry.end());
+
+ // recurse down the structure if instructed to do so
+ if (global){
+ // we can have 2 situations here for the underlying structure (the
+ // one we've wrapped around):
+ // - it's of the clustering type
+ // - it's a composite jet
+ // only in the 2nd case do we have to recurse deeper
+ const CompositeJetStructure *css = dynamic_cast<const CompositeJetStructure*>(_structure.get());
+ if (css == 0) return local_max;
+
+ vector<PseudoJet> prongs = css->pieces(PseudoJet()); // argument irrelevant
+ assert(prongs.size() == 2);
+ for (unsigned int i_prong=0; i_prong<2; ++i_prong){
+ // check if the prong has further substructure
+ if (prongs[i_prong].has_structure_of<RecursiveSymmetryCutBase>()){
+ RecursiveSymmetryCutBase::StructureType* prong_structure
+ = (RecursiveSymmetryCutBase::StructureType*) prongs[i_prong].structure_ptr();
+ local_max = max(local_max, prong_structure->max_dropped_symmetry(true));
+ }
+ }
+ }
+
+ return local_max;
+}
+
+//------------------------------------------------------------------------
+// helper class to sort by decreasing thetag
+class SortRecursiveSoftDropStructureZgThetagPair{
+public:
+ bool operator()(const pair<double, double> &p1, const pair<double, double> &p2) const{
+ return p1.second > p2.second;
+ }
+};
+//------------------------------------------------------------------------
+
+// the (zg,thetag) pairs of all the splitting that were found and passed the SD condition
+vector<pair<double,double> > RecursiveSymmetryCutBase::StructureType::sorted_zg_and_thetag() const {
+ //check_verbose("sorted_zg_and_thetag()");
+
+ // if this jet has no substructure, just return an empty vector
+ if (!has_substructure()) return vector<pair<double,double> >();
+
+ // otherwise fill a vector with all the prongs (no specific ordering)
+ vector<pair<double,double> > all;
+ vector<const RecursiveSymmetryCutBase::StructureType*> to_parse;
+ to_parse.push_back(this);
+
+ unsigned int i_parse = 0;
+ while (i_parse<to_parse.size()){
+ const RecursiveSymmetryCutBase::StructureType *current = to_parse[i_parse];
+ all.push_back(pair<double,double>(current->_symmetry, current->_delta_R));
+
+ vector<PseudoJet> prongs = current->pieces(PseudoJet());
+ assert(prongs.size() == 2);
+ for (unsigned int i_prong=0; i_prong<2; ++i_prong){
+ if (prongs[i_prong].has_structure_of<RecursiveSymmetryCutBase>()){
+ RecursiveSymmetryCutBase::StructureType* prong_structure
+ = (RecursiveSymmetryCutBase::StructureType*) prongs[i_prong].structure_ptr();
+ if (prong_structure->has_substructure())
+ to_parse.push_back(prong_structure);
+ }
+ }
+
+ ++i_parse;
+ }
+
+ sort(all.begin(), all.end(), SortRecursiveSoftDropStructureZgThetagPair());
+ return all;
+}
+
+} // namespace contrib
+
+FASTJET_END_NAMESPACE
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.3/RecursiveSymmetryCutBase.cc
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/example_recursive_softdrop.ref
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/example_recursive_softdrop.ref (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/example_recursive_softdrop.ref (revision 1431)
@@ -0,0 +1,83 @@
+# read an event with 354 particles
+#--------------------------------------------------------------------------
+# FastJet release 3.4.2
+# 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 GNU GPL v2 or higher.
+# 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.2615 6.4595 13 13 0.0294 0.1543 0.0200
+ +--> 669.6354 1.9839 2 2 0.0000
+ +--> 141.6273 0.7653 0 0 0.0000 0.1999 0.0073
+ +--> 113.3155 0.4629 0 0 0.0000 0.2089 0.0055
+ | +--> 89.6387 0.2119 0 0 0.0000
+ | +--> 23.6769 0.1396 0 0 0.0000
+ +--> 28.3123 0.1700 0 0 0.0000 0.2482 0.0045
+ +--> 21.2860 0.1396 0 0 0.0000
+ +--> 7.0264 -0.0000 0 0 0.0000
+
+Prongs without clustering information
+-------------------------------------
+(Raw) list of prongs:
+ pt mass
+ 0 669.6354 1.9839
+ 1 89.6387 0.2119
+ 2 21.2860 0.1396
+ 3 23.6769 0.1396
+ 4 7.0264 -0.0000
+
+Groomed prongs information:
+index zg thetag
+ 1 0.1543 0.0200
+ 2 0.1999 0.0073
+ 3 0.2089 0.0055
+ 4 0.2482 0.0045
+
+original jet: pt = 908.0979 m = 87.7124 y = 0.2195 phi = 6.0349
+RecursiveSoftDropped jet: pt = 830.5173 m = 4.9104 y = 0.2231 phi = 6.0299
+
+Prongs with clustering information
+----------------------------------
+ branch branch N_groomed max loc substructure
+ pt mass loc tot zdrop zg thetag
+ +--> 830.5173 4.9104 12 13 0.0232 0.0608 0.0154
+ +--> 778.7314 3.6648 0 1 0.0000 0.2350 0.0101
+ | +--> 599.1063 0.4038 1 1 0.0000
+ | +--> 179.6277 0.8534 0 1 0.0000 0.2577 0.0087
+ | +--> 131.1504 0.3785 1 1 0.0607 0.3152 0.0042
+ | | +--> 89.8058 0.1072 0 0 0.0000
+ | | +--> 41.3448 0.1396 0 0 0.0000
+ | +--> 48.4785 0.1396 0 0 0.0000
+ +--> 51.7916 0.1396 0 0 0.0000
+
+Prongs without clustering information
+-------------------------------------
+(Raw) list of prongs:
+ pt mass
+ 0 599.1063 0.4038
+ 1 51.7916 0.1396
+ 2 89.8058 0.1072
+ 3 48.4785 0.1396
+ 4 41.3448 0.1396
+
+Groomed prongs information:
+index zg thetag
+ 1 0.0608 0.0154
+ 2 0.2350 0.0101
+ 3 0.2577 0.0087
+ 4 0.3152 0.0042
Index: contrib/contribs/RecursiveTools/tags/2.0.3/example_advanced_usage.ref
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/example_advanced_usage.ref (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/example_advanced_usage.ref (revision 1431)
@@ -0,0 +1,144 @@
+---------------------------------------------------------------------------------------------
+Soft Drops to be tested:
+---------------------------------------------------------------------------------------------
+ name beta z_cut sym R0 mu recurse reclust mode
+ beta=2.0 zcut=.1 2.000 0.100 scalar_z 1.000 inf larger_pt CA groom
+ beta=1.0 zcut=.1 1.000 0.100 scalar_z 1.000 inf larger_pt CA groom
+ beta=0.5 zcut=.1 0.500 0.100 scalar_z 1.000 inf larger_pt CA groom
+ beta=2.0 zcut=.2 2.000 0.200 scalar_z 1.000 inf larger_pt CA groom
+ beta=1.0 zcut=.2 1.000 0.200 scalar_z 1.000 inf larger_pt CA groom
+ beta=0.5 zcut=.2 0.500 0.200 scalar_z 1.000 inf larger_pt CA groom
+ MMDT-like zcut=.1 0.000 0.100 scalar_z 1.000 inf larger_pt CA tag
+ MMDT-like zcut=.2 0.000 0.200 scalar_z 1.000 inf larger_pt CA tag
+ MMDT-like zcut=.3 0.000 0.300 scalar_z 1.000 inf larger_pt CA tag
+ MMDT-like zcut=.4 0.000 0.400 scalar_z 1.000 inf larger_pt CA tag
+beta=-2.0 zcut=.05 -2.000 0.050 scalar_z 1.000 inf larger_pt CA tag
+beta=-1.0 zcut=.05 -1.000 0.050 scalar_z 1.000 inf larger_pt CA tag
+beta=-0.5 zcut=.05 -0.500 0.050 scalar_z 1.000 inf larger_pt CA tag
+ b=.5 z=.3 R0=1.0 0.500 0.300 scalar_z 1.000 inf larger_pt CA groom
+ b=.5 z=.3 R0=0.5 0.500 0.300 scalar_z 0.500 inf larger_pt CA groom
+ b=.5 z=.3 R0=0.2 0.500 0.300 scalar_z 0.200 inf larger_pt CA groom
+ b=2 z=.4 scalar_z 2.000 0.400 scalar_z 1.000 inf larger_pt CA groom
+ b=2 z=.4 vector_z 2.000 0.400 vector_z 1.000 inf larger_pt CA groom
+ b=2 z=.4 y 2.000 0.400 y 1.000 inf larger_pt CA groom
+b=3 z=.2 larger_pt 3.000 0.200 scalar_z 1.000 inf larger_pt CA groom
+b=3 z=.2 larger_mt 3.000 0.200 scalar_z 1.000 inf larger_mt CA groom
+ b=3 z=.2 larger_m 3.000 0.200 scalar_z 1.000 inf larger_m CA groom
+ b=2 z=.1 mu=1.0 2.000 0.100 scalar_z 1.000 1.000 larger_pt CA groom
+ b=2 z=.1 mu=0.8 2.000 0.100 scalar_z 1.000 0.800 larger_pt CA groom
+ b=2 z=.1 mu=0.5 2.000 0.100 scalar_z 1.000 0.500 larger_pt CA groom
+ b=2.0 z=.2 kT 2.000 0.200 scalar_z 1.000 inf larger_pt KT groom
+ b=1.0 z=.2 kT 1.000 0.200 scalar_z 1.000 inf larger_pt KT groom
+ b=0.5 z=.2 kT 0.500 0.200 scalar_z 1.000 inf larger_pt KT groom
+ b=2.0 z=.4 kT 2.000 0.400 scalar_z 1.000 inf larger_pt KT groom
+ b=1.0 z=.4 kT 1.000 0.400 scalar_z 1.000 inf larger_pt KT groom
+ b=0.5 z=.4 kT 0.500 0.400 scalar_z 1.000 inf larger_pt KT groom
+---------------------------------------------------------------------------------------------
+---------------------------------------------------------------------------------------------
+Analyzing Jet 1:
+---------------------------------------------------------------------------------------------
+ name pt m y phi constit delta_R sym mu mxdropz
+ Original Jet 983.3873 39.9912 -0.8673 2.9051 35
+ beta=2.0 zcut=.1 980.4398 27.1382 -0.8675 2.9053 25 0.2092 0.0047 0.8353 0.0014
+ beta=1.0 zcut=.1 971.5229 20.8426 -0.8686 2.9051 22 0.0954 0.0294 0.5476 0.0047
+ beta=0.5 zcut=.1 933.8859 9.9073 -0.8697 2.9075 13 0.0217 0.0174 0.8786 0.0294
+ beta=2.0 zcut=.2 975.8387 22.6675 -0.8684 2.9057 23 0.1316 0.0045 0.9195 0.0047
+ beta=1.0 zcut=.2 971.5229 20.8426 -0.8686 2.9051 22 0.0954 0.0294 0.5476 0.0047
+ beta=0.5 zcut=.2 917.6736 8.7048 -0.8696 2.9079 12 0.0200 0.1543 0.5576 0.0294
+ MMDT-like zcut=.1 917.6736 8.7048 -0.8696 2.9079 12 0.0200 0.1543 0.5576 0.0294
+ MMDT-like zcut=.2 669.6354 1.9839 -0.8677 2.9075 4 0.0044 0.2031 0.7051 0.1543
+ MMDT-like zcut=.3 446.5813 1.0182 -0.8678 2.9069 2 0.0030 0.4251 0.4848 0.2031
+ MMDT-like zcut=.4 446.5813 1.0182 -0.8678 2.9069 2 0.0030 0.4251 0.4848 0.2031
+beta=-2.0 zcut=.05 ---- untagged jet ----
+beta=-1.0 zcut=.05 ---- untagged jet ----
+beta=-0.5 zcut=.05 ---- untagged jet ----
+ b=.5 z=.3 R0=1.0 917.6736 8.7048 -0.8696 2.9079 12 0.0200 0.1543 0.5576 0.0294
+ b=.5 z=.3 R0=0.5 917.6736 8.7048 -0.8696 2.9079 12 0.0200 0.1543 0.5576 0.0294
+ b=.5 z=.3 R0=0.2 917.6736 8.7048 -0.8696 2.9079 12 0.0200 0.1543 0.5576 0.0294
+ b=2 z=.4 scalar_z 971.5229 20.8426 -0.8686 2.9051 22 0.0954 0.0294 0.5476 0.0047
+ b=2 z=.4 vector_z 971.5229 20.8426 -0.8686 2.9051 22 0.0954 0.0294 0.5476 0.0047
+ b=2 z=.4 y 971.5229 20.8426 -0.8686 2.9051 22 0.0954 0.0171 0.5476 0.0013
+b=3 z=.2 larger_pt 980.4398 27.1382 -0.8675 2.9053 25 0.2092 0.0047 0.8353 0.0014
+b=3 z=.2 larger_mt 980.4398 27.1382 -0.8675 2.9053 25 0.2092 0.0047 0.8353 0.0014
+ b=3 z=.2 larger_m 980.4398 27.1382 -0.8675 2.9053 25 0.2092 0.0047 0.8353 0.0014
+ b=2 z=.1 mu=1.0 980.4398 27.1382 -0.8675 2.9053 25 0.2092 0.0047 0.8353 0.0014
+ b=2 z=.1 mu=0.8 971.5229 20.8426 -0.8686 2.9051 22 0.0954 0.0294 0.5476 0.0047
+ b=2 z=.1 mu=0.5 446.5813 1.0182 -0.8678 2.9069 2 0.0030 0.4251 0.4848 0.2031
+ b=2.0 z=.2 kT 983.3873 39.9912 -0.8673 2.9051 35 0.1119 0.0377 0.5030 0.0000
+ b=1.0 z=.2 kT 983.3873 39.9912 -0.8673 2.9051 35 0.1119 0.0377 0.5030 0.0000
+ b=0.5 z=.2 kT 946.4934 20.1170 -0.8699 2.9084 21 0.0233 0.1579 0.5951 0.0377
+ b=2.0 z=.4 kT 983.3873 39.9912 -0.8673 2.9051 35 0.1119 0.0377 0.5030 0.0000
+ b=1.0 z=.4 kT 946.4934 20.1170 -0.8699 2.9084 21 0.0233 0.1579 0.5951 0.0377
+ b=0.5 z=.4 kT 946.4934 20.1170 -0.8699 2.9084 21 0.0233 0.1579 0.5951 0.0377
+---------------------------------------------------------------------------------------------
+Analyzing Jet 2:
+---------------------------------------------------------------------------------------------
+ name pt m y phi constit delta_R sym mu mxdropz
+ Original Jet 908.0979 87.7124 0.2195 6.0349 47
+ beta=2.0 zcut=.1 887.9353 11.3171 0.2232 6.0303 15 0.1116 0.0044 0.7910 0.0104
+ beta=1.0 zcut=.1 884.0262 8.9520 0.2228 6.0306 14 0.0570 0.0067 0.8862 0.0104
+ beta=0.5 zcut=.1 872.2856 7.0426 0.2230 6.0308 12 0.0346 0.0232 0.7445 0.0104
+ beta=2.0 zcut=.2 887.9353 11.3171 0.2232 6.0303 15 0.1116 0.0044 0.7910 0.0104
+ beta=1.0 zcut=.2 872.2856 7.0426 0.2230 6.0308 12 0.0346 0.0232 0.7445 0.0104
+ beta=0.5 zcut=.2 852.0552 5.2435 0.2230 6.0300 10 0.0154 0.0608 0.7701 0.0232
+ MMDT-like zcut=.1 800.2694 4.0381 0.2230 6.0310 9 0.0101 0.2350 0.2291 0.0608
+ MMDT-like zcut=.2 800.2694 4.0381 0.2230 6.0310 9 0.0101 0.2350 0.2291 0.0608
+ MMDT-like zcut=.3 ---- untagged jet ----
+ MMDT-like zcut=.4 ---- untagged jet ----
+beta=-2.0 zcut=.05 ---- untagged jet ----
+beta=-1.0 zcut=.05 ---- untagged jet ----
+beta=-0.5 zcut=.05 ---- untagged jet ----
+ b=.5 z=.3 R0=1.0 852.0552 5.2435 0.2230 6.0300 10 0.0154 0.0608 0.7701 0.0232
+ b=.5 z=.3 R0=0.5 852.0552 5.2435 0.2230 6.0300 10 0.0154 0.0608 0.7701 0.0232
+ b=.5 z=.3 R0=0.2 800.2694 4.0381 0.2230 6.0310 9 0.0101 0.2350 0.2291 0.0608
+ b=2 z=.4 scalar_z 884.0262 8.9520 0.2228 6.0306 14 0.0570 0.0067 0.8862 0.0104
+ b=2 z=.4 vector_z 884.0262 8.9520 0.2228 6.0306 14 0.0570 0.0067 0.8862 0.0104
+ b=2 z=.4 y 884.0262 8.9520 0.2228 6.0306 14 0.0570 0.0014 0.8862 0.0050
+b=3 z=.2 larger_pt 887.9353 11.3171 0.2232 6.0303 15 0.1116 0.0044 0.7910 0.0104
+b=3 z=.2 larger_mt 887.9353 11.3171 0.2232 6.0303 15 0.1116 0.0044 0.7910 0.0104
+ b=3 z=.2 larger_m 887.9353 11.3171 0.2232 6.0303 15 0.1116 0.0044 0.7910 0.0104
+ b=2 z=.1 mu=1.0 887.9353 11.3171 0.2232 6.0303 15 0.1116 0.0044 0.7910 0.0104
+ b=2 z=.1 mu=0.8 887.9353 11.3171 0.2232 6.0303 15 0.1116 0.0044 0.7910 0.0104
+ b=2 z=.1 mu=0.5 800.2694 4.0381 0.2230 6.0310 9 0.0101 0.2350 0.2291 0.0608
+ b=2.0 z=.2 kT 900.1551 59.2173 0.2190 6.0292 31 0.0176 0.2314 0.8689 0.0104
+ b=1.0 z=.2 kT 900.1551 59.2173 0.2190 6.0292 31 0.0176 0.2314 0.8689 0.0104
+ b=0.5 z=.2 kT 900.1551 59.2173 0.2190 6.0292 31 0.0176 0.2314 0.8689 0.0104
+ b=2.0 z=.4 kT 900.1551 59.2173 0.2190 6.0292 31 0.0176 0.2314 0.8689 0.0104
+ b=1.0 z=.4 kT 900.1551 59.2173 0.2190 6.0292 31 0.0176 0.2314 0.8689 0.0104
+ b=0.5 z=.4 kT 900.1551 59.2173 0.2190 6.0292 31 0.0176 0.2314 0.8689 0.0104
+---------------------------------------------------------------------------------------------
+Analyzing Jet 3:
+---------------------------------------------------------------------------------------------
+ name pt m y phi constit delta_R sym mu mxdropz
+ Original Jet 72.9429 23.4022 -1.1908 6.1199 43
+ beta=2.0 zcut=.1 71.5847 20.0943 -1.1761 6.1254 37 0.6803 0.0730 0.5627 0.0111
+ beta=1.0 zcut=.1 71.5847 20.0943 -1.1761 6.1254 37 0.6803 0.0730 0.5627 0.0111
+ beta=0.5 zcut=.1 67.3730 11.3061 -1.1810 6.0789 29 0.3790 0.0855 0.6966 0.0730
+ beta=2.0 zcut=.2 67.3730 11.3061 -1.1810 6.0789 29 0.3790 0.0855 0.6966 0.0730
+ beta=1.0 zcut=.2 67.3730 11.3061 -1.1810 6.0789 29 0.3790 0.0855 0.6966 0.0730
+ beta=0.5 zcut=.2 57.6019 5.9671 -1.1998 6.1138 16 0.1161 0.2463 0.7416 0.0855
+ MMDT-like zcut=.1 57.6019 5.9671 -1.1998 6.1138 16 0.1161 0.2463 0.7416 0.0855
+ MMDT-like zcut=.2 57.6019 5.9671 -1.1998 6.1138 16 0.1161 0.2463 0.7416 0.0855
+ MMDT-like zcut=.3 43.4356 4.4251 -1.2213 6.0950 13 0.1136 0.4598 0.5944 0.2463
+ MMDT-like zcut=.4 43.4356 4.4251 -1.2213 6.0950 13 0.1136 0.4598 0.5944 0.2463
+beta=-2.0 zcut=.05 ---- untagged jet ----
+beta=-1.0 zcut=.05 43.4356 4.4251 -1.2213 6.0950 13 0.1136 0.4598 0.5944 0.2463
+beta=-0.5 zcut=.05 71.5847 20.0943 -1.1761 6.1254 37 0.6803 0.0730 0.5627 0.0111
+ b=.5 z=.3 R0=1.0 57.6019 5.9671 -1.1998 6.1138 16 0.1161 0.2463 0.7416 0.0855
+ b=.5 z=.3 R0=0.5 57.6019 5.9671 -1.1998 6.1138 16 0.1161 0.2463 0.7416 0.0855
+ b=.5 z=.3 R0=0.2 57.6019 5.9671 -1.1998 6.1138 16 0.1161 0.2463 0.7416 0.0855
+ b=2 z=.4 scalar_z 67.3730 11.3061 -1.1810 6.0789 29 0.3790 0.0855 0.6966 0.0730
+ b=2 z=.4 vector_z 67.3730 11.3061 -1.1810 6.0789 29 0.3790 0.0859 0.6966 0.0741
+ b=2 z=.4 y 57.6019 5.9671 -1.1998 6.1138 16 0.1161 0.0763 0.7416 0.0376
+b=3 z=.2 larger_pt 71.5847 20.0943 -1.1761 6.1254 37 0.6803 0.0730 0.5627 0.0111
+b=3 z=.2 larger_mt 71.5847 20.0943 -1.1761 6.1254 37 0.6803 0.0730 0.5627 0.0111
+ b=3 z=.2 larger_m 71.5847 20.0943 -1.1761 6.1254 37 0.6803 0.0730 0.5627 0.0111
+ b=2 z=.1 mu=1.0 71.5847 20.0943 -1.1761 6.1254 37 0.6803 0.0730 0.5627 0.0111
+ b=2 z=.1 mu=0.8 71.5847 20.0943 -1.1761 6.1254 37 0.6803 0.0730 0.5627 0.0111
+ b=2 z=.1 mu=0.5 10.2806 0.1396 -1.1761 6.0554 1 -1.0000 -1.0000 -1.0000 0.0000
+ b=2.0 z=.2 kT 72.9429 23.4022 -1.1908 6.1199 43 0.2517 0.3453 0.4508 0.0000
+ b=1.0 z=.2 kT 72.9429 23.4022 -1.1908 6.1199 43 0.2517 0.3453 0.4508 0.0000
+ b=0.5 z=.2 kT 72.9429 23.4022 -1.1908 6.1199 43 0.2517 0.3453 0.4508 0.0000
+ b=2.0 z=.4 kT 72.9429 23.4022 -1.1908 6.1199 43 0.2517 0.3453 0.4508 0.0000
+ b=1.0 z=.4 kT 72.9429 23.4022 -1.1908 6.1199 43 0.2517 0.3453 0.4508 0.0000
+ b=0.5 z=.4 kT 72.9429 23.4022 -1.1908 6.1199 43 0.2517 0.3453 0.4508 0.0000
Index: contrib/contribs/RecursiveTools/tags/2.0.3/IteratedSoftDrop.hh
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/IteratedSoftDrop.hh (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/IteratedSoftDrop.hh (revision 1431)
@@ -0,0 +1,219 @@
+// $Id$
+//
+// Copyright (c) 2017-, Jesse Thaler, Kevin Zhou, Gavin P. Salam,
+// Gregory 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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#ifndef __FASTJET_CONTRIB_ITERATEDSOFTDROP_HH__
+#define __FASTJET_CONTRIB_ITERATEDSOFTDROP_HH__
+
+#include "RecursiveSoftDrop.hh"
+
+FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh
+
+namespace contrib{
+
+//------------------------------------------------------------------------
+/// \class IteratedSoftDropInfo
+/// helper class that carries all the relevant information one can get
+/// from running IteratedSoftDrop on a given jet (or vector of jets)
+///
+class IteratedSoftDropInfo{
+public:
+ /// ctor without initialisation
+ IteratedSoftDropInfo(){}
+
+ /// ctor with initialisation
+ IteratedSoftDropInfo(std::vector<std::pair<double,double> > zg_thetag_in)
+ : _all_zg_thetag(zg_thetag_in){}
+
+ /// get the raw list of (angular-ordered) zg and thetag
+ const std::vector<std::pair<double,double> > &all_zg_thetag() const{
+ return _all_zg_thetag;
+ }
+
+ /// overloadd the () operator so that it also returns the full (zg,thetag) list
+ const std::vector<std::pair<double,double> > & operator()() const{
+ return _all_zg_thetag;
+ }
+
+ /// overloadd the [] operator to access the ith (zg,thetag) pair
+ const std::pair<double,double> & operator[](unsigned int i) const{
+ return _all_zg_thetag[i];
+ }
+
+ /// 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 angularity(double alpha, double kappa=1.0) const;
+
+ /// returns the Iterated SoftDrop multiplicity
+ unsigned int multiplicity() const{ return _all_zg_thetag.size(); }
+
+ /// returns the Iterated SoftDrop multiplicity (i.e. size)
+ unsigned int size() const{ return _all_zg_thetag.size(); }
+
+protected:
+ /// the real information: angular-ordered list of all the zg and
+ /// thetag that passed the (recursive) SD conddition
+ std::vector<std::pair<double,double> > _all_zg_thetag;
+};
+
+
+
+//------------------------------------------------------------------------
+/// \class IteratedSoftDrop
+/// implementation of the IteratedSoftDrop procedure
+///
+/// This class provides an implementation of the IteratedSoftDrop
+/// procedure. It is based on the SoftDrop procedure can be used to
+/// define a 'groomed symmetry factor', equal to the symmetry factor
+/// of the two subjets of the resulting groomed jet. The Iterated
+/// Soft Drop procedure recursively performs Soft Drop on the harder
+/// branch of the groomed jet, halting at a specified angular cut
+/// \f$\theta_{\rm cut}\f$, returning a list of symmetry factors which
+/// can be used to define observables.
+///
+/// Like SoftDrop, the cut applied recursively is
+/// \f[
+/// z > z_{\rm cut} (\theta/R_0)^\beta
+/// \f]
+/// with z the asymmetry measure and \f$\theta\f$ the geometrical
+/// distance between the two subjets. The procedure halts when
+/// \f$\theta < \theta_{\rm cut}\f$.
+///
+/// By default, this implementation returs the IteratedSoftDropInfo
+/// obtained after running IteratedSoftDrop on a jet
+///
+/// Although all these quantities can be obtained from the returned
+/// IteratedSoftDropInfo, we also provide helpers to directly get the
+/// multiplicity, some (generalised) angularity, or the raw list of
+/// (angular-ordered) (zg, thetag) pairs that passed the (recursive)
+/// SoftDrop condition.
+///
+/// We stress the fact that IteratedSoftDrop is _not_ a Transformer
+/// since it returns an IteratedSoftDropInfo and not a modified
+/// PseudoJet
+///
+class IteratedSoftDrop : public FunctionOfPseudoJet<IteratedSoftDropInfo> {
+public:
+ /// Constructor. Takes in the standard Soft Drop parameters, an angular cut \f$\theta_{\rm cut}\f$,
+ /// and a choice of angular and symmetry measure.
+ ///
+ /// \param beta the Soft Drop beta parameter
+ /// \param symmetry_cut the Soft Drop symmetry cut
+ /// \param angular_cut the angular cutoff to halt Iterated Soft Drop
+ /// \param R0 the angular distance normalization
+ /// \param subtractor an optional pointer to a pileup subtractor (ignored if zero)
+ IteratedSoftDrop(double beta, double symmetry_cut, double angular_cut, double R0 = 1.0,
+ const FunctionOfPseudoJet<PseudoJet> * subtractor = 0);
+
+ /// 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)
+ ///
+ /// Notes:
+ ///
+ /// - by default, SoftDrop will recluster the jet with the
+ /// Cambridge/Aachen algorithm if it is not already the case. This
+ /// behaviour can be changed using the "set_reclustering" method
+ /// defined below
+ ///
+ IteratedSoftDrop(double beta,
+ double symmetry_cut,
+ RecursiveSoftDrop::SymmetryMeasure symmetry_measure,
+ double angular_cut,
+ double R0 = 1.0,
+ double mu_cut = std::numeric_limits<double>::infinity(),
+ RecursiveSoftDrop::RecursionChoice recursion_choice = RecursiveSoftDrop::larger_pt,
+ const FunctionOfPseudoJet<PseudoJet> * subtractor = 0);
+
+ /// default destructor
+ virtual ~IteratedSoftDrop(){}
+
+ //----------------------------------------------------------------------
+ // behaviour tweaks (inherited from RecursiveSoftDrop and RecursiveSymmetryCutBase)
+
+ /// switch to using a dynamical R0 (see RecursiveSoftDrop)
+ void set_dynamical_R0(bool value=true) { _rsd.set_dynamical_R0(value); }
+ bool use_dynamical_R0() const { return _rsd.use_dynamical_R0(); }
+
+ /// an alternative way to set the subtractor (see RecursiveSymmetryCutBase)
+ void set_subtractor(const FunctionOfPseudoJet<PseudoJet> * subtractor_) {_rsd.set_subtractor(subtractor_);}
+ const FunctionOfPseudoJet<PseudoJet> * subtractor() const {return _rsd.subtractor();}
+
+ /// returns the IteratedSoftDropInfo associated with the jet "jet"
+ IteratedSoftDropInfo result(const PseudoJet& jet) const;
+
+ /// Tells the tagger whether to assume that the input jet has
+ /// already been subtracted (relevant only with a non-null
+ /// subtractor, see RecursiveSymmetryCutBase)
+ void set_input_jet_is_subtracted(bool is_subtracted) { _rsd.set_input_jet_is_subtracted(is_subtracted);}
+ bool input_jet_is_subtracted() const {return _rsd.input_jet_is_subtracted();}
+
+ /// configure the reclustering prior to the recursive de-clustering
+ void set_reclustering(bool do_reclustering=true, const Recluster *recluster=0){
+ _rsd.set_reclustering(do_reclustering, recluster);
+ }
+
+ //----------------------------------------------------------------------
+ // actions on jets
+ /// returns vector of ISD symmetry factors and splitting angles
+ std::vector<std::pair<double,double> > all_zg_thetag(const PseudoJet& jet) const{
+ return result(jet).all_zg_thetag();
+ }
+
+ /// 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 angularity(const PseudoJet& jet, double alpha, double kappa=1.0) const{
+ return result(jet).angularity(alpha, kappa);
+ }
+
+ /// returns the Iterated SoftDrop multiplicity
+ double multiplicity(const PseudoJet& jet) const{ return result(jet).multiplicity(); }
+
+ /// description of the class
+ std::string description() const;
+
+protected:
+ RecursiveSoftDrop _rsd;
+};
+
+
+
+} // namespace contrib
+
+FASTJET_END_NAMESPACE
+
+#endif // __FASTJET_CONTRIB_ITERATEDSOFTDROP_HH__
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.3/IteratedSoftDrop.hh
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/ModifiedMassDropTagger.hh
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/ModifiedMassDropTagger.hh (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/ModifiedMassDropTagger.hh (revision 1431)
@@ -0,0 +1,128 @@
+// $Id$
+//
+// Copyright (c) 2014-, Gavin P. Salam
+// based on arXiv:1307.007 by Mrinal Dasgupta, Simone Marzani and 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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#ifndef __FASTJET_CONTRIB_MODIFIEDMASSDROPTAGGER_HH__
+#define __FASTJET_CONTRIB_MODIFIEDMASSDROPTAGGER_HH__
+
+#include "RecursiveSymmetryCutBase.hh"
+
+FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh
+
+namespace contrib{
+
+//------------------------------------------------------------------------
+/// \class ModifiedMassDropTagger
+/// An implementation of the modified Mass-Drop Tagger from arXiv:1307.0007.
+///
+class ModifiedMassDropTagger : public RecursiveSymmetryCutBase {
+public:
+
+ /// Simplified constructor, which takes just a symmetry cut (applied
+ /// on the scalar_z variable) and an optional subtractor.
+ ///
+ /// In this incarnation the ModifiedMassDropTagger is a bit of a
+ /// misnomer, because there is no mass-drop condition
+ /// applied. Recursion into the jet structure chooses the prong with
+ /// largest pt. (Results from arXiv:1307.0007 were based on the
+ /// largest mt, but this only makes a difference for values of the
+ /// symmetry_cut close to 1/2).
+ ///
+ /// If the (optional) pileup subtractor can be supplied, then see
+ /// also the documentation for the set_input_jet_is_subtracted() member
+ /// function.
+ ///
+ /// NB: The configuration of MMDT provided by this constructor is
+ /// probably the most robust for use with subtraction.
+ ModifiedMassDropTagger(double symmetry_cut,
+ const FunctionOfPseudoJet<PseudoJet> * subtractor = 0
+ ) :
+ RecursiveSymmetryCutBase(scalar_z, // the default SymmetryMeasure
+ std::numeric_limits<double>::infinity(), // the default is no mass drop
+ larger_pt, // the default RecursionChoice
+ subtractor),
+ _symmetry_cut(symmetry_cut)
+ {}
+
+ /// Full constructor, which takes the following parameters:
+ ///
+ /// \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 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)
+ ///
+ /// To obtain the mMDT as discussed in arXiv:1307.0007, use an
+ /// symmetry_measure that's one of the following
+ ///
+ /// - RecursiveSymmetryCutBase::y (for a cut on y)
+ /// - RecursiveSymmetryCutBase::scalar_z (for a cut on z)
+ ///
+ /// and use the default recursion choice of
+ /// RecursiveSymmetryCutBase::larger_pt (larger_mt will give something
+ /// very similar, while larger_m will give the behaviour of the
+ /// original, but now deprecated MassDropTagger)
+ ///
+ /// Notes:
+ ///
+ /// - By default the ModifiedMassDropTagger will relcuster the jets
+ /// with the C/A algorithm (if needed).
+ ///
+ /// - the mu_cut parameter is mostly irrelevant when it's taken
+ /// larger than about 1/2: the tagger is then one that cuts
+ /// essentially on the (a)symmetry of the jet's momentum
+ /// sharing. The default value of infinity turns off its use
+ /// entirely
+ ModifiedMassDropTagger(double symmetry_cut,
+ SymmetryMeasure symmetry_measure,
+ double mu_cut = std::numeric_limits<double>::infinity(),
+ RecursionChoice recursion_choice = larger_pt,
+ const FunctionOfPseudoJet<PseudoJet> * subtractor = 0
+ ) :
+ RecursiveSymmetryCutBase(symmetry_measure, mu_cut, recursion_choice, subtractor),
+ _symmetry_cut(symmetry_cut)
+ {}
+
+ /// default destructor
+ virtual ~ModifiedMassDropTagger(){}
+
+ //----------------------------------------------------------------------
+ // access to class info
+ double symmetry_cut() const { return _symmetry_cut; }
+
+protected:
+
+ /// The symmetry cut function for MMDT returns just a constant, since the cut value
+ /// has no dependence on the subjet kinematics
+ virtual double symmetry_cut_fn(const PseudoJet & /* p1 */,
+ const PseudoJet & /* p2 */,
+ void *extra_parameters = 0
+ ) const {return _symmetry_cut;}
+ virtual std::string symmetry_cut_description() const;
+
+ double _symmetry_cut;
+};
+
+} // namespace contrib
+
+FASTJET_END_NAMESPACE
+
+#endif // __FASTJET_CONTRIB_MODIFIEDMASSDROPTAGGER_HH__
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.3/ModifiedMassDropTagger.hh
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/Doxyfile
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/Doxyfile (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/Doxyfile (revision 1431)
@@ -0,0 +1,2281 @@
+# Doxyfile 1.8.5
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project.
+#
+# All text after a double hash (##) is considered a comment and is placed in
+# front of the TAG it is preceding.
+#
+# All text after a single hash (#) is considered a comment and will be ignored.
+# The format is:
+# TAG = value [value, ...]
+# For lists, items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (\" \").
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the config file
+# that follow. The default is UTF-8 which is also the encoding used for all text
+# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
+# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
+# for the list of possible encodings.
+# The default value is: UTF-8.
+
+DOXYFILE_ENCODING = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
+# double-quotes, unless you are using Doxywizard) that should identify the
+# project for which the documentation is generated. This name is used in the
+# title of most generated pages and in a few other places.
+# The default value is: My Project.
+
+PROJECT_NAME = "RecursiveTools"
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
+# could be handy for archiving the generated documentation or if some version
+# control system is used.
+
+PROJECT_NUMBER =
+
+# Using the PROJECT_BRIEF tag one can provide an optional one line description
+# for a project that appears at the top of each page and should give viewer a
+# quick idea about the purpose of the project. Keep the description short.
+
+PROJECT_BRIEF =
+
+# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
+# the documentation. The maximum height of the logo should not exceed 55 pixels
+# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
+# to the output directory.
+
+PROJECT_LOGO =
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
+# into which the generated documentation will be written. If a relative path is
+# entered, it will be relative to the location where doxygen was started. If
+# left blank the current directory will be used.
+
+OUTPUT_DIRECTORY =
+
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
+# directories (in 2 levels) under the output directory of each output format and
+# will distribute the generated files over these directories. Enabling this
+# option can be useful when feeding doxygen a huge amount of source files, where
+# putting all generated files in the same directory would otherwise causes
+# performance problems for the file system.
+# The default value is: NO.
+
+CREATE_SUBDIRS = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-
+# Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi,
+# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en,
+# Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish,
+# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
+# Turkish, Ukrainian and Vietnamese.
+# The default value is: English.
+
+OUTPUT_LANGUAGE = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
+# descriptions after the members that are listed in the file and class
+# documentation (similar to Javadoc). Set to NO to disable this.
+# The default value is: YES.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
+# description of a member or function before the detailed description
+#
+# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+# The default value is: YES.
+
+REPEAT_BRIEF = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator that is
+# used to form the text in various listings. Each string in this list, if found
+# as the leading text of the brief description, will be stripped from the text
+# and the result, after processing the whole list, is used as the annotated
+# text. Otherwise, the brief description is used as-is. If left blank, the
+# following values are used ($name is automatically replaced with the name of
+# the entity):The $name class, The $name widget, The $name file, is, provides,
+# specifies, contains, represents, a, an and the.
+
+ABBREVIATE_BRIEF =
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# doxygen will generate a detailed section even if there is only a brief
+# description.
+# The default value is: NO.
+
+ALWAYS_DETAILED_SEC = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+# The default value is: NO.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
+# before files name in the file list and in the header files. If set to NO the
+# shortest path that makes the file name unique will be used
+# The default value is: YES.
+
+FULL_PATH_NAMES = YES
+
+# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
+# Stripping is only done if one of the specified strings matches the left-hand
+# part of the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the path to
+# strip.
+#
+# Note that you can specify absolute paths here, but also relative paths, which
+# will be relative from the directory where doxygen is started.
+# This tag requires that the tag FULL_PATH_NAMES is set to YES.
+
+STRIP_FROM_PATH =
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
+# path mentioned in the documentation of a class, which tells the reader which
+# header file to include in order to use a class. If left blank only the name of
+# the header file containing the class definition is used. Otherwise one should
+# specify the list of include paths that are normally passed to the compiler
+# using the -I flag.
+
+STRIP_FROM_INC_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
+# less readable) file names. This can be useful is your file systems doesn't
+# support long names like on DOS, Mac, or CD-ROM.
+# The default value is: NO.
+
+SHORT_NAMES = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
+# first line (until the first dot) of a Javadoc-style comment as the brief
+# description. If set to NO, the Javadoc-style will behave just like regular Qt-
+# style comments (thus requiring an explicit @brief command for a brief
+# description.)
+# The default value is: NO.
+
+JAVADOC_AUTOBRIEF = YES
+
+# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
+# line (until the first dot) of a Qt-style comment as the brief description. If
+# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
+# requiring an explicit \brief command for a brief description.)
+# The default value is: NO.
+
+QT_AUTOBRIEF = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
+# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
+# a brief description. This used to be the default behavior. The new default is
+# to treat a multi-line C++ comment block as a detailed description. Set this
+# tag to YES if you prefer the old behavior instead.
+#
+# Note that setting this tag to YES also means that rational rose comments are
+# not recognized any more.
+# The default value is: NO.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
+# documentation from any documented member that it re-implements.
+# The default value is: YES.
+
+INHERIT_DOCS = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
+# new page for each member. If set to NO, the documentation of a member will be
+# part of the file/class/namespace that contains it.
+# The default value is: NO.
+
+SEPARATE_MEMBER_PAGES = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
+# uses this value to replace tabs by spaces in code fragments.
+# Minimum value: 1, maximum value: 16, default value: 4.
+
+TAB_SIZE = 4
+
+# This tag can be used to specify a number of aliases that act as commands in
+# the documentation. An alias has the form:
+# name=value
+# For example adding
+# "sideeffect=@par Side Effects:\n"
+# will allow you to put the command \sideeffect (or @sideeffect) in the
+# documentation, which will result in a user-defined paragraph with heading
+# "Side Effects:". You can put \n's in the value part of an alias to insert
+# newlines.
+
+ALIASES =
+
+# This tag can be used to specify a number of word-keyword mappings (TCL only).
+# A mapping has the form "name=value". For example adding "class=itcl::class"
+# will allow you to use the command class in the itcl::class meaning.
+
+TCL_SUBST =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
+# only. Doxygen will then generate output that is more tailored for C. For
+# instance, some of the names that are used will be different. The list of all
+# members will be omitted, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_FOR_C = NO
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
+# Python sources only. Doxygen will then generate output that is more tailored
+# for that language. For instance, namespaces will be presented as packages,
+# qualified scopes will look different, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources. Doxygen will then generate output that is tailored for Fortran.
+# The default value is: NO.
+
+OPTIMIZE_FOR_FORTRAN = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for VHDL.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_VHDL = NO
+
+# Doxygen selects the parser to use depending on the extension of the files it
+# parses. With this tag you can assign which parser to use for a given
+# extension. Doxygen has a built-in mapping, but you can override or extend it
+# using this tag. The format is ext=language, where ext is a file extension, and
+# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
+# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
+# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
+# (default is Fortran), use: inc=Fortran f=C.
+#
+# Note For files without extension you can use no_extension as a placeholder.
+#
+# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
+# the files are not read by doxygen.
+
+EXTENSION_MAPPING =
+
+# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
+# according to the Markdown format, which allows for more readable
+# documentation. See http://daringfireball.net/projects/markdown/ for details.
+# The output of markdown processing is further processed by doxygen, so you can
+# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
+# case of backward compatibilities issues.
+# The default value is: YES.
+
+MARKDOWN_SUPPORT = YES
+
+# When enabled doxygen tries to link words that correspond to documented
+# classes, or namespaces to their corresponding documentation. Such a link can
+# be prevented in individual cases by by putting a % sign in front of the word
+# or globally by setting AUTOLINK_SUPPORT to NO.
+# The default value is: YES.
+
+AUTOLINK_SUPPORT = YES
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should set this
+# tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string);
+# versus func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+# The default value is: NO.
+
+BUILTIN_STL_SUPPORT = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+# The default value is: NO.
+
+CPP_CLI_SUPPORT = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
+# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
+# will parse them like normal C++ but will assume all classes use public instead
+# of private inheritance when no explicit protection keyword is present.
+# The default value is: NO.
+
+SIP_SUPPORT = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate
+# getter and setter methods for a property. Setting this option to YES will make
+# doxygen to replace the get and set methods by a property in the documentation.
+# This will only work if the methods are indeed getting or setting a simple
+# type. If this is not the case, or you want to show the methods anyway, you
+# should set this option to NO.
+# The default value is: YES.
+
+IDL_PROPERTY_SUPPORT = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES, then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+# The default value is: NO.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# Set the SUBGROUPING tag to YES to allow class member groups of the same type
+# (for instance a group of public functions) to be put as a subgroup of that
+# type (e.g. under the Public Functions section). Set it to NO to prevent
+# subgrouping. Alternatively, this can be done per class using the
+# \nosubgrouping command.
+# The default value is: YES.
+
+SUBGROUPING = YES
+
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
+# are shown inside the group in which they are included (e.g. using \ingroup)
+# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
+# and RTF).
+#
+# Note that this feature does not work in combination with
+# SEPARATE_MEMBER_PAGES.
+# The default value is: NO.
+
+INLINE_GROUPED_CLASSES = NO
+
+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
+# with only public data fields or simple typedef fields will be shown inline in
+# the documentation of the scope in which they are defined (i.e. file,
+# namespace, or group documentation), provided this scope is documented. If set
+# to NO, structs, classes, and unions are shown on a separate page (for HTML and
+# Man pages) or section (for LaTeX and RTF).
+# The default value is: NO.
+
+INLINE_SIMPLE_STRUCTS = NO
+
+# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
+# enum is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically be
+# useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+# The default value is: NO.
+
+TYPEDEF_HIDES_STRUCT = NO
+
+# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
+# cache is used to resolve symbols given their name and scope. Since this can be
+# an expensive process and often the same symbol appears multiple times in the
+# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
+# doxygen will become slower. If the cache is too large, memory is wasted. The
+# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
+# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
+# symbols. At the end of a run doxygen will report the cache usage and suggest
+# the optimal cache size from a speed point of view.
+# Minimum value: 0, maximum value: 9, default value: 0.
+
+LOOKUP_CACHE_SIZE = 0
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# documentation are documented, even if no documentation was available. Private
+# class members and static file members will be hidden unless the
+# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
+# Note: This will also disable the warnings about undocumented members that are
+# normally produced when WARNINGS is set to YES.
+# The default value is: NO.
+
+EXTRACT_ALL = NO
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
+# be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PRIVATE = NO
+
+# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
+# scope will be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PACKAGE = NO
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
+# included in the documentation.
+# The default value is: NO.
+
+EXTRACT_STATIC = NO
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
+# locally in source files will be included in the documentation. If set to NO
+# only classes defined in header files are included. Does not have any effect
+# for Java sources.
+# The default value is: YES.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# This flag is only useful for Objective-C code. When set to YES local methods,
+# which are defined in the implementation section but not in the interface are
+# included in the documentation. If set to NO only methods in the interface are
+# included.
+# The default value is: NO.
+
+EXTRACT_LOCAL_METHODS = NO
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base name of
+# the file that contains the anonymous namespace. By default anonymous namespace
+# are hidden.
+# The default value is: NO.
+
+EXTRACT_ANON_NSPACES = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
+# undocumented members inside documented classes or files. If set to NO these
+# members will be included in the various overviews, but no documentation
+# section is generated. This option has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy. If set
+# to NO these classes will be included in the various overviews. This option has
+# no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
+
+HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
+# (class|struct|union) declarations. If set to NO these declarations will be
+# included in the documentation.
+# The default value is: NO.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
+# documentation blocks found inside the body of a function. If set to NO these
+# blocks will be appended to the function's detailed documentation block.
+# The default value is: NO.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation that is typed after a
+# \internal command is included. If the tag is set to NO then the documentation
+# will be excluded. Set it to YES to include the internal documentation.
+# The default value is: NO.
+
+INTERNAL_DOCS = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
+# names in lower-case letters. If set to YES upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# and Mac users are advised to set this option to NO.
+# The default value is: system dependent.
+
+CASE_SENSE_NAMES = NO
+
+# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
+# their full class and namespace scopes in the documentation. If set to YES the
+# scope will be hidden.
+# The default value is: NO.
+
+HIDE_SCOPE_NAMES = NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
+# the files that are included by a file in the documentation of that file.
+# The default value is: YES.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
+# files with double quotes in the documentation rather than with sharp brackets.
+# The default value is: NO.
+
+FORCE_LOCAL_INCLUDES = NO
+
+# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
+# documentation for inline members.
+# The default value is: YES.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
+# (detailed) documentation of file and class members alphabetically by member
+# name. If set to NO the members will appear in declaration order.
+# The default value is: YES.
+
+SORT_MEMBER_DOCS = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
+# descriptions of file, namespace and class members alphabetically by member
+# name. If set to NO the members will appear in declaration order.
+# The default value is: NO.
+
+SORT_BRIEF_DOCS = NO
+
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
+# (brief and detailed) documentation of class members so that constructors and
+# destructors are listed first. If set to NO the constructors will appear in the
+# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
+# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
+# member documentation.
+# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
+# detailed member documentation.
+# The default value is: NO.
+
+SORT_MEMBERS_CTORS_1ST = NO
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
+# of group names into alphabetical order. If set to NO the group names will
+# appear in their defined order.
+# The default value is: NO.
+
+SORT_GROUP_NAMES = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
+# fully-qualified names, including namespaces. If set to NO, the class list will
+# be sorted only by class name, not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the alphabetical
+# list.
+# The default value is: NO.
+
+SORT_BY_SCOPE_NAME = NO
+
+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
+# type resolution of all parameters of a function it will reject a match between
+# the prototype and the implementation of a member function even if there is
+# only one candidate or it is obvious which candidate to choose by doing a
+# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
+# accept a match between prototype and implementation in such cases.
+# The default value is: NO.
+
+STRICT_PROTO_MATCHING = NO
+
+# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
+# todo list. This list is created by putting \todo commands in the
+# documentation.
+# The default value is: YES.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
+# test list. This list is created by putting \test commands in the
+# documentation.
+# The default value is: YES.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
+# list. This list is created by putting \bug commands in the documentation.
+# The default value is: YES.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
+# the deprecated list. This list is created by putting \deprecated commands in
+# the documentation.
+# The default value is: YES.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional documentation
+# sections, marked by \if <section_label> ... \endif and \cond <section_label>
+# ... \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:
+#
+# <filter> <input-file>
+#
+# where <filter> is the value of the INPUT_FILTER tag, and <input-file> 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 <access key> + S
+# (what the <access key> is depends on the OS and browser, but it is typically
+# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
+# key> to jump into the search results window, the results can be navigated
+# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
+# the search. The filter options can be selected when the cursor is inside the
+# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
+# to select a filter and <Enter> or <escape> to activate or cancel the filter
+# option.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+SEARCHENGINE = YES
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a web server instead of a web client using Javascript. There
+# are two flavours of web server based searching depending on the
+# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
+# searching and an index file used by the script. When EXTERNAL_SEARCH is
+# enabled the indexing and searching needs to be provided by external tools. See
+# the section "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SERVER_BASED_SEARCH = NO
+
+# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
+# script for searching. Instead the search results are written to an XML file
+# which needs to be processed by an external indexer. Doxygen will invoke an
+# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
+# search results.
+#
+# Doxygen ships with an example indexer ( doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: http://xapian.org/).
+#
+# See the section "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH = NO
+
+# The SEARCHENGINE_URL should point to a search engine hosted by a web server
+# which will return the search results when EXTERNAL_SEARCH is enabled.
+#
+# Doxygen ships with an example indexer ( doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: http://xapian.org/). See the section "External Indexing and
+# Searching" for details.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHENGINE_URL =
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
+# search data is written to a file for indexing by an external tool. With the
+# SEARCHDATA_FILE tag the name of this file can be specified.
+# The default file is: searchdata.xml.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHDATA_FILE = searchdata.xml
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
+# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
+# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
+# projects and redirect the results back to the right project.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH_ID =
+
+# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
+# projects other than the one defined by this configuration file, but that are
+# all added to the same external search index. Each project needs to have a
+# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
+# to a relative location where the documentation can be found. The format is:
+# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTRA_SEARCH_MAPPINGS =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
+# The default value is: YES.
+
+GENERATE_LATEX = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX 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: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked.
+#
+# Note that when enabling USE_PDFLATEX this option is only used for generating
+# bitmaps for formulas in the HTML output, but not in the Makefile that is
+# written to the output directory.
+# The default file is: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_CMD_NAME = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
+# index for LaTeX.
+# The default file is: makeindex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+COMPACT_LATEX = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used by the
+# printer.
+# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
+# 14 inches) and executive (7.25 x 10.5 inches).
+# The default value is: a4.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+PAPER_TYPE = a4
+
+# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
+# that should be included in the LaTeX output. To get the times font for
+# instance you can specify
+# EXTRA_PACKAGES=times
+# If left blank no extra packages will be included.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+EXTRA_PACKAGES =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
+# generated LaTeX document. The header should contain everything until the first
+# chapter. If it is left blank doxygen will generate a standard header. See
+# section "Doxygen usage" for information on how to let doxygen write the
+# default header to a separate file.
+#
+# Note: Only use a user-defined header if you know what you are doing! The
+# following commands have a special meaning inside the header: $title,
+# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
+# replace them by respectively the title of the page, the current date and time,
+# only the current date, the version number of doxygen, the project name (see
+# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HEADER =
+
+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
+# generated LaTeX document. The footer should contain everything after the last
+# chapter. If it is left blank doxygen will generate a standard footer.
+#
+# Note: Only use a user-defined footer if you know what you are doing!
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_FOOTER =
+
+# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the LATEX_OUTPUT output
+# directory. Note that the files will be copied as-is; there are no commands or
+# markers available.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_FILES =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
+# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
+# contain links (just like the HTML output) instead of page references. This
+# makes the output suitable for online browsing using a PDF viewer.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+PDF_HYPERLINKS = YES
+
+# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
+# the PDF file directly from the LaTeX files. Set this option to YES to get a
+# higher quality PDF documentation.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+USE_PDFLATEX = YES
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
+# command to the generated LaTeX files. This will instruct LaTeX to keep running
+# if errors occur, instead of asking the user for help. This option is also used
+# when generating formulas in HTML.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BATCHMODE = NO
+
+# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
+# index chapters (such as File Index, Compound Index, etc.) in the output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HIDE_INDICES = NO
+
+# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
+# code with syntax highlighting in the LaTeX output.
+#
+# Note that which sources are shown also depends on other settings such as
+# SOURCE_BROWSER.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_SOURCE_CODE = NO
+
+# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
+# bibliography, e.g. plainnat, or ieeetr. See
+# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
+# The default value is: plain.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BIB_STYLE = plain
+
+#---------------------------------------------------------------------------
+# Configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
+# RTF output is optimized for Word 97 and may not look too pretty with other RTF
+# readers/editors.
+# The default value is: NO.
+
+GENERATE_RTF = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF 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: rtf.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_OUTPUT = rtf
+
+# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+COMPACT_RTF = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
+# contain hyperlink fields. The RTF file will contain links (just like the HTML
+# output) instead of page references. This makes the output suitable for online
+# browsing using Word or some other Word compatible readers that support those
+# fields.
+#
+# Note: WordPad (write) and others do not support links.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_HYPERLINKS = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's config
+# file, i.e. a series of assignments. You only have to provide replacements,
+# missing definitions are set to their default value.
+#
+# See also section "Doxygen usage" for information on how to generate the
+# default style sheet that doxygen normally uses.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an RTF document. Syntax is
+# similar to doxygen's config file. A template extensions file can be generated
+# using doxygen -e rtf extensionFile.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
+# classes and files.
+# The default value is: NO.
+
+GENERATE_MAN = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it. A directory man3 will be created inside the directory specified by
+# MAN_OUTPUT.
+# The default directory is: man.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to the generated
+# man pages. In case the manual section does not start with a number, the number
+# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
+# optional.
+# The default value is: .3.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_EXTENSION = .3
+
+# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
+# will generate one additional man file for each entity documented in the real
+# man page(s). These additional files only source the real man page, but without
+# them the man command would be unable to find the correct page.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
+# captures the structure of the code including all documentation.
+# The default value is: NO.
+
+GENERATE_XML = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages 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: xml.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_OUTPUT = xml
+
+# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
+# validating XML parser to check the syntax of the XML files.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_SCHEMA =
+
+# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
+# validating XML parser to check the syntax of the XML files.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_DTD =
+
+# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
+# listings (including syntax highlighting and cross-referencing information) to
+# the XML output. Note that enabling this will significantly increase the size
+# of the XML output.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_PROGRAMLISTING = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to the DOCBOOK output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
+# that can be used to generate PDF.
+# The default value is: NO.
+
+GENERATE_DOCBOOK = NO
+
+# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages 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: docbook.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_OUTPUT = docbook
+
+#---------------------------------------------------------------------------
+# Configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
+# Definitions (see http://autogen.sf.net) file that captures the structure of
+# the code including all documentation. Note that this feature is still
+# experimental and incomplete at the moment.
+# The default value is: NO.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
+# file that captures the structure of the code including all documentation.
+#
+# Note that this feature is still experimental and incomplete at the moment.
+# The default value is: NO.
+
+GENERATE_PERLMOD = NO
+
+# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
+# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
+# output from the Perl module output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_LATEX = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
+# formatted so it can be parsed by a human reader. This is useful if you want to
+# understand what is going on. On the other hand, if this tag is set to NO the
+# size of the Perl module output will be much smaller and Perl will parse it
+# just the same.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file are
+# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
+# so different doxyrules.make files included by the same Makefile don't
+# overwrite each other's variables.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
+# C-preprocessor directives found in the sources and include files.
+# The default value is: YES.
+
+ENABLE_PREPROCESSING = YES
+
+# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
+# in the source code. If set to NO only conditional compilation will be
+# performed. Macro expansion can be done in a controlled way by setting
+# EXPAND_ONLY_PREDEF to YES.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+MACRO_EXPANSION = YES
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
+# the macro expansion is limited to the macros specified with the PREDEFINED and
+# EXPAND_AS_DEFINED tags.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+EXPAND_ONLY_PREDEF = YES
+
+# If the SEARCH_INCLUDES tag is set to YES the includes files in the
+# INCLUDE_PATH will be searched if a #include is found.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+SEARCH_INCLUDES = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by the
+# preprocessor.
+# This tag requires that the tag SEARCH_INCLUDES is set to YES.
+
+INCLUDE_PATH =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will be
+# used.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+INCLUDE_FILE_PATTERNS =
+
+# The PREDEFINED tag can be used to specify one or more macro names that are
+# defined before the preprocessor is started (similar to the -D option of e.g.
+# gcc). The argument of the tag is a list of macros of the form: name or
+# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
+# is assumed. To prevent a macro definition from being undefined via #undef or
+# recursively expanded use the := operator instead of the = operator.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+PREDEFINED = "FASTJET_BEGIN_NAMESPACE= namespace fastjet{" \
+ "FASTJET_END_NAMESPACE=}"
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
+# tag can be used to specify a list of macro names that should be expanded. The
+# macro definition that is found in the sources will be used. Use the PREDEFINED
+# tag if you want to use a different macro definition that overrules the
+# definition found in the source code.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+EXPAND_AS_DEFINED =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
+# remove all refrences to function-like macros that are alone on a line, have an
+# all uppercase name, and do not end with a semicolon. Such function macros are
+# typically used for boiler-plate code, and will confuse the parser if not
+# removed.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+SKIP_FUNCTION_MACROS = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES tag can be used to specify one or more tag files. For each tag
+# file the location of the external documentation should be added. The format of
+# a tag file without this location is as follows:
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where loc1 and loc2 can be relative or absolute paths or URLs. See the
+# section "Linking to external documentation" for more information about the use
+# of tag files.
+# Note: Each tag file must have an unique name (where the name does NOT include
+# the path). If a tag file is not located in the directory in which doxygen is
+# run, you must also specify the path to the tagfile here.
+
+TAGFILES =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
+# tag file that is based on the input files it reads. See section "Linking to
+# external documentation" for more information about the usage of tag files.
+
+GENERATE_TAGFILE =
+
+# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
+# class index. If set to NO only the inherited external classes will be listed.
+# The default value is: NO.
+
+ALLEXTERNALS = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
+# the modules index. If set to NO, only the current project's groups will be
+# listed.
+# The default value is: YES.
+
+EXTERNAL_GROUPS = YES
+
+# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
+# the related pages index. If set to NO, only the current project's pages will
+# be listed.
+# The default value is: YES.
+
+EXTERNAL_PAGES = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of 'which perl').
+# The default file (with absolute path) is: /usr/bin/perl.
+
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
+# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
+# NO turns the diagrams off. Note that this option also works with HAVE_DOT
+# disabled, but it is recommended to install and use dot, since it yields more
+# powerful graphs.
+# The default value is: YES.
+
+CLASS_DIAGRAMS = YES
+
+# You can define message sequence charts within doxygen comments using the \msc
+# command. Doxygen will then run the mscgen tool (see:
+# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
+# the mscgen tool resides. If left empty the tool is assumed to be found in the
+# default search path.
+
+MSCGEN_PATH =
+
+# If set to YES, the inheritance and collaboration graphs will hide inheritance
+# and usage relations if the target is undocumented or is not a class.
+# The default value is: YES.
+
+HIDE_UNDOC_RELATIONS = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz (see:
+# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
+# Bell Labs. The other options in this section have no effect if this option is
+# set to NO
+# The default value is: NO.
+
+HAVE_DOT = NO
+
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
+# to run in parallel. When set to 0 doxygen will base this on the number of
+# processors available in the system. You can set it explicitly to a value
+# larger than 0 to get control over the balance between CPU load and processing
+# speed.
+# Minimum value: 0, maximum value: 32, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_NUM_THREADS = 0
+
+# When you want a differently looking font n the dot files that doxygen
+# generates you can specify the font name using DOT_FONTNAME. You need to make
+# sure dot is able to find the font, which can be done by putting it in a
+# standard location or by setting the DOTFONTPATH environment variable or by
+# setting DOT_FONTPATH to the directory containing the font.
+# The default value is: Helvetica.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTNAME = Helvetica
+
+# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
+# dot graphs.
+# Minimum value: 4, maximum value: 24, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTSIZE = 10
+
+# By default doxygen will tell dot to use the default font as specified with
+# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
+# the path where dot can find it using this tag.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTPATH =
+
+# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
+# each documented class showing the direct and indirect inheritance relations.
+# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CLASS_GRAPH = YES
+
+# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
+# graph for each documented class showing the direct and indirect implementation
+# dependencies (inheritance, containment, and class references variables) of the
+# class with other documented classes.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+COLLABORATION_GRAPH = YES
+
+# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
+# groups, showing the direct groups dependencies.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GROUP_GRAPHS = YES
+
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LOOK = NO
+
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
+# class node. If there are many fields or methods and many nodes the graph may
+# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
+# number of items for each type to make the size more manageable. Set this to 0
+# for no limit. Note that the threshold may be exceeded by 50% before the limit
+# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
+# but if the number exceeds 15, the total amount of fields shown is limited to
+# 10.
+# Minimum value: 0, maximum value: 100, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LIMIT_NUM_FIELDS = 10
+
+# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
+# collaboration graphs will show the relations between templates and their
+# instances.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+TEMPLATE_RELATIONS = NO
+
+# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
+# YES then doxygen will generate a graph for each documented file showing the
+# direct and indirect include dependencies of the file with other documented
+# files.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INCLUDE_GRAPH = YES
+
+# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
+# set to YES then doxygen will generate a graph for each documented file showing
+# the direct and indirect include dependencies of the file with other documented
+# files.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INCLUDED_BY_GRAPH = YES
+
+# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
+# dependency graph for every global function or class method.
+#
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable call graphs for selected
+# functions only using the \callgraph command.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CALL_GRAPH = NO
+
+# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
+# dependency graph for every global function or class method.
+#
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable caller graphs for selected
+# functions only using the \callergraph command.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CALLER_GRAPH = NO
+
+# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
+# hierarchy of all classes instead of a textual one.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GRAPHICAL_HIERARCHY = YES
+
+# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
+# dependencies a directory has on other directories in a graphical way. The
+# dependency relations are determined by the #include relations between the
+# files in the directories.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DIRECTORY_GRAPH = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot.
+# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
+# to make the SVG files visible in IE 9+ (other browsers do not have this
+# requirement).
+# Possible values are: png, jpg, gif and svg.
+# The default value is: png.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_IMAGE_FORMAT = png
+
+# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
+# enable generation of interactive SVG images that allow zooming and panning.
+#
+# Note that this requires a modern browser other than Internet Explorer. Tested
+# and working are Firefox, Chrome, Safari, and Opera.
+# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
+# the SVG files visible. Older versions of IE do not have SVG support.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INTERACTIVE_SVG = NO
+
+# The DOT_PATH tag can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_PATH =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the \dotfile
+# command).
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOTFILE_DIRS =
+
+# The MSCFILE_DIRS tag can be used to specify one or more directories that
+# contain msc files that are included in the documentation (see the \mscfile
+# command).
+
+MSCFILE_DIRS =
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
+# that will be shown in the graph. If the number of nodes in a graph becomes
+# larger than this value, doxygen will truncate the graph, which is visualized
+# by representing a node as a red box. Note that doxygen if the number of direct
+# children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
+# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+# Minimum value: 0, maximum value: 10000, default value: 50.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_GRAPH_MAX_NODES = 50
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
+# generated by dot. A depth value of 3 means that only nodes reachable from the
+# root by following a path via at most 3 edges will be shown. Nodes that lay
+# further from the root node will be omitted. Note that setting this option to 1
+# or 2 may greatly reduce the computation time needed for large code bases. Also
+# note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+# Minimum value: 0, maximum value: 1000, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+MAX_DOT_GRAPH_DEPTH = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is disabled by default, because dot on Windows does not seem
+# to support this out of the box.
+#
+# Warning: Depending on the platform used, enabling this option may lead to
+# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
+# read).
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_TRANSPARENT = NO
+
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10) support
+# this, this feature is disabled by default.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_MULTI_TARGETS = NO
+
+# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
+# explaining the meaning of the various boxes and arrows in the dot generated
+# graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GENERATE_LEGEND = YES
+
+# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
+# files that are used to generate the various graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_CLEANUP = YES
Index: contrib/contribs/RecursiveTools/tags/2.0.3/VERSION
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/VERSION (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/VERSION (revision 1431)
@@ -0,0 +1 @@
+2.0.3
Index: contrib/contribs/RecursiveTools/tags/2.0.3/AUTHORS
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/AUTHORS (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/AUTHORS (revision 1431)
@@ -0,0 +1,31 @@
+The RecursiveTools FastJet contrib is developed and maintained by:
+
+ Gavin P. Salam <gavin.salam@cern.ch>
+ Gregory Soyez <soyez@fastjet.fr>
+ Jesse Thaler <jthaler@jthaler.net>
+ Kevin Zhou <knzhou@mit.edu>
+ Frederic Dreyer <fdreyer@mit.edu>
+
+The physics is based on:
+
+ [ModifiedMassDropTagger]
+ Towards an understanding of jet substructure.
+ Mrinal Dasgupta, Alessandro Fregoso, Simone Marzani, and Gavin P. Salam.
+ JHEP 1309:029 (2013), arXiv:1307.0007.
+
+ [SoftDrop]
+ Soft Drop.
+ Andrew J. Larkoski, Simone Marzani, Gregory Soyez, and Jesse Thaler.
+ JHEP 1405:146 (2014), arXiv:1402.2657
+
+ [IteratedSoftDrop]
+ Casimir Meets Poisson: Improved Quark/Gluon Discrimination with Counting Observables.
+ Christopher Frye, Andrew J. Larkoski, Jesse Thaler, Kevin Zhou.
+ JHEP 1709:083 (2017), arXiv:1704.06266
+
+ [RecursiveSoftDrop]
+ [BottomUpSoftDrop]
+ Recursive Soft Drop.
+ Frederic A. Dreyer, Lina Necib, Gregory Soyez, and Jesse Thaler
+ JHEP 1806:093 (2018), arXiv:1804.03657
+
\ No newline at end of file
Index: contrib/contribs/RecursiveTools/tags/2.0.3/example_mmdt.ref
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/example_mmdt.ref (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/example_mmdt.ref (revision 1431)
@@ -0,0 +1,39 @@
+# read an event with 354 particles
+#--------------------------------------------------------------------------
+# FastJet release 3.1.0-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,
+# CGAL and 3rd party plugin jet algorithms. See COPYING file for details.
+#--------------------------------------------------------------------------
+tagger is: Recursive Tagger with a symmetry cut scalar_z > 0.1 [ModifiedMassDropTagger], no mass-drop requirement, recursion into the subjet with larger pt
+
+original jet: pt = 983.387 m = 39.9912 y = -0.867307 phi = 2.90511
+tagged jet: pt = 917.674 m = 8.70484 y = -0.869593 phi = 2.90788
+ delta_R between subjets: 0.0200353
+ symmetry measure(z): 0.154333
+ mass drop(mu): 0.557579
+filtered jet: pt = 917.674 m = 8.70484 y = -0.869593 phi = 2.90788
+
+
+original jet: pt = 910.164 m = 122.615 y = 0.223738 phi = 6.04265
+tagged jet: pt = 800.269 m = 4.03811 y = 0.223011 phi = 6.03096
+ delta_R between subjets: 0.0101382
+ symmetry measure(z): 0.235041
+ mass drop(mu): 0.229134
+filtered jet: pt = 778.731 m = 3.66481 y = 0.223066 phi = 6.0309
+
+
+original jet: pt = 73.2118 m = 21.4859 y = -1.16399 phi = 6.11977
+tagged jet: pt = 57.6019 m = 5.96709 y = -1.19982 phi = 6.11382
+ delta_R between subjets: 0.116062
+ symmetry measure(z): 0.246343
+ mass drop(mu): 0.741581
+filtered jet: pt = 46.7389 m = 4.6395 y = -1.19991 phi = 6.12566
+
Index: contrib/contribs/RecursiveTools/tags/2.0.3/example_bottomup_softdrop.cc
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/example_bottomup_softdrop.cc (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/example_bottomup_softdrop.cc (revision 1431)
@@ -0,0 +1,123 @@
+//----------------------------------------------------------------------
+/// \file example_bottomup_softdrop.cc
+///
+/// This example program is meant to illustrate how the
+/// fastjet::contrib::BottomUpSoftDrop class is used.
+///
+/// Run this example with
+///
+/// \verbatim
+/// ./example_bottomup_softdrop < ../data/single-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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#include <iostream>
+#include <sstream>
+
+#include <iomanip>
+#include <cmath>
+#include "fastjet/ClusterSequence.hh"
+#include "BottomUpSoftDrop.hh" // In external code, this should be fastjet/contrib/BottomUpSoftDrop.hh
+
+using namespace std;
+using namespace fastjet;
+
+// forward declaration to make things clearer
+void read_event(vector<PseudoJet> &event);
+void print_prongs(const PseudoJet &jet, const string &pprefix);
+ostream & operator<<(ostream &, const PseudoJet &);
+
+//----------------------------------------------------------------------
+int main(){
+
+ //----------------------------------------------------------
+ // read in input particles
+ vector<PseudoJet> event;
+ read_event(event);
+ cout << "# read an event with " << event.size() << " particles" << endl;
+
+ // first get some anti-kt jets
+ double R = 1.0, ptmin = 100.0;
+ JetDefinition jet_def(antikt_algorithm, R);
+ ClusterSequence cs(event, jet_def);
+ vector<PseudoJet> jets = sorted_by_pt(cs.inclusive_jets(ptmin));
+
+ //----------------------------------------------------------------------
+ // give the soft drop groomer a short name
+ // Use a symmetry cut z > z_cut R^beta
+ // By default, there is no mass-drop requirement
+ double z_cut = 0.2;
+ double beta = 1.0;
+ contrib::BottomUpSoftDrop busd(beta, z_cut);
+
+ //----------------------------------------------------------------------
+ cout << "BottomUpSoftDrop groomer is: " << busd.description() << endl;
+
+ for (unsigned ijet = 0; ijet < jets.size(); ijet++) {
+ // Run SoftDrop and examine the output
+ PseudoJet busd_jet = busd(jets[ijet]);
+ cout << endl;
+ cout << "original jet: " << jets[ijet] << endl;
+ cout << "BottomUpSoftDropped jet: " << busd_jet << endl;
+
+ assert(busd_jet != 0); //because bottom-up soft drop is a groomer (not a tagger), it should always return a soft-dropped jet
+
+ }
+
+ return 0;
+}
+
+//----------------------------------------------------------------------
+/// read in input particles
+void read_event(vector<PseudoJet> &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 << " pt = " << jet.pt()
+ << " m = " << jet.m()
+ << " y = " << jet.rap()
+ << " phi = " << jet.phi();
+ }
+ return ostr;
+}
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.3/example_bottomup_softdrop.cc
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3/BottomUpSoftDrop.hh
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3/BottomUpSoftDrop.hh (revision 0)
+++ contrib/contribs/RecursiveTools/tags/2.0.3/BottomUpSoftDrop.hh (revision 1431)
@@ -0,0 +1,303 @@
+// $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 <http://www.gnu.org/licenses/>.
+//----------------------------------------------------------------------
+
+#ifndef __BOTTOMUPSOFTDROP_HH__
+#define __BOTTOMUPSOFTDROP_HH__
+
+#include "fastjet/ClusterSequence.hh"
+#include "fastjet/WrappedStructure.hh"
+#include "fastjet/tools/Transformer.hh"
+
+#include <iostream>
+#include <string>
+
+// TODO
+//
+// - missing class description
+//
+// - check what to do when pta=ptb=0
+// for the moment, we recombine both for multiple reasons
+// . this avois breakingteh symemtry between pa and pb
+// . it would be groomed in later steps anyway
+// Note that this is slightly inconsistent with our use of
+// > (instead of >=) in the cdt
+
+FASTJET_BEGIN_NAMESPACE
+
+namespace contrib{
+
+// fwd declarations
+class BottomUpSoftDrop;
+class BottomUpSoftDropStructure;
+class BottomUpSoftDropRecombiner;
+class BottomUpSoftDropPlugin;
+
+//----------------------------------------------------------------------
+/// \class BottomUpSoftDrop
+/// Implementation of the BottomUpSoftDrop transformer
+///
+/// Bottom-Up Soft drop grooms a jet by applying a modified
+/// recombination scheme, where particles are recombined only if they
+/// pass the Soft Drop condition
+///
+/// \f[
+/// z < z_{\rm cut} (\theta/R0)^\beta
+/// \f]
+///
+/// the groomed jet contains the particles remaining after this
+/// pair-wise recombination
+///
+/// Note:
+/// - one can use BottomUpSoftDrop on a full event with the
+/// global_grooming(event) method.
+/// - if two recombined particles a and b have momentum pta=ptb=0,
+/// we recombine both.
+///
+
+
+class BottomUpSoftDrop : public Transformer {
+public:
+ /// minimal constructor, which the jet algorithm to CA, sets the radius
+ /// to JetDefinition::max_allowable_R (practically equivalent to
+ /// infinity) and also tries to use a recombiner based on the one in
+ /// the jet definition of the particular jet being Soft Dropped.
+ ///
+ /// \param beta the value for beta
+ /// \param symmetry_cut the value for symmetry_cut
+ /// \param R0 the value for R0
+ BottomUpSoftDrop(double beta, double symmetry_cut, double R0 = 1.0)
+ : _jet_def(cambridge_algorithm, JetDefinition::max_allowable_R),
+ _beta(beta),_symmetry_cut(symmetry_cut), _R0(R0),
+ _get_recombiner_from_jet(true) {}
+
+ /// alternative constructor which takes a specified jet algorithm
+ ///
+ /// \param jet_alg the jet algorithm for the internal clustering (uses R=infty)
+ /// \param symmetry_cut the value of symmetry_cut
+ /// \param beta the value for beta
+ /// \param R0 the value for R0
+ BottomUpSoftDrop(const JetAlgorithm jet_alg, double beta, double symmetry_cut,
+ double R0 = 1.0)
+ : _jet_def(jet_alg, JetDefinition::max_allowable_R),
+ _beta(beta), _symmetry_cut(symmetry_cut), _R0(R0),
+ _get_recombiner_from_jet(true) {}
+
+
+ /// alternative ctor in which the full reclustering jet definition can
+ /// be specified.
+ ///
+ /// \param jet_def the jet definition for the internal clustering
+ /// \param symmetry_cut the value of symmetry_cut
+ /// \param beta the value for beta
+ /// \param R0 the value for R0
+ BottomUpSoftDrop(const JetDefinition &jet_def, double beta, double symmetry_cut,
+ double R0 = 1.0)
+ : _jet_def(jet_def), _beta(beta), _symmetry_cut(symmetry_cut), _R0(R0),
+ _get_recombiner_from_jet(false) {}
+
+ /// action on a single jet
+ virtual PseudoJet result(const PseudoJet &jet) const;
+
+ /// global grooming on a full event
+ /// note: does not support jet areas
+ virtual std::vector<PseudoJet> global_grooming(const std::vector<PseudoJet> & event) const;
+
+ /// description
+ virtual std::string description() const;
+
+ // the type of the associated structure
+ typedef BottomUpSoftDropStructure StructureType;
+
+private:
+ /// check if the jet has explicit_ghosts (knowing that there is an
+ /// area support)
+ bool _check_explicit_ghosts(const PseudoJet &jet) const;
+
+ /// see if there is a common recombiner among the pieces; if there
+ /// is return true and set jet_def_for_recombiner so that the
+ /// recombiner can be taken from that JetDefinition. Otherwise,
+ /// return false. 'assigned' is initially false; when true, each
+ /// time we meet a new jet definition, we'll check it shares the
+ /// same recombiner as jet_def_for_recombiner.
+ bool _check_common_recombiner(const PseudoJet &jet,
+ JetDefinition &jet_def_for_recombiner,
+ bool assigned=false) const;
+
+
+ JetDefinition _jet_def; ///< the internal jet definition
+ double _beta; ///< the value of beta
+ double _symmetry_cut; ///< the value of symmetry_cut
+ double _R0; ///< the value of R0
+ bool _get_recombiner_from_jet; ///< true for minimal constructor,
+ ///< causes recombiner to be set equal
+ ///< to that already used in the jet
+ ///< (if it can be deduced)
+};
+
+//----------------------------------------------------------------------
+/// The structure associated with a PseudoJet thas has gone through a
+/// bottom/up SoftDrop transformer
+class BottomUpSoftDropStructure : public WrappedStructure{
+public:
+ /// default ctor
+ /// \param result_jet the jet for which we have to keep the structure
+ BottomUpSoftDropStructure(const PseudoJet & result_jet)
+ : WrappedStructure(result_jet.structure_shared_ptr()){}
+
+ /// description
+ virtual std::string description() const{
+ return "Bottom/Up Soft Dropped PseudoJet";
+ }
+
+ /// return the constituents that have been rejected
+ std::vector<PseudoJet> rejected() const{
+ return validated_cs()->childless_pseudojets();
+ }
+
+ /// return the other jets that may have been found along with the
+ /// result of the bottom/up Soft Drop
+ /// The resulting vector is sorted in pt
+ std::vector<PseudoJet> extra_jets() const {
+ return sorted_by_pt((!SelectorNHardest(1))(validated_cs()->inclusive_jets()));
+ }
+
+ /// return the value of beta that was used for this specific Soft Drop.
+ double beta() const {return _beta;}
+
+ /// return the value of symmetry_cut that was used for this specific Soft Drop.
+ double symmetry_cut() const {return _symmetry_cut;}
+
+ /// return the value of R0 that was used for this specific Soft Drop.
+ double R0() const {return _R0;}
+
+protected:
+ friend class BottomUpSoftDrop; ///< to allow setting the internal information
+
+private:
+ double _beta, _symmetry_cut, _R0;
+};
+
+//----------------------------------------------------------------------
+/// Class for Soft Drop recombination
+/// recombines the objects that are not vetoed by Bottom-Up SoftDrop
+///
+/// This recombiner only recombines, using the provided 'recombiner',
+/// objects (i and j) that pass the following SoftDrop criterion:
+///
+/// min(pti, ptj) > zcut (pti+ptj) (theta_ij/R0)^beta
+///
+/// If the criterion fail, the hardest of i and j is kept and the
+/// softest is rejected.
+///
+/// Note that this in not meant for standalone use [in particular
+/// because it could lead to memory issues due to the rejected indices
+/// stored internally].
+///
+/// This class is a direct adaptation of PruningRecombiner in Fastjet tools
+class BottomUpSoftDropRecombiner : public JetDefinition::Recombiner {
+public:
+ /// ctor
+ /// \param symmetry_cut value of cut on symmetry measure
+ /// \param beta avalue of beta parameter
+ /// \param recomb pointer to a recombiner to use to cluster pairs
+ BottomUpSoftDropRecombiner(double beta, double symmetry_cut, double R0,
+ const JetDefinition::Recombiner *recombiner)
+ : _beta(beta), _symmetry_cut(symmetry_cut), _R0sqr(R0*R0),
+ _recombiner(recombiner) {}
+
+ /// perform a recombination taking into account the Soft Drop
+ /// conditions
+ virtual void recombine(const PseudoJet &pa,
+ const PseudoJet &pb,
+ PseudoJet &pab) const;
+
+ /// returns the description of the recombiner
+ virtual std::string description() const {
+ std::ostringstream oss;
+ oss << "SoftDrop recombiner with symmetry_cut = " << _symmetry_cut
+ << ", beta = " << _beta
+ << ", and underlying recombiner = " << _recombiner->description();
+ return oss.str();
+ }
+
+ /// return the history indices that have been soft dropped away
+ const std::vector<unsigned int> & rejected() const{ return _rejected;}
+
+ /// clears the list of rejected indices
+ ///
+ /// If one decides to use this recombiner standalone, one has to
+ /// call this after each clustering in order for the rejected() vector
+ /// to remain sensible and not grow to infinite size.
+ void clear_rejected(){ _rejected.clear();}
+
+private:
+ double _beta; ///< beta parameter
+ double _symmetry_cut; ///< value of symmetry_cut
+ double _R0sqr; ///< normalisation of the angular distance
+ const JetDefinition::Recombiner *_recombiner; ///< the underlying recombiner to use
+ mutable std::vector<unsigned int> _rejected; ///< list of rejected history indices
+};
+
+//----------------------------------------------------------------------
+/// \class BottomUpSoftDropPlugin
+/// Class for a bottom/up Soft Drop algorithm, based on the Pruner plugin
+///
+/// This is an internal plugin that clusters the particles using the
+/// BottomUpRecombiner.
+///
+/// See BottomUpRecombiner for a description of what bottom-up
+/// SoftDrop does.
+///
+/// Note that this is an internal class used by the BottomUpSoftDrop
+/// transformer and it is not meant to be used as a standalone
+/// clustering tool.
+class BottomUpSoftDropPlugin : public JetDefinition::Plugin {
+public:
+ /// ctor
+ /// \param jet_def the jet definition to be used for the
+ /// internal clustering
+ /// \param symmetry_cut value of cut on symmetry measure
+ /// \param beta value of beta parameter
+ BottomUpSoftDropPlugin(const JetDefinition &jet_def, double beta, double symmetry_cut,
+ double R0 = 1.0)
+ : _jet_def(jet_def), _beta(beta), _symmetry_cut(symmetry_cut), _R0(R0) {}
+
+ /// the actual clustering work for the plugin
+ virtual void run_clustering(ClusterSequence &input_cs) const;
+
+ /// description of the plugin
+ virtual std::string description() const;
+
+ /// returns the radius
+ virtual double R() const {return _jet_def.R();}
+
+private:
+ JetDefinition _jet_def; ///< the internal jet definition
+ double _beta; ///< beta parameter
+ double _symmetry_cut; ///< value of symmetry_cut
+ double _R0; ///< normalisation of the angular distance
+};
+
+}
+
+FASTJET_END_NAMESPACE // defined in fastjet/internal/base.hh
+#endif // __BOTTOMUPSOFTDROP_HH__
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.3/BottomUpSoftDrop.hh
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Index: contrib/contribs/RecursiveTools/tags/2.0.3
===================================================================
--- contrib/contribs/RecursiveTools/tags/2.0.3 (revision 1430)
+++ contrib/contribs/RecursiveTools/tags/2.0.3 (revision 1431)
Property changes on: contrib/contribs/RecursiveTools/tags/2.0.3
___________________________________________________________________
Added: svn:mergeinfo
Merged /contrib/contribs/RecursiveTools/branches/1.0-beta1-softdrop-addition:r611-681
Added: svn:ignore
## -0,0 +1,3 ##
+html
+
+example

File Metadata

Mime Type
text/x-diff
Expires
Tue, Nov 19, 6:27 PM (1 d, 22 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3805592
Default Alt Text
(424 KB)

Event Timeline