LAr supercell data are received by the eFEX in a 10-bit multi-linear encoded form. More...

#include <eFEXCompression.h>

Collaboration diagram for LVL1::eFEXCompression:

Static Public Member Functions
static unsigned int	compress (int Et)
	Compress data. More...

static int	expand (unsigned int code)
	Uncompress data. More...

static unsigned int	threshold (unsigned int code, int threshold=-800)
	Apply threshold to compressed data. More...

static bool	noiseCut (unsigned int code, int layer, bool ignoreDisable=false)
	Apply supercell noise cut. More...

static int	decode (int EtVal, int layer, bool ignoreDisable=false)
	Full sequence. More...

Static Public Attributes
static std::atomic< bool >	s_disableNoiseCuts = false

Static Private Attributes
static const int	s_maxET = 144800
	Maximum ET value that can be encoded. More...

static const unsigned int	s_nRanges = 4
	Number of ranges. More...

static const int	s_steps [s_nRanges] = {25, 50, 100, 400}
	Step sizes in each range, MeV. More...

static const int	s_minET [s_nRanges] = {-750, 5600, 18400, 44000}
	Minimum ET values in each range, MeV. More...

static const int	s_minCode [s_nRanges] = {2, 256, 512, 768}
	Minimum code value in each range. More...

static const int	s_NoData = 0
	Indicates no data present. More...

static const unsigned int	s_LArUnderflow = 1
	LAr underflow code. More...

static const unsigned int	s_LArOverflow = 1020
	LAr overflow code. More...

static const unsigned int	s_LArReserved = 1021
	Reserved code value. More...

static const unsigned int	s_LArInvalid = 1022
	Invalid code value. More...

static const unsigned int	s_LArSaturated = 1023
	LAr saturated code. More...

static const unsigned int	s_LArMaxCode = 1023
	Maximum code value. More...

static const unsigned int	s_eFEXstep = 25
	L1Calo ET digit step. More...

static const unsigned int	s_eFEXOverflow = 0xffff
	L1Calo saturated/overflow. More...

static const int	s_error = -999
	Error return value. More...

static const unsigned int	m_noisecutPS = 64
	Noise Cuts per layer. More...

static const unsigned int	m_noisecutL1 = 48

static const unsigned int	m_noisecutL2 = 48

static const unsigned int	m_noisecutL3 = 48

static const unsigned int	m_noisecutHad = 48

Detailed Description

LAr supercell data are received by the eFEX in a 10-bit multi-linear encoded form.

This simple utility class contains 3 functions:

Compress: encodes a signed integer MeV value
Expand: decodes a 10 bit unsigned int into a signed integer MeV value
Threshold: applies a threshold (in MeV) to the compressed code, zeroing if below
NoiseCut: applies a noise cut per layer
Linearize: decodes a 10 bit unsigned int into the unsigned 16 bit eFEX ET with least count of 25 MeV. A user-defined threshold (in MeV) can be applied, but as the eFEX ET is positive a negative threshold is equivalent to a threshold of 0.
Decode: encodes a signed integer MeV value, checks is noise cut is passed, and then decodes a 10 bit unsigned int into the unsigned 16 bit eFEX ET with least count of 25 MeV.

Definition at line 40 of file eFEXCompression.h.

Member Function Documentation

◆ compress()

unsigned int LVL1::eFEXCompression::compress ( int Et )

static

Compress data.

Definition at line 25 of file eFEXCompression.cxx.

                                                {
     if (Et < s_minET[i]) break;
     range = i;
   }
  
   // Calculate code
   unsigned int code = 0;
  
   if (range < 0) {
     // Below minimum value
     code = s_LArUnderflow; 
   }
   else {
     // Lies inside one of the value ranges
     int steps = (Et - s_minET[range])/s_steps[range];
     code = s_minCode[range] + steps;
   }
  
   return code;
 }
  
 int eFEXCompression::expand(unsigned int code) {
  
   // Deal with special codes first:
   if (code == s_NoData)  return 0;

◆ decode()

int LVL1::eFEXCompression::decode	(	int	EtVal,
		int	layer,
		bool	ignoreDisable = `false`
	)

static

Full sequence.

Check if noise cut is passed

Expand the ET value

Convert to eFEX digit scale: 25 MeV

Definition at line 118 of file eFEXCompression.cxx.

                                                           {
     code = tcode;
   }
  
   int Et = eFEXCompression::expand(code);
   
   return Et/s_eFEXstep;
 }
  
 } // end of namespace bracket

◆ expand()

int LVL1::eFEXCompression::expand ( unsigned int code )

static

Uncompress data.

Now expand code into an ET value. Start by finding what range the code is in

Now expand the value

Definition at line 55 of file eFEXCompression.cxx.

                                                  {
     if (code < (unsigned int)s_minCode[i+1]) break;
     range++;
   }
   int Et = s_minET[range] + (code-s_minCode[range])*s_steps[range];
  
   return Et;
 }
  
 bool eFEXCompression::noiseCut(unsigned int code, int layer, bool ignoreDisable) {
     // Check if noise cut is passed - one cut per layer  
     bool pass=true;
  

◆ noiseCut()

bool LVL1::eFEXCompression::noiseCut	(	unsigned int	code,
		int	layer,
		bool	ignoreDisable = `false`
	)

static

Apply supercell noise cut.

Definition at line 76 of file eFEXCompression.cxx.

                  {
     case 0: 
       if(code<m_noisecutPS){ pass = false; }
       break;
     case 1:
       if(code<m_noisecutL1){ pass = false; }
       break;
     case 2:
       if(code<m_noisecutL2){ pass = false; }
       break;
     case 3: 
       if(code<m_noisecutL3){ pass = false; }
       break;
     case 4:
       if(code<m_noisecutHad){ pass = false; }
       break;
     default: 
       pass = false;
       break;
     }
     
     return pass;
 }
  
  
 unsigned int eFEXCompression::threshold(unsigned int code, int threshold) {
  

◆ threshold()

unsigned int LVL1::eFEXCompression::threshold	(	unsigned int	code,
		int	threshold = `-800`
	)

static

Apply threshold to compressed data.

Convert threshold into a compressed code

Zero code if < threshold

Definition at line 107 of file eFEXCompression.cxx.

                                                                     {
  
   // Calculate code
   unsigned int tcode = eFEXCompression::compress(EtVal);

Member Data Documentation

◆ m_noisecutHad

const unsigned int LVL1::eFEXCompression::m_noisecutHad = 48

staticprivate

Definition at line 97 of file eFEXCompression.h.

◆ m_noisecutL1

const unsigned int LVL1::eFEXCompression::m_noisecutL1 = 48

staticprivate

Definition at line 94 of file eFEXCompression.h.

◆ m_noisecutL2

const unsigned int LVL1::eFEXCompression::m_noisecutL2 = 48

staticprivate

Definition at line 95 of file eFEXCompression.h.

◆ m_noisecutL3

const unsigned int LVL1::eFEXCompression::m_noisecutL3 = 48

staticprivate

Definition at line 96 of file eFEXCompression.h.

◆ m_noisecutPS

const unsigned int LVL1::eFEXCompression::m_noisecutPS = 64

staticprivate

Noise Cuts per layer.

Definition at line 93 of file eFEXCompression.h.

◆ s_disableNoiseCuts

std::atomic< bool > LVL1::eFEXCompression::s_disableNoiseCuts = false

static

Definition at line 59 of file eFEXCompression.h.

◆ s_eFEXOverflow

const unsigned int LVL1::eFEXCompression::s_eFEXOverflow = 0xffff

staticprivate

L1Calo saturated/overflow.

Definition at line 89 of file eFEXCompression.h.

◆ s_eFEXstep

const unsigned int LVL1::eFEXCompression::s_eFEXstep = 25

staticprivate

L1Calo ET digit step.

Definition at line 87 of file eFEXCompression.h.

◆ s_error

const int LVL1::eFEXCompression::s_error = -999

staticprivate

Error return value.

Definition at line 91 of file eFEXCompression.h.

◆ s_LArInvalid

const unsigned int LVL1::eFEXCompression::s_LArInvalid = 1022

staticprivate

Invalid code value.

Definition at line 81 of file eFEXCompression.h.

◆ s_LArMaxCode

const unsigned int LVL1::eFEXCompression::s_LArMaxCode = 1023

staticprivate

Maximum code value.

Definition at line 85 of file eFEXCompression.h.

◆ s_LArOverflow

const unsigned int LVL1::eFEXCompression::s_LArOverflow = 1020

staticprivate

LAr overflow code.

Definition at line 77 of file eFEXCompression.h.

◆ s_LArReserved

const unsigned int LVL1::eFEXCompression::s_LArReserved = 1021

staticprivate

Reserved code value.

Definition at line 79 of file eFEXCompression.h.

◆ s_LArSaturated

const unsigned int LVL1::eFEXCompression::s_LArSaturated = 1023

staticprivate

LAr saturated code.

Definition at line 83 of file eFEXCompression.h.

◆ s_LArUnderflow

const unsigned int LVL1::eFEXCompression::s_LArUnderflow = 1

staticprivate

LAr underflow code.

Definition at line 75 of file eFEXCompression.h.

◆ s_maxET

const int LVL1::eFEXCompression::s_maxET = 144800

staticprivate

Maximum ET value that can be encoded.

Definition at line 63 of file eFEXCompression.h.

◆ s_minCode

const int LVL1::eFEXCompression::s_minCode = {2, 256, 512, 768}

staticprivate

Minimum code value in each range.

Definition at line 71 of file eFEXCompression.h.

◆ s_minET

const int LVL1::eFEXCompression::s_minET = {-750, 5600, 18400, 44000}

staticprivate

Minimum ET values in each range, MeV.

Definition at line 69 of file eFEXCompression.h.

◆ s_NoData

const int LVL1::eFEXCompression::s_NoData = 0

staticprivate

Indicates no data present.

Definition at line 73 of file eFEXCompression.h.

◆ s_nRanges

const unsigned int LVL1::eFEXCompression::s_nRanges = 4

staticprivate

Number of ranges.

Definition at line 65 of file eFEXCompression.h.

◆ s_steps

const int LVL1::eFEXCompression::s_steps = {25, 50, 100, 400}

staticprivate

Step sizes in each range, MeV.

Definition at line 67 of file eFEXCompression.h.

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

Static Public Member Functions

Static Public Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ compress()

◆ decode()

◆ expand()

◆ noiseCut()

◆ threshold()

Member Data Documentation

◆ m_noisecutHad

◆ m_noisecutL1

◆ m_noisecutL2

◆ m_noisecutL3

◆ m_noisecutPS

◆ s_disableNoiseCuts

◆ s_eFEXOverflow

◆ s_eFEXstep

◆ s_error

◆ s_LArInvalid

◆ s_LArMaxCode

◆ s_LArOverflow

◆ s_LArReserved

◆ s_LArSaturated

◆ s_LArUnderflow

◆ s_maxET

◆ s_minCode

◆ s_minET

◆ s_NoData

◆ s_nRanges

◆ s_steps