-
Notifications
You must be signed in to change notification settings - Fork 35
/
clustersequence.go
542 lines (480 loc) · 12.6 KB
/
clustersequence.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
// Copyright 2017 The go-hep Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package fastjet
import (
"errors"
"fmt"
"math"
"go-hep.org/x/hep/fastjet/internal/heap"
"go-hep.org/x/hep/fmom"
)
// history holds information about the clustering
type history struct {
parent1 int // index of first parent of this jet were created
parent2 int // index of second parent of this jet were created
child int // index where the current jet is recombined with another
jet int
dij float64
maxdij float64
}
const (
invalidIndex = -3
inexistentParent = -2
beamJetIndex = -1
)
type ClusterSequence struct {
def JetDefinition
alg JetAlgorithm
strategy Strategy
r float64
r2 float64
invR2 float64
qtot float64
initn int
jets []Jet
history []history
structure JetStructure
}
func NewClusterSequence(jets []Jet, def JetDefinition) (*ClusterSequence, error) {
var err error
cs := &ClusterSequence{
def: def,
alg: def.Algorithm(),
strategy: def.Strategy(),
r: def.R(),
jets: make([]Jet, len(jets), len(jets)*2),
}
cs.r2 = cs.r * cs.r
cs.invR2 = 1.0 / cs.r2
cs.structure = ClusterSequenceStructure{cs}
copy(cs.jets, jets)
err = cs.init()
if err != nil {
return nil, err
}
err = cs.run()
if err != nil {
return nil, err
}
return cs, err
}
// NumExclusiveJets returns the number of exclusive jets that would have been obtained
// running the algorithm in exclusive mode with the given dcut
func (cs *ClusterSequence) NumExclusiveJets(dcut float64) int {
// first locate where clustering would have stopped
i := len(cs.history) - 1 // last jet
for ; 0 <= i; i-- {
if cs.history[i].maxdij <= dcut {
break
}
}
stoppt := i + 1
njets := 2*cs.initn - stoppt
return njets
}
func (cs *ClusterSequence) ExclusiveJets(dcut float64) ([]Jet, error) {
njets := cs.NumExclusiveJets(dcut)
return cs.ExclusiveJetsUpTo(njets)
}
func (cs *ClusterSequence) ExclusiveJetsUpTo(njets int) ([]Jet, error) {
var err error
if njets > cs.initn {
err = errors.New("fastjet: requested too many exclusive jets")
return nil, err
}
// calculate the point where we have to stop the clustering
// relation between stoppt, njets assumes one extra jet disappears
// at each clustering
stoppt := 2*cs.initn - njets
// make sure it's safe when more jets are requested than there are particles
if stoppt < cs.initn {
stoppt = cs.initn
}
// additional checking
if 2*cs.initn != len(cs.history) {
err = errors.New("fastjet: too few initial jets")
return nil, err
}
// now go forwards and reconstitute the jets that we have --
// basically for any history element, see if the parent jets to
// which it refers were created before the stopping point -- if they
// were then add them to the list, otherwise they are subsequent
// recombinations of the jets that we are looking for
ljets := make([]Jet, 0, imin(njets, cs.initn))
for i := stoppt; i < len(cs.history); i++ {
parent1 := cs.history[i].parent1
if parent1 < stoppt {
ljets = append(ljets, cs.jets[cs.history[parent1].jet])
}
parent2 := cs.history[i].parent2
if 0 < parent2 && parent2 < stoppt {
ljets = append(ljets, cs.jets[cs.history[parent2].jet])
}
}
return ljets, err
}
func (cs *ClusterSequence) InclusiveJets(ptmin float64) ([]Jet, error) {
var err error
dcut := ptmin * ptmin
jets := make([]Jet, 0)
i := len(cs.history) - 1 // last jet
switch cs.alg {
case KtAlgorithm:
for ; 0 <= i; i-- {
// with our specific definition of dij and dib (ie: R appears only in
// dij) then dij==dib is the same as the jet.Pt2() and we can exploit
// this in selecting the jets...
if cs.history[i].maxdij < dcut {
break
}
if hh := cs.history[i]; hh.parent2 == beamJetIndex && hh.dij >= dcut {
// for beam jets
jets = append(jets, cs.jets[cs.history[hh.parent1].jet])
}
}
case CambridgeAlgorithm:
for ; 0 <= i; i-- {
// inclusive jets are all at the end of clustering sequence in the
// cambridge algorithm.
// if we find a non-exclusive jet, exit.
if cs.history[i].parent2 != beamJetIndex {
break
}
parent1 := cs.history[i].parent1
jet := &cs.jets[cs.history[parent1].jet]
if jet.Pt2() >= dcut {
jets = append(jets, *jet)
}
}
case PluginAlgorithm, EeKtAlgorithm, AntiKtAlgorithm,
GenKtAlgorithm, EeGenKtAlgorithm, CambridgeForPassiveAlgorithm:
// for inclusive jets with a plugin algorithm, we make no
// assumption about anything (relation of dij to momenta,
// ordering of the dij, etc...)
for ; 0 <= i; i-- {
hh := cs.history[i]
if hh.parent2 != beamJetIndex {
continue
}
parent1 := hh.parent1
jet := &cs.jets[cs.history[parent1].jet]
if jet.Pt2() >= dcut {
jets = append(jets, *jet)
}
}
}
return jets, err
}
func (cs *ClusterSequence) init() error {
var err error
cs.history = make([]history, 0, len(cs.jets)*2)
cs.qtot = 0
for i := range cs.jets {
jet := &cs.jets[i]
cs.history = append(cs.history,
history{
parent1: inexistentParent,
parent2: inexistentParent,
child: invalidIndex,
jet: i,
dij: 0.0,
maxdij: 0.0,
},
)
// perform any momentum pre-processing needed by the recombination scheme
err = cs.def.Recombiner().Preprocess(jet)
if err != nil {
return err
}
jet.hidx = i
jet.structure = cs.structure
cs.qtot += jet.E()
}
// store the initial number of particles.
// this is used by the ClusterSequence to compute the number of exclusive jets
// (in the ExclusiveJets method).
cs.initn = len(cs.jets)
return err
}
func (cs *ClusterSequence) run() error {
var err error
// nothing to run when event is empty
if len(cs.jets) <= 0 {
return err
}
// FIXME
err = cs.runN3Dumb()
if err != nil {
return err
}
return err
}
// Constituents retrieves the list of constituents of a given jet
func (cs *ClusterSequence) Constituents(jet *Jet) ([]Jet, error) {
return cs.addConstituents(jet)
}
func (cs *ClusterSequence) addConstituents(jet *Jet) ([]Jet, error) {
var err error
var subjets []Jet
// find position in cluster history
i := jet.hidx
hh := &cs.history[i]
parent1 := hh.parent1
if parent1 == inexistentParent {
// It is an original particle (labelled by its parent having value
// inexistentParent), therefore add it on to the subjet vector
// Note: we add the initial particle and not simply 'jet' so that
// calling addConstituents with a subtracted jet containing
// only one particle will work.
subjets = append(subjets, cs.jets[i])
return subjets, err
}
// add parent 1
sub1, err := cs.addConstituents(&cs.jets[cs.history[parent1].jet])
if err != nil {
return subjets, err
}
subjets = append(subjets, sub1...)
// see if parent2 is a real jet, then add its constituents
parent2 := hh.parent2
if parent2 == beamJetIndex {
return subjets, err
}
sub2, err := cs.addConstituents(&cs.jets[cs.history[parent2].jet])
if err != nil {
return subjets, err
}
subjets = append(subjets, sub2...)
return subjets, err
}
func (cs *ClusterSequence) jetScaleForAlgorithm(jet *Jet) float64 {
switch cs.alg {
case KtAlgorithm:
return jet.Pt2()
case CambridgeAlgorithm:
return 1.0
case AntiKtAlgorithm:
kt2 := jet.Pt2()
if kt2 > 1e-300 {
return 1.0 / kt2
}
return 1e300
case GenKtAlgorithm:
kt2 := jet.Pt2()
p := cs.def.ExtraParam()
if p <= 0 && kt2 < 1e-300 {
kt2 = 1e-300
}
return math.Pow(kt2, p)
case CambridgeForPassiveAlgorithm:
kt2 := jet.Pt2()
lim := cs.def.ExtraParam()
if kt2 < lim*lim && kt2 != 0 {
return 1.0 / kt2
}
return 1.0
case EeGenKtAlgorithm:
kt2 := jet.E()
p := cs.def.ExtraParam()
if p <= 0 && kt2 < 1e-300 {
kt2 = 1e-300
}
return math.Pow(kt2, 2*p)
case EeKtAlgorithm:
e := jet.E()
if e < 1e-300 {
e = 1e-300
}
return e * e
default:
panic(fmt.Errorf("fastjet: unrecognised jet algorithm (%v)", cs.alg))
}
}
func (cs *ClusterSequence) setStructure(j *Jet) {
j.structure = cs.structure
}
// do_ij_recombination_step
func (cs *ClusterSequence) ijRecombinationStep(i, j int, dij float64) (int, error) {
k := -1
// create the new jet by recombining the first two
ijet := &cs.jets[i]
jjet := &cs.jets[j]
kjet, err := cs.def.Recombiner().Recombine(ijet, jjet)
if err != nil {
return k, err
}
k = len(cs.jets)
khist := len(cs.history)
kjet.hidx = khist
cs.jets = append(cs.jets, kjet)
ihist := ijet.hidx
jhist := jjet.hidx
err = cs.addStepToHistory(khist, imin(ihist, jhist), imax(ihist, jhist), k, dij)
return k, err
}
func (cs *ClusterSequence) ibRecombinationStep(i int, dib float64) error {
k := len(cs.history)
err := cs.addStepToHistory(k, cs.jets[i].hidx, beamJetIndex, invalidIndex, dib)
return err
}
func (cs *ClusterSequence) addStepToHistory(istep, i1, i2, idx int, dij float64) error {
var err error
cs.history = append(cs.history,
history{
parent1: i1,
parent2: i2,
jet: idx,
child: invalidIndex,
dij: dij,
maxdij: math.Max(dij, cs.history[len(cs.history)-1].maxdij),
},
)
step := len(cs.history) - 1
if step != istep {
panic(fmt.Errorf("fastjet: internal logic error (step number dont match (%d != %d))",
step, istep,
))
}
cs.history[i1].child = step
if i2 >= 0 {
cs.history[i2].child = step
}
// get cross-referencing right
if idx != invalidIndex {
cs.jets[idx].hidx = step
cs.setStructure(&cs.jets[idx])
}
return err
}
// runs the N3Dumb strategy
func (cs *ClusterSequence) runN3Dumb() error {
var err error
njets := len(cs.jets)
type jetinfo struct {
jet *Jet
idx int
}
jets := make([]jetinfo, njets)
indices := make([]int, njets)
for i := range cs.jets {
jets[i] = jetinfo{
jet: &cs.jets[i],
idx: i,
}
indices[i] = i
}
for n := njets; n > 0; n-- {
ii := 0
jj := -2
// find smallest beam distance
ymin := cs.jetScaleForAlgorithm(jets[0].jet)
for i := 0; i < n; i++ {
y := cs.jetScaleForAlgorithm(jets[i].jet)
if y < ymin {
ymin = y
ii = i
jj = -2
}
}
// find smallest distance between pair of jets
for i := 0; i < n-1; i++ {
ijet := jets[i].jet
for j := i + 1; j < n; j++ {
jjet := jets[j].jet
jetscale := math.Min(
cs.jetScaleForAlgorithm(ijet),
cs.jetScaleForAlgorithm(jjet),
)
y := math.MaxFloat64
switch cs.alg {
case EeGenKtAlgorithm:
den := 1 - math.Cos(cs.r)
if cs.r > math.Pi {
den = 3 + math.Cos(cs.r)
}
if den != 0 {
y = jetscale * (1 - fmom.CosTheta(&ijet.PxPyPzE, &jjet.PxPyPzE)) / den
}
case EeKtAlgorithm:
y = 2 * jetscale * (1 - fmom.CosTheta(&ijet.PxPyPzE, &jjet.PxPyPzE))
default:
y = jetscale * Distance(ijet, jjet) * cs.invR2
}
if y < ymin {
ymin = y
ii = i
jj = j
}
}
}
// now recombine
newn := 2*len(jets) - n
if jj >= 0 {
//combine pair
nn, err := cs.ijRecombinationStep(jets[ii].idx, jets[jj].idx, ymin)
if err != nil {
return err
}
// internal bookkeeping
jets[ii] = jetinfo{
jet: &cs.jets[nn],
idx: nn,
}
// have jj point to jet that was pointed at by n-1
// since original jj is no longer current
jets[jj] = jets[n-1]
indices[ii] = newn
indices[jj] = indices[n-1]
} else {
// combine ii with beam
err = cs.ibRecombinationStep(jets[ii].idx, ymin)
if err != nil {
return err
}
// put last jet in place of ii which has disappeared
jets[ii] = jets[n-1]
indices[ii] = indices[n-1]
}
}
return err
}
// runNlnN runs the clustering using a Hierarchical Delaunay triangulation
// and a min-heap to achieve O(N*ln N) behaviour.
//
// There are internally asserted assumptions about absence of points
// with coincident eta-phi coordinates.
func (cs *ClusterSequence) runNlnN() error {
panic(fmt.Errorf("fastjet: runNlnN not implemented"))
}
// addKtDistance adds the current kt distance for particle jeti to the heap
// using information about the nearest neighbor in the eta-phi plane.
// Work as follows:
//
// . if the kt is zero then its nearest neighbour is taken to be
// the beam jet and the distance is zero.
//
// . if cylinder distance to nearest neighbour > r^2 then it is
// yiB that is smallest and this is added to the heap.
//
// . otherwise if the nearest neighbour jj has a larger kt then add
// dij to the heap.
//
// . otherwise do nothing
//
func (cs *ClusterSequence) addKtDistance(h *heap.Heap, jeti, jetj int, dist float64) {
yiB := cs.jetScaleForAlgorithm(&cs.jets[jeti])
if yiB == 0 {
h.Push(jeti, beamJetIndex, yiB)
return
}
deltaR2 := dist * cs.invR2
if deltaR2 > 1 {
h.Push(jeti, beamJetIndex, yiB)
return
}
if yiB <= cs.jetScaleForAlgorithm(&cs.jets[jetj]) {
dij := deltaR2 * yiB
h.Push(jeti, jetj, dij)
}
}