RealisticSimClusterMapper Class Reference

#include <RealisticSimClusterMapper.h>

Inheritance diagram for RealisticSimClusterMapper:

Public Member Functions
void	buildClusters (const edm::Handle< reco::PFRecHitCollection > &, const std::vector< bool > &, const std::vector< bool > &, reco::PFClusterCollection &) override
RealisticSimClusterMapper &	operator= (const RealisticSimClusterMapper &)=delete
	RealisticSimClusterMapper (const edm::ParameterSet &conf, edm::ConsumesCollector &sumes)
	RealisticSimClusterMapper (const RealisticSimClusterMapper &)=delete
void	update (const edm::EventSetup &) final
void	updateEvent (const edm::Event &) final
	~RealisticSimClusterMapper () override
Public Member Functions inherited from InitialClusteringStepBase
	InitialClusteringStepBase (const edm::ParameterSet &conf, edm::ConsumesCollector &sumes)
	InitialClusteringStepBase (const ICSB &)=delete
std::ostream &	operator<< (std::ostream &o) const
ICSB &	operator= (const ICSB &)=delete
void	reset ()
virtual	~InitialClusteringStepBase ()=default

Private Attributes
const float	calibMaxEta_ = 3.0
const float	calibMinEta_ = 1.4
std::vector< double >	egammaCalib_
const float	exclusiveFraction_ = 0.7f
std::vector< double >	hadronCalib_
const float	invisibleFraction_ = 0.3f
const float	maxDforTimingSquared_ = 4.0f
const float	maxDistance_ = 10.f
const bool	maxDistanceFilter_ = false
const unsigned int	minNHitsforTiming_ = 3
hgcal::RecHitTools	rhtools_
edm::Handle< SimClusterCollection >	simClusterH_
edm::EDGetTokenT< SimClusterCollection >	simClusterToken_
const float	timeOffset_
const bool	useMCFractionsForExclEnergy_ = false

Additional Inherited Members
Protected Types inherited from InitialClusteringStepBase
typedef std::tuple< std::vector< int >,std::vector< double >, std::vector< double > >	I3tuple
Protected Member Functions inherited from InitialClusteringStepBase
reco::PFRecHitRef	makeRefhit (const edm::Handle< reco::PFRecHitCollection > &h, const unsigned i) const
Protected Attributes inherited from InitialClusteringStepBase
const std::unordered_map< std::string, int >	_layerMap
unsigned	_nClustersFound
unsigned	_nSeeds
std::unordered_map< int, I3tuple >	_thresholds

Detailed Description

Definition at line 14 of file RealisticSimClusterMapper.h.

Constructor & Destructor Documentation

RealisticSimClusterMapper::RealisticSimClusterMapper ( const edm::ParameterSet &  conf, edm::ConsumesCollector &  sumes  )

inline

Definition at line 16 of file RealisticSimClusterMapper.h.

References edm::ConsumesCollector::consumes(), egammaCalib_, edm::ParameterSet::getParameter(), hadronCalib_, and simClusterToken_.

Referenced by ~RealisticSimClusterMapper().

                                          :
    InitialClusteringStepBase(conf,sumes),
    invisibleFraction_(conf.getParameter<double>("invisibleFraction")),
    exclusiveFraction_(conf.getParameter<double>("exclusiveFraction")),
    maxDistanceFilter_(conf.getParameter<bool>("maxDistanceFilter")),
    maxDistance_(conf.getParameter<double>("maxDistance")),
    maxDforTimingSquared_(conf.getParameter<double>("maxDforTimingSquared")),
    timeOffset_(conf.getParameter<double>("timeOffset")),
    minNHitsforTiming_(conf.getParameter<unsigned int>("minNHitsforTiming")),
    useMCFractionsForExclEnergy_(conf.getParameter<bool>("useMCFractionsForExclEnergy")),
    calibMinEta_(conf.getParameter<double>("calibMinEta")),
    calibMaxEta_(conf.getParameter<double>("calibMaxEta"))
    {
      simClusterToken_ = sumes.consumes<SimClusterCollection>(conf.getParameter<edm::InputTag>("simClusterSrc"));
      hadronCalib_ = conf.getParameter < std::vector<double> > ("hadronCalib");
      egammaCalib_ = conf.getParameter < std::vector<double> > ("egammaCalib");
    }

RealisticSimClusterMapper::~RealisticSimClusterMapper ( )

inlineoverride

Definition at line 35 of file RealisticSimClusterMapper.h.

References buildClusters(), operator=(), RealisticSimClusterMapper(), update(), and updateEvent().

{}

RealisticSimClusterMapper::RealisticSimClusterMapper ( const RealisticSimClusterMapper &  )

delete

Member Function Documentation

void RealisticSimClusterMapper::buildClusters ( const edm::Handle< reco::PFRecHitCollection > &  input, const std::vector< bool > &  rechitMask, const std::vector< bool > &  seedable, reco::PFClusterCollection &  output  )

overridevirtual

Implements InitialClusteringStepBase.

Definition at line 63 of file RealisticSimClusterMapper.cc.

References funct::abs(), reco::PFCluster::addRecHitFraction(), calibMaxEta_, calibMinEta_, RealisticHitToClusterAssociator::computeAssociation(), egammaCalib_, PVValHelper::eta, exclusiveFraction_, f, RealisticHitToClusterAssociator::filterHitsByDistance(), RealisticHitToClusterAssociator::findAndMergeInvisibleClusters(), RealisticHitToClusterAssociator::findCentersOfGravity(), hgcalsimclustertime::fixSizeHighestDensity(), DetId::Forward, ForwardEmpty, dedxEstimators_cff::fraction, spr::getEnergy(), hgcal::RecHitTools::getGeometryType(), hgcal::RecHitTools::getLayer(), hgcal::RecHitTools::getLayerWithOffset(), hgcal::RecHitTools::getPosition(), hadronCalib_, hfClusterShapes_cfi::hits, SimCluster::hits_and_fractions(), reco::CaloCluster::hitsAndFractions(), mps_fire::i, RealisticHitToClusterAssociator::init(), input, RealisticHitToClusterAssociator::insertHitEnergy(), RealisticHitToClusterAssociator::insertHitPosition(), RealisticHitToClusterAssociator::insertLayerId(), RealisticHitToClusterAssociator::insertSimClusterIdAndFraction(), invisibleFraction_, hgcal::RecHitTools::lastLayerEE(), hgcal::RecHitTools::lastLayerFH(), InitialClusteringStepBase::makeRefhit(), maxDforTimingSquared_, maxDistance_, maxDistanceFilter_, minNHitsforTiming_, or, common_cff::pdgId, funct::pow(), RealisticHitToClusterAssociator::realisticClusters(), rhtools_, SimDataFormats::CaloAnalysis::sc, SurveyInfoScenario_cff::seed, reco::CaloCluster::setCorrectedEnergy(), reco::CaloCluster::setEnergy(), reco::CaloCluster::setSeed(), reco::PFCluster::setTime(), simClusterH_, timeOffset_, and useMCFractionsForExclEnergy_.

Referenced by ~RealisticSimClusterMapper().

{
    const SimClusterCollection& simClusters = *simClusterH_;
    auto const& hits = *input;
    RealisticHitToClusterAssociator realisticAssociator;
    const int numberOfLayers = rhtools_.getGeometryType()==0 ? rhtools_.getLayer(ForwardSubdetector::ForwardEmpty) : rhtools_.getLayer(DetId::Forward);
    realisticAssociator.init(hits.size(), simClusters.size(), numberOfLayers + 1);
    // for quick indexing back to hit energy
    std::unordered_map < uint32_t, size_t > detIdToIndex(hits.size());
    for (uint32_t i = 0; i < hits.size(); ++i)
    {
        detIdToIndex[hits[i].detId()] = i;
        auto ref = makeRefhit(input, i);
        const auto& hitPos = rhtools_.getPosition(ref->detId());

        realisticAssociator.insertHitPosition(hitPos.x(), hitPos.y(), hitPos.z(), i);
        realisticAssociator.insertHitEnergy(ref->energy(), i);
        realisticAssociator.insertLayerId(rhtools_.getLayerWithOffset(ref->detId()), i);

    }

    for (unsigned int ic = 0; ic < simClusters.size(); ++ic)
    {
        const auto & sc = simClusters[ic];
        const auto& hitsAndFractions = sc.hits_and_fractions();
        for (const auto& hAndF : hitsAndFractions)
        {
            auto itr = detIdToIndex.find(hAndF.first);
            if (itr == detIdToIndex.end())
            {
                continue; // hit wasn't saved in reco or did not pass the SNR threshold
            }
            auto hitId = itr->second;
            auto ref = makeRefhit(input, hitId);
            float fraction = hAndF.second;
            float associatedEnergy = fraction * ref->energy();
            realisticAssociator.insertSimClusterIdAndFraction(ic, fraction, hitId,
                    associatedEnergy);
        }
    }
    realisticAssociator.computeAssociation(exclusiveFraction_, useMCFractionsForExclEnergy_,
            rhtools_.lastLayerEE(), rhtools_.lastLayerFH());
    realisticAssociator.findAndMergeInvisibleClusters(invisibleFraction_, exclusiveFraction_);
    realisticAssociator.findCentersOfGravity();
    if(maxDistanceFilter_)
        realisticAssociator.filterHitsByDistance(maxDistance_);

    const auto& realisticClusters = realisticAssociator.realisticClusters();
    unsigned int nClusters = realisticClusters.size();
    float bin_norm = 1. / (calibMaxEta_ - calibMinEta_);
    float egamma_bin_norm = egammaCalib_.size() * bin_norm;
    float hadron_bin_norm = hadronCalib_.size() * bin_norm;
    for (unsigned ic = 0; ic < nClusters; ++ic)
    {
        float highest_energy = 0.0f;
        output.emplace_back();
        reco::PFCluster& back = output.back();
        edm::Ref < std::vector<reco::PFRecHit> > seed;
        float energyCorrection = 1.f;
        float timeRealisticSC = -99.;
        if (realisticClusters[ic].isVisible())
        {
            int pdgId = simClusters[ic].pdgId();
            auto abseta = std::abs(simClusters[ic].eta());
            if ((abseta >= calibMinEta_) and (abseta <= calibMaxEta_)) //protecting range
            {
                if ((isEGamma(pdgId) or isPi0(pdgId)) and !egammaCalib_.empty())
                {
                    unsigned int etabin = std::floor(
                            ((abseta - calibMinEta_) * egamma_bin_norm));
                    energyCorrection = egammaCalib_[etabin];
                }
                else if (isHadron(pdgId) and !(isPi0(pdgId)) and !hadronCalib_.empty()) // this function is expensive.. should we treat as hadron everything which is not egamma?
                {
                    unsigned int etabin = std::floor(
                            ((abseta - calibMinEta_) * hadron_bin_norm));
                    energyCorrection = hadronCalib_[etabin];
                }

            }
        std::vector<float> timeHits;
            const auto& hitsIdsAndFractions = realisticClusters[ic].hitsIdsAndFractions();
            for (const auto& idAndF : hitsIdsAndFractions)
            {
                auto fraction = idAndF.second;
                if (fraction > 0.f)
                {
                    auto ref = makeRefhit(input, idAndF.first);
                    back.addRecHitFraction(reco::PFRecHitFraction(ref, fraction));
                    const float hit_energy = fraction * ref->energy();
                    if (hit_energy > highest_energy || highest_energy == 0.0)
                    {
                        highest_energy = hit_energy;
                        seed = ref;
                    }
                    //select hits good for timing
                    if(ref->time() > -1. ){
              int rhLayer = rhtools_.getLayerWithOffset(ref->detId());
              std::array<float,3> scPosition = realisticClusters[ic].getCenterOfGravity(rhLayer);
              float distanceSquared = std::pow((ref->position().x() - scPosition[0]),2) + std::pow((ref->position().y() - scPosition[1]),2);
              if(distanceSquared < maxDforTimingSquared_){
            timeHits.push_back(ref->time() - timeOffset_);
              }
            }
                }
            }
        //assign time if minimum number of hits
        if(timeHits.size() >= minNHitsforTiming_) timeRealisticSC = hgcalsimclustertime::fixSizeHighestDensity(timeHits);
    }
        if (!back.hitsAndFractions().empty())
        {
            back.setSeed(seed->detId());
            back.setEnergy(realisticClusters[ic].getEnergy());
            back.setCorrectedEnergy(energyCorrection*realisticClusters[ic].getEnergy()); //applying energy correction
        back.setTime(timeRealisticSC);
        }
        else
        {
            back.setSeed(-1);
            back.setEnergy(0.f);
        }
    }
}

RealisticSimClusterMapper& RealisticSimClusterMapper::operator= ( const RealisticSimClusterMapper &  )

delete

Referenced by ~RealisticSimClusterMapper().

void RealisticSimClusterMapper::update ( const edm::EventSetup &  es )

finalvirtual

Reimplemented from InitialClusteringStepBase.

Definition at line 58 of file RealisticSimClusterMapper.cc.

References hgcal::RecHitTools::getEventSetup(), and rhtools_.

Referenced by progressbar.ProgressBar::__next__(), MatrixUtil.Matrix::__setitem__(), MatrixUtil.Steps::__setitem__(), Vispa.Gui.VispaWidget.VispaWidget::autosize(), Vispa.Views.LineDecayView.LineDecayContainer::createObject(), Vispa.Views.LineDecayView.LineDecayContainer::deselectAllObjects(), Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner::deselectAllWidgets(), Vispa.Gui.VispaWidget.VispaWidget::enableAutosizing(), progressbar.ProgressBar::finish(), Vispa.Gui.MenuWidget.MenuWidget::leaveEvent(), Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner::mouseMoveEvent(), Vispa.Gui.MenuWidget.MenuWidget::mouseMoveEvent(), Vispa.Views.LineDecayView.LineDecayContainer::mouseMoveEvent(), Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner::mouseReleaseEvent(), Vispa.Views.LineDecayView.LineDecayContainer::objectMoved(), MatrixUtil.Steps::overwrite(), Vispa.Views.LineDecayView.LineDecayContainer::removeObject(), Vispa.Gui.ConnectableWidget.ConnectableWidget::removePorts(), Vispa.Gui.FindDialog.FindDialog::reset(), Vispa.Gui.PortConnection.PointToPointConnection::select(), Vispa.Gui.VispaWidget.VispaWidget::select(), Vispa.Views.LineDecayView.LineDecayContainer::select(), Vispa.Gui.VispaWidget.VispaWidget::setText(), Vispa.Gui.VispaWidget.VispaWidget::setTitle(), Vispa.Gui.ZoomableWidget.ZoomableWidget::setZoom(), Vispa.Views.LineDecayView.LineDecayContainer::setZoom(), Vispa.Gui.PortConnection.PointToPointConnection::updateConnection(), and ~RealisticSimClusterMapper().

{
    rhtools_.getEventSetup(es);
}

void RealisticSimClusterMapper::updateEvent ( const edm::Event &  ev )

finalvirtual

Reimplemented from InitialClusteringStepBase.

Definition at line 53 of file RealisticSimClusterMapper.cc.

References edm::Event::getByToken(), simClusterH_, and simClusterToken_.

Referenced by ~RealisticSimClusterMapper().

{
    ev.getByToken(simClusterToken_, simClusterH_);
}

Member Data Documentation

const float RealisticSimClusterMapper::calibMaxEta_ = 3.0

private

Definition at line 58 of file RealisticSimClusterMapper.h.

Referenced by buildClusters().

const float RealisticSimClusterMapper::calibMinEta_ = 1.4

private

Definition at line 57 of file RealisticSimClusterMapper.h.

Referenced by buildClusters().

std::vector<double> RealisticSimClusterMapper::egammaCalib_

private

Definition at line 60 of file RealisticSimClusterMapper.h.

Referenced by buildClusters(), and RealisticSimClusterMapper().

const float RealisticSimClusterMapper::exclusiveFraction_ = 0.7f

private

Definition at line 50 of file RealisticSimClusterMapper.h.

Referenced by buildClusters().

std::vector<double> RealisticSimClusterMapper::hadronCalib_

private

Definition at line 59 of file RealisticSimClusterMapper.h.

Referenced by buildClusters(), and RealisticSimClusterMapper().

const float RealisticSimClusterMapper::invisibleFraction_ = 0.3f

private

Definition at line 49 of file RealisticSimClusterMapper.h.

Referenced by buildClusters().

const float RealisticSimClusterMapper::maxDforTimingSquared_ = 4.0f

private

Definition at line 53 of file RealisticSimClusterMapper.h.

Referenced by buildClusters().

const float RealisticSimClusterMapper::maxDistance_ = 10.f

private

Definition at line 52 of file RealisticSimClusterMapper.h.

Referenced by buildClusters().

const bool RealisticSimClusterMapper::maxDistanceFilter_ = false

private

Definition at line 51 of file RealisticSimClusterMapper.h.

Referenced by buildClusters().

const unsigned int RealisticSimClusterMapper::minNHitsforTiming_ = 3

private

Definition at line 55 of file RealisticSimClusterMapper.h.

Referenced by buildClusters().

hgcal::RecHitTools RealisticSimClusterMapper::rhtools_

private

Definition at line 48 of file RealisticSimClusterMapper.h.

Referenced by buildClusters(), and update().

edm::Handle<SimClusterCollection> RealisticSimClusterMapper::simClusterH_

private

Definition at line 63 of file RealisticSimClusterMapper.h.

Referenced by buildClusters(), and updateEvent().

edm::EDGetTokenT<SimClusterCollection> RealisticSimClusterMapper::simClusterToken_

private

Definition at line 62 of file RealisticSimClusterMapper.h.

Referenced by RealisticSimClusterMapper(), and updateEvent().

const float RealisticSimClusterMapper::timeOffset_

private

Definition at line 54 of file RealisticSimClusterMapper.h.

Referenced by buildClusters().

const bool RealisticSimClusterMapper::useMCFractionsForExclEnergy_ = false

private

Definition at line 56 of file RealisticSimClusterMapper.h.

Referenced by buildClusters().