include/fastjet/ClusterSequence1GhostPassiveArea.hh

0001 //FJSTARTHEADER
0002 // $Id$
0003 //
0004 // Copyright (c) 2005-2021, Matteo Cacciari, Gavin P. Salam and Gregory Soyez
0005 //
0006 //----------------------------------------------------------------------
0007 // This file is part of FastJet.
0008 //
0009 //  FastJet is free software; you can redistribute it and/or modify
0010 //  it under the terms of the GNU General Public License as published by
0011 //  the Free Software Foundation; either version 2 of the License, or
0012 //  (at your option) any later version.
0013 //
0014 //  The algorithms that underlie FastJet have required considerable
0015 //  development. They are described in the original FastJet paper,
0016 //  hep-ph/0512210 and in the manual, arXiv:1111.6097. If you use
0017 //  FastJet as part of work towards a scientific publication, please
0018 //  quote the version you use and include a citation to the manual and
0019 //  optionally also to hep-ph/0512210.
0020 //
0021 //  FastJet is distributed in the hope that it will be useful,
0022 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
0023 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0024 //  GNU General Public License for more details.
0025 //
0026 //  You should have received a copy of the GNU General Public License
0027 //  along with FastJet. If not, see <http://www.gnu.org/licenses/>.
0028 //----------------------------------------------------------------------
0029 //FJENDHEADER
0030
0031 #ifndef __FASTJET_CLUSTERSEQUENCE1GHOSTPASSIVEAREA_HH__
0032 #define __FASTJET_CLUSTERSEQUENCE1GHOSTPASSIVEAREA_HH__
0033
0034
0035 #include "fastjet/PseudoJet.hh"
0036 #include "fastjet/ClusterSequenceAreaBase.hh"
0037 #include "fastjet/ClusterSequenceActiveArea.hh"
0038 #include<iostream>
0039 #include<vector>
0040
0041 FASTJET_BEGIN_NAMESPACE      // defined in fastjet/internal/base.hh
0042
0043 //using namespace std;
0044
0045 /// @ingroup sec_area_classes
0046 /// \class ClusterSequence1GhostPassiveArea
0047 /// Like ClusterSequence with computation of the passive jet area by
0048 /// adding a single ghost
0049 ///
0050 /// Class that behaves essentially like ClusterSequence except
0051 /// that it also provides access to the area of a jet (which
0052 /// will be a random quantity... Figure out what to do about seeds
0053 /// later...)
0054 ///
0055 /// This class should not be used directly. Rather use
0056 /// ClusterSequenceArea
0057 class ClusterSequence1GhostPassiveArea : public ClusterSequenceActiveArea {
0058 public:
0059
0060   ClusterSequence1GhostPassiveArea() {}
0061
0062   /// constructor based on JetDefinition and 1GhostPassiveAreaSpec
0063   template<class L> ClusterSequence1GhostPassiveArea
0064          (const std::vector<L> & pseudojets,
0065       const JetDefinition & jet_def_in,
0066       const GhostedAreaSpec & area_spec,
0067       const bool & writeout_combinations = false) ;
0068
0069   /// return an estimate for the number of empty jets -- one uses the
0070   /// AreaBase one rather than the ActiveArea one (which for which we
0071   /// do not have the information).
0072   virtual double n_empty_jets(const Selector & selector) const FASTJET_OVERRIDE{
0073     return ClusterSequenceAreaBase::n_empty_jets(selector);
0074   }
0075
0076 protected:
0077   /// does the initialisation and running specific to the passive
0078   /// areas class
0079   void _initialise_and_run_1GPA (const JetDefinition & jet_def_in,
0080                                const GhostedAreaSpec & area_spec,
0081                                const bool & writeout_combinations = false);
0082
0083 private:
0084
0085   void _run_1GPA(const GhostedAreaSpec & area_spec);
0086 };
0087
0088
0089
0090
0091 template<class L> ClusterSequence1GhostPassiveArea::ClusterSequence1GhostPassiveArea
0092 (const std::vector<L> & pseudojets,
0093  const JetDefinition & jet_def_in,
0094  const GhostedAreaSpec & area_spec,
0095  const bool & writeout_combinations) {
0096
0097   // transfer the initial jets (type L) into our own array
0098   _transfer_input_jets(pseudojets);
0099
0100   // run the clustering for passive areas
0101   _initialise_and_run_1GPA(jet_def_in, area_spec, writeout_combinations);
0102
0103 }
0104
0105
0106
0107 FASTJET_END_NAMESPACE
0108
0109 #endif // __FASTJET_CLUSTERSEQUENCE1GHOSTPASSIVEAREA_HH__