python.DQUtilities.IDBSDefectEncoding Class Reference

Collaboration diagram for python.DQUtilities.IDBSDefectEncoding:

Public Member Functions
def	defectToInt (cls, defect)
def	defectListToInt (cls, defects)
def	intToDefectList (cls, dint)

Static Public Attributes
list	defectBitPos

Detailed Description

Class to enocode and decode IDBS defects.  No instances fo this class can be instanciated
and it bascially just acts as a poor man's namespace (should really be a module)

Definition at line 349 of file DQUtilities.py.

Member Function Documentation

defectListToInt()

def python.DQUtilities.IDBSDefectEncoding.defectListToInt	(		cls,
			defects
	)

Encode list of defects as an int.  If no defect (empty list) returns 0 for bakcward compatibility

Definition at line 368 of file DQUtilities.py.

    def defectListToInt(cls, defects):
        """Encode list of defects as an int.  If no defect (empty list) returns 0 for bakcward compatibility"""
        return sum([cls.defectToInt(d) for d in defects])
 

defectToInt()

def python.DQUtilities.IDBSDefectEncoding.defectToInt	(		cls,
			defect
	)

Encode defect as an int.  If defect is unknown raise error

Definition at line 359 of file DQUtilities.py.

    def defectToInt(cls, defect):
        """Encode defect as an int.  If defect is unknown raise error"""
 
        if defect not in IDBSDefectEncoding.defectBitPos:
            raise DefectError ('ERROR: Unknown defect %s encountered' % defect)
 
        return (1 << IDBSDefectEncoding.defectBitPos.index(defect))
 

intToDefectList()

def python.DQUtilities.IDBSDefectEncoding.intToDefectList	(		cls,
			dint
	)

Decode int as list of defects.  Raise error if unkown defect encountered

Definition at line 373 of file DQUtilities.py.

    def intToDefectList(cls, dint):
        """Decode int as list of defects.  Raise error if unkown defect encountered"""
 
        # Convert int to binary string with correct endianess 
        binStr  = bin(dint)[2:][::-1]
 
        if len(binStr) > len(IDBSDefectEncoding.defectBitPos):
            raise DefectError ("ERROR: integer %s out of range" % dint)
 
        # If dint is odd then has the unknown bit set
        if bool(dint & 1):
            raise DefectError ('ERROR: Unknown defect encountered')
 
        return [d[0] for d in zip(IDBSDefectEncoding.defectBitPos,binStr) if d[1]=='1']

Member Data Documentation

defectBitPos

list python.DQUtilities.IDBSDefectEncoding.defectBitPos

static

Initial value:

=  ['UNKNOWN', 'ID_BS_2010YELLOW', 'ID_BS_RUNAVERAGE', 'ID_BS_PARAMETERSTEP',
                      'ID_BS_NOBEAMSPOT', 'ID_BS_2010RED', 'LUMI_VDM']

Definition at line 355 of file DQUtilities.py.

---

The documentation for this class was generated from the following file:

• DQUtilities.py