#include <SiPixelClusterProducer.h>

Inheritance diagram for cms::SiPixelClusterProducer:

Public Member Functions
virtual void	beginJob () override

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< SiPixelCluster > &output)
	Iterate over DetUnits, and invoke the PixelClusterizer on each. More...

void	setupClusterizer ()

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

virtual	~SiPixelClusterProducer ()

Public Member Functions inherited from edm::EDProducer
	EDProducer ()

ModuleDescription const &	moduleDescription () const

virtual	~EDProducer ()

Public Member Functions inherited from edm::ProducerBase
	ProducerBase ()

void	registerProducts (ProducerBase , ProductRegistry , ModuleDescription const &)

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

virtual	~ProducerBase ()

Public Member Functions inherited from edm::EDConsumerBase
	EDConsumerBase ()

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

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

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

std::vector < ProductHolderIndexAndSkipBit > const &	itemsToGetFromEvent () const

void	labelsForToken (EDGetToken iToken, Labels &oLabels) const

void	modulesDependentUpon (const std::string &iProcessName, std::vector< const char * > &oModuleLabels) const

bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const

bool	registeredToConsumeMany (TypeID const &, BranchType) const

void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)

virtual	~EDConsumerBase ()

Private Attributes
PixelClusterizerBase *	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::EDProducer
typedef EDProducer	ModuleType

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

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

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

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

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

Definition at line 57 of file SiPixelClusterProducer.h.

Constructor & Destructor Documentation

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

explicit

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

Definition at line 51 of file SiPixelClusterProducer.cc.

References edm::ParameterSet::getParameter(), 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<SiPixelClusterCollectionNew>(); 
 
     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();
 
   }

SiPixelClusterProducer::~SiPixelClusterProducer ( )

virtual

Definition at line 81 of file SiPixelClusterProducer.cc.

References clusterizer_, and theSiPixelGainCalibration_.

                                                   { 
     delete clusterizer_;
     delete theSiPixelGainCalibration_;
   }  

Member Function Documentation

void SiPixelClusterProducer::beginJob ( void )

overridevirtual

Reimplemented from edm::EDProducer.

Definition at line 87 of file SiPixelClusterProducer.cc.

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

   {
     edm::LogInfo("SiPixelClusterizer") << "[SiPixelClusterizer::beginJob]";
     clusterizer_->setSiPixelGainCalibrationService(theSiPixelGainCalibration_);
   }

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

overridevirtual

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

Implements edm::EDProducer.

Definition at line 96 of file SiPixelClusterProducer.cc.

References relativeConstraints::geom, edm::EventSetup::get(), edm::Event::getByToken(), input, 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
     std::auto_ptr<SiPixelClusterCollectionNew> output( new SiPixelClusterCollectionNew() );
     //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
     e.put( output );
 
   }

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

Iterate over DetUnits, and invoke the PixelClusterizer on each.

Definition at line 149 of file SiPixelClusterProducer.cc.

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

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
     edm::DetSetVector<PixelDigi>::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, 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<SiPixelCluster> empty;
         empty.swap(output);
         break;
       }
     } // end of DetUnit loop
     
     //LogDebug ("SiPixelClusterProducer") << " Executing " 
     //      << clusterMode_ << " resulted in " << numberOfClusters
     //                  << " SiPixelClusters in " << numberOfDetUnits << " DetUnits."; 
   }

void SiPixelClusterProducer::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 129 of file SiPixelClusterProducer.cc.

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

Referenced by SiPixelClusterProducer().

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