FastJet  3.0.6
ClusterSequence1GhostPassiveArea.hh
1 //STARTHEADER
2 // $Id: ClusterSequence1GhostPassiveArea.hh 2687 2011-11-14 11:17:51Z soyez $
3 //
4 // Copyright (c) 2005-2011, Matteo Cacciari, Gavin P. Salam and Gregory Soyez
5 //
6 //----------------------------------------------------------------------
7 // This file is part of FastJet.
8 //
9 // FastJet is free software; you can redistribute it and/or modify
10 // it under the terms of the GNU General Public License as published by
11 // the Free Software Foundation; either version 2 of the License, or
12 // (at your option) any later version.
13 //
14 // The algorithms that underlie FastJet have required considerable
15 // development and are described in hep-ph/0512210. If you use
16 // FastJet as part of work towards a scientific publication, please
17 // include a citation to the FastJet paper.
18 //
19 // FastJet is distributed in the hope that it will be useful,
20 // but WITHOUT ANY WARRANTY; without even the implied warranty of
21 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 // GNU General Public License for more details.
23 //
24 // You should have received a copy of the GNU General Public License
25 // along with FastJet. If not, see <http://www.gnu.org/licenses/>.
26 //----------------------------------------------------------------------
27 //ENDHEADER
28 
29 #ifndef __FASTJET_CLUSTERSEQUENCE1GHOSTPASSIVEAREA_HH__
30 #define __FASTJET_CLUSTERSEQUENCE1GHOSTPASSIVEAREA_HH__
31 
32 
33 #include "fastjet/PseudoJet.hh"
34 #include "fastjet/ClusterSequenceAreaBase.hh"
35 #include "fastjet/ClusterSequenceActiveArea.hh"
36 #include<iostream>
37 #include<vector>
38 
39 FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh
40 
41 //using namespace std;
42 
43 /// @ingroup sec_area_classes
44 /// \class ClusterSequence1GhostPassiveArea
45 /// Like ClusterSequence with computation of the passive jet area by
46 /// adding a single ghost
47 ///
48 /// Class that behaves essentially like ClusterSequence except
49 /// that it also provides access to the area of a jet (which
50 /// will be a random quantity... Figure out what to do about seeds
51 /// later...)
52 ///
53 /// This class should not be used directly. Rather use
54 /// ClusterSequenceArea
56 public:
57 
59 
60  /// constructor based on JetDefinition and 1GhostPassiveAreaSpec
61  template<class L> ClusterSequence1GhostPassiveArea
62  (const std::vector<L> & pseudojets,
63  const JetDefinition & jet_def_in,
64  const GhostedAreaSpec & area_spec,
65  const bool & writeout_combinations = false) ;
66 
67  /// return an estimate for the number of empty jets -- one uses the
68  /// AreaBase one rather than the ActiveArea one (which for which we
69  /// do not have the information).
70  virtual double n_empty_jets(const Selector & selector) const {
71  return ClusterSequenceAreaBase::n_empty_jets(selector);
72  }
73 
74 protected:
75  /// does the initialisation and running specific to the passive
76  /// areas class
77  void _initialise_and_run_1GPA (const JetDefinition & jet_def_in,
78  const GhostedAreaSpec & area_spec,
79  const bool & writeout_combinations = false);
80 
81 private:
82 
83  void _run_1GPA(const GhostedAreaSpec & area_spec);
84 };
85 
86 
87 
88 
89 template<class L> ClusterSequence1GhostPassiveArea::ClusterSequence1GhostPassiveArea
90 (const std::vector<L> & pseudojets,
91  const JetDefinition & jet_def_in,
92  const GhostedAreaSpec & area_spec,
93  const bool & writeout_combinations) {
94 
95  // transfer the initial jets (type L) into our own array
96  _transfer_input_jets(pseudojets);
97 
98  // run the clustering for passive areas
99  _initialise_and_run_1GPA(jet_def_in, area_spec, writeout_combinations);
100 
101 }
102 
103 
104 
105 FASTJET_END_NAMESPACE
106 
107 #endif // __FASTJET_CLUSTERSEQUENCE1GHOSTPASSIVEAREA_HH__
virtual double n_empty_jets(const Selector &selector) const
return an estimate for the number of empty jets – one uses the AreaBase one rather than the ActiveAr...
Like ClusterSequence with computation of the passive jet area by adding a single ghost.
Like ClusterSequence with computation of the active jet area.
Class that encodes information about cuts and other selection criteria that can be applied to PseudoJ...
Definition: Selector.hh:141
Parameters to configure the computation of jet areas using ghosts.
class that is intended to hold a full definition of the jet clusterer