EDProducer to cluster PixelDigis into Phase2ITPixelClusters. More...

#include <Phase2ITPixelClusterProducer.h>

Inheritance diagram for Phase2ITPixelClusterProducer:

Public Member Functions
	Phase2ITPixelClusterProducer (const edm::ParameterSet &conf)
	Constructor: set the ParameterSet and defer all thinking to setupClusterizer(). More...

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

void	run (const edm::DetSetVector< PixelDigi > &input, edm::ESHandle< TrackerGeometry > &geom, edmNew::DetSetVector< Phase2ITPixelCluster > &output)
	Iterate over DetUnits, and invoke the Phase2ITPixelClusterizer on each. More...

void	setupClusterizer ()

virtual	~Phase2ITPixelClusterProducer ()

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

	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 &	itemsToGetFromEvent () 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
Phase2ITPixelClusterizerBase *	clusterizer_

std::string	clusterMode_

edm::ParameterSet	conf_

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

bool	readyToCluster_

edm::InputTag	src_

SiPixelGainCalibrationServiceBase *	theSiPixelGainCalibration_

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

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 Phase2ITPixelClusters.

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

Phase2ITPixelClusterProducer invokes one of descendents from Phase2ITPixelClusterizerBase, e.g. PixelThresholdClusterizer (which is the only available option right now). Phase2ITPixelClusterProducer loads the PixelDigis, and then iterates over DetIds, invoking Phase2ITPixelClusterizer's clusterizeDetUnit to perform the clustering. clusterizeDetUnit() returns a DetSetVector of Phase2ITPixelClusters, 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: Petar Maksimovic (JHU). DetSetVector implementation by Vincenzo Chiochia (Uni Zurich) Modify the local container (cache) to improve the speed. D.K. 5/07

Definition at line 49 of file Phase2ITPixelClusterProducer.h.

Constructor & Destructor Documentation

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

explicit

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

Phase2ITPixelClusterProducer.cc

Description: see Phase2ITPixelClusterProducer.h Author: P. Maksimovic (porting from original ORCA version) Get rid of the noiseVector. d.k. 28/3/06 Implementation of the DetSetVector container. V.Chiochia, May 06 Phase2ITPixelClusterCollection 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 Phase2ITPixelClusterProducer.cc.

References edm::ParameterSet::getParameter(), Phase2ITPixelClusterizer_cfi::payloadType, setupClusterizer(), src_, AlCaHLTBitMon_QueryRunRegistry::string, theSiPixelGainCalibration_, and tPixelDigi.

     : 
     conf_(conf),
     theSiPixelGainCalibration_(0), 
     clusterMode_("None"),     // bogus
     clusterizer_(0),          // the default, in case we fail to make one
     readyToCluster_(false),   // since we obviously aren't
     src_( conf.getParameter<edm::InputTag>( "src" ) ),
     maxTotalClusters_( conf.getParameter<int32_t>( "maxNumberOfClusters" ) )
   {
     tPixelDigi = consumes<edm::DetSetVector<PixelDigi>>(src_);
     //--- Declare to the EDM what kind of collections we will be making.
     produces<Phase2ITPixelClusterCollectionNew>(); 
 
     std::string payloadType = conf.getParameter<std::string>( "payloadType" );
 
     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();
 
   }

Phase2ITPixelClusterProducer::~Phase2ITPixelClusterProducer ( )

virtual

Definition at line 78 of file Phase2ITPixelClusterProducer.cc.

References clusterizer_, and theSiPixelGainCalibration_.

                                                               { 
     delete clusterizer_;
     delete theSiPixelGainCalibration_;
   }  

Member Function Documentation

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

overridevirtual

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

Definition at line 87 of file Phase2ITPixelClusterProducer.cc.

References relativeConstraints::geom, edm::EventSetup::get(), edm::Event::getByToken(), input, eostools::move(), convertSQLitetoXML_cfg::output, edm::Event::put(), run(), SiPixelGainCalibrationServiceBase::setESObjects(), theSiPixelGainCalibration_, and tPixelDigi.

   {
 
     //Setup gain calibration service
     theSiPixelGainCalibration_->setESObjects( es );
 
    // Step A.1: get input data
     //edm::Handle<PixelDigiCollection> pixDigis;
     edm::Handle< edm::DetSetVector<PixelDigi> >  input;
     e.getByToken(tPixelDigi, input);
 
     // Step A.2: get event setup
     edm::ESHandle<TrackerGeometry> geom;
     es.get<TrackerDigiGeometryRecord>().get( geom );
 
     // Step B: create the final output collection
     auto output = std::make_unique<Phase2ITPixelClusterCollectionNew>();
     //FIXME: put a reserve() here
 
     // Step C: Iterate over DetIds and invoke the pixel clusterizer algorithm
     // on each DetUnit
     run(*input, geom, *output );
 
     // Step D: write output to file
     output->shrink_to_fit();
     e.put(std::move(output));
 
   }

void Phase2ITPixelClusterProducer::run	(	const edm::DetSetVector< PixelDigi > &	input,
		edm::ESHandle< TrackerGeometry > &	geom,
		edmNew::DetSetVector< Phase2ITPixelCluster > &	output
	)

Iterate over DetUnits, and invoke the Phase2ITPixelClusterizer on each.

Definition at line 142 of file Phase2ITPixelClusterProducer.cc.

References edm::DetSetVector< T >::begin(), Phase2ITPixelClusterizerBase::clusterizeDetUnit(), clusterizer_, DEFINE_FWK_MODULE, relativeConstraints::empty, edm::DetSetVector< T >::end(), TrackerGeometry::idToDetUnit(), maxTotalClusters_, readyToCluster_, and edmNew::DetSetVector< T >::swap().

Referenced by produce().

                                                                                       {
     if ( ! readyToCluster_ ) {
       edm::LogError("Phase2ITPixelClusterProducer")
         <<" 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
     edm::DetSetVector<PixelDigi>::const_iterator DSViter = input.begin();
     for( ; DSViter != input.end(); DSViter++) {
       ++numberOfDetUnits;
 
       //  LogDebug takes very long time, get rid off.
       //LogDebug("SiStripClusterizer") << "[Phase2ITPixelClusterProducer::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<Phase2ITPixelCluster>::FastFiller spc(output, DSViter->detId());
       clusterizer_->clusterizeDetUnit(*DSViter, pixDet, badChannels, spc);
       if ( spc.empty() ) {
         spc.abort();
       } else {
     numberOfClusters += spc.size();
       }
 
       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<Phase2ITPixelCluster> empty;
         empty.swap(output);
         break;
       }
     } // end of DetUnit loop
     
     //LogDebug ("Phase2ITPixelClusterProducer") << " Executing " 
     //      << clusterMode_ << " resulted in " << numberOfClusters
     //                  << " Phase2ITPixelClusters in " << numberOfDetUnits << " DetUnits."; 
   }

void Phase2ITPixelClusterProducer::setupClusterizer ( )

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 121 of file Phase2ITPixelClusterProducer.cc.

References clusterizer_, clusterMode_, conf_, edm::ParameterSet::getUntrackedParameter(), readyToCluster_, Phase2ITPixelClusterizerBase::setSiPixelGainCalibrationService(), AlCaHLTBitMon_QueryRunRegistry::string, and theSiPixelGainCalibration_.

Referenced by Phase2ITPixelClusterProducer().

                                                        {
     clusterMode_ = 
       conf_.getUntrackedParameter<std::string>("ClusterMode","Phase2ITPixelThresholdClusterizer");
 
     if ( clusterMode_ == "Phase2ITPixelThresholdClusterizer" ) {
       clusterizer_ = new Phase2ITPixelThresholdClusterizer(conf_);
       clusterizer_->setSiPixelGainCalibrationService(theSiPixelGainCalibration_);
       readyToCluster_ = true;
     } 
     else {
       edm::LogError("Phase2ITPixelClusterProducer") << "[Phase2ITPixelClusterProducer]:"
         <<" choice " << clusterMode_ << " is invalid.\n"
         << "Possible choices:\n" 
         << "    Phase2ITPixelThresholdClusterizer";
       readyToCluster_ = false;
     }
   }