CSCCLCTData Class Reference

#include <CSCCLCTData.h>

Public Member Functions
void	add (const CSCComparatorDigi &digi, int layer)
	TODO for packing. Doesn't do flipping yet. More...
void	add (const CSCComparatorDigi &digi, const CSCDetId &id)
	TODO for packing. Doesn't do flipping yet. More...
bool	bitValue (int cfeb, int tbin, int layer, int distrip)
bool	check () const
std::vector< CSCComparatorDigi >	comparatorDigis (int layer)
	layers count from one More...
std::vector< CSCComparatorDigi >	comparatorDigis (uint32_t idlayer, unsigned icfeb)
	layers count from one More...
	CSCCLCTData (const CSCTMBHeader *tmbHeader)
	CSCCLCTData (int ncfebs, int ntbins, int firmware_version=2007)
	CSCCLCTData (int ncfebs, int ntbins, const unsigned short *e0bbuf, int firmware_version=2007)
unsigned short *	data ()
CSCCLCTDataWord &	dataWord (int iline) const
CSCCLCTDataWord &	dataWord (int cfeb, int tbin, int layer) const
void	dump () const
int	nlines () const
int	sizeInWords () const
	in 16-bit words More...

Static Public Member Functions
static void	selfTest ()
static void	setDebug (const bool value)

Private Member Functions
void	zero ()

Private Attributes
int	ncfebs_
int	ntbins_
int	size_
unsigned short	theData [7 *6 *32]
int	theFirmwareVersion

Static Private Attributes
static std::atomic< bool >	debug {false}

Detailed Description

Definition at line 26 of file CSCCLCTData.h.

Constructor & Destructor Documentation

CSCCLCTData::CSCCLCTData ( const CSCTMBHeader *  tmbHeader )

explicit

Definition at line 17 of file CSCCLCTData.cc.

References CSCTMBHeader::FirmwareVersion(), nlines(), NULL, size_, theFirmwareVersion, and zero().

    : ncfebs_(tmbHeader->NCFEBs()), ntbins_(tmbHeader->NTBins())
{
  if (tmbHeader != NULL)  theFirmwareVersion = tmbHeader->FirmwareVersion();
  else theFirmwareVersion = 2007;
  size_ = nlines();
  zero();
}

CSCCLCTData::CSCCLCTData	(	int	ncfebs,
		int	ntbins,
		int	firmware_version = 2007
	)

Definition at line 27 of file CSCCLCTData.cc.

References nlines(), size_, and zero().

    : ncfebs_(ncfebs), ntbins_(ntbins), theFirmwareVersion(firmware_version)
{
  size_ = nlines();
  zero();
}

CSCCLCTData::CSCCLCTData	(	int	ncfebs,
		int	ntbins,
		const unsigned short *	e0bbuf,
		int	firmware_version = 2007
	)

Definition at line 37 of file CSCCLCTData.cc.

References nlines(), size_, and theData.

    : ncfebs_(ncfebs), ntbins_(ntbins), theFirmwareVersion(firmware_version)
{
  // add two more for odd ntbins, plus one for the e0c
  // Oct 2004 Rick: e0c line belongs to CSCTMBTrailer
  size_ = (nlines()%2==1)? nlines()+2 : nlines();

  memcpy(theData, buf, size_*2);

}

Member Function Documentation

void CSCCLCTData::add	(	const CSCComparatorDigi &	digi,
		int	layer
	)

TODO for packing. Doesn't do flipping yet.

!!! Do we need to introduce format version here to accomodate 7 CFEBs

Definition at line 222 of file CSCCLCTData.cc.

References assert(), dataWord(), CSCComparatorDigi::getComparator(), CSCComparatorDigi::getStrip(), CSCComparatorDigi::getTimeBinsOn(), ntbins_, and CSCCLCTDataWord::set().

Referenced by CSCEventData::add(), counter.Counter::register(), and selfTest().

{
  //FIXME do flipping
  int strip = digi.getStrip();
  int halfStrip = (strip-1)*2 + digi.getComparator();
  int cfeb = (strip-1)/16;
  int distrip = ((strip-1)%16) / 2;


  // assert(distrip < 8 && cfeb < 6 && halfStrip < 161);
  assert(distrip < 8 && cfeb < 8 && halfStrip < 225);

  std::vector<int> timeBinsOn = digi.getTimeBinsOn();
  for (std::vector<int>::const_iterator tbinItr = timeBinsOn.begin();
       tbinItr != timeBinsOn.end(); ++tbinItr)
    {
      int tbin = *tbinItr;
      if (tbin >= 0 && tbin < ntbins_-2)
        {
          // First triad bit indicates the presence of the hit
          dataWord(cfeb, tbin, layer).set(distrip, true);
          // Second bit indicates which of the two strips contains the hit
          if (strip%2 == 0)
            dataWord(cfeb, tbin+1, layer).set(distrip, true);
          // Third bit indicates whether the hit is located on the left or on the
          // right side of the strip.
          if (digi.getComparator())
            dataWord(cfeb, tbin+2, layer).set(distrip, true);

        }
    }
}

void CSCCLCTData::add	(	const CSCComparatorDigi &	digi,
		const CSCDetId &	id
	)

TODO for packing. Doesn't do flipping yet.

!!! Do we need to introduce format version here to accomodate 7 CFEBs

Definition at line 259 of file CSCCLCTData.cc.

References assert(), dataWord(), CSCDetId::endcap(), CSCComparatorDigi::getComparator(), CSCComparatorDigi::getStrip(), CSCComparatorDigi::getTimeBinsOn(), CSCDetId::layer(), ntbins_, CSCDetId::ring(), CSCCLCTDataWord::set(), CSCDetId::station(), theFirmwareVersion, and SurfaceOrientation::zplus.

Referenced by counter.Counter::register().

{

  static const bool doStripSwapping = true;
  bool me1a = (cid.station()==1) && (cid.ring()==4);
  bool zplus = (cid.endcap() == 1);
  bool me1b = (cid.station()==1) && (cid.ring()==1);
//  bool me11 = (cid.station()==1) && ((cid.ring()==1) || (cid.ring()==4));

  unsigned layer = cid.layer();


  int strip = digi.getStrip();
  int halfstrip = (strip-1)*2 + digi.getComparator();
  int cfeb = (strip-1)/16;
  int distrip = ((strip-1)%16) / 2;
  int bit2 = (strip-1)%2;
  int bit3 = digi.getComparator();



  // assert(distrip < 8 && cfeb < 6 && halfStrip < 161);
  if (theFirmwareVersion >= 2013) {
    assert(distrip < 8 && cfeb < 8 && halfstrip < 225);
  } else {
    assert(distrip < 8 && cfeb < 6 && halfstrip < 161);
  }

  // Lets try to do ME11 strip flipping
  if (doStripSwapping)
    {

      if (theFirmwareVersion >= 2013)
        {
          if ( (me1a || (me1b && (cfeb > 3))) &&  zplus )
            {
              distrip = 7-distrip;  // 0-7 -> 7-0
              cfeb = 10 - cfeb;
              bit2 = ((31-(halfstrip%32))%4)/2;
              bit3 = ((31-(halfstrip%32))%4)%2;

            }
          if ( me1b && !zplus && (cfeb<4))
            {
              distrip = 7-distrip;
              cfeb = 3 - cfeb;
              bit2 = ((31-(halfstrip%32))%4)/2;
              bit3 = ((31-(halfstrip%32))%4)%2;


            }
        }
      else
        {
          // if ( me1a )           { cfeb_corr = 0; } // reset 4 to 0
          if ( (me1a || (me1b && (cfeb > 3))) &&  zplus )
            {
              distrip = 7-distrip; // 0-7 -> 7-0
              bit2 = ((31-(halfstrip%32))%4)/2;
              bit3 = ((31-(halfstrip%32))%4)%2;
            }
          if ( me1b && !zplus && (cfeb<4))
            {
              distrip = 7-distrip;
              cfeb = 3 - cfeb;
              bit2 = ((31-(halfstrip%32))%4)/2;
              bit3 = ((31-(halfstrip%32))%4)%2;


            }
        }
    }


  std::vector<int> timeBinsOn = digi.getTimeBinsOn();
  for (std::vector<int>::const_iterator tbinItr = timeBinsOn.begin();
       tbinItr != timeBinsOn.end();
       ++tbinItr)
    {
      int tbin = *tbinItr;
      if (tbin >= 0 && tbin < ntbins_-2)
        {
          // First triad bit indicates the presence of the hit
          dataWord(cfeb, tbin, layer).set(distrip, true);
          // Second bit indicates which of the two strips contains the hit
          // if (strip%2 == 0)
          if (bit2)
            dataWord(cfeb, tbin+1, layer).set(distrip, true);
          // Third bit indicates whether the hit is located on the left or on the
          // right side of the strip.
          // if (digi.getComparator())
          if (bit3)
            dataWord(cfeb, tbin+2, layer).set(distrip, true);

        }
    }
}

bool CSCCLCTData::bitValue ( int  cfeb, int  tbin, int  layer, int  distrip  )

inline

Definition at line 68 of file CSCCLCTData.h.

References dataWord(), and CSCCLCTDataWord::value().

Referenced by comparatorDigis().

                                                            {
    return dataWord(cfeb, tbin, layer).value(distrip);
  }

bool CSCCLCTData::check

(

)

const

first do some checks

Definition at line 359 of file CSCCLCTData.cc.

References CSCCLCTDataWord::cfeb_, dataWord(), debug, LogTrace, ncfebs_, ntbins_, mps_fire::result, and CSCCLCTDataWord::tbin_.

Referenced by cscdqm::EventProcessor::processCSC(), and CSCTMBData::UnpackTMB().

{
  bool result = true;
  for (int cfeb = 0; cfeb < ncfebs_; ++cfeb)
    {
      for (int tbin = 0; tbin < ntbins_; ++tbin)
        {
          for (int layer = 1; layer <= 6; ++layer)
            {
              const CSCCLCTDataWord & word = dataWord(cfeb, tbin, layer);
              bool wordIsGood = (word.tbin_ == tbin) && (word.cfeb_ == cfeb);
              result = result && wordIsGood;
              if (!wordIsGood && debug)
                {
                  LogTrace("CSCCLCTData|CSCRawToDigi") << "Bad CLCT data  in layer " << layer
                  << " expect CFEB " << cfeb << " tbin " << tbin;
                  LogTrace("CSCCLCTData|CSCRawToDigi") << " See " << word.cfeb_ << " "
                  << word.tbin_;
                }
            }
        }
    }
  if (!result) LogTrace("CSCCLCTData|CSCRawToDigi") << "++ Bad CLCT Data ++ ";
  return result;
}

std::vector< CSCComparatorDigi > CSCCLCTData::comparatorDigis

(

int

layer

)

layers count from one

Definition at line 206 of file CSCCLCTData.cc.

References assert(), ncfebs_, and mps_fire::result.

Referenced by cscdqm::EventProcessor::processCSC(), and selfTest().

{
  //returns comparators for one layer for all cfebs
  std::vector<CSCComparatorDigi> result;
  assert(layer>0 && layer<= 6);

  for (int cfeb = 0; cfeb < ncfebs_; ++cfeb)
    {
      std::vector<CSCComparatorDigi> oneCfebDigi = comparatorDigis(layer,cfeb);
      result.insert(result.end(), oneCfebDigi.begin(), oneCfebDigi.end());
    }

  return result;
}

std::vector< CSCComparatorDigi > CSCCLCTData::comparatorDigis	(	uint32_t	idlayer,
		unsigned	icfeb
	)

layers count from one

first do some checks

what is actually stored in comparator digis are 0/1 for left/right halfstrip for each strip

constructing four bitted words for tbits on

Definition at line 65 of file CSCCLCTData.cc.

References assert(), bitValue(), CSCCLCTDataWord::cfeb_, dataWord(), debug, CSCDetId::endcap(), CSCDetId::layer(), LogTrace, ntbins_, convertSQLitetoXML_cfg::output, mps_fire::result, CSCDetId::ring(), CSCDetId::station(), CSCCLCTDataWord::tbin_, theFirmwareVersion, and SurfaceOrientation::zplus.

{
  static const bool doStripSwapping = true;
  bool me1a = (CSCDetId::station(idlayer)==1) && (CSCDetId::ring(idlayer)==4);
  bool zplus = (CSCDetId::endcap(idlayer) == 1);
  bool me1b = (CSCDetId::station(idlayer)==1) && (CSCDetId::ring(idlayer)==1);
//  bool me11 = (CSCDetId::station(idlayer)==1) && ((CSCDetId::ring(idlayer)==1) || (CSCDetId::ring(idlayer)==4));
  unsigned layer = CSCDetId::layer(idlayer);



  //looking for comp output on layer
  std::vector<CSCComparatorDigi> result;
  assert(layer>0 && layer<= 6);
  // this is pretty sparse data, so I wish we could check the
  // data word by word, not bit by bit, but I don't see how to
  // do the time sequencing that way.
  for (int distrip = 0; distrip < 8; ++distrip)
    {
      uint16_t tbinbitsS0HS0=0;
      uint16_t tbinbitsS0HS1=0;
      uint16_t tbinbitsS1HS0=0;
      uint16_t tbinbitsS1HS1=0;
      for (int tbin = 0; tbin < ntbins_-2; ++tbin)
        {
          if (bitValue(cfeb, tbin, layer, distrip))
            {
              CSCCLCTDataWord word = dataWord(cfeb, tbin, layer);
              assert(word.tbin_ == tbin);
              assert(word.cfeb_ == cfeb);
              // we have a hit.  The next two time samples
              // are the other two bits in the triad
              int bit2 = bitValue(cfeb, tbin+1, layer, distrip);
              int bit3 = bitValue(cfeb, tbin+2, layer, distrip);
              // should count from zero
              int chamberDistrip = distrip + cfeb*8;
              int HalfStrip = 4*chamberDistrip + bit2*2 + bit3;
              int output = 4 + bit2*2 + bit3;
              /*
               * Handles distrip logic; comparator output is for pairs of strips:
               * hit  bin  dec
               * x--- 100   4
               * -x-- 101   5
               * --x- 110   6
               * ---x 111   7
               *
               */

              if (debug)
                LogTrace ("CSCCLCTData|CSCRawToDigi")
                << "fillComparatorOutputs: layer = "
                << layer << " timebin = " << tbin
                << " cfeb = " << cfeb << " distrip = " << chamberDistrip
                << " HalfStrip = " << HalfStrip
                << " Output " << output << std::endl;

              if (output==4) tbinbitsS0HS0=tbinbitsS0HS0+(1<<tbin);
              if (output==5) tbinbitsS0HS1=tbinbitsS0HS1+(1<<tbin);
              if (output==6) tbinbitsS1HS0=tbinbitsS1HS0+(1<<tbin);
              if (output==7) tbinbitsS1HS1=tbinbitsS1HS1+(1<<tbin);

              tbin += 2;
            }
        }//end of loop over time bins
      //we do not have to check over the last couple of time bins if there are no hits since
      //comparators take 3 time bins

      // Store digis each of possible four halfstrips for given distrip:
      if (tbinbitsS0HS0 || tbinbitsS0HS1 || tbinbitsS1HS0 || tbinbitsS1HS1)
        {
          unsigned int cfeb_corr    = cfeb;
          unsigned int distrip_corr = distrip;

          if (doStripSwapping)
            {
              // Fix ordering of strips and CFEBs in ME1/1.
              // SV, 27/05/08: keep CFEB=4 for ME1/a until CLCT trigger logic
              // stops combining it with the info from the other 4 CFEBs (ME1/b).
              //
              if (theFirmwareVersion >= 2013)
                {
                  if ( me1a &&  zplus )
                    {
                      distrip_corr = 7-distrip;  // 0-7 -> 7-0
                      cfeb_corr = 10-cfeb;
                    }
                  if ( me1b && !zplus )
                    {
                      distrip_corr = 7-distrip;
                      cfeb_corr = 3-cfeb;
                    }
                }
              else
                {
                  // if ( me1a )           { cfeb_corr = 0; } // reset 4 to 0
                  if ( me1a &&  zplus )
                    {
                      distrip_corr = 7-distrip; // 0-7 -> 7-0
                    }
                  if ( me1b && !zplus )
                    {
                      distrip_corr = 7-distrip;
                      cfeb_corr = 3-cfeb;
                    }
                }
            }


          int strip = 16*cfeb_corr + 2*distrip_corr + 1;

          if (debug)
            LogTrace ("CSCCLCTData|CSCRawToDigi")
            << "fillComparatorOutputs: cfeb_corr = " << cfeb_corr
            << " distrip_corr = " << distrip_corr << " strip = " << strip;

          if (doStripSwapping && (( me1a && zplus ) || ( me1b && !zplus )))
            {
              // Half-strips need to be flipped too.
              if (tbinbitsS1HS1) result.push_back(CSCComparatorDigi(strip, 0, tbinbitsS1HS1));
              if (tbinbitsS1HS0) result.push_back(CSCComparatorDigi(strip, 1, tbinbitsS1HS0));
              if (tbinbitsS0HS1) result.push_back(CSCComparatorDigi(strip+1, 0, tbinbitsS0HS1));
              if (tbinbitsS0HS0) result.push_back(CSCComparatorDigi(strip+1, 1, tbinbitsS0HS0));
            }
          else
            {
              if (tbinbitsS0HS0) result.push_back(CSCComparatorDigi(strip, 0, tbinbitsS0HS0));
              if (tbinbitsS0HS1) result.push_back(CSCComparatorDigi(strip, 1, tbinbitsS0HS1));
              if (tbinbitsS1HS0) result.push_back(CSCComparatorDigi(strip+1, 0, tbinbitsS1HS0));
              if (tbinbitsS1HS1) result.push_back(CSCComparatorDigi(strip+1, 1, tbinbitsS1HS1));
            }
          //uh oh ugly ugly ugly!
        }
    }//end of loop over distrips
  return result;
}

unsigned short* CSCCLCTData::data ( )

inline

Definition at line 44 of file CSCCLCTData.h.

References theData.

Referenced by cuy.FindIssue::__init__(), and CSCTMBData::pack().

{return theData;}

CSCCLCTDataWord& CSCCLCTData::dataWord ( int  iline ) const

inline

Definition at line 54 of file CSCCLCTData.h.

References assert(), ztail::d, ntuplemaker::iline, nlines(), alignCSCRings::s, and theData.

Referenced by add(), bitValue(), check(), comparatorDigis(), dataWord(), and zero().

                                              {
#ifdef ASSERTS
    assert(iline < nlines());
#endif
    union dataPtr { const unsigned short * s; CSCCLCTDataWord * d; } mptr;
    mptr.s = theData+iline;
    return *(mptr.d);
  }

CSCCLCTDataWord& CSCCLCTData::dataWord ( int  cfeb, int  tbin, int  layer  ) const

inline

Definition at line 63 of file CSCCLCTData.h.

References dataWord(), ntuplemaker::iline, and ntbins_.

                                                                  {
    int iline = (layer-1) + tbin*6 + cfeb*6*ntbins_;
    return dataWord(iline);
  }

void CSCCLCTData::dump

(

void

)

const

Definition at line 387 of file CSCCLCTData.cc.

References i, size_, and theData.

{
  for (int i=0; i<size_; i++)
    {
      printf("%04x %04x %04x %04x\n", theData[i+3], theData[i+2], theData[i+1], theData[i]);
      i+=3;
    }
}

int CSCCLCTData::nlines ( ) const

inline

Definition at line 47 of file CSCCLCTData.h.

References ncfebs_, and ntbins_.

Referenced by CSCCLCTData(), and dataWord().

{ return ncfebs_*ntbins_*6; }

void CSCCLCTData::selfTest ( )

static

Definition at line 397 of file CSCCLCTData.cc.

References add(), assert(), and comparatorDigis().

{
  CSCCLCTData clctData(5, 16);
  // aim for output 4 in 5th time bin, = 0000000000010000
  CSCComparatorDigi comparatorDigi1(1, 0, 0x10);
  // aim for output 5 in 6th time bin, = 0000 0000 0010 0000
  CSCComparatorDigi comparatorDigi2(39, 1, 0x20);
  // aim for output 7 in 7th time bin, = 000 0000 0100 0000
  CSCComparatorDigi comparatorDigi3(80, 1, 0x40);

  clctData.add(comparatorDigi1,1);
  clctData.add(comparatorDigi2,4);
  clctData.add(comparatorDigi3,6);

  CSCDetId layer1(1,4,1,2,1);
  CSCDetId layer4(1,4,1,2,4);
  CSCDetId layer6(1,4,1,2,6);

  std::vector<CSCComparatorDigi> digis1 = clctData.comparatorDigis(1);
  std::vector<CSCComparatorDigi> digis2 = clctData.comparatorDigis(4);
  std::vector<CSCComparatorDigi> digis3 = clctData.comparatorDigis(6);

  assert(digis1.size() == 1);
  assert(digis2.size() == 1);
  assert(digis3.size() == 1);

  assert(digis1[0].getStrip() == 1);
  assert(digis1[0].getComparator() == 0);
  assert(digis1[0].getTimeBin() == 4);

  assert(digis2[0].getStrip() == 39);
  assert(digis2[0].getComparator() == 1);
  assert(digis2[0].getTimeBin() == 5);

  assert(digis3[0].getStrip() == 80);
  assert(digis3[0].getComparator() == 1);
  assert(digis3[0].getTimeBin() == 6);
}

static void CSCCLCTData::setDebug ( const bool  value )

inlinestatic

turns on/off debug flag for this class

Definition at line 35 of file CSCCLCTData.h.

References debug, and relativeConstraints::value.

Referenced by CSCDCCUnpacker::CSCDCCUnpacker().

{debug = value;};

int CSCCLCTData::sizeInWords ( ) const

inline

in 16-bit words

Definition at line 46 of file CSCCLCTData.h.

References size_.

Referenced by CSCTMBData::CSCTMBData(), CSCTMBData::pack(), and CSCTMBData::UnpackTMB().

{ return size_;}

void CSCCLCTData::zero ( )

private

Definition at line 49 of file CSCCLCTData.cc.

References dataWord(), ncfebs_, and ntbins_.

Referenced by CSCCLCTData().

{
  for (int ifeb = 0; ifeb < ncfebs_; ++ifeb)
    {
      for (int tbin = 0; tbin < ntbins_; ++tbin)
        {
          for (int layer = 1; layer <= 6; ++layer)
            {
              dataWord(ifeb, tbin, layer) = CSCCLCTDataWord(ifeb, tbin, 0);
            }
        }
    }

}

Member Data Documentation

std::atomic< bool > CSCCLCTData::debug {false}

staticprivate

Definition at line 90 of file CSCCLCTData.h.

Referenced by check(), comparatorDigis(), util.rrapi.RRApi::dprint(), rrapi.RRApi::dprint(), pkg.AbstractPkg::generate(), rrapi.RRApi::get(), util.rrapi.RRApi::get(), pkg.AbstractPkg::get_kwds(), setDebug(), and pkg.AbstractPkg::write().

int CSCCLCTData::ncfebs_

private

Definition at line 93 of file CSCCLCTData.h.

Referenced by check(), comparatorDigis(), nlines(), and zero().

int CSCCLCTData::ntbins_

private

Definition at line 94 of file CSCCLCTData.h.

Referenced by add(), check(), comparatorDigis(), dataWord(), nlines(), and zero().

int CSCCLCTData::size_

private

Definition at line 95 of file CSCCLCTData.h.

Referenced by CSCCLCTData(), dump(), and sizeInWords().

unsigned short CSCCLCTData::theData[7 *6 *32]

private

Definition at line 96 of file CSCCLCTData.h.

Referenced by CSCCLCTData(), data(), dataWord(), and dump().

int CSCCLCTData::theFirmwareVersion

private

Definition at line 97 of file CSCCLCTData.h.

Referenced by add(), comparatorDigis(), and CSCCLCTData().