PFBlockAlgo Class Reference

Particle Flow Algorithm. More...

#include <PFBlockAlgo.h>

Public Types
typedef std::vector< std::unique_ptr< reco::PFBlockElement > >	ElementList
typedef std::array< std::pair< unsigned int, unsigned int >, reco::PFBlockElement::kNBETypes >	ElementRanges

Public Member Functions
void	buildElements (const edm::Event &)
reco::PFBlockCollection	findBlocks ()
	build blocks More...
	PFBlockAlgo ()
void	setDebug (bool debug)
	sets debug printout flag More...
void	setImporters (const std::vector< edm::ParameterSet > &, edm::ConsumesCollector &)
void	setLinkers (const std::vector< edm::ParameterSet > &)
void	updateEventSetup (const edm::EventSetup &)
	~PFBlockAlgo ()

Private Member Functions
void	link (const reco::PFBlockElement *el1, const reco::PFBlockElement *el2, double &dist) const
	check whether 2 elements are linked. Returns distance More...
void	packLinks (reco::PFBlock &block, const std::unordered_map< std::pair< unsigned int, unsigned int >, double > &links) const

Private Attributes
bool	debug_
	if true, debug printouts activated More...
ElementList	elements_
const std::unordered_map< std::string, reco::PFBlockElement::Type >	elementTypes_
std::vector< std::unique_ptr< BlockElementImporterBase > >	importers_
std::vector< std::unique_ptr< KDTreeLinkerBase > >	kdtrees_
std::vector< std::unique_ptr< BlockElementLinkerBase > >	linkTests_
unsigned int	linkTestSquare_ [reco::PFBlockElement::kNBETypes][reco::PFBlockElement::kNBETypes]
ElementRanges	ranges_
bool	useHO_

Friends
std::ostream &	operator<< (std::ostream &, const PFBlockAlgo &)

Detailed Description

Particle Flow Algorithm.

Author

Colin Bernet (rewrite/refactor by L. Gray)

Date

January 2006 (April 2014)

Definition at line 34 of file PFBlockAlgo.h.

Member Typedef Documentation

ElementList

typedef std::vector<std::unique_ptr<reco::PFBlockElement> > PFBlockAlgo::ElementList

Definition at line 37 of file PFBlockAlgo.h.

ElementRanges

typedef std::array<std::pair<unsigned int, unsigned int>, reco::PFBlockElement::kNBETypes> PFBlockAlgo::ElementRanges

Definition at line 39 of file PFBlockAlgo.h.

Constructor & Destructor Documentation

PFBlockAlgo()

PFBlockAlgo::PFBlockAlgo

(

)

Definition at line 69 of file PFBlockAlgo.cc.

References ECAL, HCAL, DigiToRawDM_cff::HO, and INIT_ENTRY.

    : debug_(false),
      elementTypes_({INIT_ENTRY(PFBlockElement::TRACK),
                     INIT_ENTRY(PFBlockElement::PS1),
                     INIT_ENTRY(PFBlockElement::PS2),
                     INIT_ENTRY(PFBlockElement::ECAL),
                     INIT_ENTRY(PFBlockElement::HCAL),
                     INIT_ENTRY(PFBlockElement::GSF),
                     INIT_ENTRY(PFBlockElement::BREM),
                     INIT_ENTRY(PFBlockElement::HFEM),
                     INIT_ENTRY(PFBlockElement::HFHAD),
                     INIT_ENTRY(PFBlockElement::SC),
                     INIT_ENTRY(PFBlockElement::HO),
                     INIT_ENTRY(PFBlockElement::HGCAL)}) {}

~PFBlockAlgo()

PFBlockAlgo::~PFBlockAlgo

(

)

Definition at line 132 of file PFBlockAlgo.cc.

References gather_cfg::cout, debug_, and elements_.

                          {
#ifdef PFLOW_DEBUG
  if (debug_)
    cout << "~PFBlockAlgo - number of remaining elements: " << elements_.size() << endl;
#endif
}

Member Function Documentation

buildElements()

void PFBlockAlgo::buildElements

(

const edm::Event &

evt

)

Definition at line 284 of file PFBlockAlgo.cc.

References a, b, elements_, mps_fire::i, importers_, ALPAKA_ACCELERATOR_NAMESPACE::vertexFinder::it, kdtrees_, ranges_, and jetUpdater_cfi::sort.

Referenced by PFBlockProducer::produce().

                                                   {
  // import block elements as defined in python configuration
  ranges_.fill(std::make_pair(0, 0));
  elements_.clear();
  for (const auto& importer : importers_) {
    importer->importToBlock(evt, elements_);
  }

  std::sort(elements_.begin(), elements_.end(), [](const auto& a, const auto& b) { return a->type() < b->type(); });

  // list is now partitioned, so mark the boundaries so we can efficiently skip chunks
  unsigned current_type = (!elements_.empty() ? elements_[0]->type() : 0);
  unsigned last_type = (!elements_.empty() ? elements_.back()->type() : 0);
  ranges_[current_type].first = 0;
  ranges_[last_type].second = elements_.size() - 1;
  for (size_t i = 0; i < elements_.size(); ++i) {
    const auto the_type = elements_[i]->type();
    if (the_type != current_type) {
      ranges_[the_type].first = i;
      ranges_[current_type].second = i - 1;
      current_type = the_type;
    }
  }
  // -------------- Loop over block elements ---------------------

  // Here we provide to all KDTree linkers the collections to link.
  // Glowinski & Gouzevitch

  for (ElementList::iterator it = elements_.begin(); it != elements_.end(); ++it) {
    for (const auto& kdtree : kdtrees_) {
      if ((*it)->type() == kdtree->targetType()) {
        kdtree->insertTargetElt(it->get());
      }
      if ((*it)->type() == kdtree->fieldType()) {
        kdtree->insertFieldClusterElt(it->get());
      }
    }
  }
  //std::cout << "(new) imported: " << elements_.size() << " elements!" << std::endl;
}

findBlocks()

reco::PFBlockCollection PFBlockAlgo::findBlocks

(

)

build blocks

Definition at line 139 of file PFBlockAlgo.cc.

References OfflinePixel3DPrimaryVertices_cfi::block_size, gather_cfg::blocks, elements_, mps_fire::i, dqmiolumiharvest::j, kdtrees_, submitPVResolutionJobs::key, relativeConstraints::keys, electronStore::links, linkTests_, linkTestSquare_, pfDeepBoostedJetPreprocessParams_cfi::lower_bound, SiStripPI::min, LaserDQM_cfg::p1, SiStripOfflineCRack_cfg::p2, packLinks(), FastTimerService_cff::range, and ranges_.

Referenced by PFBlockProducer::produce().

                                              {
  // Glowinski & Gouzevitch
  for (const auto& kdtree : kdtrees_) {
    kdtree->process();
  }
  // !Glowinski & Gouzevitch
  reco::PFBlockCollection blocks;
  // the blocks have not been passed to the event, and need to be cleared
  blocks.reserve(elements_.size());

  QuickUnion qu(elements_.size());
  const auto elem_size = elements_.size();
  for (unsigned i = 0; i < elem_size; ++i) {
    for (unsigned j = i + 1; j < elem_size; ++j) {
      if (qu.connected(i, j))
        continue;
      if (!linkTests_[linkTestSquare_[elements_[i]->type()][elements_[j]->type()]]) {
        j = ranges_[elements_[j]->type()].second;
        continue;
      }
      auto p1(elements_[i].get()), p2(elements_[j].get());
      const PFBlockElement::Type type1 = p1->type();
      const PFBlockElement::Type type2 = p2->type();
      const unsigned index = linkTestSquare_[type1][type2];
      if (linkTests_[index]->linkPrefilter(p1, p2)) {
        const double dist = linkTests_[index]->testLink(p1, p2);
        // compute linking info if it is possible
        if (dist > -0.5) {
          qu.unite(i, j);
        }
      }
    }
  }

  std::unordered_multimap<unsigned, unsigned> blocksmap(elements_.size());
  std::vector<unsigned> keys;
  keys.reserve(elements_.size());
  for (unsigned i = 0; i < elements_.size(); ++i) {
    unsigned key = i;
    while (key != qu.find(key))
      key = qu.find(key);  // make sure we always find the root node...
    auto pos = std::lower_bound(keys.begin(), keys.end(), key);
    if (pos == keys.end() || *pos != key) {
      keys.insert(pos, key);
    }
    blocksmap.emplace(key, i);
  }

  for (auto key : keys) {
    blocks.push_back(reco::PFBlock());
    auto range = blocksmap.equal_range(key);
    auto& the_block = blocks.back();
    ElementList::value_type::pointer p1(elements_[range.first->second].get());
    the_block.addElement(p1);
    const unsigned block_size = blocksmap.count(key) + 1;
    //reserve up to 1M or 8MB; pay rehash cost for more
    std::unordered_map<std::pair<unsigned int, unsigned int>, double> links(min(1000000u, block_size * block_size));
    auto itr = range.first;
    ++itr;
    for (; itr != range.second; ++itr) {
      ElementList::value_type::pointer p2(elements_[itr->second].get());
      const PFBlockElement::Type type1 = p1->type();
      const PFBlockElement::Type type2 = p2->type();
      the_block.addElement(p2);
      const unsigned index = linkTestSquare_[type1][type2];
      if (nullptr != linkTests_[index]) {
        const double dist = linkTests_[index]->testLink(p1, p2);
        links.emplace(std::make_pair(p1->index(), p2->index()), dist);
      }
    }
    packLinks(the_block, links);
  }

  elements_.clear();

  return blocks;
}

link()

void PFBlockAlgo::link ( const reco::PFBlockElement *  el1, const reco::PFBlockElement *  el2, double &  dist  ) const

inlineprivate

check whether 2 elements are linked. Returns distance

Definition at line 261 of file PFBlockAlgo.cc.

References ALPAKA_ACCELERATOR_NAMESPACE::brokenline::constexpr(), gather_cfg::cout, debug_, reco::PFBlockElement::kNBETypes, linkTests_, SiStripPI::max, SiStripPI::min, and reco::PFBlockElement::type().

Referenced by packLinks().

                                                                                                              {
  constexpr unsigned rowsize = reco::PFBlockElement::kNBETypes;
  dist = -1.0;
  const PFBlockElement::Type type1 = el1->type();
  const PFBlockElement::Type type2 = el2->type();
  const unsigned index = rowsize * std::max(type1, type2) + std::min(type1, type2);
  if (debug_) {
    std::cout << " PFBlockAlgo links type1 " << type1 << " type2 " << type2 << std::endl;
  }

  // index is always checked in the preFilter above, no need to check here
  dist = linkTests_[index]->testLink(el1, el2);
}

packLinks()

void PFBlockAlgo::packLinks ( reco::PFBlock &  block, const std::unordered_map< std::pair< unsigned int, unsigned int >, double > &  links  ) const

private

compute missing links in the blocks (the recursive procedure does not build all links)

Definition at line 217 of file PFBlockAlgo.cc.

References groupFilesInBlocks::block, ALPAKA_ACCELERATOR_NAMESPACE::brokenline::constexpr(), funct::false, testProducerWithPsetDescEmpty_cfi::i1, testProducerWithPsetDescEmpty_cfi::i2, reco::PFBlockElement::kNBETypes, link(), electronStore::links, linkTests_, and edm::OwnVector< T, P >::size().

Referenced by findBlocks().

                                                                                                              {
  constexpr unsigned rowsize = reco::PFBlockElement::kNBETypes;

  const edm::OwnVector<reco::PFBlockElement>& els = block.elements();

  block.bookLinkData();
  unsigned elsize = els.size();
  //First Loop: update all link data
  for (unsigned i1 = 0; i1 < elsize; ++i1) {
    for (unsigned i2 = 0; i2 < i1; ++i2) {
      // no reflexive link
      //if( i1==i2 ) continue;

      double dist = -1;

      bool linked = false;

      // are these elements already linked ?
      // this can be optimized
      const auto link_itr = links.find(std::make_pair(i2, i1));
      if (link_itr != links.end()) {
        dist = link_itr->second;
        linked = true;
      }

      if (!linked) {
        const PFBlockElement::Type type1 = els[i1].type();
        const PFBlockElement::Type type2 = els[i2].type();
        const auto minmax = std::minmax(type1, type2);
        const unsigned index = rowsize * minmax.second + minmax.first;
        bool bTestLink =
            (nullptr == linkTests_[index] ? false : linkTests_[index]->linkPrefilter(&(els[i1]), &(els[i2])));
        if (bTestLink)
          link(&els[i1], &els[i2], dist);
      }

      //loading link data according to link test used: RECHIT
      //block.setLink( i1, i2, chi2, block.linkData() );
      block.setLink(i1, i2, dist, block.linkData());
    }
  }
}

setDebug()

void PFBlockAlgo::setDebug ( bool  debug )

inline

sets debug printout flag

Definition at line 59 of file PFBlockAlgo.h.

References debug, and debug_.

{ debug_ = debug; }

setImporters()

void PFBlockAlgo::setImporters	(	const std::vector< edm::ParameterSet > &	confs,
		edm::ConsumesCollector &	cc
	)

Definition at line 124 of file PFBlockAlgo.cc.

References gpuPixelDoublets::cc, beamerCreator::create(), get, HLT_2024v12_cff::importerName, importers_, and AlCaHLTBitMon_QueryRunRegistry::string.

                                                                                                {
  importers_.reserve(confs.size());
  for (const auto& conf : confs) {
    const std::string& importerName = conf.getParameter<std::string>("importerName");
    importers_.emplace_back(BlockElementImporterFactory::get()->create(importerName, conf, cc));
  }
}

setLinkers()

void PFBlockAlgo::setLinkers

(

const std::vector< edm::ParameterSet > &

confs

)

Definition at line 84 of file PFBlockAlgo.cc.

References ALPAKA_ACCELERATOR_NAMESPACE::brokenline::constexpr(), beamerCreator::create(), elementTypes_, Exception, get, mps_fire::i, dqmiolumiharvest::j, kdtrees_, reco::PFBlockElement::kNBETypes, HLT_2024v12_cff::linkerName, linkTests_, linkTestSquare_, SiStripPI::max, SiStripPI::min, hcallasereventfilter2012_cfi::prefix, submitPVValidationJobs::split(), AlCaHLTBitMon_QueryRunRegistry::string, and HLT_2024v12_cff::useKDTree.

                                                                    {
  constexpr unsigned rowsize = reco::PFBlockElement::kNBETypes;
  for (unsigned i = 0; i < rowsize; ++i) {
    for (unsigned j = 0; j < rowsize; ++j) {
      linkTestSquare_[i][j] = 0;
    }
  }
  linkTests_.resize(rowsize * rowsize);
  const std::string prefix("PFBlockElement::");
  const std::string pfx_kdtree("KDTree");
  for (const auto& conf : confs) {
    const std::string& linkerName = conf.getParameter<std::string>("linkerName");
    const std::string& linkTypeStr = conf.getParameter<std::string>("linkType");
    size_t split = linkTypeStr.find(':');
    if (split == std::string::npos) {
      throw cms::Exception("MalformedLinkType") << "\"" << linkTypeStr << "\" is not a valid link type definition."
                                                << " This string should have the form \"linkFrom:linkTo\"";
    }
    std::string link1(prefix + linkTypeStr.substr(0, split));
    std::string link2(prefix + linkTypeStr.substr(split + 1, std::string::npos));
    if (!(elementTypes_.count(link1) && elementTypes_.count(link2))) {
      throw cms::Exception("InvalidBlockElementType")
          << "One of \"" << link1 << "\" or \"" << link2 << "\" are invalid block element types!";
    }
    const PFBlockElement::Type type1 = elementTypes_.at(link1);
    const PFBlockElement::Type type2 = elementTypes_.at(link2);
    const unsigned index = rowsize * std::max(type1, type2) + std::min(type1, type2);
    linkTests_[index] = BlockElementLinkerFactory::get()->create(linkerName, conf);
    linkTestSquare_[type1][type2] = index;
    linkTestSquare_[type2][type1] = index;
    // setup KDtree if requested
    const bool useKDTree = conf.getParameter<bool>("useKDTree");
    if (useKDTree) {
      kdtrees_.emplace_back(KDTreeLinkerFactory::get()->create(pfx_kdtree + linkerName, conf));
      kdtrees_.back()->setTargetType(std::min(type1, type2));
      kdtrees_.back()->setFieldType(std::max(type1, type2));
    }  // useKDTree
  }    // loop over confs
}

updateEventSetup()

void PFBlockAlgo::updateEventSetup

(

const edm::EventSetup &

es

)

Definition at line 275 of file PFBlockAlgo.cc.

References importers_.

Referenced by PFBlockProducer::beginLuminosityBlock().

                                                          {
  for (auto& importer : importers_) {
    importer->updateEventSetup(es);
  }
}

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  out, const PFBlockAlgo &  a  )

friend

Definition at line 325 of file PFBlockAlgo.cc.

                                                              {
  if (!out)
    return out;

  out << "====== Particle Flow Block Algorithm ======= ";
  out << endl;
  out << "number of unassociated elements : " << a.elements_.size() << endl;
  out << endl;

  for (auto const& element : a.elements_) {
    out << "\t" << *element << endl;
  }

  return out;
}

Member Data Documentation

debug_

bool PFBlockAlgo::debug_

private

if true, debug printouts activated

Definition at line 75 of file PFBlockAlgo.h.

Referenced by link(), setDebug(), and ~PFBlockAlgo().

elements_

ElementList PFBlockAlgo::elements_

private

Definition at line 71 of file PFBlockAlgo.h.

Referenced by buildElements(), findBlocks(), and ~PFBlockAlgo().

elementTypes_

const std::unordered_map<std::string, reco::PFBlockElement::Type> PFBlockAlgo::elementTypes_

private

Definition at line 82 of file PFBlockAlgo.h.

Referenced by setLinkers().

importers_

std::vector<std::unique_ptr<BlockElementImporterBase> > PFBlockAlgo::importers_

private

Definition at line 80 of file PFBlockAlgo.h.

Referenced by buildElements(), setImporters(), and updateEventSetup().

kdtrees_

std::vector<std::unique_ptr<KDTreeLinkerBase> > PFBlockAlgo::kdtrees_

private

Definition at line 86 of file PFBlockAlgo.h.

Referenced by buildElements(), findBlocks(), and setLinkers().

linkTests_

std::vector<std::unique_ptr<BlockElementLinkerBase> > PFBlockAlgo::linkTests_

private

Definition at line 83 of file PFBlockAlgo.h.

Referenced by findBlocks(), link(), packLinks(), and setLinkers().

linkTestSquare_

unsigned int PFBlockAlgo::linkTestSquare_[reco::PFBlockElement::kNBETypes][reco::PFBlockElement::kNBETypes]

private

Definition at line 84 of file PFBlockAlgo.h.

Referenced by findBlocks(), and setLinkers().

ranges_

ElementRanges PFBlockAlgo::ranges_

private

Definition at line 72 of file PFBlockAlgo.h.

Referenced by buildElements(), and findBlocks().

useHO_

bool PFBlockAlgo::useHO_

private

Definition at line 78 of file PFBlockAlgo.h.