EDProducer to cluster PixelDigis into SiPixelClusters. More...

#include <SiPixelClusterProducer.h>

Inheritance diagram for SiPixelClusterProducer:

Public Member Functions
void	produce (edm::Event &e, const edm::EventSetup &c) override
	The "Event" entrypoint: gets called by framework for every event. More...

template<typename T >
void	run (const T &input, const edm::ESHandle< TrackerGeometry > &geom, edmNew::DetSetVector< SiPixelCluster > &output)
	Iterate over DetUnits, and invoke the PixelClusterizer on each. More...

void	setupClusterizer (const edm::ParameterSet &conf)

	SiPixelClusterProducer (const edm::ParameterSet &conf)
	Constructor: set the ParameterSet and defer all thinking to setupClusterizer(). More...

	~SiPixelClusterProducer () override

Public Member Functions inherited from edm::stream::EDProducer<>
	EDProducer ()=default

	EDProducer (const EDProducer &)=delete

bool	hasAbilityToProduceInBeginLumis () const final

bool	hasAbilityToProduceInBeginProcessBlocks () const final

bool	hasAbilityToProduceInBeginRuns () const final

bool	hasAbilityToProduceInEndLumis () const final

bool	hasAbilityToProduceInEndProcessBlocks () const final

bool	hasAbilityToProduceInEndRuns () const final

const EDProducer &	operator= (const EDProducer &)=delete

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)

Private Attributes
std::unique_ptr< PixelClusterizerBase >	clusterizer_

const std::string	clusterMode_

const int32_t	maxTotalClusters_
	Optional limit on the total number of clusters. More...

std::unique_ptr< SiPixelGainCalibrationServiceBase >	theSiPixelGainCalibration_

edm::EDGetTokenT< SiPixelClusterCollectionNew >	tPixelClusters

edm::EDGetTokenT< edm::DetSetVector< PixelDigi > >	tPixelDigi

edm::EDPutTokenT< SiPixelClusterCollectionNew >	tPutPixelClusters

edm::ESGetToken< TrackerGeometry, TrackerDigiGeometryRecord >	trackerGeomToken_

edm::ESGetToken< TrackerTopology, TrackerTopologyRcd >	trackerTopoToken_

const TrackerTopology *	tTopo_

Additional Inherited Members
Public Types inherited from edm::stream::EDProducer<>
using	CacheTypes = CacheContexts< T... >

using	GlobalCache = typename CacheTypes::GlobalCache

using	HasAbility = AbilityChecker< T... >

using	InputProcessBlockCache = typename CacheTypes::InputProcessBlockCache

using	LuminosityBlockCache = typename CacheTypes::LuminosityBlockCache

using	LuminosityBlockContext = LuminosityBlockContextT< LuminosityBlockCache, RunCache, GlobalCache >

using	LuminosityBlockSummaryCache = typename CacheTypes::LuminosityBlockSummaryCache

using	RunCache = typename CacheTypes::RunCache

using	RunContext = RunContextT< RunCache, GlobalCache >

using	RunSummaryCache = typename CacheTypes::RunSummaryCache

Detailed Description

EDProducer to cluster PixelDigis into SiPixelClusters.

SiPixelClusterProducer is an EDProducer subclass (i.e., a module) which orchestrates clustering of PixelDigis to SiPixelClusters. Consequently, the input is edm::DetSetVector<PixelDigi> and the output is edm::DetSetVector<SiPixelCluster>.

SiPixelClusterProducer invokes one of descendents from PixelClusterizerBase, e.g. PixelThresholdClusterizer (which is the only available option right now). SiPixelClusterProducer loads the PixelDigis, and then iterates over DetIds, invoking PixelClusterizer's clusterizeDetUnit to perform the clustering. clusterizeDetUnit() returns a DetSetVector of SiPixelClusters, which are then recorded in the event.

The calibrations are not loaded at the moment (v1), although that is being planned for the near future.

Author: porting from ORCA by Petar Maksimovic (JHU). DetSetVector implementation by Vincenzo Chiochia (Uni Zurich) Modify the local container (cache) to improve the speed. D.K. 5/07

Version: v1, Oct 26, 2005

Definition at line 54 of file SiPixelClusterProducer.h.

Constructor & Destructor Documentation

◆ SiPixelClusterProducer()

SiPixelClusterProducer::SiPixelClusterProducer ( const edm::ParameterSet & conf )

explicit

Constructor: set the ParameterSet and defer all thinking to setupClusterizer().

SiPixelClusterProducer.cc

Description: see SiPixelClusterProducer.h Author: P. Maksimovic (porting from original ORCA version) History: Oct 14, 2005, initial version Get rid of the noiseVector. d.k. 28/3/06 Implementation of the DetSetVector container. V.Chiochia, May 06 SiPixelClusterCollection typedef of DetSetVector V.Chiochia, June 06 Introduce the DetSet local container (cache) for speed. d.k. 05/07

Definition at line 48 of file SiPixelClusterProducer.cc.

References clusterMode_, edm::ParameterSet::getParameter(), HLT_2024v14_cff::payloadType, setupClusterizer(), AlCaHLTBitMon_QueryRunRegistry::string, theSiPixelGainCalibration_, tPixelClusters, tPixelDigi, trackerGeomToken_, and trackerTopoToken_.

     : tPutPixelClusters(produces<SiPixelClusterCollectionNew>()),
       clusterMode_(conf.getParameter<std::string>("ClusterMode")),
       maxTotalClusters_(conf.getParameter<int32_t>("maxNumberOfClusters")) {
   if (clusterMode_ == "PixelThresholdReclusterizer")
     tPixelClusters = consumes<SiPixelClusterCollectionNew>(conf.getParameter<edm::InputTag>("src"));
   else
     tPixelDigi = consumes<edm::DetSetVector<PixelDigi>>(conf.getParameter<edm::InputTag>("src"));
 
   trackerTopoToken_ = esConsumes<TrackerTopology, TrackerTopologyRcd>();
   trackerGeomToken_ = esConsumes<TrackerGeometry, TrackerDigiGeometryRecord>();
 
   const auto& payloadType = conf.getParameter<std::string>("payloadType");
 
   if (payloadType == "HLT")
     theSiPixelGainCalibration_ = std::make_unique<SiPixelGainCalibrationForHLTService>(conf, consumesCollector());
   else if (payloadType == "Offline")
     theSiPixelGainCalibration_ = std::make_unique<SiPixelGainCalibrationOfflineService>(conf, consumesCollector());
   else if (payloadType == "Full")
     theSiPixelGainCalibration_ = std::make_unique<SiPixelGainCalibrationService>(conf, consumesCollector());
   else if (payloadType == "None")
     theSiPixelGainCalibration_ = nullptr;
 
   //--- Make the algorithm(s) according to what the user specified
   //--- in the ParameterSet.
   setupClusterizer(conf);
 }

◆ ~SiPixelClusterProducer()

SiPixelClusterProducer::~SiPixelClusterProducer ( )

overridedefault

Member Function Documentation

◆ fillDescriptions()

void SiPixelClusterProducer::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

static

Definition at line 79 of file SiPixelClusterProducer.cc.

References edm::ConfigurationDescriptions::add(), submitPVResolutionJobs::desc, SiPixelGainCalibrationServiceBase::fillPSetDescription(), PixelThresholdClusterizer::fillPSetDescription(), ProducerED_cfi::InputTag, and AlCaHLTBitMon_QueryRunRegistry::string.

                                                                                         {
   edm::ParameterSetDescription desc;
 
   desc.add<edm::InputTag>("src", edm::InputTag("siPixelDigis"));
   desc.add<std::string>("ClusterMode", "PixelThresholdClusterizer");
   desc.add<int>("maxNumberOfClusters", -1)->setComment("-1 means no limit");
   desc.add<std::string>("payloadType", "Offline")
       ->setComment("Options: HLT - column granularity, Offline - gain:col/ped:pix, None: no gain calibrations");
 
   PixelThresholdClusterizer::fillPSetDescription(desc);
   SiPixelGainCalibrationServiceBase::fillPSetDescription(desc);  // no-op, but in principle the structures are there...
 
   descriptions.add("SiPixelClusterizerDefault", desc);
 }

◆ produce()

void SiPixelClusterProducer::produce	(	edm::Event &	e,
		const edm::EventSetup &	c
	)

override

The "Event" entrypoint: gets called by framework for every event.

Definition at line 97 of file SiPixelClusterProducer.cc.

References clusterMode_, bsc_activity_cfg::clusters, MillePedeFileConverter_cfg::e, relativeConstraints::geom, edm::EventSetup::getHandle(), HLT_FULL_cff::inputClusters, eostools::move(), edm::ESHandle< T >::product(), run(), theSiPixelGainCalibration_, tPixelClusters, tPixelDigi, tPutPixelClusters, trackerGeomToken_, trackerTopoToken_, and tTopo_.

                                                                          {
   //Setup gain calibration service
   if (theSiPixelGainCalibration_.get())
     theSiPixelGainCalibration_->setESObjects(es);
 
   // Step A.1: get input data
   edm::Handle<SiPixelClusterCollectionNew> inputClusters;
   edm::Handle<edm::DetSetVector<PixelDigi>> inputDigi;
   if (clusterMode_ == "PixelThresholdReclusterizer")
     e.getByToken(tPixelClusters, inputClusters);
   else
     e.getByToken(tPixelDigi, inputDigi);
 
   // Step A.2: get event setup
   edm::ESHandle<TrackerGeometry> geom = es.getHandle(trackerGeomToken_);
 
   edm::ESHandle<TrackerTopology> trackerTopologyHandle = es.getHandle(trackerTopoToken_);
   tTopo_ = trackerTopologyHandle.product();
 
   // Step B: create the final output collection
   auto output = std::make_unique<SiPixelClusterCollectionNew>();
   //FIXME: put a reserve() here
 
   // Step C: Iterate over DetIds and invoke the pixel clusterizer algorithm
   // on each DetUnit
   if (clusterMode_ == "PixelThresholdReclusterizer")
     run(*inputClusters, geom, *output);
   else
     run(*inputDigi, geom, *output);
 
   // Step D: write output to file
   output->shrink_to_fit();
 
   // set sequential identifier
   for (auto clusters : *output) {
     uint16_t id = 0;
     for (auto& cluster : clusters) {
       cluster.setOriginalId(id++);
     }
   }
   e.put(tPutPixelClusters, std::move(output));
 }

◆ run()

template<typename T >

void SiPixelClusterProducer::run	(	const T &	input,
		const edm::ESHandle< TrackerGeometry > &	geom,
		edmNew::DetSetVector< SiPixelCluster > &	output
	)

Iterate over DetUnits, and invoke the PixelClusterizer on each.

Definition at line 163 of file SiPixelClusterProducer.cc.

References cms::cuda::assert(), clusterizer_, relativeConstraints::empty, relativeConstraints::geom, input, maxTotalClusters_, electrons_cff::numberOfClusters, and tTopo_.

Referenced by produce().

                                                                              {
   int numberOfClusters = 0;
 
   // Iterate on detector units
   for (auto const& dsv : input) {
     //  LogDebug takes very long time, get rid off.
     //LogDebug("SiStripClusterizer") << "[SiPixelClusterProducer::run] DetID" << dsv.id;
 
     std::vector<short> badChannels;
     DetId detIdObject(dsv.detId());
 
     // Comment: At the moment the clusterizer depends on geometry
     // to access information as the pixel topology (number of columns
     // and rows in a detector module).
     // In the future the geometry service will be replaced with
     // a ES service.
     const GeomDetUnit* geoUnit = geom->idToDetUnit(detIdObject);
     const PixelGeomDetUnit* pixDet = dynamic_cast<const PixelGeomDetUnit*>(geoUnit);
     if (!pixDet) {
       // Fatal error!  TO DO: throw an exception!
       assert(0);
     }
     {
       // Produce clusters for this DetUnit and store them in
       // a DetSet
       edmNew::DetSetVector<SiPixelCluster>::FastFiller spc(output, dsv.detId());
       clusterizer_->clusterizeDetUnit(dsv, pixDet, tTopo_, badChannels, spc);
       if (spc.empty()) {
         spc.abort();
       } else {
         numberOfClusters += spc.size();
       }
     }  // spc is not deleted and detsetvector updated
     if ((maxTotalClusters_ >= 0) && (numberOfClusters > maxTotalClusters_)) {
       edm::LogError("TooManyClusters")
           << "Limit on the number of clusters exceeded. An empty cluster collection will be produced instead.\n";
       edmNew::DetSetVector<SiPixelCluster> empty;
       empty.swap(output);
       break;
     }
   }  // end of DetUnit loop
 }

◆ setupClusterizer()

void SiPixelClusterProducer::setupClusterizer ( const edm::ParameterSet & conf )

Set up the specific algorithm we are going to use. TO DO: in the future, we should allow for a different algorithm for each detector subset (e.g. barrel vs forward, per layer, etc).

Definition at line 145 of file SiPixelClusterProducer.cc.

References clusterizer_, clusterMode_, Exception, and theSiPixelGainCalibration_.

Referenced by SiPixelClusterProducer().

                                                                          {
   if (clusterMode_ == "PixelThresholdReclusterizer" || clusterMode_ == "PixelThresholdClusterizer") {
     clusterizer_ = std::make_unique<PixelThresholdClusterizer>(conf);
     if (theSiPixelGainCalibration_.get()) {
       clusterizer_->setSiPixelGainCalibrationService(theSiPixelGainCalibration_.get());
     }
   } else {
     throw cms::Exception("Configuration") << "[SiPixelClusterProducer]:"
                                           << " choice " << clusterMode_ << " is invalid.\n"
                                           << "Possible choices:\n"
                                           << "    PixelThresholdClusterizer";
   }
 }