StubKiller Class Reference

#include <StubKiller.h>

Public Member Functions
std::map< DetId, float >	getListOfDeadModules ()
void	initialise (unsigned int killScenario, const TrackerTopology *trackerTopology, const TrackerGeometry *trackerGeometry)
bool	killStub (const TTStub< Ref_Phase2TrackerDigi_ > *stub, const std::vector< int > layersToKill, const double minPhiToKill, const double maxPhiToKill, const double minZToKill, const double maxZToKill, const double minRToKill, const double maxRToKill, const double fractionOfStubsToKillInLayers, const double fractionOfStubsToKillEverywhere)
bool	killStub (const TTStub< Ref_Phase2TrackerDigi_ > *stub)
bool	killStubInDeadModule (const TTStub< Ref_Phase2TrackerDigi_ > *stub)
	StubKiller ()
	~StubKiller ()

Private Member Functions
void	addDeadLayerModulesToDeadModuleList ()
void	chooseModulesToKill ()

Private Attributes
std::map< DetId, float >	deadModules_
double	fractionOfModulesToKillEverywhere_
double	fractionOfStubsToKillEverywhere_
double	fractionOfStubsToKillInLayers_
unsigned int	killScenario_
std::vector< int >	layersToKill_
double	maxPhiToKill_
double	maxRToKill_
double	maxZToKill_
double	minPhiToKill_
double	minRToKill_
double	minZToKill_
const TrackerGeometry *	trackerGeometry_
const TrackerTopology *	trackerTopology_

Detailed Description

Definition at line 12 of file StubKiller.h.

Constructor & Destructor Documentation

StubKiller()

StubKiller::StubKiller

(

)

Definition at line 5 of file StubKiller.cc.

    : killScenario_(0),
      trackerTopology_(nullptr),
      trackerGeometry_(nullptr),
      layersToKill_(vector<int>()),
      minPhiToKill_(0),
      maxPhiToKill_(0),
      minZToKill_(0),
      maxZToKill_(0),
      minRToKill_(0),
      maxRToKill_(0),
      fractionOfStubsToKillInLayers_(0),
      fractionOfStubsToKillEverywhere_(0),
      fractionOfModulesToKillEverywhere_(0) {}

~StubKiller()

StubKiller::~StubKiller ( )

inline

Definition at line 15 of file StubKiller.h.

{}

Member Function Documentation

addDeadLayerModulesToDeadModuleList()

void StubKiller::addDeadLayerModulesToDeadModuleList ( )

private

Definition at line 157 of file StubKiller.cc.

References deadModules_, TrackerGeometry::detUnits(), spr::find(), fractionOfStubsToKillInLayers_, TrackerTopology::layer(), layersToKill_, maxRToKill_, maxZToKill_, minPhiToKill_, minRToKill_, minZToKill_, Pi, TrackerTopology::side(), DetId::subdetId(), StripSubdetector::TIB, TrackerTopology::tidWheel(), StripSubdetector::TOB, trackerGeometry_, and trackerTopology_.

Referenced by initialise().

                                                     {
  for (const GeomDetUnit* gd : trackerGeometry_->detUnits()) {
    float moduleR = gd->position().perp();
    float moduleZ = gd->position().z();
    float modulePhi = gd->position().phi();
    DetId geoDetId = gd->geographicalId();
    bool isInBarrel = geoDetId.subdetId() == StripSubdetector::TOB || geoDetId.subdetId() == StripSubdetector::TIB;

    int layerID = 0;
    if (isInBarrel) {
      layerID = trackerTopology_->layer(geoDetId);
    } else {
      layerID = 10 * trackerTopology_->side(geoDetId) + trackerTopology_->tidWheel(geoDetId);
    }

    if (find(layersToKill_.begin(), layersToKill_.end(), layerID) != layersToKill_.end()) {
      if (modulePhi < -1.0 * TMath::Pi())
        modulePhi += 2.0 * TMath::Pi();
      else if (modulePhi > TMath::Pi())
        modulePhi -= 2.0 * TMath::Pi();

      if (modulePhi > minPhiToKill_ && modulePhi < maxPhiToKill_ && moduleZ > minZToKill_ && moduleZ < maxZToKill_ &&
          moduleR > minRToKill_ && moduleR < maxRToKill_) {
        if (deadModules_.find(gd->geographicalId()) == deadModules_.end()) {
          deadModules_[gd->geographicalId()] = fractionOfStubsToKillInLayers_;
        }
      }
    }
  }
}

chooseModulesToKill()

void StubKiller::chooseModulesToKill ( )

private

Definition at line 144 of file StubKiller.cc.

References deadModules_, TrackerGeometry::detUnits(), fractionOfModulesToKillEverywhere_, TrackerTopology::isLower(), trackerGeometry_, and trackerTopology_.

Referenced by initialise().

                                     {
  TRandom3* randomGenerator = new TRandom3();
  randomGenerator->SetSeed(0);

  for (const GeomDetUnit* gd : trackerGeometry_->detUnits()) {
    if (!trackerTopology_->isLower(gd->geographicalId()))
      continue;
    if (randomGenerator->Uniform(0.0, 1.0) < fractionOfModulesToKillEverywhere_) {
      deadModules_[gd->geographicalId()] = 1;
    }
  }
}

getListOfDeadModules()

std::map<DetId, float> StubKiller::getListOfDeadModules ( )

inline

Definition at line 36 of file StubKiller.h.

References deadModules_.

{ return deadModules_; }

initialise()

void StubKiller::initialise	(	unsigned int	killScenario,
		const TrackerTopology *	trackerTopology,
		const TrackerGeometry *	trackerGeometry
	)

Definition at line 20 of file StubKiller.cc.

References addDeadLayerModulesToDeadModuleList(), chooseModulesToKill(), deadModules_, fractionOfModulesToKillEverywhere_, fractionOfStubsToKillEverywhere_, fractionOfStubsToKillInLayers_, killScenario_, layersToKill_, maxPhiToKill_, maxRToKill_, maxZToKill_, minPhiToKill_, minRToKill_, minZToKill_, trackerGeometry_, and trackerTopology_.

Referenced by L1FPGATrackProducer::produce().

                                                                    {
  killScenario_ = killScenario;
  trackerTopology_ = trackerTopology;
  trackerGeometry_ = trackerGeometry;

  switch (killScenario_) {
    // kill layer 5 in one quadrant + 5% random module loss to connect to what was done before
    case 1:
      layersToKill_ = {5};
      minPhiToKill_ = 0.0;
      maxPhiToKill_ = TMath::PiOver2();
      minZToKill_ = -1000.0;
      maxZToKill_ = 0.0;
      minRToKill_ = 0.0;
      maxRToKill_ = 1000.0;
      fractionOfStubsToKillInLayers_ = 1;
      fractionOfStubsToKillEverywhere_ = 0;
      fractionOfModulesToKillEverywhere_ = 0.05;
      break;

    // kill layer 1 in one quadrant + 5% random module loss
    case 2:
      layersToKill_ = {1};
      minPhiToKill_ = 0.0;
      maxPhiToKill_ = TMath::PiOver2();
      minZToKill_ = -1000.0;
      maxZToKill_ = 0.0;
      minRToKill_ = 0.0;
      maxRToKill_ = 1000.0;
      fractionOfStubsToKillInLayers_ = 1;
      fractionOfStubsToKillEverywhere_ = 0;
      fractionOfModulesToKillEverywhere_ = 0.05;
      break;

    // kill layer 1 + layer 2, both in same quadrant
    case 3:
      layersToKill_ = {1, 2};
      minPhiToKill_ = 0.0;
      maxPhiToKill_ = TMath::PiOver2();
      minZToKill_ = -1000.0;
      maxZToKill_ = 0.0;
      minRToKill_ = 0.0;
      maxRToKill_ = 1000.0;
      fractionOfStubsToKillInLayers_ = 1;
      fractionOfStubsToKillEverywhere_ = 0;
      fractionOfModulesToKillEverywhere_ = 0;
      break;

    // kill layer 1 and disk 1, both in same quadrant
    case 4:
      layersToKill_ = {1, 11};
      minPhiToKill_ = 0.0;
      maxPhiToKill_ = TMath::PiOver2();
      minZToKill_ = -1000.0;
      maxZToKill_ = 0.0;
      minRToKill_ = 0.0;
      maxRToKill_ = 66.5;
      fractionOfStubsToKillInLayers_ = 1;
      fractionOfStubsToKillEverywhere_ = 0;
      fractionOfModulesToKillEverywhere_ = 0;
      break;

    // 5% random module loss throughout tracker
    case 5:
      layersToKill_ = {};
      fractionOfStubsToKillInLayers_ = 0;
      fractionOfStubsToKillEverywhere_ = 0;
      fractionOfModulesToKillEverywhere_ = 0.05;
      break;

    // 1% random module loss throughout tracker
    case 6:
      layersToKill_ = {};
      fractionOfStubsToKillInLayers_ = 0;
      fractionOfStubsToKillEverywhere_ = 0;
      fractionOfModulesToKillEverywhere_ = 0.01;
      break;

    // kill layer 5 in one quadrant + 1% random module loss
    case 7:
      layersToKill_ = {5};
      minPhiToKill_ = 0.0;
      maxPhiToKill_ = TMath::PiOver2();
      minZToKill_ = -1000.0;
      maxZToKill_ = 0.0;
      minRToKill_ = 0.0;
      maxRToKill_ = 1000.0;
      fractionOfStubsToKillInLayers_ = 1;
      fractionOfStubsToKillEverywhere_ = 0;
      fractionOfModulesToKillEverywhere_ = 0.01;
      break;

    // kill layer 1 in one quadrant +1 % random module loss
    case 8:
      layersToKill_ = {1};
      minPhiToKill_ = 0.0;
      maxPhiToKill_ = TMath::PiOver2();
      minZToKill_ = -1000.0;
      maxZToKill_ = 0.0;
      minRToKill_ = 0.0;
      maxRToKill_ = 1000.0;
      fractionOfStubsToKillInLayers_ = 1;
      fractionOfStubsToKillEverywhere_ = 0;
      fractionOfModulesToKillEverywhere_ = 0.01;
      break;

    // 10% random module loss throughout tracker
    case 9:
      layersToKill_ = {};
      fractionOfStubsToKillInLayers_ = 0;
      fractionOfStubsToKillEverywhere_ = 0;
      fractionOfModulesToKillEverywhere_ = 0.10;
      break;
  }

  deadModules_.clear();
  if (fractionOfModulesToKillEverywhere_ > 0) {
    this->chooseModulesToKill();
  }
  this->addDeadLayerModulesToDeadModuleList();
}

killStub() [1/2]

bool StubKiller::killStub	(	const TTStub< Ref_Phase2TrackerDigi_ > *	stub,
		const std::vector< int >	layersToKill,
		const double	minPhiToKill,
		const double	maxPhiToKill,
		const double	minZToKill,
		const double	maxZToKill,
		const double	minRToKill,
		const double	maxRToKill,
		const double	fractionOfStubsToKillInLayers,
		const double	fractionOfStubsToKillEverywhere
	)

Definition at line 212 of file StubKiller.cc.

References TTStub< T >::clusterRef(), spr::find(), TTStub< T >::getDetId(), TrackerGeometry::idToDetUnit(), TrackerTopology::layer(), Topology::localPosition(), Pi, DetId::rawId(), TrackerTopology::side(), PixelGeomDetUnit::specificTopology(), DetId::subdetId(), GeomDet::surface(), StripSubdetector::TIB, TrackerTopology::tidWheel(), StripSubdetector::TOB, Surface::toGlobal(), trackerGeometry_, and trackerTopology_.

Referenced by killStub(), and L1FPGATrackProducer::produce().

                                                                        {
  // Only kill stubs in specified layers
  if (!layersToKill.empty()) {
    // Get the layer the stub is in, and check if it's in the layer you want to kill
    DetId stackDetid = stub->getDetId();
    DetId geoDetId(stackDetid.rawId() + 1);

    bool isInBarrel = geoDetId.subdetId() == StripSubdetector::TOB || geoDetId.subdetId() == StripSubdetector::TIB;

    int layerID = 0;
    if (isInBarrel) {
      layerID = trackerTopology_->layer(geoDetId);
    } else {
      layerID = 10 * trackerTopology_->side(geoDetId) + trackerTopology_->tidWheel(geoDetId);
    }

    if (find(layersToKill.begin(), layersToKill.end(), layerID) != layersToKill.end()) {
      // Get the phi and z of stub, and check if it's in the region you want to kill
      const GeomDetUnit* det0 = trackerGeometry_->idToDetUnit(geoDetId);
      const PixelGeomDetUnit* theGeomDet = dynamic_cast<const PixelGeomDetUnit*>(det0);
      const PixelTopology* topol = dynamic_cast<const PixelTopology*>(&(theGeomDet->specificTopology()));
      MeasurementPoint measurementPoint = stub->clusterRef(0)->findAverageLocalCoordinatesCentered();
      LocalPoint clustlp = topol->localPosition(measurementPoint);
      GlobalPoint pos = theGeomDet->surface().toGlobal(clustlp);

      // Just in case phi is outside of -pi -> pi
      double stubPhi = pos.phi();
      if (stubPhi < -1.0 * TMath::Pi())
        stubPhi += 2.0 * TMath::Pi();
      else if (stubPhi > TMath::Pi())
        stubPhi -= 2.0 * TMath::Pi();

      if (stubPhi > minPhiToKill && stubPhi < maxPhiToKill && pos.z() > minZToKill && pos.z() < maxZToKill &&
          pos.perp() > minRToKill && pos.perp() < maxRToKill) {
        // Kill fraction of stubs
        if (fractionOfStubsToKillInLayers == 1) {
          return true;
        } else {
          static TRandom randomGenerator;
          if (randomGenerator.Rndm() < fractionOfStubsToKillInLayers) {
            return true;
          }
        }
      }
    }
  }

  // Kill fraction of stubs throughout tracker
  if (fractionOfStubsToKillEverywhere > 0) {
    static TRandom randomGenerator;
    if (randomGenerator.Rndm() < fractionOfStubsToKillEverywhere) {
      return true;
    }
  }

  return false;
}

killStub() [2/2]

bool StubKiller::killStub

(

const TTStub< Ref_Phase2TrackerDigi_ > *

stub

)

Definition at line 188 of file StubKiller.cc.

References fractionOfStubsToKillEverywhere_, fractionOfStubsToKillInLayers_, killScenario_, killStub(), killStubInDeadModule(), layersToKill_, maxPhiToKill_, maxRToKill_, maxZToKill_, minPhiToKill_, minRToKill_, and minZToKill_.

                                                                    {
  if (killScenario_ == 0)
    return false;
  else {
    bool killStubRandomly = killStub(stub,
                                     layersToKill_,
                                     minPhiToKill_,
                                     maxPhiToKill_,
                                     minZToKill_,
                                     maxZToKill_,
                                     minRToKill_,
                                     maxRToKill_,
                                     fractionOfStubsToKillInLayers_,
                                     fractionOfStubsToKillEverywhere_);
    bool killStubInDeadModules = killStubInDeadModule(stub);
    return killStubRandomly || killStubInDeadModules;
  }
}

killStubInDeadModule()

bool StubKiller::killStubInDeadModule

(

const TTStub< Ref_Phase2TrackerDigi_ > *

stub

)

Definition at line 279 of file StubKiller.cc.

References deadModules_, TTStub< T >::getDetId(), and DetId::rawId().

Referenced by killStub().

                                                                                {
  if (!deadModules_.empty()) {
    DetId stackDetid = stub->getDetId();
    DetId geoDetId(stackDetid.rawId() + 1);
    if (deadModules_.find(geoDetId) != deadModules_.end())
      return true;
  }

  return false;
}

Member Data Documentation

deadModules_

std::map<DetId, float> StubKiller::deadModules_

private

Definition at line 57 of file StubKiller.h.

Referenced by addDeadLayerModulesToDeadModuleList(), chooseModulesToKill(), getListOfDeadModules(), initialise(), and killStubInDeadModule().

fractionOfModulesToKillEverywhere_

double StubKiller::fractionOfModulesToKillEverywhere_

private

Definition at line 55 of file StubKiller.h.

Referenced by chooseModulesToKill(), and initialise().

fractionOfStubsToKillEverywhere_

double StubKiller::fractionOfStubsToKillEverywhere_

private

Definition at line 54 of file StubKiller.h.

Referenced by initialise(), and killStub().

fractionOfStubsToKillInLayers_

double StubKiller::fractionOfStubsToKillInLayers_

private

Definition at line 53 of file StubKiller.h.

Referenced by addDeadLayerModulesToDeadModuleList(), initialise(), and killStub().

killScenario_

unsigned int StubKiller::killScenario_

private

Definition at line 42 of file StubKiller.h.

Referenced by initialise(), and killStub().

layersToKill_

std::vector<int> StubKiller::layersToKill_

private

Definition at line 46 of file StubKiller.h.

Referenced by addDeadLayerModulesToDeadModuleList(), initialise(), and killStub().

maxPhiToKill_

double StubKiller::maxPhiToKill_

private

Definition at line 48 of file StubKiller.h.

Referenced by initialise(), and killStub().

maxRToKill_

double StubKiller::maxRToKill_

private

Definition at line 52 of file StubKiller.h.

Referenced by addDeadLayerModulesToDeadModuleList(), initialise(), and killStub().

maxZToKill_

double StubKiller::maxZToKill_

private

Definition at line 50 of file StubKiller.h.

Referenced by addDeadLayerModulesToDeadModuleList(), initialise(), and killStub().

minPhiToKill_

double StubKiller::minPhiToKill_

private

Definition at line 47 of file StubKiller.h.

Referenced by addDeadLayerModulesToDeadModuleList(), initialise(), and killStub().

minRToKill_

double StubKiller::minRToKill_

private

Definition at line 51 of file StubKiller.h.

Referenced by addDeadLayerModulesToDeadModuleList(), initialise(), and killStub().

minZToKill_

double StubKiller::minZToKill_

private

Definition at line 49 of file StubKiller.h.

Referenced by addDeadLayerModulesToDeadModuleList(), initialise(), and killStub().

trackerGeometry_

const TrackerGeometry* StubKiller::trackerGeometry_

private

Definition at line 44 of file StubKiller.h.

Referenced by addDeadLayerModulesToDeadModuleList(), chooseModulesToKill(), initialise(), and killStub().

trackerTopology_

const TrackerTopology* StubKiller::trackerTopology_

private

Definition at line 43 of file StubKiller.h.

Referenced by addDeadLayerModulesToDeadModuleList(), chooseModulesToKill(), initialise(), and killStub().