FastJet  3.0.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ClusterSequencePassiveArea.hh
1 //STARTHEADER
2 // $Id: ClusterSequencePassiveArea.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_CLUSTERSEQUENCEPASSIVEAREA_HH__
30 #define __FASTJET_CLUSTERSEQUENCEPASSIVEAREA_HH__
31 
32 
33 #include "fastjet/PseudoJet.hh"
34 #include "fastjet/ClusterSequence1GhostPassiveArea.hh"
35 #include<iostream>
36 #include<vector>
37 
38 FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh
39 
40 //using namespace std;
41 
42 /// @ingroup sec_area_classes
43 /// \class ClusterSequencePassiveArea
44 /// Like ClusterSequence with computation of the passive jet area
45 ///
46 /// Class that behaves essentially like ClusterSequence except
47 /// that it also provides access to the area of a jet (which
48 /// will be a random quantity... Figure out what to do about seeds
49 /// later...)
50 ///
51 /// This class should not be used directly. Rather use
52 /// ClusterSequenceArea with the appropriate AreaDefinition
54 public:
55 
56  /// constructor based on JetDefinition and PassiveAreaSpec
57  template<class L> ClusterSequencePassiveArea
58  (const std::vector<L> & pseudojets,
59  const JetDefinition & jet_def_in,
60  const GhostedAreaSpec & area_spec,
61  const bool & writeout_combinations = false) ;
62 
63  /// return an empty area that's appropriate to the passive area
64  /// determination carried out
65  virtual double empty_area(const Selector & selector) const;
66 
67 private:
68 
69  /// does the initialisation and running specific to the passive
70  /// areas class
71  void _initialise_and_run_PA (const JetDefinition & jet_def_in,
72  const GhostedAreaSpec & area_spec,
73  const bool & writeout_combinations = false);
74 
75 };
76 
77 
78 
79 
80 template<class L> ClusterSequencePassiveArea::ClusterSequencePassiveArea
81 (const std::vector<L> & pseudojets,
82  const JetDefinition & jet_def_in,
83  const GhostedAreaSpec & area_spec,
84  const bool & writeout_combinations) {
85 
86  // transfer the initial jets (type L) into our own array
87  _transfer_input_jets(pseudojets);
88 
89  // run the clustering for passive areas
90  _initialise_and_run_PA(jet_def_in, area_spec, writeout_combinations);
91 
92 }
93 
94 
95 
96 FASTJET_END_NAMESPACE
97 
98 #endif // __FASTJET_CLUSTERSEQUENCEPASSIVEAREA_HH__