DeDxEstimatorProducer Class Reference

#include <RecoTracker/DeDxEstimatorProducer/src/DeDxEstimatorProducer.cc>

Inheritance diagram for DeDxEstimatorProducer:

Public Member Functions
	DeDxEstimatorProducer (const edm::ParameterSet &)
	~DeDxEstimatorProducer () 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 Member Functions
void	beginRun (edm::Run const &run, const edm::EventSetup &) override
void	makeCalibrationMap (const TrackerGeometry &tkGeom)
void	processHit (const TrackingRecHit *recHit, float trackMomentum, float &cosine, reco::DeDxHitCollection &dedxHits, int &NClusterSaturating)
void	produce (edm::Event &, const edm::EventSetup &) override

Private Attributes
std::vector< std::vector< float > >	calibGains
std::string	m_calibrationPath
BaseDeDxEstimator *	m_estimator
unsigned int	m_off
edm::EDGetTokenT< reco::TrackCollection >	m_tracksTag
unsigned int	MaxNrStrips
float	meVperADCPixel
float	meVperADCStrip
bool	shapetest
edm::ESHandle< TrackerGeometry >	tkGeom
bool	useCalibration
bool	usePixel
bool	useStrip

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

Description: <one line="" class="" summary>="">

Implementation: <Notes on="" implementation>="">

Definition at line 45 of file DeDxEstimatorProducer.h.

Constructor & Destructor Documentation

DeDxEstimatorProducer()

DeDxEstimatorProducer::DeDxEstimatorProducer ( const edm::ParameterSet &  iConfig )

explicit

Definition at line 47 of file DeDxEstimatorProducer.cc.

                                                                           {
  produces<ValueMap<DeDxData>>();
 
  string estimatorName = iConfig.getParameter<string>("estimator");
  if (estimatorName == "median")
    m_estimator = new MedianDeDxEstimator(iConfig);
  else if (estimatorName == "generic")
    m_estimator = new GenericAverageDeDxEstimator(iConfig);
  else if (estimatorName == "truncated")
    m_estimator = new TruncatedAverageDeDxEstimator(iConfig);
  else if (estimatorName == "genericTruncated")
    m_estimator = new GenericTruncatedAverageDeDxEstimator(iConfig);
  else if (estimatorName == "unbinnedFit")
    m_estimator = new UnbinnedFitDeDxEstimator(iConfig);
  else if (estimatorName == "productDiscrim")
    m_estimator = new ProductDeDxDiscriminator(iConfig);
  else if (estimatorName == "btagDiscrim")
    m_estimator = new BTagLikeDeDxDiscriminator(iConfig);
  else if (estimatorName == "smirnovDiscrim")
    m_estimator = new SmirnovDeDxDiscriminator(iConfig);
  else if (estimatorName == "asmirnovDiscrim")
    m_estimator = new ASmirnovDeDxDiscriminator(iConfig);
 
  //Commented for now, might be used in the future
  //   MaxNrStrips         = iConfig.getUntrackedParameter<unsigned>("maxNrStrips"        ,  255);
 
  m_tracksTag = consumes<reco::TrackCollection>(iConfig.getParameter<edm::InputTag>("tracks"));
 
  usePixel = iConfig.getParameter<bool>("UsePixel");
  useStrip = iConfig.getParameter<bool>("UseStrip");
  meVperADCPixel = iConfig.getParameter<double>("MeVperADCPixel");
  meVperADCStrip = iConfig.getParameter<double>("MeVperADCStrip");
 
  shapetest = iConfig.getParameter<bool>("ShapeTest");
  useCalibration = iConfig.getParameter<bool>("UseCalibration");
  m_calibrationPath = iConfig.getParameter<string>("calibrationPath");
 
  if (!usePixel && !useStrip)
    edm::LogWarning("DeDxHitsProducer")
        << "Pixel Hits AND Strip Hits will not be used to estimate dEdx --> BUG, Please Update the config file";
}

References edm::ParameterSet::getParameter(), dedxEstimators_cff::useCalibration, dedxEstimators_cff::usePixel, and dedxEstimators_cff::useStrip.

~DeDxEstimatorProducer()

DeDxEstimatorProducer::~DeDxEstimatorProducer ( )

override

Definition at line 89 of file DeDxEstimatorProducer.cc.

{ delete m_estimator; }

Member Function Documentation

beginRun()

void DeDxEstimatorProducer::beginRun ( edm::Run const &  run, const edm::EventSetup &  iSetup  )

overrideprivate

Definition at line 92 of file DeDxEstimatorProducer.cc.

                                                                                   {
  iSetup.get<TrackerDigiGeometryRecord>().get(tkGeom);
  if (useCalibration && calibGains.empty()) {
    m_off = tkGeom->offsetDU(GeomDetEnumerators::PixelBarrel);  //index start at the first pixel
 
    DeDxTools::makeCalibrationMap(m_calibrationPath, *tkGeom, calibGains, m_off);
  }
 
  m_estimator->beginRun(run, iSetup);
}

References reco::get(), edm::EventSetup::get(), DeDxTools::makeCalibrationMap(), GeomDetEnumerators::PixelBarrel, writedatasetfile::run, and dedxEstimators_cff::useCalibration.

fillDescriptions()

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

static

Definition at line 28 of file DeDxEstimatorProducer.cc.

                                                                                       {
  edm::ParameterSetDescription desc;
  desc.add<string>("estimator", "generic");
  desc.add<edm::InputTag>("tracks", edm::InputTag("generalTracks"));
  desc.add<bool>("UsePixel", false);
  desc.add<bool>("UseStrip", true);
  desc.add<double>("MeVperADCPixel", 3.61e-06);
  desc.add<double>("MeVperADCStrip", 3.61e-06 * 265);
  desc.add<bool>("ShapeTest", true);
  desc.add<bool>("UseCalibration", false);
  desc.add<string>("calibrationPath", "");
  desc.add<string>("Reccord", "SiStripDeDxMip_3D_Rcd");
  desc.add<string>("ProbabilityMode", "Accumulation");
  desc.add<double>("fraction", 0.4);
  desc.add<double>("exponent", -2.0);
 
  descriptions.add("DeDxEstimatorProducer", desc);
}

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::add(), and HLT_2018_cff::InputTag.

makeCalibrationMap()

void DeDxEstimatorProducer::makeCalibrationMap ( const TrackerGeometry &  tkGeom )

private

processHit()

void DeDxEstimatorProducer::processHit ( const TrackingRecHit *  recHit, float  trackMomentum, float &  cosine, reco::DeDxHitCollection &  dedxHits, int &  NClusterSaturating  )

private

Definition at line 149 of file DeDxEstimatorProducer.cc.

                                                                {
  auto const& thit = static_cast<BaseTrackerRecHit const&>(*recHit);
  if (!thit.isValid())
    return;
 
  auto const& clus = thit.firstClusterRef();
  if (!clus.isValid())
    return;
 
  if (clus.isPixel()) {
    if (!usePixel)
      return;
 
    const auto* detUnit = recHit->detUnit();
    if (detUnit == nullptr)
      detUnit = tkGeom->idToDet(thit.geographicalId());
    float pathLen = detUnit->surface().bounds().thickness() / fabs(cosine);
    float chargeAbs = clus.pixelCluster().charge();
    float charge = meVperADCPixel * chargeAbs / pathLen;
    dedxHits.push_back(DeDxHit(charge, trackMomentum, pathLen, thit.geographicalId()));
  } else if (clus.isStrip() && !thit.isMatched()) {
    if (!useStrip)
      return;
 
    const auto* detUnit = recHit->detUnit();
    if (detUnit == nullptr)
      detUnit = tkGeom->idToDet(thit.geographicalId());
    int NSaturating = 0;
    float pathLen = detUnit->surface().bounds().thickness() / fabs(cosine);
    float chargeAbs = DeDxTools::getCharge(&(clus.stripCluster()), NSaturating, *detUnit, calibGains, m_off);
    float charge = meVperADCStrip * chargeAbs / pathLen;
    if (!shapetest || (shapetest && DeDxTools::shapeSelection(clus.stripCluster()))) {
      dedxHits.push_back(DeDxHit(charge, trackMomentum, pathLen, thit.geographicalId()));
      if (NSaturating > 0)
        NClusterSaturating++;
    }
  } else if (clus.isStrip() && thit.isMatched()) {
    if (!useStrip)
      return;
    const SiStripMatchedRecHit2D* matchedHit = dynamic_cast<const SiStripMatchedRecHit2D*>(recHit);
    if (!matchedHit)
      return;
    const GluedGeomDet* gdet = static_cast<const GluedGeomDet*>(matchedHit->det());
    if (gdet == nullptr)
      gdet = static_cast<const GluedGeomDet*>(tkGeom->idToDet(thit.geographicalId()));
 
    auto& detUnitM = *(gdet->monoDet());
    int NSaturating = 0;
    float pathLen = detUnitM.surface().bounds().thickness() / fabs(cosine);
    float chargeAbs = DeDxTools::getCharge(&(matchedHit->monoCluster()), NSaturating, detUnitM, calibGains, m_off);
    float charge = meVperADCStrip * chargeAbs / pathLen;
    if (!shapetest || (shapetest && DeDxTools::shapeSelection(matchedHit->monoCluster()))) {
      dedxHits.push_back(DeDxHit(charge, trackMomentum, pathLen, matchedHit->monoId()));
      if (NSaturating > 0)
        NClusterSaturating++;
    }
 
    auto& detUnitS = *(gdet->stereoDet());
    NSaturating = 0;
    pathLen = detUnitS.surface().bounds().thickness() / fabs(cosine);
    chargeAbs = DeDxTools::getCharge(&(matchedHit->stereoCluster()), NSaturating, detUnitS, calibGains, m_off);
    charge = meVperADCStrip * chargeAbs / pathLen;
    if (!shapetest || (shapetest && DeDxTools::shapeSelection(matchedHit->stereoCluster()))) {
      dedxHits.push_back(DeDxHit(charge, trackMomentum, pathLen, matchedHit->stereoId()));
      if (NSaturating > 0)
        NClusterSaturating++;
    }
  }
}

References ALCARECOTkAlJpsiMuMu_cff::charge, TrackingRecHit::det(), DeDxTools::getCharge(), SiStripMatchedRecHit2D::monoCluster(), GluedGeomDet::monoDet(), SiStripMatchedRecHit2D::monoId(), rpcPointValidation_cfi::recHit, DeDxTools::shapeSelection(), SiStripMatchedRecHit2D::stereoCluster(), GluedGeomDet::stereoDet(), SiStripMatchedRecHit2D::stereoId(), reco::btau::trackMomentum, dedxEstimators_cff::usePixel, and dedxEstimators_cff::useStrip.

produce()

void DeDxEstimatorProducer::produce ( edm::Event &  iEvent, const edm::EventSetup &  iSetup  )

overrideprivate

Definition at line 103 of file DeDxEstimatorProducer.cc.

                                                                                 {
  auto trackDeDxEstimateAssociation = std::make_unique<ValueMap<DeDxData>>();
  ValueMap<DeDxData>::Filler filler(*trackDeDxEstimateAssociation);
 
  edm::Handle<reco::TrackCollection> trackCollectionHandle;
  iEvent.getByToken(m_tracksTag, trackCollectionHandle);
 
  std::vector<DeDxData> dedxEstimate(trackCollectionHandle->size());
 
  for (unsigned int j = 0; j < trackCollectionHandle->size(); j++) {
    const reco::TrackRef track = reco::TrackRef(trackCollectionHandle.product(), j);
 
    int NClusterSaturating = 0;
    DeDxHitCollection dedxHits;
 
    auto const& trajParams = track->extra()->trajParams();
    assert(trajParams.size() == track->recHitsSize());
    auto hb = track->recHitsBegin();
    dedxHits.reserve(track->recHitsSize() / 2);
    for (unsigned int h = 0; h < track->recHitsSize(); h++) {
      auto recHit = *(hb + h);
      if (!trackerHitRTTI::isFromDet(*recHit))
        continue;
 
      auto trackDirection = trajParams[h].direction();
      float cosine = trackDirection.z() / trackDirection.mag();
      processHit(recHit, track->p(), cosine, dedxHits, NClusterSaturating);
    }
 
    sort(dedxHits.begin(), dedxHits.end(), less<DeDxHit>());
    std::pair<float, float> val_and_error = m_estimator->dedx(dedxHits);
 
    //WARNING: Since the dEdX Error is not properly computed for the moment
    //It was decided to store the number of saturating cluster in that dataformat
    val_and_error.second = NClusterSaturating;
    dedxEstimate[j] = DeDxData(val_and_error.first, val_and_error.second, dedxHits.size());
  }
 
  filler.insert(trackCollectionHandle, dedxEstimate.begin(), dedxEstimate.end());
 
  // fill the association map and put it into the event
  filler.fill();
  iEvent.put(std::move(trackDeDxEstimateAssociation));
}

References cms::cuda::assert(), trigObjTnPSource_cfi::filler, h, es_hardcode_cfi::hb, iEvent, trackerHitRTTI::isFromDet(), dqmiolumiharvest::j, eostools::move(), edm::Handle< T >::product(), rpcPointValidation_cfi::recHit, and HLT_2018_cff::track.

Member Data Documentation

calibGains

std::vector<std::vector<float> > DeDxEstimatorProducer::calibGains

private

Definition at line 78 of file DeDxEstimatorProducer.h.

m_calibrationPath

std::string DeDxEstimatorProducer::m_calibrationPath

private

Definition at line 74 of file DeDxEstimatorProducer.h.

m_estimator

BaseDeDxEstimator* DeDxEstimatorProducer::m_estimator

private

Definition at line 63 of file DeDxEstimatorProducer.h.

m_off

unsigned int DeDxEstimatorProducer::m_off

private

Definition at line 79 of file DeDxEstimatorProducer.h.

m_tracksTag

edm::EDGetTokenT<reco::TrackCollection> DeDxEstimatorProducer::m_tracksTag

private

Definition at line 65 of file DeDxEstimatorProducer.h.

MaxNrStrips

unsigned int DeDxEstimatorProducer::MaxNrStrips

private

Definition at line 72 of file DeDxEstimatorProducer.h.

meVperADCPixel

float DeDxEstimatorProducer::meVperADCPixel

private

Definition at line 69 of file DeDxEstimatorProducer.h.

meVperADCStrip

float DeDxEstimatorProducer::meVperADCStrip

private

Definition at line 70 of file DeDxEstimatorProducer.h.

shapetest

bool DeDxEstimatorProducer::shapetest

private

Definition at line 76 of file DeDxEstimatorProducer.h.

tkGeom

edm::ESHandle<TrackerGeometry> DeDxEstimatorProducer::tkGeom

private

Definition at line 81 of file DeDxEstimatorProducer.h.

useCalibration

bool DeDxEstimatorProducer::useCalibration

private

Definition at line 75 of file DeDxEstimatorProducer.h.

usePixel

bool DeDxEstimatorProducer::usePixel

private

Definition at line 67 of file DeDxEstimatorProducer.h.

useStrip

bool DeDxEstimatorProducer::useStrip

private

Definition at line 68 of file DeDxEstimatorProducer.h.