FastJet
3.1.0-beta.1
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Groups
Pages
plugins
Jade
fastjet
JadePlugin.hh
1
#ifndef __JADEPLUGIN_HH__
2
#define __JADEPLUGIN_HH__
3
4
//FJSTARTHEADER
5
// $Id: JadePlugin.hh 3433 2014-07-23 08:17:03Z salam $
6
//
7
// Copyright (c) 2005-2014, Matteo Cacciari, Gavin P. Salam and Gregory Soyez
8
//
9
//----------------------------------------------------------------------
10
// This file is part of FastJet.
11
//
12
// FastJet is free software; you can redistribute it and/or modify
13
// it under the terms of the GNU General Public License as published by
14
// the Free Software Foundation; either version 2 of the License, or
15
// (at your option) any later version.
16
//
17
// The algorithms that underlie FastJet have required considerable
18
// development. They are described in the original FastJet paper,
19
// hep-ph/0512210 and in the manual, arXiv:1111.6097. If you use
20
// FastJet as part of work towards a scientific publication, please
21
// quote the version you use and include a citation to the manual and
22
// optionally also to hep-ph/0512210.
23
//
24
// FastJet is distributed in the hope that it will be useful,
25
// but WITHOUT ANY WARRANTY; without even the implied warranty of
26
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27
// GNU General Public License for more details.
28
//
29
// You should have received a copy of the GNU General Public License
30
// along with FastJet. If not, see <http://www.gnu.org/licenses/>.
31
//----------------------------------------------------------------------
32
//FJENDHEADER
33
34
#include "fastjet/JetDefinition.hh"
35
36
FASTJET_BEGIN_NAMESPACE
// defined in fastjet/internal/base.hh
37
38
// forward declaration to reduce includes
39
class
ClusterSequence;
40
41
//----------------------------------------------------------------------
42
//
43
/// @ingroup plugins
44
/// \class JadePlugin
45
/// Implementation of the e+e- Jade algorithm (plugin for fastjet v2.4 upwards)
46
///
47
/// JadePlugin is a plugin for fastjet (v2.4 upwards)
48
/// It implements the JADE algorithm, which is an e+e- sequential
49
/// recombination algorithm with interparticle distance
50
///
51
/// dij = 2 E_i E_j (1 - cos theta_ij)
52
///
53
/// or equivalently
54
///
55
/// yij = dij/E_{vis}^2
56
///
57
/// This corresponds to the distance measured used in
58
///
59
/// "Experimental Investigation of the Energy Dependence of the Strong Coupling Strength."
60
/// JADE Collaboration (S. Bethke et al.)
61
/// Phys.Lett.B213:235,1988
62
///
63
/// The JADE article carries out particle recombinations in the
64
/// E-scheme (4-vector recombination), which is the default procedure for this
65
/// plugin.
66
///
67
/// NOTE: other widely used schemes include E0, P, P0; however they also
68
/// involve modifications to the distance measure. Be sure of
69
/// what you're doing before running a JADE type algorithm.
70
///
71
/// To access the jets with a given ycut value (clustering stops once
72
/// all yij > ycut), use
73
///
74
/// vector<PseudoJet> jets = cluster_sequence.exclusive_jets_ycut(ycut);
75
///
76
/// and related routines.
77
class
JadePlugin
:
public
JetDefinition::Plugin
{
78
public
:
79
/// Main constructor for the Jade Plugin class.
80
JadePlugin
(){}
81
82
/// copy constructor
83
JadePlugin
(
const
JadePlugin
& plugin) {
84
*
this
= plugin;
85
}
86
87
// the things that are required by base class
88
virtual
std::string description ()
const
;
89
virtual
void
run_clustering(
ClusterSequence
&)
const
;
90
91
/// the plugin mechanism's standard way of accessing the jet radius.
92
/// This must be set to return something sensible, even if R
93
/// does not make sense for this algorithm!
94
virtual
double
R
()
const
{
return
1.0;}
95
96
/// avoid the warning whenever the user requests "exclusive" jets
97
/// from the cluster sequence
98
virtual
bool
exclusive_sequence_meaningful
()
const
{
return
true
;}
99
100
private
:
101
102
};
103
104
FASTJET_END_NAMESPACE
// defined in fastjet/internal/base.hh
105
106
#endif // __JADEPLUGIN_HH__
107
Generated on Fri Aug 15 2014 16:12:48 for FastJet by
1.8.4