CosmicClusterAlgo.cc

Go to the documentation of this file.

#include "RecoEcal/EgammaClusterAlgos/interface/CosmicClusterAlgo.h"

#include <vector>  //TEMP JHAUPT 4-27

// Geometry
#include "Geometry/Records/interface/CaloGeometryRecord.h"
#include "Geometry/CaloGeometry/interface/CaloSubdetectorGeometry.h"
#include "Geometry/CaloGeometry/interface/CaloCellGeometry.h"
#include "Geometry/CaloTopology/interface/EcalEndcapTopology.h"
#include "Geometry/CaloTopology/interface/EcalBarrelTopology.h"
#include "RecoEcal/EgammaCoreTools/interface/ClusterEtLess.h"

// Return a vector of clusters from a collection of EcalRecHits:
//
std::vector<reco::BasicCluster> CosmicClusterAlgo::makeClusters(const EcalRecHitCollection *hits,
                                                                const EcalUncalibratedRecHitCollection *uncalibhits,
                                                                const CaloSubdetectorGeometry *geometry_p,
                                                                const CaloSubdetectorTopology *topology_p,
                                                                const CaloSubdetectorGeometry *geometryES_p,
                                                                EcalPart ecalPart,
                                                                bool regional,
                                                                const std::vector<RectangularEtaPhiRegion> &regions) {
  seeds.clear();
  used_s.clear();
  canSeed_s.clear();
  clusters_v.clear();

  recHits_ = hits;
  uncalibRecHits_ = uncalibhits;

  inEB = true;
  double threshold = 0;
  std::string ecalPart_string;
  if (ecalPart == endcap) {
    threshold = ecalEndcapSeedThreshold;
    ecalPart_string = "EndCap";
    inEB = false;
  }
  if (ecalPart == barrel) {
    threshold = ecalBarrelSeedThreshold;
    ecalPart_string = "Barrel";
    inEB = true;
  }

  if (verbosity < pINFO) {
    std::cout << "-------------------------------------------------------------" << std::endl;
    std::cout << "Island algorithm invoked for ECAL" << ecalPart_string << std::endl;
    std::cout << "Looking for seeds, threshold used = " << threshold << " ADC" << std::endl;
  }

  int nregions = 0;
  if (regional)
    nregions = regions.size();

  if (!regional || nregions) {
    EcalRecHitCollection::const_iterator it;
    for (it = recHits_->begin(); it != recHits_->end(); it++) {
      if (!uncalibRecHits_) {
        if (verbosity < pINFO) {
          std::cout << "-------------------------------------------------------------" << std::endl;
          std::cout << "No Uncalibrated RecHits no Uncalibrated rec hit collection available" << std::endl;
        }
        continue;
      }

      // if rechit affected by features other than these, do not allow if seeding
      // features are hard coded, for now; add severity?
      uint32_t rhFlag = (*it).recoFlag();
      if (!(rhFlag == EcalRecHit::kGood || rhFlag == EcalRecHit::kOutOfTime || rhFlag == EcalRecHit::kPoorCalib))
        continue;

      EcalUncalibratedRecHitCollection::const_iterator itt = uncalibRecHits_->find(it->id());

      if (itt == uncalibRecHits_->end()) {
        if (verbosity < pINFO) {
          std::cout << "-------------------------------------------------------------" << std::endl;
          std::cout << "No Uncalibrated RecHit associated with the RecHit Probably no Uncalibrated rec hit collection "
                       "available"
                    << std::endl;
        }
        continue;
      }

      EcalUncalibratedRecHit uhit_p = *itt;

      // looking for cluster seeds
      if (uhit_p.amplitude() < (inEB ? ecalBarrelSeedThreshold : ecalEndcapSeedThreshold))
        continue;  //

      auto thisCell = geometry_p->getGeometry(it->id());

      // Require that RecHit is within clustering region in case
      // of regional reconstruction
      bool withinRegion = false;
      if (regional) {
        std::vector<RectangularEtaPhiRegion>::const_iterator region;
        for (region = regions.begin(); region != regions.end(); region++) {
          if (region->inRegion(thisCell->etaPos(), thisCell->phiPos())) {
            withinRegion = true;
            break;
          }
        }
      }

      if (!regional || withinRegion) {
        seeds.push_back(
            *it);  // JHaupt 4-27-2008 Et -> energy, most likely not needed as there is already a threshold requirement.
      }
    }
  }

  sort(seeds.begin(), seeds.end(), [](auto const &x, auto const &y) { return x.energy() > y.energy(); });

  if (verbosity < pINFO) {
    std::cout << "JH Total number of seeds found in event = " << seeds.size() << std::endl;
    for (EcalRecHitCollection::const_iterator ji = seeds.begin(); ji != seeds.end(); ++ji) {
      //std::cout << "JH Seed Energy " << ji->energy() << " hashed " << ((EBDetId)ji->id()).hashedIndex()  << std::endl;
    }
  }

  mainSearch(geometry_p, topology_p, geometryES_p, ecalPart);
  std::sort(clusters_v.rbegin(), clusters_v.rend(), isClusterEtLess);

  if (verbosity < pINFO) {
    std::cout << "---------- end of main search. clusters have been sorted ----" << std::endl;
  }

  return clusters_v;
}

// Search for clusters
//
void CosmicClusterAlgo::mainSearch(const CaloSubdetectorGeometry *geometry_p,
                                   const CaloSubdetectorTopology *topology_p,
                                   const CaloSubdetectorGeometry *geometryES_p,
                                   EcalPart ecalPart) {
  if (verbosity < pINFO) {
    std::cout << "Building clusters............" << std::endl;
  }

  // Loop over seeds:
  std::vector<EcalRecHit>::iterator it;
  for (it = seeds.begin(); it != seeds.end(); it++) {
    // check if this crystal is able to seed
    // (event though it is already used)
    bool usedButCanSeed = false;
    if (canSeed_s.find(it->id()) != canSeed_s.end())
      usedButCanSeed = true;

    // make sure the current seed does not belong to a cluster already.
    if ((used_s.find(it->id()) != used_s.end()) && (usedButCanSeed == false)) {
      if (it == seeds.begin()) {
        if (verbosity < pINFO) {
          std::cout << "##############################################################" << std::endl;
          std::cout << "DEBUG ALERT: Highest energy seed already belongs to a cluster!" << std::endl;
          std::cout << "##############################################################" << std::endl;
        }
      }

      // seed crystal is used or is used and cannot seed a cluster
      // so continue to the next seed crystal...
      continue;
    }

    // clear the vector of hits in current clusterconst EcalRecHitCollection* hits,
    current_v9.clear();
    current_v25.clear();
    current_v25Sup.clear();

    // Create a navigator at the seed
    CaloNavigator<DetId> navigator(it->id(), topology_p);
    DetId seedId = navigator.pos();
    navigator.setHome(seedId);

    // Is the seed a local maximum?
    bool localMaxima = checkMaxima(navigator);

    if (localMaxima) {
      // build the 5x5 taking care over which crystals //JHaupt 4-27-08 3x3 is a good option...
      // can seed new clusters and which can't
      prepareCluster(navigator, geometry_p);
    }

    // If some crystals in the current vector then
    // make them into a cluster
    if (!current_v25.empty()) {
      makeCluster(geometry_p, geometryES_p, seedId);
    }

  }  // End loop on seed crystals
}

void CosmicClusterAlgo::makeCluster(const CaloSubdetectorGeometry *geometry,
                                    const CaloSubdetectorGeometry *geometryES,
                                    DetId seedId) {
  double energy = 0;
  double energySecond = 0.;  //JHaupt 4-27-08 Added for the second crystal stream
  double energyMax = 0.;     //JHaupt 4-27-08 Added for the max crystal stream
  DetId detFir;
  DetId detSec;
  //bool goodCluster = false; //JHaupt 4-27-08 Added so that some can be earased.. used another day Might not be needed as seeds are energy ordered...

  std::vector<DetId>::iterator it;
  for (it = current_v9.begin(); it != current_v9.end(); it++) {
    // Martina - check recoFlag for crystals sorrounding the good one
    EcalRecHitCollection::const_iterator itt = recHits_->find(*it);
    // double-check that iterator can be dereferenced
    if (itt == recHits_->end())
      continue;
    // if rechit affected by features other than these, do not allow 2 crystal seeding either
    // features are hard coded, for now; add severity?
    uint32_t rhFlag = (*itt).recoFlag();
    if (!(rhFlag == EcalRecHit::kGood || rhFlag == EcalRecHit::kOutOfTime || rhFlag == EcalRecHit::kPoorCalib))
      continue;


    EcalUncalibratedRecHitCollection::const_iterator ittu = uncalibRecHits_->find(*it);
    EcalUncalibratedRecHit uhit_p = *ittu;

    if (uhit_p.amplitude() > energySecond) {
      energySecond = uhit_p.amplitude();
      detSec = uhit_p.id();
    }
    if (energySecond > energyMax) {
      std::swap(energySecond, energyMax);
      std::swap(detFir, detSec);
    }
  }

  //if ((detFir.det() == DetId::Ecal) && (detFir.subdetId() == EcalEndcap)) inEB = false;
  //We ignore the possiblity that the cluster may span into the EE

  if ((energyMax < (inEB ? ecalBarrelSingleThreshold : ecalEndcapSingleThreshold)) &&
      (energySecond < (inEB ? ecalBarrelSecondThreshold : ecalEndcapSecondThreshold)))
    return;

  for (it = current_v25.begin(); it != current_v25.end(); it++) {
    EcalRecHitCollection::const_iterator itt = recHits_->find(*it);
    EcalRecHit hit_p = *itt;

    EcalUncalibratedRecHitCollection::const_iterator ittu = uncalibRecHits_->find(*it);
    EcalUncalibratedRecHit uhit_p = *ittu;

    if (uhit_p.amplitude() > (inEB ? ecalBarrelSupThreshold : ecalEndcapSupThreshold)) {
      // energy fraction = 1
      current_v25Sup.push_back(std::pair<DetId, float>(hit_p.id(), 1.));
      energy += hit_p.energy();  //Keep the fully corrected energy
    }
  }

  Point position;
  position = posCalculator_.Calculate_Location(current_v25Sup, recHits_, geometry, geometryES);

  //don't write empty clusters
  if (energy == 0 && position == Point(0, 0, 0))
    return;

  if (verbosity < pINFO) {
    std::cout << "JH******** NEW CLUSTER ********" << std::endl;
    std::cout << "JHNo. of crystals = " << current_v25Sup.size() << std::endl;
    std::cout << "JH     Energy     = " << energy << std::endl;
    std::cout << "JH     Phi        = " << position.phi() << std::endl;
    std::cout << "JH     Eta        = " << position.eta() << std::endl;
    std::cout << "JH*****************************" << std::endl;
    // specialize this
    //       std::cout << "JH****Emax****  "<<energyMax << " ieta " <<detFir.ieta() <<" iphi "<<detFir.ieta()  << std::endl;
    //       std::cout << "JH****Esec****  "<<energySecond << " ieta " <<detSec.ieta() <<" iphi "<<detSec.ieta() << std::endl;
  }
  clusters_v.push_back(
      reco::BasicCluster(energy, position, reco::CaloID(), current_v25Sup, reco::CaloCluster::multi5x5, seedId));
}

bool CosmicClusterAlgo::checkMaxima(CaloNavigator<DetId> &navigator) {
  bool maxima = true;
  EcalRecHitCollection::const_iterator thisHit;
  EcalRecHitCollection::const_iterator seedHit = recHits_->find(navigator.pos());
  double thisEnergy = 0.;
  double seedEnergy = seedHit->energy();

  std::vector<DetId> swissCrossVec;
  swissCrossVec.clear();

  swissCrossVec.push_back(navigator.west());
  navigator.home();
  swissCrossVec.push_back(navigator.east());
  navigator.home();
  swissCrossVec.push_back(navigator.north());
  navigator.home();
  swissCrossVec.push_back(navigator.south());
  navigator.home();

  for (unsigned int i = 0; i < swissCrossVec.size(); ++i) {
    thisHit = recHits_->find(swissCrossVec[i]);
    if ((swissCrossVec[i] == DetId(0)) || thisHit == recHits_->end())
      thisEnergy = 0.0;
    else
      thisEnergy = thisHit->energy();
    if (thisEnergy > seedEnergy) {
      maxima = false;
      break;
    }
  }

  return maxima;
}

void CosmicClusterAlgo::prepareCluster(CaloNavigator<DetId> &navigator, const CaloSubdetectorGeometry *geometry) {
  DetId thisDet;
  std::set<DetId>::iterator setItr;

  // now add the 5x5 taking care to mark the edges
  // as able to seed and where overlapping in the central
  // region with crystals that were previously able to seed
  // change their status so they are not able to seed
  //std::cout << std::endl;
  for (int dx = -2; dx < 3; ++dx)  //for (int dx = -2; dx < 3; ++dx)
  {
    for (int dy = -2; dy < 3; ++dy)  //for (int dy = -2; dy < 3; ++ dy)
    {
      // navigate in free steps forming
      // a full 5x5
      thisDet = navigator.offsetBy(dx, dy);
      navigator.home();

      // add the current crystal
      //std::cout << "adding " << dx << ", " << dy << std::endl;

      // now consider if we are in an edge (outer 16)
      // or central (inner 9) region
      if ((abs(dx) > 1) || (abs(dy) > 1)) {
        // this is an "edge" so should be allowed to seed
        // provided it is not already used
        //std::cout << "   setting can seed" << std::endl;
        addCrystal(thisDet, false);  //These are in the V25
        canSeed_s.insert(thisDet);
      }  // end if "edge"
      else {
        // or else we are in the central 3x3
        // and must remove any of these crystals from the canSeed set
        setItr = canSeed_s.find(thisDet);
        addCrystal(thisDet, true);  //These are in the V9
        if (setItr != canSeed_s.end()) {
          //std::cout << "   unsetting can seed" << std::endl;
          canSeed_s.erase(setItr);
        }
      }  // end if "centre"

    }  // end loop on dy

  }  // end loop on dx

  //std::cout << "*** " << std::endl;
  //std::cout << " current_v contains " << current_v.size() << std::endl;
  //std::cout << "*** " << std::endl;
}

void CosmicClusterAlgo::addCrystal(const DetId &det, const bool in9) {
  EcalRecHitCollection::const_iterator thisIt = recHits_->find(det);
  if ((thisIt != recHits_->end()) && (thisIt->id() != DetId(0))) {
    if ((used_s.find(thisIt->id()) == used_s.end())) {
      EcalUncalibratedRecHitCollection::const_iterator thisItu = uncalibRecHits_->find(det);
      used_s.insert(det);
      if ((thisIt->energy() >= -1.) && !(thisItu->chi2() < -1.)) {
        if (in9)
          current_v9.push_back(det);
        current_v25.push_back(det);
      }
    }
  }
}