SiPixelClusterProducer Class Reference

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
bool	hasAbilityToProduceInBeginLumis () const final
bool	hasAbilityToProduceInBeginRuns () const final
bool	hasAbilityToProduceInEndLumis () const final
bool	hasAbilityToProduceInEndRuns () const final

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

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

    : 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"));
 
  const auto& payloadType = conf.getParameter<std::string>("payloadType");
  if (payloadType == "HLT")
    theSiPixelGainCalibration_ = std::make_unique<SiPixelGainCalibrationForHLTService>(conf);
  else if (payloadType == "Offline")
    theSiPixelGainCalibration_ = std::make_unique<SiPixelGainCalibrationOfflineService>(conf);
  else if (payloadType == "Full")
    theSiPixelGainCalibration_ = std::make_unique<SiPixelGainCalibrationService>(conf);
 
  //--- Make the algorithm(s) according to what the user specified
  //--- in the ParameterSet.
  setupClusterizer(conf);
}

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

~SiPixelClusterProducer()

SiPixelClusterProducer::~SiPixelClusterProducer ( )

overridedefault

Member Function Documentation

fillDescriptions()

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

static

Definition at line 74 of file SiPixelClusterProducer.cc.

                                                                                        {
  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");
 
  PixelThresholdClusterizer::fillPSetDescription(desc);
  SiPixelGainCalibrationServiceBase::fillPSetDescription(desc);  // no-op, but in principle the structures are there...
 
  descriptions.add("SiPixelClusterizerDefault", desc);
}

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::add(), SiPixelGainCalibrationServiceBase::fillPSetDescription(), PixelThresholdClusterizer::fillPSetDescription(), HLT_2018_cff::InputTag, and AlCaHLTBitMon_QueryRunRegistry::string.

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

                                                                         {
  //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(tPutPixelClusters, std::move(output));
}

References clusterMode_, MillePedeFileConverter_cfg::e, relativeConstraints::geom, edm::EventSetup::get(), get, eostools::move(), convertSQLitetoXML_cfg::output, edm::ESHandle< T >::product(), run(), theSiPixelGainCalibration_, tPixelClusters, tPixelDigi, tPutPixelClusters, and tTopo_.

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

                                                                             {
  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.";
}

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

Referenced by produce().

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

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

References clusterizer_, clusterMode_, Exception, and theSiPixelGainCalibration_.

Referenced by SiPixelClusterProducer().

Member Data Documentation

clusterizer_

std::unique_ptr<PixelClusterizerBase> SiPixelClusterProducer::clusterizer_

private

Definition at line 77 of file SiPixelClusterProducer.h.

Referenced by run(), and setupClusterizer().

clusterMode_

const std::string SiPixelClusterProducer::clusterMode_

private

Definition at line 76 of file SiPixelClusterProducer.h.

Referenced by produce(), setupClusterizer(), and SiPixelClusterProducer().

maxTotalClusters_

const int32_t SiPixelClusterProducer::maxTotalClusters_

private

Optional limit on the total number of clusters.

Definition at line 81 of file SiPixelClusterProducer.h.

Referenced by run().

theSiPixelGainCalibration_

std::unique_ptr<SiPixelGainCalibrationServiceBase> SiPixelClusterProducer::theSiPixelGainCalibration_

private

Definition at line 75 of file SiPixelClusterProducer.h.

Referenced by produce(), setupClusterizer(), and SiPixelClusterProducer().

tPixelClusters

edm::EDGetTokenT<SiPixelClusterCollectionNew> SiPixelClusterProducer::tPixelClusters

private

Definition at line 71 of file SiPixelClusterProducer.h.

Referenced by produce(), and SiPixelClusterProducer().

tPixelDigi

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

private

Definition at line 72 of file SiPixelClusterProducer.h.

Referenced by produce(), and SiPixelClusterProducer().

tPutPixelClusters

edm::EDPutTokenT<SiPixelClusterCollectionNew> SiPixelClusterProducer::tPutPixelClusters

private

Definition at line 73 of file SiPixelClusterProducer.h.

Referenced by produce().

tTopo_

const TrackerTopology* SiPixelClusterProducer::tTopo_

private

Definition at line 78 of file SiPixelClusterProducer.h.

Referenced by produce(), and run().