include/fastjet/ClusterSequencePassiveArea.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_CLUSTERSEQUENCEPASSIVEAREA_HH__
0032 #define __FASTJET_CLUSTERSEQUENCEPASSIVEAREA_HH__
0033
0034
0035 #include "fastjet/PseudoJet.hh"
0036 #include "fastjet/ClusterSequence1GhostPassiveArea.hh"
0037 #include<iostream>
0038 #include<vector>
0039
0040 FASTJET_BEGIN_NAMESPACE      // defined in fastjet/internal/base.hh
0041
0042 //using namespace std;
0043
0044 /// @ingroup sec_area_classes
0045 /// \class ClusterSequencePassiveArea
0046 /// Like ClusterSequence with computation of the passive jet area
0047 ///
0048 /// Class that behaves essentially like ClusterSequence except
0049 /// that it also provides access to the area of a jet (which
0050 /// will be a random quantity... Figure out what to do about seeds
0051 /// later...)
0052 ///
0053 /// This class should not be used directly. Rather use
0054 /// ClusterSequenceArea with the appropriate AreaDefinition
0055 class ClusterSequencePassiveArea : public ClusterSequence1GhostPassiveArea {
0056 public:
0057
0058   /// constructor based on JetDefinition and PassiveAreaSpec
0059   template<class L> ClusterSequencePassiveArea
0060          (const std::vector<L> & pseudojets,
0061       const JetDefinition & jet_def_in,
0062       const GhostedAreaSpec & area_spec,
0063       const bool & writeout_combinations = false) ;
0064
0065   /// return an empty area that's appropriate to the passive area
0066   /// determination carried out
0067   virtual double empty_area(const Selector & selector) const FASTJET_OVERRIDE;
0068
0069 private:
0070
0071   /// does the initialisation and running specific to the passive
0072   /// areas class
0073   void _initialise_and_run_PA (const JetDefinition & jet_def_in,
0074                                const GhostedAreaSpec & area_spec,
0075                                const bool & writeout_combinations = false);
0076
0077 };
0078
0079
0080
0081
0082 template<class L> ClusterSequencePassiveArea::ClusterSequencePassiveArea
0083 (const std::vector<L> & pseudojets,
0084  const JetDefinition & jet_def_in,
0085  const GhostedAreaSpec & area_spec,
0086  const bool & writeout_combinations) {
0087
0088   // transfer the initial jets (type L) into our own array
0089   _transfer_input_jets(pseudojets);
0090
0091   // run the clustering for passive areas
0092   _initialise_and_run_PA(jet_def_in, area_spec, writeout_combinations);
0093
0094 }
0095
0096
0097
0098 FASTJET_END_NAMESPACE
0099
0100 #endif // __FASTJET_CLUSTERSEQUENCEPASSIVEAREA_HH__