SiStripPedestals Class Reference

#include <SiStripPedestals.h>

Classes
struct	DetRegistry
class	StrictWeakOrdering

Public Types
typedef std::vector< char >	Container
typedef std::vector< char >::const_iterator	ContainerIterator
typedef std::vector< uint16_t >	InputVector
typedef std::pair< ContainerIterator, ContainerIterator >	Range
typedef std::vector< DetRegistry >	Registry
typedef Registry::const_iterator	RegistryIterator

Public Member Functions
void	allPeds (std::vector< int > &pefs, const Range &range) const
ContainerIterator	getDataVectorBegin () const
ContainerIterator	getDataVectorEnd () const
void	getDetIds (std::vector< uint32_t > &DetIds_) const
float	getPed (const uint16_t &strip, const Range &range) const
const Range	getRange (const uint32_t &detID) const
RegistryIterator	getRegistryVectorBegin () const
RegistryIterator	getRegistryVectorEnd () const
void	printDebug (std::stringstream &ss, const TrackerTopology *trackerTopo) const
	Prints all pedestals. More...
void	printSummary (std::stringstream &ss, const TrackerTopology *trackerTopo) const
	Prints mean pedestal value divided for subdet, layer and mono/stereo. More...
bool	put (const uint32_t &detID, InputVector &input)
void	setData (float ped, InputVector &vped)
	SiStripPedestals ()
	~SiStripPedestals ()

Private Member Functions
uint16_t	decode (const uint16_t &strip, const Range &range) const
void	encode (InputVector &Vi, std::vector< unsigned char > &Vo_CHAR)
uint16_t	get10bits (const uint8_t *&ptr, int8_t skip) const
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Private Attributes
Registry	indexes
Container	v_pedestals

Friends
class	boost::serialization::access
template<typename CondSerializationT , typename Enabled >
struct	cond::serialization::access

Detailed Description

Stores the pedestal of every strip.
Encodes the information in a vector<char> and uses a vector<DetRegistry> to connect each range of values to the corresponding detId.
The DetRegistry struct contains the detId and two uint32_t giving the index of begin and end of the corresponding range in the vector<char>.
Has methods to return the pedestal of a given strip of of all the strips.

The printSummary method uses SiStripDetSummary. See description therein.
The printDebug method prints the pedestal value for every strip of every detId.

Definition at line 27 of file SiStripPedestals.h.

Member Typedef Documentation

typedef std::vector<char> SiStripPedestals::Container

Definition at line 50 of file SiStripPedestals.h.

typedef std::vector<char>::const_iterator SiStripPedestals::ContainerIterator

Definition at line 51 of file SiStripPedestals.h.

typedef std::vector<uint16_t> SiStripPedestals::InputVector

Definition at line 55 of file SiStripPedestals.h.

typedef std::pair<ContainerIterator, ContainerIterator> SiStripPedestals::Range

Definition at line 52 of file SiStripPedestals.h.

typedef std::vector<DetRegistry> SiStripPedestals::Registry

Definition at line 53 of file SiStripPedestals.h.

typedef Registry::const_iterator SiStripPedestals::RegistryIterator

Definition at line 54 of file SiStripPedestals.h.

Constructor & Destructor Documentation

SiStripPedestals::SiStripPedestals ( )

inline

Definition at line 57 of file SiStripPedestals.h.

{};

SiStripPedestals::~SiStripPedestals ( )

inline

Definition at line 58 of file SiStripPedestals.h.

References getDetIds(), getRange(), input, and put().

{};

Member Function Documentation

void SiStripPedestals::allPeds	(	std::vector< int > &	pefs,
		const Range &	range
	)		const

Definition at line 142 of file SiStripPedestals.cc.

References Exception, get10bits(), MillePedeFileConverter_cfg::out, and findQualityFiles::size.

Referenced by getRegistryVectorEnd(), sistrip::FEDEmulator::retrievePedestals(), and SiStripPedestalsSubtractor::subtract_().

                                                                              {
    size_t mysize  = ((range.second-range.first) << 3) / 10;
    size_t size = peds.size();
    if (mysize < size) throw cms::Exception("CorruptedData") 
            << "[SiStripPedestals::allPeds] Requested pedestals for " << peds.size() << " strips, I have it only for " << mysize << " strips\n";
    size_t size4 = size & (~0x3), carry = size & 0x3; // we have an optimized way of unpacking 4 strips
    const uint8_t *ptr = reinterpret_cast<const uint8_t *>(&*range.second) - 1;
    std::vector<int>::iterator out = peds.begin(), end4 = peds.begin() + size4;
    // we do it this baroque way instead of just loopin on all the strips because it's faster
    // as the value of 'skip' is a constant, so the compiler can compute the masks directly
   while (out < end4) {
        *out = static_cast<int> ( get10bits(ptr, 0) ); ++out;
        *out = static_cast<int> ( get10bits(ptr, 2) ); ++out;
        *out = static_cast<int> ( get10bits(ptr, 4) ); ++out;
        *out = static_cast<int> ( get10bits(ptr, 6) ); ++out;
        --ptr; // every 4 strips we have to skip one more bit
    } 
    for (size_t rem = 0; rem < carry; ++rem ) {
        *out = static_cast<int> ( get10bits(ptr, 2*rem) ); ++out;
    }
}

uint16_t SiStripPedestals::decode ( const uint16_t &  strip, const Range &  range  ) const

private

Definition at line 100 of file SiStripPedestals.cc.

References data, and relativeConstraints::value.

Referenced by ztail.Decoder::follow(), getPed(), getRegistryVectorEnd(), and ztail.Decoder::initial_synchronize().

                                                                                 {
  const char *data = &*(range.second -1);  // pointer to the last byte of data
  static const uint16_t BITS_PER_STRIP = 10;

  uint32_t lowBit        = strip * BITS_PER_STRIP;
  uint8_t firstByteBit   = (lowBit & 6);//module 
  uint8_t firstByteNBits = 8 - firstByteBit;
  uint8_t firstByteMask  = 0xffu << firstByteBit;
  uint8_t secondByteMask = ~(0xffu << (BITS_PER_STRIP - firstByteNBits));
  uint16_t value         =   ((uint16_t(*(data-lowBit/8  )) & firstByteMask) >> firstByteBit) | ((uint16_t(*(data-lowBit/8-1)) & secondByteMask) << firstByteNBits);
  
  /*
    if(strip  < 25){
    std::cout       << "***************DECODE*********************"<<"\n"
    << "strip "<<strip << " " 
    << value 
    <<"\t   :"<<print_as_binary(value) 
    <<"\t  :"<<print_as_binary(    ((uint16_t(*(data-lowBit/8  )) & firstByteMask) >>   firstByteBit)       )
    << "-"<<print_as_binary(  ((uint16_t(*(data-lowBit/8-1)) & secondByteMask) <<firstByteNBits)    )
    << "\t *(data-lowBit/8) " << print_as_binary(    *(data-lowBit/8 ))
    << "\t *(data-lowBit/8-1) " << print_as_binary(    *(data-lowBit/8 -1 ))
    << "\tlowBit:"<< lowBit
    << "\tfirstByteMask :"<<print_as_binary(firstByteMask)
    << "\tsecondByteMask:"<<print_as_binary(secondByteMask)
    << "\tfirstByteBit:"<<print_as_binary(firstByteBit)
    << std::endl;
    }
  */
  return value;
}

void SiStripPedestals::encode ( InputVector &  Vi, std::vector< unsigned char > &  Vo_CHAR  )

private

Definition at line 59 of file SiStripPedestals.cc.

References data, and mps_fire::i.

Referenced by getRegistryVectorEnd(), and put().

                                                                          {
  static const uint16_t  BITS_PER_STRIP  = 10;
  const size_t           VoSize          = (size_t)((Vi.size() *       BITS_PER_STRIP)/8+.999);
  Vo.resize(VoSize);
  for(size_t i = 0; i<Vo.size(); ++i)
    Vo[i]   &=      0x00u;
  
  for(unsigned int stripIndex =0; stripIndex<Vi.size(); ++stripIndex){
    unsigned char*  data    =       &Vo[Vo.size()-1];
    uint32_t lowBit         =       stripIndex * BITS_PER_STRIP;
    uint8_t firstByteBit    =       (lowBit & 0x6);
    uint8_t firstByteNBits  =       8 - firstByteBit;
    uint8_t firstByteMask   =       0xffu << firstByteBit;
    uint8_t secondByteNbits =       (BITS_PER_STRIP - firstByteNBits);
    uint8_t secondByteMask  =       ~(0xffu << secondByteNbits);

    *(data-lowBit/8)        =       (*(data-lowBit/8)   & ~(firstByteMask))         | ((Vi[stripIndex] & 0xffu) <<firstByteBit);
    *(data-lowBit/8-1)      =       (*(data-lowBit/8-1) & ~(secondByteMask))        | ((Vi[stripIndex] >> firstByteNBits) & secondByteMask);

    /*
      if(stripIndex   < 25 ){
      std::cout       << "***************ENCODE*********************"<<std::endl
      << "\tdata-lowBit/8     :"<<print_as_binary((*(data-lowBit/8)   & ~(firstByteMask)))
      << "-"<<print_as_binary(((Vi[stripIndex] & 0xffu) <<firstByteBit))
      << "\tdata-lowBit/8-1   :"<<print_as_binary((*(data-lowBit/8-1)   & ~(secondByteMask)))
      << "-"<<print_as_binary((((Vi[stripIndex]>> firstByteNBits) & secondByteMask)))
      << std::endl;
      std::cout       << "strip "<<stripIndex<<"\tvi: " << Vi[stripIndex] <<"\t"
      << print_short_as_binary(Vi[stripIndex])
      << "\tvo1:"<< print_char_as_binary(*(data-lowBit/8))
      << "\tvo2:"<< print_char_as_binary(*(data-lowBit/8-1))
      << "\tlowBit:"<< lowBit
      << "\tfirstByteMask :"<<print_as_binary(firstByteMask)
      << "\tsecondByteMask:"<<print_as_binary(secondByteMask)
      << "\tfirstByteBit:"<<print_as_binary(firstByteBit)
      << std::endl;
      }
    */
  }
}

uint16_t SiStripPedestals::get10bits ( const uint8_t *&  ptr, int8_t  skip  ) const

inlineprivate

Get 9 bit words from a bit stream, starting from the right, skipping the first 'skip' bits (0 < skip < 7). Ptr must point to the rightmost byte that has some bits of this word, and is updated by this function

Definition at line 133 of file SiStripPedestals.cc.

References createPayload::skip.

Referenced by allPeds(), and getRegistryVectorEnd().

                                                                                   {
    uint8_t maskThis = (0xFF << skip);
    uint8_t maskThat = ((4 << skip) - 1);
    uint16_t ret = ( ((*ptr) & maskThis) >> skip );
    --ptr;
    return ret | ( ((*ptr) & maskThat) << (8 - skip) );
}

ContainerIterator SiStripPedestals::getDataVectorBegin ( ) const

inline

Definition at line 65 of file SiStripPedestals.h.

References v_pedestals.

{return v_pedestals.begin();}

ContainerIterator SiStripPedestals::getDataVectorEnd ( ) const

inline

Definition at line 66 of file SiStripPedestals.h.

References v_pedestals.

{return v_pedestals.end();}

void SiStripPedestals::getDetIds

(

std::vector< uint32_t > &

DetIds_

)

const

Definition at line 37 of file SiStripPedestals.cc.

References begin, end, indexes, and AlCaHLTBitMon_ParallelJobs::p.

Referenced by SiStripPedestalsReader::analyze(), SiStripPedestalsDQM::getActiveDetIds(), printDebug(), printSummary(), and ~SiStripPedestals().

                                                                   {
  // returns vector of DetIds in map
  SiStripPedestals::RegistryIterator begin = indexes.begin();
  SiStripPedestals::RegistryIterator end   = indexes.end();
  for (SiStripPedestals::RegistryIterator p=begin; p != end; ++p) {
    DetIds_.push_back(p->detid);
  }
}

float SiStripPedestals::getPed	(	const uint16_t &	strip,
		const Range &	range
	)		const

Definition at line 51 of file SiStripPedestals.cc.

References decode(), Exception, and digitizers_cfi::strip.

Referenced by SiStripPedestalsReader::analyze(), CalibrationScanTask::CalibrationScanTask(), CalibrationTask::CalibrationTask(), SiStripAPVRestorer::createCMMapRealPed(), SiStripDigitizerAlgorithm::digitize(), SiStripMonitorPedestals::fillCondDBMEs(), SiStripPedestalsDQM::fillMEsForDet(), SiStripPedestalsDQM::fillMEsForLayer(), LaserAlignment::fillPedestalProfiles(), getRegistryVectorEnd(), printDebug(), printSummary(), and DigiSimLinkAlgorithm::run().

                                                                              {
  if (10*strip>=(range.second-range.first)*8){
    throw cms::Exception("CorruptedData")
      << "[SiStripPedestals::getPed] looking for SiStripPedestals for a strip out of range: strip " << strip;
  }
  return   static_cast<float> (decode(strip,range));
}

const SiStripPedestals::Range SiStripPedestals::getRange

(

const uint32_t &

detID

)

const

Definition at line 27 of file SiStripPedestals.cc.

References indexes, pfDeepBoostedJetPreprocessParams_cfi::lower_bound, AlCaHLTBitMon_ParallelJobs::p, and v_pedestals.

Referenced by SiStripPedestalsReader::analyze(), CalibrationScanTask::CalibrationScanTask(), CalibrationTask::CalibrationTask(), SiStripAPVRestorer::createCMMapRealPed(), SiStripDigitizerAlgorithm::digitize(), SiStripMonitorPedestals::fillCondDBMEs(), SiStripPedestalsDQM::fillMEsForDet(), SiStripPedestalsDQM::fillMEsForLayer(), LaserAlignment::fillPedestalProfiles(), printDebug(), printSummary(), sistrip::FEDEmulator::retrievePedestals(), DigiSimLinkAlgorithm::run(), SiStripPedestalsSubtractor::subtract_(), and ~SiStripPedestals().

                                                                                  {
  // get SiStripPedestals Range of DetId

  RegistryIterator p = std::lower_bound(indexes.begin(),indexes.end(),DetId,SiStripPedestals::StrictWeakOrdering());
  if (p==indexes.end()|| p->detid!=DetId) 
    return SiStripPedestals::Range(v_pedestals.end(),v_pedestals.end()); 
  else 
    return SiStripPedestals::Range(v_pedestals.begin()+p->ibegin,v_pedestals.begin()+p->iend);
}

RegistryIterator SiStripPedestals::getRegistryVectorBegin ( ) const

inline

Definition at line 67 of file SiStripPedestals.h.

References indexes.

{return indexes.begin();}

RegistryIterator SiStripPedestals::getRegistryVectorEnd ( ) const

inline

Definition at line 68 of file SiStripPedestals.h.

References allPeds(), decode(), encode(), get10bits(), getPed(), indexes, printDebug(), printSummary(), setData(), createPayload::skip, and digitizers_cfi::strip.

{return indexes.end();}

void SiStripPedestals::printDebug	(	std::stringstream &	ss,
		const TrackerTopology *	trackerTopo
	)		const

Prints all pedestals.

Definition at line 180 of file SiStripPedestals.cc.

References getDetIds(), getPed(), getRange(), triggerObjects_cff::id, and digitizers_cfi::strip.

Referenced by getRegistryVectorEnd().

{
  std::vector<uint32_t> detid;
  getDetIds(detid);

  ss << "Number of detids = " << detid.size() << std::endl;

  for( size_t id = 0; id < detid.size(); ++id ) {
    SiStripPedestals::Range range = getRange(detid[id]);

    int strip = 0;
    ss << "detid" << std::setw(15) << "strip" << std::setw(10) << "pedestal" << std::endl;
    int detId = 0;
    int oldDetId = 0;
    for( int it=0; it < (range.second-range.first)*8/10; ++it ){
      detId = detid[id];
      if( detId != oldDetId ) {
        oldDetId = detId;
        ss << detid[id];
      }
      else ss << "   ";
      ss << std::setw(15) << strip++ << std::setw(10) << getPed(it,range) << std::endl;
    }
  }
}

void SiStripPedestals::printSummary	(	std::stringstream &	ss,
		const TrackerTopology *	trackerTopo
	)		const

Prints mean pedestal value divided for subdet, layer and mono/stereo.

Definition at line 164 of file SiStripPedestals.cc.

References getDetIds(), getPed(), getRange(), triggerObjects_cff::id, and heppy_report::summary.

Referenced by getRegistryVectorEnd().

{
  std::vector<uint32_t> detid;
  getDetIds(detid);
  SiStripDetSummary summary{trackerTopo};
  for( size_t id = 0; id < detid.size(); ++id ) {
    SiStripPedestals::Range range = getRange(detid[id]);
    for( int it=0; it < (range.second-range.first)*8/10; ++it ){
      summary.add( detid[id], getPed(it,range) );
    }
  }
  ss << "Summary of pedestals:" << std::endl;
  summary.print(ss);
}

bool SiStripPedestals::put	(	const uint32_t &	detID,
		InputVector &	input
	)

Definition at line 5 of file SiStripPedestals.cc.

References SiStripPedestals::DetRegistry::detid, encode(), SiStripPedestals::DetRegistry::ibegin, SiStripPedestals::DetRegistry::iend, indexes, pfDeepBoostedJetPreprocessParams_cfi::lower_bound, AlCaHLTBitMon_ParallelJobs::p, sd, and v_pedestals.

Referenced by SiStripPedestalsBuilder::analyze(), SiStripPopConPedestalsHandlerFromDQM::dqmEndJob(), SiStripCondObjBuilderFromDb::storePedestals(), and ~SiStripPedestals().

                                                                    {
  // put in SiStripPedestals of DetId
  std::vector<unsigned char>      Vo_CHAR;
  encode(input, Vo_CHAR);

  Registry::iterator p = std::lower_bound(indexes.begin(),indexes.end(),DetId,SiStripPedestals::StrictWeakOrdering());
  if (p!=indexes.end() && p->detid==DetId)
    return false;

  //size_t sd= input.second-input.first;
  size_t sd= Vo_CHAR.end() - Vo_CHAR.begin();
  DetRegistry detregistry;
  detregistry.detid=DetId;
  detregistry.ibegin=v_pedestals.size();
  detregistry.iend=v_pedestals.size()+sd;
  indexes.insert(p,detregistry);

  //v_pedestals.insert(v_pedestals.end(),input.first,input.second);
  v_pedestals.insert(v_pedestals.end(),Vo_CHAR.begin(),Vo_CHAR.end());
  return true;
}

template<class Archive >

void SiStripPedestals::serialize ( Archive &  ar, const unsigned int  version  )

private

void SiStripPedestals::setData	(	float	ped,
		SiStripPedestals::InputVector &	vped
	)

Definition at line 47 of file SiStripPedestals.cc.

Referenced by SiStripPedestalsBuilder::analyze(), SiStripPopConPedestalsHandlerFromDQM::dqmEndJob(), getRegistryVectorEnd(), SiStripCondObjBuilderFromDb::setDefaultValuesCabling(), and SiStripCondObjBuilderFromDb::setValuesCabling().

                                                                          {
  vped.push_back((static_cast<uint16_t>  (ped) & 0x3FF)) ;
}

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Definition at line 88 of file SiStripPedestals.h.

template<typename CondSerializationT , typename Enabled >

friend struct cond::serialization::access

friend

Definition at line 88 of file SiStripPedestals.h.

Member Data Documentation

Registry SiStripPedestals::indexes

private

Definition at line 86 of file SiStripPedestals.h.

Referenced by getDetIds(), getRange(), getRegistryVectorBegin(), getRegistryVectorEnd(), and put().

Container SiStripPedestals::v_pedestals

private

Definition at line 85 of file SiStripPedestals.h.

Referenced by getDataVectorBegin(), getDataVectorEnd(), getRange(), and put().