EDProducer to cluster PixelDigis into SiPixelClusters. More...

#include <SiPixelClusterProducer.h>

Inheritance diagram for SiPixelClusterProducer:

Public Member Functions
virtual 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...

virtual	~SiPixelClusterProducer ()

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

Public Member Functions inherited from edm::stream::EDProducerBase
	EDProducerBase ()

ModuleDescription const &	moduleDescription () const

virtual	~EDProducerBase ()

Public Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

std::vector< edm::ProductResolverIndex > const &	indiciesForPutProducts (BranchType iBranchType) const

	ProducerBase ()

void	registerProducts (ProducerBase , ProductRegistry , ModuleDescription const &)

std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...

void	resolvePutIndicies (BranchType iBranchType, std::unordered_multimap< std::string, edm::ProductResolverIndex > const &iIndicies, std::string const &moduleLabel)

virtual	~ProducerBase () noexcept(false)

Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const

void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...

	EDConsumerBase ()

	EDConsumerBase (EDConsumerBase const &)=delete

	EDConsumerBase (EDConsumerBase &&)=default

ProductResolverIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const

void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const

void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const

std::vector< ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const

void	labelsForToken (EDGetToken iToken, Labels &oLabels) const

void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const

EDConsumerBase const &	operator= (EDConsumerBase const &)=delete

EDConsumerBase &	operator= (EDConsumerBase &&)=default

bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const

bool	registeredToConsumeMany (TypeID const &, BranchType) const

void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)

virtual	~EDConsumerBase () noexcept(false)

Private Attributes
PixelClusterizerBase *	clusterizer_

const std::string	clusterMode_

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

const std::string	payloadType_

bool	readyToCluster_

SiPixelGainCalibrationServiceBase *	theSiPixelGainCalibration_

edm::EDGetTokenT< SiPixelClusterCollectionNew >	tPixelClusters

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

const TrackerTopology *	tTopo_

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

typedef CacheTypes::GlobalCache	GlobalCache

typedef AbilityChecker< T... >	HasAbility

typedef CacheTypes::LuminosityBlockCache	LuminosityBlockCache

typedef LuminosityBlockContextT< LuminosityBlockCache, RunCache, GlobalCache >	LuminosityBlockContext

typedef CacheTypes::LuminosityBlockSummaryCache	LuminosityBlockSummaryCache

typedef CacheTypes::RunCache	RunCache

typedef RunContextT< RunCache, GlobalCache >	RunContext

typedef CacheTypes::RunSummaryCache	RunSummaryCache

Public Types inherited from edm::stream::EDProducerBase
typedef EDProducerAdaptorBase	ModuleType

Public Types inherited from edm::ProducerBase
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Static Public Member Functions inherited from edm::stream::EDProducerBase
static const std::string &	baseType ()

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)

EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)

ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...

template<typename ProductType , BranchType B = InEvent>
void	consumesMany ()

void	consumesMany (const TypeToGet &id)

template<BranchType B>
void	consumesMany (const TypeToGet &id)

template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

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 52 of file SiPixelClusterProducer.h.

Constructor & Destructor Documentation

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 49 of file SiPixelClusterProducer.cc.

References clusterMode_, edm::ParameterSet::getParameter(), payloadType_, setupClusterizer(), theSiPixelGainCalibration_, tPixelClusters, and tPixelDigi.

     : 
     theSiPixelGainCalibration_(0), 
     clusterMode_( conf.getUntrackedParameter<std::string>("ClusterMode","PixelThresholdClusterizer") ),
     clusterizer_(0),          // the default, in case we fail to make one
     readyToCluster_(false),   // since we obviously aren't
     maxTotalClusters_( conf.getParameter<int32_t>( "maxNumberOfClusters" ) ),
     payloadType_( conf.getParameter<std::string>( "payloadType" ) )
   {
     if ( clusterMode_ == "PixelThresholdReclusterizer" )
       tPixelClusters = consumes<SiPixelClusterCollectionNew>( conf.getParameter<edm::InputTag>("src") );
     else
       tPixelDigi = consumes<edm::DetSetVector<PixelDigi>>( conf.getParameter<edm::InputTag>("src") );
     //--- Declare to the EDM what kind of collections we will be making.
     produces<SiPixelClusterCollectionNew>(); 
 
     if (strcmp(payloadType_.c_str(), "HLT") == 0)
        theSiPixelGainCalibration_ = new SiPixelGainCalibrationForHLTService(conf);
     else if (strcmp(payloadType_.c_str(), "Offline") == 0)
        theSiPixelGainCalibration_ = new SiPixelGainCalibrationOfflineService(conf);
     else if (strcmp(payloadType_.c_str(), "Full") == 0)
        theSiPixelGainCalibration_ = new SiPixelGainCalibrationService(conf);
 
     //--- Make the algorithm(s) according to what the user specified
     //--- in the ParameterSet.
     setupClusterizer(conf);
 
   }

SiPixelClusterProducer::~SiPixelClusterProducer ( )

virtual

Definition at line 79 of file SiPixelClusterProducer.cc.

References clusterizer_, and theSiPixelGainCalibration_.

                                                   { 
     delete clusterizer_;
     delete theSiPixelGainCalibration_;
   }  

Member Function Documentation

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

overridevirtual

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

Definition at line 88 of file SiPixelClusterProducer.cc.

References clusterMode_, relativeConstraints::geom, edm::EventSetup::get(), edm::Event::getByToken(), eostools::move(), convertSQLitetoXML_cfg::output, edm::ESHandle< T >::product(), edm::Event::put(), run(), SiPixelGainCalibrationServiceBase::setESObjects(), theSiPixelGainCalibration_, tPixelClusters, tPixelDigi, and tTopo_.

   {
 
     //Setup gain calibration service
     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.get<TrackerDigiGeometryRecord>().get( geom );
 
     edm::ESHandle<TrackerTopology> trackerTopologyHandle;
     es.get<TrackerTopologyRcd>().get(trackerTopologyHandle);
     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();
     e.put(std::move(output));
 
   }

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 153 of file SiPixelClusterProducer.cc.

References PixelClusterizerBase::clusterizeDetUnit(), clusterizer_, DEFINE_FWK_MODULE, relativeConstraints::empty, TrackerGeometry::idToDetUnit(), maxTotalClusters_, readyToCluster_, edmNew::DetSetVector< T >::swap(), and tTopo_.

Referenced by produce().

                                                                                 {
     if ( ! readyToCluster_ ) {
       edm::LogError("SiPixelClusterProducer")
         <<" at least one clusterizer is not ready -- can't run!" ;
       // TO DO: throw an exception here?  The user may want to know...
       return;   // clusterizer is invalid, bail out
     }
 
     int numberOfDetUnits = 0;
     int numberOfClusters = 0;
  
     // Iterate on detector units
     typename T::const_iterator DSViter = input.begin();
     for( ; DSViter != input.end(); DSViter++) {
       ++numberOfDetUnits;
 
       //  LogDebug takes very long time, get rid off.
       //LogDebug("SiStripClusterizer") << "[SiPixelClusterProducer::run] DetID" << DSViter->id;
 
       std::vector<short> badChannels; 
       DetId detIdObject(DSViter->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, DSViter->detId());
       clusterizer_->clusterizeDetUnit(*DSViter, 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
     
     //LogDebug ("SiPixelClusterProducer") << " Executing " 
     //      << clusterMode_ << " resulted in " << numberOfClusters
     //                  << " SiPixelClusters in " << numberOfDetUnits << " DetUnits."; 
   }

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 132 of file SiPixelClusterProducer.cc.

References clusterizer_, clusterMode_, readyToCluster_, PixelClusterizerBase::setSiPixelGainCalibrationService(), and theSiPixelGainCalibration_.

Referenced by SiPixelClusterProducer().

                                                                             {
 
     if ( clusterMode_ == "PixelThresholdReclusterizer" || clusterMode_ == "PixelThresholdClusterizer" ) {
       clusterizer_ = new PixelThresholdClusterizer(conf);
       clusterizer_->setSiPixelGainCalibrationService(theSiPixelGainCalibration_);
       readyToCluster_ = true;
     } 
     else {
       edm::LogError("SiPixelClusterProducer") << "[SiPixelClusterProducer]:"
         <<" choice " << clusterMode_ << " is invalid.\n"
         << "Possible choices:\n" 
         << "    PixelThresholdClusterizer";
       readyToCluster_ = false;
     }
   }