GoldenPatternBase Class Reference

#include <GoldenPatternBase.h>

Inheritance diagram for GoldenPatternBase:

Public Types
typedef boost::multi_array< GoldenPatternResult, 2 >	resultsArrayType
typedef std::vector< int >	vector1D

Public Member Functions
virtual void	finalise (unsigned int procIndx)
	last step of the event processing, before sorting and ghost busting More...
const OMTFConfiguration *	getConfig () const
virtual int	getDistPhiBitShift (unsigned int iLayer, unsigned int iRefLayer) const =0
resultsArrayType &	getResults ()
	GoldenPatternBase (const Key &aKey)
	GoldenPatternBase (const Key &aKey, const OMTFConfiguration *omtfConfig)
virtual Key &	key ()
virtual int	meanDistPhiValue (unsigned int iLayer, unsigned int iRefLayer, int refLayerPhiB=0) const =0
virtual PdfValueType	pdfValue (unsigned int iLayer, unsigned int iRefLayer, unsigned int iBin, int refLayerPhiB=0) const =0
virtual StubResult	process1Layer1RefLayer (unsigned int iRefLayer, unsigned int iLayer, MuonStubPtrs1D layerStubs, const MuonStubPtr refStub)
virtual int	propagateRefPhi (int phiRef, int etaRef, unsigned int iRefLayer)=0
virtual void	setConfig (const OMTFConfiguration *omtfConfig)
virtual void	setDistPhiBitShift (int value, unsigned int iLayer, unsigned int iRefLayer)=0
virtual void	setMeanDistPhiValue (int value, unsigned int iLayer, unsigned int iRefLayer, unsigned int paramIndex=0)=0
virtual void	setPdfValue (PdfValueType value, unsigned int iLayer, unsigned int iRefLayer, unsigned int iBin, int refLayerPhiB=0)=0
virtual	~GoldenPatternBase ()

Protected Attributes
const OMTFConfiguration *	myOmtfConfig
resultsArrayType	results
Key	theKey
	Pattern kinematic identification (iEta,iPt,iCharge) More...

Detailed Description

Definition at line 61 of file GoldenPatternBase.h.

Member Typedef Documentation

resultsArrayType

typedef boost::multi_array<GoldenPatternResult, 2> GoldenPatternBase::resultsArrayType

Definition at line 65 of file GoldenPatternBase.h.

vector1D

typedef std::vector<int> GoldenPatternBase::vector1D

Definition at line 63 of file GoldenPatternBase.h.

Constructor & Destructor Documentation

GoldenPatternBase() [1/2]

GoldenPatternBase::GoldenPatternBase

(

const Key &

aKey

)

Definition at line 20 of file GoldenPatternBase.cc.

: theKey(aKey), myOmtfConfig(nullptr) {}

GoldenPatternBase() [2/2]

GoldenPatternBase::GoldenPatternBase	(	const Key &	aKey,
		const OMTFConfiguration *	omtfConfig
	)

Definition at line 22 of file GoldenPatternBase.cc.

References results.

    : theKey(aKey),
      myOmtfConfig(omtfConfig),
      results(boost::extents[myOmtfConfig->processorCnt()][myOmtfConfig->nTestRefHits()]) {
  for (unsigned int iProc = 0; iProc < results.size(); iProc++) {
    for (unsigned int iTestRefHit = 0; iTestRefHit < results[iProc].size(); iTestRefHit++) {
      results[iProc][iTestRefHit].init(omtfConfig);
    }
  }
}

~GoldenPatternBase()

virtual GoldenPatternBase::~GoldenPatternBase ( )

inlinevirtual

Definition at line 73 of file GoldenPatternBase.h.

{}

Member Function Documentation

finalise()

void GoldenPatternBase::finalise ( unsigned int  procIndx )

virtual

last step of the event processing, before sorting and ghost busting

Definition at line 137 of file GoldenPatternBase.cc.

References getResults(), and mps_fire::result.

                                                      {
  for (auto& result : getResults()[procIndx]) {
    result.finalise();
  }
}

getConfig()

const OMTFConfiguration* GoldenPatternBase::getConfig ( ) const

inline

Definition at line 77 of file GoldenPatternBase.h.

References myOmtfConfig.

{ return myOmtfConfig; }

getDistPhiBitShift()

virtual int GoldenPatternBase::getDistPhiBitShift ( unsigned int  iLayer, unsigned int  iRefLayer  ) const

pure virtual

Implemented in GoldenPattern.

Referenced by process1Layer1RefLayer().

getResults()

resultsArrayType& GoldenPatternBase::getResults ( )

inline

Definition at line 112 of file GoldenPatternBase.h.

References results.

Referenced by finalise(), and PatternGenerator::updateStat().

{ return results; }

key()

virtual Key& GoldenPatternBase::key ( )

inlinevirtual

Definition at line 79 of file GoldenPatternBase.h.

References theKey.

Referenced by AlgoMuon::getCharge(), AlgoMuon::getHwPatternNumber(), AlgoMuon::getPatternNumber(), and AlgoMuon::getPt().

{ return theKey; }

meanDistPhiValue()

virtual int GoldenPatternBase::meanDistPhiValue ( unsigned int  iLayer, unsigned int  iRefLayer, int  refLayerPhiB = 0  ) const

pure virtual

Implemented in GoldenPattern.

Referenced by process1Layer1RefLayer().

pdfValue()

virtual PdfValueType GoldenPatternBase::pdfValue ( unsigned int  iLayer, unsigned int  iRefLayer, unsigned int  iBin, int  refLayerPhiB = 0  ) const

pure virtual

Implemented in GoldenPattern.

Referenced by process1Layer1RefLayer().

process1Layer1RefLayer()

StubResult GoldenPatternBase::process1Layer1RefLayer ( unsigned int  iRefLayer, unsigned int  iLayer, MuonStubPtrs1D  layerStubs, const MuonStubPtr  refStub  )

virtual

Process single measurement layer with a single ref layer Method should be thread safe

Select hit closest to the mean of probability distribution in given layer

Check if phiDistMin is within pdf range -63 +63 in firmware here the arithmetic "value and sign" is used, therefore the range is -63 +63, and not -64 +63
Shift phidist, so 0 is at the middle of the range

Definition at line 45 of file GoldenPatternBase.cc.

References funct::abs(), ProcConfigurationBase::foldPhi(), getDistPhiBitShift(), OMTFConfiguration::isBendingLayer(), OMTFConfiguration::isNoHitValueInPdf(), meanDistPhiValue(), myOmtfConfig, OMTFConfiguration::nPdfAddrBits(), OMTFConfiguration::nPhiBins(), pdfValue(), and Validation_hcalonly_cfi::sign.

                                                                                {
  //if (this->getDistPhiBitShift(iLayer, iRefLayer) != 0) LogTrace("l1tOmtfEventPrint")<<__FUNCTION__<<":"<<__LINE__<<key()<<this->getDistPhiBitShift(iLayer, iRefLayer)<<std::endl;

  int phiMean = this->meanDistPhiValue(iLayer, iRefLayer, refStub->phiBHw);
  int phiDistMin = myOmtfConfig->nPhiBins();  //1<<(myOmtfConfig->nPdfAddrBits()); //"infinite" value for the beginning

  MuonStubPtr selectedStub;

  int phiRefHit = 0;
  if (refStub)
    phiRefHit = refStub->phiHw;

  if (this->myOmtfConfig->isBendingLayer(iLayer)) {
    phiRefHit = 0;  //phi ref hit for the bending layer set to 0, since it should not be included in the phiDist
  }

  for (auto& stub : layerStubs) {
    if (!stub)  //empty pointer
      continue;

    int hitPhi = stub->phiHw;
    if (this->myOmtfConfig->isBendingLayer(iLayer)) {
      //rejecting phiB of the low quality DT stubs is done in the OMTFInputMaker
      hitPhi = stub->phiBHw;
    }

    if (hitPhi >= (int)myOmtfConfig->nPhiBins())  //TODO is this needed now? the empty hit will be empty stub
      continue;  //empty itHits are marked with nPhiBins() in OMTFProcessor::restrictInput

    int phiDist = this->myOmtfConfig->foldPhi(hitPhi - phiMean - phiRefHit);
    //for standard omtf foldPhi is not needed, but if one processor works for full phi then it is
    //if (this->getDistPhiBitShift(iLayer, iRefLayer) != 0)
    /*LogTrace("l1tOmtfEventPrint") <<"\n"<<__FUNCTION__<<":"<<__LINE__<<" "<<theKey<<std::endl;
    LogTrace("l1tOmtfEventPrint") <<__FUNCTION__<<":"<<__LINE__
            <<"  iRefLayer "<<iRefLayer<<" iLayer "<<iLayer
            <<" hitPhi "<<hitPhi<<" phiMean "<<phiMean<<" phiRefHit "<<phiRefHit<<" phiDist "<<phiDist<<std::endl;*/

    //firmware works on the sign-value, shift must be done on abs(phiDist)
    int sign = phiDist < 0 ? -1 : 1;
    phiDist = abs(phiDist) >> this->getDistPhiBitShift(iLayer, iRefLayer);
    phiDist *= sign;
    //if the shift is done here, it means that the phiMean in the xml should be the same as without shift
    //if (this->getDistPhiBitShift(iLayer, iRefLayer) != 0) std::cout<<__FUNCTION__<<":"<<__LINE__<<" phiDist "<<phiDist<<std::endl;
    if (abs(phiDist) < abs(phiDistMin)) {
      phiDistMin = phiDist;
      selectedStub = stub;
    }
  }

  if (!selectedStub) {
    if (this->myOmtfConfig->isNoHitValueInPdf()) {
      PdfValueType pdfVal = this->pdfValue(iLayer, iRefLayer, 0);
      return StubResult(pdfVal, false, myOmtfConfig->nPhiBins(), iLayer, selectedStub);
    } else {
      return StubResult(0, false, myOmtfConfig->nPhiBins(), iLayer, selectedStub);  //2018 version
    }
  }

  int pdfMiddle = 1 << (myOmtfConfig->nPdfAddrBits() - 1);

  /*  debug
  if(phiDistMin != 128 && iRefLayer == 0 && iLayer == 1)*/
  /*LogTrace("l1tOmtfEventPrint")<<__FUNCTION__<<":"<<__LINE__<<" iRefLayer "<<iRefLayer<<" iLayer "<<iLayer<<" selectedStub "<<*selectedStub
          <<" phiDistMin "<<phiDistMin<<" phiMean "<<phiMean<<" shift "<<this->getDistPhiBitShift(iLayer, iRefLayer)<<std::endl;*/

  if (abs(phiDistMin) > ((1 << (myOmtfConfig->nPdfAddrBits() - 1)) - 1)) {
    return StubResult(0, false, phiDistMin + pdfMiddle, iLayer, selectedStub);

    //return GoldenPatternResult::LayerResult(this->pdfValue(iLayer, iRefLayer, 0), false, phiDistMin + pdfMiddle, selHit);
    //in some algorithms versions with thresholds we use the bin 0 to store the pdf value returned when there was no hit.
    //in the version without thresholds, the value in the bin 0 should be 0
  }

  phiDistMin += pdfMiddle;
  //if (this->getDistPhiBitShift(iLayer, iRefLayer) != 0) LogTrace("l1tOmtfEventPrint")<<__FUNCTION__<<":"<<__LINE__<<" phiDistMin "<<phiDistMin<<std::endl;
  PdfValueType pdfVal = this->pdfValue(iLayer, iRefLayer, phiDistMin);
  if (pdfVal <= 0) {
    return StubResult(0, false, phiDistMin, iLayer, selectedStub);
  }
  return StubResult(pdfVal, true, phiDistMin, iLayer, selectedStub);
}

propagateRefPhi()

virtual int GoldenPatternBase::propagateRefPhi ( int  phiRef, int  etaRef, unsigned int  iRefLayer  )

pure virtual

Propagate phi from given reference layer to MB2 or ME2 ME2 is used if eta of reference hit is larger than 1.1 expressed in integer MicroGMT scale: 1.1/2.61*240 = 101

Implemented in GoldenPattern, and GoldenPattern.

setConfig()

void GoldenPatternBase::setConfig ( const OMTFConfiguration *  omtfConfig )

virtual

Definition at line 33 of file GoldenPatternBase.cc.

References myOmtfConfig, OMTFConfiguration::nTestRefHits(), OMTFConfiguration::processorCnt(), and results.

                                                                     {
  myOmtfConfig = omtfConfig;
  results.resize(boost::extents[myOmtfConfig->processorCnt()][myOmtfConfig->nTestRefHits()]);
  for (unsigned int iProc = 0; iProc < results.size(); iProc++) {
    for (unsigned int iTestRefHit = 0; iTestRefHit < results[iProc].size(); iTestRefHit++) {
      results[iProc][iTestRefHit].init(omtfConfig);
    }
  }
}

setDistPhiBitShift()

virtual void GoldenPatternBase::setDistPhiBitShift ( int  value, unsigned int  iLayer, unsigned int  iRefLayer  )

pure virtual

Implemented in GoldenPattern.

setMeanDistPhiValue()

virtual void GoldenPatternBase::setMeanDistPhiValue ( int  value, unsigned int  iLayer, unsigned int  iRefLayer, unsigned int  paramIndex = 0  )

pure virtual

Implemented in GoldenPattern.

setPdfValue()

virtual void GoldenPatternBase::setPdfValue ( PdfValueType  value, unsigned int  iLayer, unsigned int  iRefLayer, unsigned int  iBin, int  refLayerPhiB = 0  )

pure virtual

Implemented in GoldenPattern.

Member Data Documentation

myOmtfConfig

const OMTFConfiguration* GoldenPatternBase::myOmtfConfig

protected

Definition at line 121 of file GoldenPatternBase.h.

Referenced by getConfig(), process1Layer1RefLayer(), and setConfig().

results

resultsArrayType GoldenPatternBase::results

protected

Definition at line 123 of file GoldenPatternBase.h.

Referenced by getResults(), GoldenPatternBase(), and setConfig().

theKey

Key GoldenPatternBase::theKey

protected

Pattern kinematic identification (iEta,iPt,iCharge)

Definition at line 119 of file GoldenPatternBase.h.

Referenced by key().