23 auto delta_x = x1 - x2;
24 auto delta_y = y1 - y2;
25 auto r_square = delta_x * delta_x + delta_y * delta_y;
26 return std::sqrt(r_square);
31T
CLUE::dist(T x1, T y1, T z1, T x2, T y2, T z2) {
32 auto delta_x = x1 - x2;
33 auto delta_y = y1 - y2;
34 auto delta_z = z1 - z2;
35 auto r_square = delta_x * delta_x + delta_y * delta_y + delta_z * delta_z;
36 return std::sqrt(r_square);
44void CLUE::electronSeparation(std::vector<ldmx::EcalHit> hits) {
45 std::vector<double> layer_thickness = {2., 3.5, 5.3, 5.3, 5.3, 5.3,
46 5.3, 5.3, 5.3, 5.3, 5.3, 10.5,
47 10.5, 10.5, 10.5, 10.5};
50 std::sort(hits.begin(), hits.end(),
52 return a.getZPos() < b.getZPos();
55 std::vector<ldmx::EcalHit> first_layers;
56 std::vector<IntermediateCluster> first_layer_clusters;
58 double layer_z = hits[0].getZPos();
59 for (
const auto& hit : hits) {
60 if (hit.getZPos() > layer_z + layer_thickness[layer_tag] + air) {
65 first_layers.push_back(hit);
67 cluster.setLayer(layer_tag);
68 first_layer_clusters.push_back(cluster);
73 for (
int i = 0; i < first_layer_clusters.size(); i++) {
74 if (first_layer_clusters[i].empty())
continue;
76 for (
int j = i + 1; j < first_layer_clusters.size(); j++) {
77 if (first_layer_clusters[j].empty())
continue;
78 if (
dist(first_layer_clusters[i].centroidX(),
79 first_layer_clusters[i].centroidY(),
80 first_layer_clusters[j].centroidX(),
81 first_layer_clusters[j].centroidY()) < 8.) {
82 first_layer_clusters[i].add(first_layer_clusters[j]);
83 first_layer_clusters[j].clear();
90 ldmx_log(trace) <<
"--- ELECTRON SEPARATION ---";
91 for (
int i = 0; i < first_layer_clusters.size(); i++) {
92 if (first_layer_clusters[i].empty())
continue;
93 ldmx_log(trace) <<
" Cluster " << i
94 <<
" x: " << first_layer_clusters[i].centroidX()
95 <<
" y: " << first_layer_clusters[i].centroidY();
96 for (
int j = i + 1; j < first_layer_clusters.size(); j++) {
97 if (first_layer_clusters[j].empty())
continue;
98 auto d =
dist(first_layer_clusters[i].centroidX(),
99 first_layer_clusters[i].centroidY(),
100 first_layer_clusters[j].centroidX(),
101 first_layer_clusters[j].centroidY());
102 ldmx_log(trace) <<
"Dist to cluster " << j <<
": " << d;
108std::vector<std::vector<const ldmx::EcalHit*>> CLUE::createLayers(
109 const std::vector<const ldmx::EcalHit*>& hits) {
110 ldmx_log(trace) <<
"--- LAYER CREATION ---";
111 ldmx_log(trace) <<
"Number of layers: " << nbr_of_layers_;
115 std::vector<std::vector<const ldmx::EcalHit*>> hits_per_layer(nbr_of_layers_);
118 std::vector<double> layer_max_energies(nbr_of_layers_, 0.0);
121 layer_rho_c_.clear();
124 double rhoc_factor = rhoc_ / 250.;
126 for (
const auto& hit : hits) {
129 int layer = ecal_id.layer();
131 if (layer >= nbr_of_layers_) {
132 ldmx_log(trace) <<
"Skipping hit in layer " << layer
133 <<
" (beyond nbr_of_layers_ = " << nbr_of_layers_ <<
")";
138 if (hit->getEnergy() > layer_max_energies[layer]) {
139 layer_max_energies[layer] = hit->getEnergy();
142 ldmx_log(trace) <<
" Adding hit with energy " << hit->getEnergy()
143 <<
" to layer " << layer;
144 hits_per_layer[layer].push_back(hit);
148 for (
int i = 0; i < nbr_of_layers_; i++) {
149 double rho_c = layer_max_energies[i] / rhoc_factor;
150 layer_rho_c_.push_back(rho_c);
151 ldmx_log(trace) <<
"Layer " << i <<
" has " << hits_per_layer[i].size()
152 <<
" hits, max energy " << layer_max_energies[i]
153 <<
", rho_c " << rho_c;
156 ldmx_log(trace) <<
"Created " << hits_per_layer.size() <<
" layers";
157 return hits_per_layer;
160float CLUE::roundToDecimal(
float x_,
int num_decimal_precision_digits) {
161 float power_of_10 = std::pow(10, num_decimal_precision_digits);
162 return std::round(x_ * power_of_10) / power_of_10;
165std::vector<std::shared_ptr<CLUE::Density>> CLUE::setup(
166 const std::vector<const ldmx::EcalHit*>& hits) {
167 std::vector<std::shared_ptr<Density>> densities;
168 std::map<std::pair<float, float>, std::shared_ptr<Density>> density_map;
170 ldmx_log(trace) <<
"--- SETUP ---";
171 ldmx_log(trace) <<
"Building densities";
172 for (
const auto& hit : hits) {
174 float x = roundToDecimal(hit->getXPos(), 4);
175 float y = roundToDecimal(hit->getYPos(), 4);
176 float z = roundToDecimal(hit->getZPos(), 4);
177 ldmx_log(trace) <<
" New hit { x: " << x <<
" y: " << y <<
"}"
178 <<
" (and z: " << z <<
")";
179 std::pair<float, float> coords;
180 if (dc_ != 0 && nbr_of_layers_ > 1) {
182 double i = std::ceil(std::abs(x) / dc_);
183 double j = std::ceil(std::abs(y) / dc_);
197 ldmx_log(trace) <<
" Index " << i <<
", " << j <<
"; x: " << x
205 if (density_map.find(coords) == density_map.end()) {
206 density_map.emplace(coords, std::make_shared<CLUE::Density>(x, y));
207 ldmx_log(trace) <<
" * New density created";
209 ldmx_log(trace) <<
" --> Found density with x: "
210 << density_map[coords]->x_
211 <<
" y: " << density_map[coords]->y_;
213 density_map[coords]->hits_.push_back(hit);
214 density_map[coords]->total_energy_ += hit->getEnergy();
215 density_map[coords]->z_ += hit->getZPos();
217 event_centroid_.
add(hit);
220 densities.reserve(density_map.size());
221 for (
const auto& entry : density_map) {
222 densities.push_back(std::move(entry.second));
225 std::sort(densities.begin(), densities.end(),
226 [](
const std::shared_ptr<CLUE::Density>& a,
227 const std::shared_ptr<CLUE::Density>& b) {
228 return a->total_energy_ > b->total_energy_;
231 ldmx_log(trace) <<
"Decide parents";
234 for (
int i = 0; i < densities.size(); i++) {
235 densities[i]->index_ = i;
237 densities[i]->z_ = densities[i]->z_ / densities[i]->hits_.size();
238 ldmx_log(trace) <<
" Index: " << i <<
"; x: " << densities[i]->x_
239 <<
"; y: " << densities[i]->y_
240 <<
"; Energy: " << densities[i]->total_energy_;
242 for (
int j = 0; j < i; j++) {
243 float distance_2d =
dist(densities[i]->x_, densities[i]->y_,
244 densities[j]->x_, densities[j]->y_);
247 if ((distance_2d < dm_) && (distance_2d < densities[i]->delta_)) {
248 densities[i]->delta_ = distance_2d;
249 densities[i]->follower_of_ = j;
250 ldmx_log(trace) <<
" New parent, index " << j
251 <<
"; delta_2d: " << std::setprecision(4)
262std::vector<std::vector<const ldmx::EcalHit*>> CLUE::clustering(
263 std::vector<std::shared_ptr<CLUE::Density>>& densities,
264 bool connecting_layers,
int layer_index) {
265 ldmx_log(trace) <<
"--- CLUSTERING ---";
266 ldmx_log(trace) <<
"Number of densities: " << densities.size()
267 <<
"; connecting_layers: " << connecting_layers
268 <<
"; layer_index: " << layer_index;
269 if (!connecting_layers && nbr_of_layers_ > 1) {
271 rhoc_ = layer_rho_c_[layer_index];
272 ldmx_log(trace) <<
"Setting rho_c on layer " << layer_index <<
" to "
274 if (layer_index * 2 - 1 < radius_.size()) {
275 deltac_ = radius_[layer_index * 2 - 1];
276 ldmx_log(trace) <<
"Setting delta_c on layer " << layer_index <<
" to "
279 }
else if (connecting_layers) {
289 bool energy_overload =
false;
290 double max_energy = 10000.;
291 clustering_loops_ = 0;
292 double delta_c_mod = deltac_;
293 double centroid_radius = 10.;
296 std::vector<std::shared_ptr<Density>>& layer_seeds = seeds_[layer_index];
299 std::vector<std::vector<const ldmx::EcalHit*>> clusters;
301 std::vector<bool> merged_densities;
302 merged_densities.resize(densities.size());
304 std::vector<double> cluster_energies;
307 if (energy_overload) {
309 delta_c_mod = delta_c_mod / 1.1;
310 ldmx_log(trace) <<
"Energy overload, new delta_cmod: " << delta_c_mod;
311 energy_overload =
false;
315 ldmx_log(trace) <<
"Clustering loop " << clustering_loops_;
321 layer_seeds.reserve(densities.size());
323 clusters.reserve(densities.size());
324 cluster_energies.clear();
325 cluster_energies.reserve(densities.size());
327 std::stack<int> cluster_stack;
329 std::vector<std::vector<int>> followers;
330 followers.resize(densities.size());
333 for (
auto& density : densities) {
335 ldmx_log(trace) <<
" Index: " << density->index_
336 <<
"; x: " << density->x_ <<
"; y: " << density->y_
337 <<
"; Energy: " << density->total_energy_
338 <<
" Parent ID: " << density->follower_of_
339 <<
"; Delta: " << density->delta_;
342 if (delta_c_mod != deltac_ && density->cluster_id_ >= 0 &&
343 merged_densities[density->cluster_id_] &&
345 event_centroid_.
centroidY()) < centroid_radius) {
350 density->total_energy_ > rhoc_ && density->delta_ > delta_c_mod;
352 is_seed = density->total_energy_ > rhoc_ && density->delta_ > deltac_;
354 ldmx_log(trace) <<
" Distance to event centroid: "
355 <<
dist(density->x_, density->y_,
361 (density->total_energy_ < rhoc_) && (density->delta_ > deltao_);
362 density->cluster_id_ = -1;
364 ldmx_log(trace) <<
" This is a Seed";
365 ldmx_log(trace) <<
" Distance to centroid: "
366 <<
dist(density->x_, density->y_,
369 <<
"; with delta " << density->delta_;
370 ldmx_log(trace) <<
" Setting cluster ID to " << k;
371 density->cluster_id_ = k;
374 cluster_stack.push(density->index_);
375 clusters.push_back(density->hits_);
376 cluster_energies.push_back(density->total_energy_);
377 layer_seeds.push_back(density);
378 }
else if (!is_outlier) {
379 ldmx_log(trace) <<
" This is a Follower";
380 int& parent_index = density->follower_of_;
381 if (parent_index != -1)
382 followers[parent_index].push_back(density->index_);
385 <<
" Somehow found a follower with parent index -1: id = "
388 ldmx_log(trace) <<
" This is an Outlier";
392 merged_densities.clear();
393 merged_densities.resize(densities.size());
396 while (cluster_stack.size() > 0) {
397 auto& d = densities[cluster_stack.top()];
399 auto& cid = d->cluster_id_;
401 for (
const auto follower_index : followers[d->index_]) {
402 auto& follower = densities[follower_index];
404 follower->cluster_id_ = cid;
405 cluster_energies[cid] += follower->total_energy_;
407 if (reclustering_ && cluster_energies[cid] > max_energy &&
408 delta_c_mod > 0.5 && clustering_loops_ < 100) {
411 merged_densities[cid] =
true;
412 if (!energy_overload && clustering_loops_ == 99) {
413 ldmx_log(warn) <<
"Merging clusters, max cluster loops hit";
415 energy_overload =
true;
416 if (clustering_loops_ != 1) {
422 clusters[cid].insert(std::end(clusters[cid]),
423 std::begin(follower->hits_),
424 std::end(follower->hits_));
427 cluster_stack.push(follower_index);
432 if (clustering_loops_ == 1 && energy_overload)
433 initial_cluster_nbr_ = clusters.size();
435 }
while (energy_overload);
437 if (!connecting_layers && nbr_of_layers_ > 1) {
440 for (
auto& seed : layer_seeds) {
441 seed->delta_ = std::numeric_limits<float>::max();
442 seed->hits_ = clusters[seed->cluster_id_];
443 seed->total_energy_ = cluster_energies[seed->cluster_id_];
444 seed->index_ = seed_index_;
448 std::sort(layer_seeds.begin(), layer_seeds.end(),
449 [](
const std::shared_ptr<Density>& a,
450 const std::shared_ptr<Density>& b) {
451 return a->total_energy_ > b->total_energy_;
459std::vector<std::shared_ptr<CLUE::Density>> CLUE::setupForClue3D() {
460 ldmx_log(trace) <<
"--- LAYER SETUP ---";
461 std::vector<std::shared_ptr<CLUE::Density>> densities;
462 layer_rho_c_.clear();
463 for (
int layer = 0; layer < nbr_of_layers_; layer++) {
464 ldmx_log(trace) <<
" LAYER " << layer <<
" with " << seeds_[layer].size()
466 auto& seeds_in_current_layer = seeds_[layer];
467 double highest_energy = 0.;
468 for (
const auto& current_seed : seeds_in_current_layer) {
470 current_seed->layer_ = layer;
471 if (current_seed->total_energy_ > highest_energy)
472 highest_energy = current_seed->total_energy_;
473 ldmx_log(trace) <<
" Density with index " << current_seed->index_
474 <<
", energy: " << current_seed->total_energy_
475 <<
" position (x,y)= {" << current_seed->x_ <<
","
476 << current_seed->y_ <<
")";
481 if ((layer - depth >= 0) && (layer - depth < seeds_.size())) {
482 ldmx_log(trace) <<
" Looking at pre-layer: " << layer - depth;
484 ldmx_log(trace) <<
" In previous layer... ";
485 auto& previous_layer = seeds_[layer - depth];
486 ldmx_log(trace) <<
" Got " << previous_layer.size() <<
" seeds";
487 for (
const auto& prev_seed : previous_layer) {
489 auto distance_2d_prev =
dist(current_seed->x_, current_seed->y_,
490 prev_seed->x_, prev_seed->y_);
491 auto dz_prev = std::abs(current_seed->z_ - prev_seed->z_);
492 ldmx_log(trace) <<
" DeltaXY to index " << prev_seed->index_
493 <<
": " << std::setprecision(4) << distance_2d_prev;
494 ldmx_log(trace) <<
" DeltaZ to index " << prev_seed->index_
495 <<
": " << std::setprecision(4) << dz_prev;
496 if (prev_seed->total_energy_ > current_seed->total_energy_ &&
497 distance_2d_prev < current_seed->delta_ &&
498 dz_prev < current_seed->z_delta_) {
499 ldmx_log(trace) <<
" New parent: index " << prev_seed->index_
500 <<
" on layer " << layer - depth <<
"; energy "
501 << prev_seed->total_energy_;
502 ldmx_log(trace) <<
" New 2D distance to prev-layer: "
503 << std::setprecision(4) << distance_2d_prev;
505 <<
" New delta Z: " << std::setprecision(4) << dz_prev;
506 current_seed->delta_ = distance_2d_prev;
507 current_seed->z_delta_ = dz_prev;
508 current_seed->follower_of_ = prev_seed->index_;
509 }
else if (prev_seed->total_energy_ < current_seed->total_energy_) {
510 ldmx_log(trace) <<
" Breaking on index " << prev_seed->index_
511 <<
" with energy " << prev_seed->total_energy_;
517 if (layer + depth < nbr_of_layers_ && layer + depth < seeds_.size()) {
518 ldmx_log(trace) <<
" Looking at post-layer: " << layer + depth;
519 auto& next_layer = seeds_[layer + depth];
520 ldmx_log(trace) <<
" Got " << next_layer.size() <<
" seeds";
521 for (
const auto& next_seed : next_layer) {
522 auto distance_2d_next =
dist(current_seed->x_, current_seed->y_,
523 next_seed->x_, next_seed->y_);
524 auto dz_next = std::abs(current_seed->z_ - next_seed->z_);
525 ldmx_log(trace) <<
" DeltaXY to index " << next_seed->index_
526 <<
": " << std::setprecision(4) << distance_2d_next;
527 ldmx_log(trace) <<
" DeltaZ to index_" << next_seed->index_
528 <<
": " << std::setprecision(4) << dz_next;
529 if (next_seed->total_energy_ > current_seed->total_energy_ &&
530 distance_2d_next < current_seed->delta_ &&
531 dz_next < current_seed->z_delta_) {
532 ldmx_log(trace) <<
" New parent: index_" << next_seed->index_
533 <<
" on layer " << layer + depth <<
"; energy "
534 << next_seed->total_energy_;
535 ldmx_log(trace) <<
" New 2D distance to next-layer: "
536 << std::setprecision(4) << distance_2d_next;
538 <<
" New delta_Z: " << std::setprecision(4) << dz_next;
539 current_seed->delta_ = distance_2d_next;
540 current_seed->z_delta_ = dz_next;
541 current_seed->follower_of_ = next_seed->index_;
542 }
else if (next_seed->total_energy_ < current_seed->total_energy_) {
543 ldmx_log(trace) <<
" Breaking on index_" << next_seed->index_
544 <<
" with energy " << next_seed->total_energy_;
551 ldmx_log(trace) <<
" Done setting parents.";
552 densities.push_back(current_seed);
555 layer_rho_c_.push_back(highest_energy / 2);
560void CLUE::convertToIntermediateClusters(
561 std::vector<std::vector<const ldmx::EcalHit*>>& clusters) {
564 for (
const auto& cluster : clusters) {
566 intermediate_cluster_first_layer{};
568 for (
const auto& hit : cluster) {
569 intermediate_cluster.add(hit);
572 auto layer = ecal_id.layer();
573 intermediate_cluster.setLayer(layer);
575 intermediate_cluster_first_layer.add(hit);
576 intermediate_cluster_first_layer.setLayer(layer);
579 final_clusters_.push_back(intermediate_cluster);
580 first_layer_centroids_.push_back(intermediate_cluster_first_layer);
581 auto cent_x = intermediate_cluster.centroidX();
582 auto cent_y = intermediate_cluster.centroidY();
583 auto event_cent_x = event_centroid_.
centroidX();
584 auto event_cent_y = event_centroid_.
centroidY();
585 const auto& distance =
dist(cent_x, cent_y, event_cent_x, event_cent_y);
586 centroid_distances_.push_back(distance);
590void CLUE::cluster(
const std::vector<ldmx::EcalHit>& unsorted_hits,
double dc,
591 double rc,
double delta_c,
double delta_o,
int nbr_of_layers,
593 ldmx_log(info) <<
"Starting CLUE clustering with parameters:" <<
"dc " << dc
594 <<
", rc " << rc <<
", delta_c " << delta_c <<
", delta_o "
595 << delta_o <<
", nbr_of_layers " << nbr_of_layers
596 <<
", reclustering " << reclustering;
606 dm_ = std::max(delta_c, delta_o);
609 reclustering_ = reclustering;
610 nbr_of_layers_ = nbr_of_layers;
612 if (nbr_of_layers_ < 1) {
614 nbr_of_layers_ = max_layers_;
615 }
else if (nbr_of_layers_ > max_layers_) {
616 ldmx_log(warn) <<
"nbr_of_layers_ " << nbr_of_layers_
617 <<
" exceeds max layers " << max_layers_
618 <<
", setting to max layers";
619 nbr_of_layers_ = max_layers_;
623 std::vector<const ldmx::EcalHit*> hits;
624 hits.reserve(unsorted_hits.size());
625 ldmx_log(debug) <<
"Clustering " << unsorted_hits.size() <<
" hits";
626 for (
const auto& unsorted_hit : unsorted_hits) {
627 hits.push_back(&unsorted_hit);
630 ldmx_log(debug) <<
"Sorting hits by Z position";
631 std::sort(hits.begin(), hits.end(),
633 return a->getZPos() < b->getZPos();
636 seeds_.resize(nbr_of_layers_);
638 if (nbr_of_layers_ > 1) {
639 ldmx_log(debug) <<
"Creating layers";
641 const auto layers = createLayers(hits);
642 ldmx_log(debug) <<
"Doing layer-wise clustering on " << layers.size()
644 for (
int i = 0; i < layers.size(); i++) {
645 ldmx_log(trace) <<
"--- LAYER " << i + 1 <<
" ---";
646 auto densities = setup(layers[i]);
647 auto clusters = clustering(densities,
false, i);
648 convertToIntermediateClusters(clusters);
657 ldmx_log(debug) <<
"Only one layer, doing 2D clustering";
658 auto densities = setup(hits);
659 auto clusters = clustering(densities,
false);
660 convertToIntermediateClusters(clusters);
A version of CLUE (CMS) for clustering in ECal.
Class that defines an ECal detector ID with a cell number.
T dist(T x1, T y1, T x2, T y2)
Euclidean distance between two points.
Stores reconstructed hit information from the ECAL.
Extension of DetectorID providing access to ECal layers and cell numbers in a hex grid.
double centroidY() const
Get the centroid Y position (energy-weighted).
double centroidX() const
Get the centroid X position (energy-weighted).
void add(const HitType *hit)
Add a hit to the cluster using its stored position.