SiPixelQuality.h

Go to the documentation of this file.

// SiPixelQuality.h
//
// class definition to hold a list of disabled pixel modules
//
// M. Eads
// Apr 2008

#ifndef SiPixelQuality_H
#define SiPixelQuality_H

#include "CondFormats/Serialization/interface/Serializable.h"

#include <vector>
#include <utility>

#include "DataFormats/DetId/interface/DetId.h"
#include "DataFormats/GeometryVector/interface/LocalPoint.h"
#include "CondFormats/SiPixelObjects/interface/GlobalPixel.h"
#include "CondFormats/SiPixelObjects/interface/SiPixelFedCablingMap.h"
#include "CondFormats/SiPixelObjects/interface/SiPixelFedCabling.h"
#include "CondFormats/SiPixelObjects/interface/PixelROC.h"
#include "CondFormats/SiPixelObjects/interface/LocalPixel.h"
#include "CondFormats/SiStripObjects/interface/SiStripDetVOff.h"

namespace edm {
  class EventSetup;
}

class TrackerGeometry;

class SiPixelQuality {

 public:
  struct disabledModuleType { 
    uint32_t DetID;  
    int      errorType;
    unsigned short BadRocs;
  
  COND_SERIALIZABLE;
};

      //  errortype "whole" = int 0 in DB //
      //  errortype "tbmA" = int 1 in DB  //
      //  errortype "tbmB" = int 2 in DB  //
      //  errortype "none" = int 3 in DB  //

      //each bad roc correspond to a bit to 1: num=  //
      // 0 <-> all good rocs                         //
      // 1 <-> only roc 0 bad                        //
      // 2<-> only roc 1 bad                         //
      // 3<->  roc 0 and 1 bad                       //
      // 4 <-> only roc 2 bad                        //
      //  ...                                        //





  class BadComponentStrictWeakOrdering{
  public:
    bool operator() (const disabledModuleType& p,const uint32_t i) const {return p.DetID < i;}
    bool operator() (const disabledModuleType& p,const disabledModuleType& q) const {return p.DetID < q.DetID;}   
  };



  SiPixelQuality() : theDisabledModules(0) {;}

  // constructor from a list of disabled modules
  SiPixelQuality(std::vector<disabledModuleType> & disabledModules) : theDisabledModules(disabledModules) {;}

  virtual ~SiPixelQuality() {;}

  // set the list of disabled modules (current list is lost)
  void setDisabledModuleList(std::vector<disabledModuleType> & disabledModules) 
  { theDisabledModules = disabledModules; }

  // add a single module to the vector of disabled modules
  void addDisabledModule(disabledModuleType module)
  { theDisabledModules.push_back(module); }

  // add a vector of modules to the vector of disabled modules
  void addDisabledModule(std::vector<disabledModuleType> & idVector);

  // remove disabled module from the list
  // returns false if id not in disable list, true otherwise
  //  bool removeDisabledModule(const disabledModuleType & module);
  //   bool removeDisabledModule(const uint32_t & detid); 


//--------------- Interface for the user -----------------//
//------- designed to match SiStripQuality methods ----------//
  //method copied from the SiStripQuality
  void add(const SiStripDetVOff*);
  //----------------------------------------
  //number of Bad modules
  int BadModuleNumber();   
  
  bool IsModuleBad(const uint32_t & detid) const;  //returns True if module disabled
  bool IsModuleUsable(const uint32_t& detid) const;  //returns True if module NOT disabled
  bool IsRocBad(const uint32_t& detid, const short& rocNb) const;  //returns True if ROC is disabled
  bool IsAreaBad(uint32_t detid, sipixelobjects::GlobalPixel global,  const edm::EventSetup& es, const SiPixelFedCabling* map ) const;
  short getBadRocs(const uint32_t& detid) const;  //returns bad Rocs for given DetId
  //each bad roc correspond to a bit to 1: num=
  //0 <-> all good rocs
  //1 <-> only roc 0 bad
  //2<-> only roc 1 bad
  //3<->  roc 0 and 1 bad
  // 4 <-> only roc 2 bad
  //...
  const std::vector<disabledModuleType> getBadComponentList() const  //returns list of disabled modules/ROCs
    { return theDisabledModules; }
  const std::vector< LocalPoint > getBadRocPositions(const uint32_t & detid, const TrackerGeometry& theTracker, const SiPixelFedCabling* map ) const; 
    //  const std::vector< std::pair <uint8_t, uint8_t> > getBadRocPositions(const uint32_t & detid,  const edm::EventSetup& es, const SiPixelFedCabling* map ) const; 



 private:
  std::vector<disabledModuleType> theDisabledModules;
  bool IsFedBad(const uint32_t & detid) const; 


 COND_SERIALIZABLE;
}; // class SiPixelQuality


#endif