#include <CscRODReadOutV0.h>

Collaboration diagram for CscRODReadOutV0:

Public Member Functions
	CscRODReadOutV0 ()
	~CscRODReadOutV0 ()=default
uint32_t	getHeaderMarker ()
uint32_t	getHeaderSize ()
uint32_t	getFooterSize ()
uint32_t	getFormatVersion ()
double	getSamplingTime ()
double	getStartTime ()
double	getConversion ()
double	getMaxTimeBin ()
uint32_t	getSourceID (uint16_t side, uint16_t rodId)
void	encodeFragments (const uint16_t *amplitude, const uint32_t &address, std::vector< uint32_t > &v) const
void	set (const CscIdHelper *cscHelper)
bool	isBody (const uint32_t fragment) const
bool	isAmplitude (const uint16_t fragment) const
bool	isAddress (const uint32_t fragment) const
void	decodeSourceID (uint32_t sourceId)
void	decodeAmplitude (const uint32_t fragment, int index)
void	decodeAddress (const uint32_t fragment)
Identifier	decodeAddress ()
Identifier	decodeAddress (const Identifier &moduleId)
double	findCharge ()
double	signal_amplitude (double samplingTime) const
uint32_t	address (const Identifier &channelId, int &eta, int &phi) const
uint16_t	sourceID () const
uint16_t	moduleType () const
uint16_t	subDetectorId () const
uint16_t	rodId () const
uint16_t	getAmp1 () const
uint16_t	getAmp2 () const
uint16_t	getAmp3 () const
uint16_t	getAmp4 () const
uint32_t	address () const

Private Member Functions
void	set32bits (const uint16_t *v16, uint32_t &v32) const
double	signal (double z) const

Private Attributes
const CscIdHelper *	m_cscHelper
uint16_t	m_sourceID
uint16_t	m_moduleType
uint16_t	m_rodId
uint16_t	m_subDetectorId
uint16_t	m_amp1
uint16_t	m_amp2
uint16_t	m_amp3
uint16_t	m_amp4
uint32_t	m_address
double	m_norm
double	m_TIME_OFFSET
double	m_SIGNAL_WIDTH
double	m_SAMPLING_TIME
int	m_NUMBER_OF_INTEGRATION
double	m_CHARGE_TO_ADC_COUNT
double	m_Z0

Static Private Attributes
static const uint32_t	ROD_HEADER = 0xEE1234EE
static const uint32_t	ROD_HEADER_SIZE = 0x8
static const uint32_t	ROD_VERSION = 0x00000000
static const uint32_t	ROD_FOOTER_SIZE = 0x3
static const uint16_t	SOURCE_ID = 0x00
static const uint16_t	MODULE_TYPE = 0x00
static const uint16_t	BODY_AMPLITUDE = 0x000A
static const uint32_t	BODY_ADDRESS = 0x0000000C

Detailed Description

Definition at line 19 of file CscRODReadOutV0.h.

Constructor & Destructor Documentation

◆ CscRODReadOutV0()

CscRODReadOutV0::CscRODReadOutV0 ( )

Definition at line 9 of file CscRODReadOutV0.cxx.

                                 :
    m_cscHelper(nullptr),
    m_sourceID(0),
    m_moduleType(0),
    m_rodId(0),
    m_subDetectorId(0),
    m_amp1(0),
    m_amp2(0),
    m_amp3(0),
    m_amp4(0),
    m_address(0) {
    m_TIME_OFFSET = 46.825;  // ns
    m_SIGNAL_WIDTH = 16.08;  // ns
    m_SAMPLING_TIME = 50.0;  // ns
    m_Z0 = 9.394;            // time bin at the maximum
                             // obtained by setting the derivative = 0
                             // this gives 2 solutions: Z0=9.394 and 16.606
                             // 9.394 is for positive amplitude
 
    m_NUMBER_OF_INTEGRATION = 12;
 
    // conversion factor from ee charge to ADC count
    // assuming for now 1 ADC count = 0.32 femtoCoulomb!
 
    /* From Valeri Tcherniatine --- April 11, 2004
      conversion= ( e*G*k*m*d*1.6e-19)/2000
      e=75 - average number ionization e in CSC
      G=10^5 - gas gain
      k=0.15 - factor taking to account electronic time integration (charge
      deficit) and only one cathode readout
      m=0.5 - part of induce charge contained in max. strip
      d=7 - value of dynamic range expressed in average particle ionization
      deposition in CSC. At this value (7) out of region inefficiency is <2%.
      1.6e-19 - e charge
      2000 - max. ADC counts for positive part of signal
      Collect all numbers together conversion = 0.32 femtoCoulomb per ADC count
    */
 
    m_CHARGE_TO_ADC_COUNT = (0.32e-15) / (1.602e-19);
    m_norm = signal(m_Z0);
}

◆ ~CscRODReadOutV0()

CscRODReadOutV0::~CscRODReadOutV0 ( )

default

Member Function Documentation

◆ address() [1/2]

uint32_t CscRODReadOutV0::address ( ) const

inline

Definition at line 65 of file CscRODReadOutV0.h.

65{ return m_address; }

◆ address() [2/2]

uint32_t CscRODReadOutV0::address	(	const Identifier &	channelId,
		int &	eta,
		int &	phi ) const

inline

Definition at line 178 of file CscRODReadOutV0.h.

                                                                                              {
    // unpack the strip identifier
    int name = m_cscHelper->stationName(channelId);
    eta = m_cscHelper->stationEta(channelId);
    phi = m_cscHelper->stationPhi(channelId);
    int chamberLayer = m_cscHelper->chamberLayer(channelId);
    int wireLayer = m_cscHelper->wireLayer(channelId);
    int orientation = m_cscHelper->measuresPhi(channelId);
    int strip = m_cscHelper->strip(channelId);
 
    // redefine the ranges
    uint32_t nameIndex = uint32_t(name - 50);
    uint32_t etaIndex = (eta == -1) ? 0 : 1;
    uint32_t phiIndex = uint32_t(phi - 1);
    uint32_t chamberIndex = uint32_t(chamberLayer - 1);
    uint32_t layerIndex = uint32_t(wireLayer - 1);
    uint32_t stripType = uint32_t(orientation);
    uint32_t stripNumber = uint32_t(strip);
 
    // build the address
    uint32_t address =
        nameIndex << 17 | etaIndex << 16 | phiIndex << 13 | chamberIndex << 12 | layerIndex << 9 | stripType << 8 | stripNumber;
 
    return address;
}

◆ decodeAddress() [1/3]

Identifier CscRODReadOutV0::decodeAddress ( )

inline

Definition at line 148 of file CscRODReadOutV0.h.

                                                 {
    int stationName = ((m_address & 0x00020000) >> 17) + 50;
    int stationEta = (((m_address & 0x00010000) >> 16) == 0x0) ? -1 : 1;
    int stationPhi = ((m_address & 0x0000E000) >> 13) + 1;
 
    return m_cscHelper->elementID(stationName, stationEta, stationPhi);
}

◆ decodeAddress() [2/3]

Identifier CscRODReadOutV0::decodeAddress ( const Identifier & moduleId )

inline

Definition at line 156 of file CscRODReadOutV0.h.

                                                                           {
    int chamberLayer = ((m_address & 0x00001000) >> 12) + 1;
    int wireLayer = ((m_address & 0x00000E00) >> 9) + 1;
    int measuresPhi = ((m_address & 0x00000100) >> 8);
    int strip = (m_address & 0x000000FF);
    return m_cscHelper->channelID(moduleId, chamberLayer, wireLayer, measuresPhi, strip);
}

◆ decodeAddress() [3/3]

void CscRODReadOutV0::decodeAddress ( const uint32_t fragment )

inline

Definition at line 146 of file CscRODReadOutV0.h.

146{ m_address = 0x0003FFFF & fragment; }

◆ decodeAmplitude()

void CscRODReadOutV0::decodeAmplitude	(	const uint32_t	fragment,
		int	index )

inline

Definition at line 132 of file CscRODReadOutV0.h.

                                                                               {
    uint32_t amp1 = 0;
    uint32_t amp2 = 0;
    amp1 = 0x0000FFFF & fragment;
    amp2 = (0xFFFF0000 & fragment) >> 16;
    if (index == 1) {
        m_amp1 = 0x0FFF & amp1;
        m_amp2 = 0x0FFF & amp2;
    } else {
        m_amp3 = 0x0FFF & amp1;
        m_amp4 = 0x0FFF & amp2;
    }
}

◆ decodeSourceID()

void CscRODReadOutV0::decodeSourceID ( uint32_t sourceId )

inline

Definition at line 108 of file CscRODReadOutV0.h.

                                                             {
    m_sourceID = (sourceID & 0xff000000) >> 24;
    m_moduleType = (sourceID & 0x00ff0000) >> 16;
    m_subDetectorId = (sourceID & 0x0000ff00) >> 8;
    m_rodId = (sourceID & 0x000000ff);
}

◆ encodeFragments()

void CscRODReadOutV0::encodeFragments	(	const uint16_t *	amplitude,
		const uint32_t &	address,
		std::vector< uint32_t > &	v ) const

Definition at line 54 of file CscRODReadOutV0.cxx.

                                                                                                                      {
    uint16_t amp[2] = {0, 0};
    uint32_t v32 = 0;
 
    for (int i = 0; i < 2; i++) amp[i] = (BODY_AMPLITUDE << 12) | *(amplitude + i);
    set32bits(amp, v32);
    v[0] = v32;
    v32 = 0;
    for (int i = 2; i < 4; i++) amp[i - 2] = (BODY_AMPLITUDE << 12) | *(amplitude + i);
    set32bits(amp, v32);
    v[1] = v32;
 
    v[2] = (BODY_ADDRESS << 28) | address;
}

◆ findCharge()

double CscRODReadOutV0::findCharge ( )

Definition at line 69 of file CscRODReadOutV0.cxx.

                                   {
    const int N_SAMPLE = 4;
 
    // the sampling times
    double time[N_SAMPLE];
    for (int i = 0; i < N_SAMPLE; i++) time[i] = (i + 1) * m_SAMPLING_TIME + m_TIME_OFFSET;
 
    // the corresponding amplitudes
    uint16_t amp[N_SAMPLE];
    amp[0] = m_amp1;
    amp[1] = m_amp2;
    amp[2] = m_amp3;
    amp[3] = m_amp4;
 
    // to be replaced by a fitting procedure
    double adcCount = 0.0;
    int n = 0;
    for (int i = 0; i < N_SAMPLE; i++) {
        if (auto amplitude = signal_amplitude(time[i]); amplitude !=0){
           //coverity[DIVIDE_BY_ZERO:FALSE]
           adcCount = adcCount + amp[i] / amplitude;
        } else {
          continue;
        }
        if (amp[i] > 0) n++;
    }
    if (n == 0)[[unlikely]]{
      throw std::runtime_error("CscRODReadOutV0::findCharge: denominator 'n' is zero.");
    }
    adcCount = adcCount / n;
 
    return adcCount;
}

◆ getAmp1()

uint16_t CscRODReadOutV0::getAmp1 ( ) const

inline

Definition at line 61 of file CscRODReadOutV0.h.

61{ return m_amp1; }

◆ getAmp2()

uint16_t CscRODReadOutV0::getAmp2 ( ) const

inline

Definition at line 62 of file CscRODReadOutV0.h.

62{ return m_amp2; }

◆ getAmp3()

uint16_t CscRODReadOutV0::getAmp3 ( ) const

inline

Definition at line 63 of file CscRODReadOutV0.h.

63{ return m_amp3; }

◆ getAmp4()

uint16_t CscRODReadOutV0::getAmp4 ( ) const

inline

Definition at line 64 of file CscRODReadOutV0.h.

64{ return m_amp4; }

◆ getConversion()

double CscRODReadOutV0::getConversion ( )

inline

Definition at line 31 of file CscRODReadOutV0.h.

31{ return m_CHARGE_TO_ADC_COUNT; }

◆ getFooterSize()

uint32_t CscRODReadOutV0::getFooterSize ( )

inline

Definition at line 27 of file CscRODReadOutV0.h.

27{ return ROD_FOOTER_SIZE; }

CscRODReadOutV0::ROD_FOOTER_SIZE

static const uint32_t ROD_FOOTER_SIZE

Definition CscRODReadOutV0.h:90

◆ getFormatVersion()

uint32_t CscRODReadOutV0::getFormatVersion ( )

inline

Definition at line 28 of file CscRODReadOutV0.h.

28{ return ROD_VERSION; }

CscRODReadOutV0::ROD_VERSION

static const uint32_t ROD_VERSION

Definition CscRODReadOutV0.h:89

◆ getHeaderMarker()

uint32_t CscRODReadOutV0::getHeaderMarker ( )

inline

Definition at line 25 of file CscRODReadOutV0.h.

25{ return ROD_HEADER; }

CscRODReadOutV0::ROD_HEADER

static const uint32_t ROD_HEADER

Definition CscRODReadOutV0.h:87

◆ getHeaderSize()

uint32_t CscRODReadOutV0::getHeaderSize ( )

inline

Definition at line 26 of file CscRODReadOutV0.h.

26{ return ROD_HEADER_SIZE; }

CscRODReadOutV0::ROD_HEADER_SIZE

static const uint32_t ROD_HEADER_SIZE

Definition CscRODReadOutV0.h:88

◆ getMaxTimeBin()

double CscRODReadOutV0::getMaxTimeBin ( )

inline

Definition at line 32 of file CscRODReadOutV0.h.

32{ return m_Z0; }

◆ getSamplingTime()

double CscRODReadOutV0::getSamplingTime ( )

inline

Definition at line 29 of file CscRODReadOutV0.h.

29{ return m_SAMPLING_TIME; }

◆ getSourceID()

uint32_t CscRODReadOutV0::getSourceID	(	uint16_t	side,
		uint16_t	rodId )

inline

Definition at line 102 of file CscRODReadOutV0.h.

                                                                          {
    uint32_t sourceIdentifier = 0;
    sourceIdentifier = SOURCE_ID << 24 | MODULE_TYPE << 16 | side << 8 | rodId;
    return sourceIdentifier;
}

◆ getStartTime()

double CscRODReadOutV0::getStartTime ( )

inline

Definition at line 30 of file CscRODReadOutV0.h.

30{ return m_TIME_OFFSET; }

◆ isAddress()

bool CscRODReadOutV0::isAddress ( const uint32_t fragment ) const

inline

Definition at line 130 of file CscRODReadOutV0.h.

130{ return (0xC0000000 & fragment); }

◆ isAmplitude()

bool CscRODReadOutV0::isAmplitude ( const uint16_t fragment ) const

inline

Definition at line 128 of file CscRODReadOutV0.h.

128{ return (0xA000 & fragment); }

◆ isBody()

bool CscRODReadOutV0::isBody ( const uint32_t fragment ) const

inline

Definition at line 126 of file CscRODReadOutV0.h.

126{ return (0x80000000 & fragment); }

◆ moduleType()

uint16_t CscRODReadOutV0::moduleType ( ) const

inline

Definition at line 58 of file CscRODReadOutV0.h.

58{ return m_moduleType; }

◆ rodId()

uint16_t CscRODReadOutV0::rodId ( ) const

inline

Definition at line 60 of file CscRODReadOutV0.h.

60{ return m_rodId; }

◆ set()

void CscRODReadOutV0::set ( const CscIdHelper * cscHelper )

inline

Definition at line 39 of file CscRODReadOutV0.h.

39{ m_cscHelper = cscHelper; }

◆ set32bits()

void CscRODReadOutV0::set32bits	(	const uint16_t *	v16,
		uint32_t &	v32 ) const

inlineprivate

Definition at line 115 of file CscRODReadOutV0.h.

                                                                               {
    uint32_t p = 0, v = 0;
    uint16_t n = 2;
    uint16_t pos[] = {0, 16};
    for (uint16_t i = 0; i < n; i++) {
        v = (uint32_t)(*(v16 + i));
        p = (uint32_t)(*(pos + i));
        v32 = v32 | (v << p);
    }
}

◆ signal()

double CscRODReadOutV0::signal ( double z ) const

inlineprivate

Definition at line 172 of file CscRODReadOutV0.h.

                                                    {
    double amplitude = (1.0 - z / (1 + m_NUMBER_OF_INTEGRATION)) * std::pow(z, m_NUMBER_OF_INTEGRATION) * std::exp(-z);
    return amplitude;
}

◆ signal_amplitude()

double CscRODReadOutV0::signal_amplitude ( double samplingTime ) const

inline

Definition at line 165 of file CscRODReadOutV0.h.

                                                                         {
    if (samplingTime <= m_TIME_OFFSET) return 0.0;
    double z = (samplingTime - m_TIME_OFFSET) / m_SIGNAL_WIDTH;
    return signal(z) / m_norm;
}

◆ sourceID()

uint16_t CscRODReadOutV0::sourceID ( ) const

inline

Definition at line 57 of file CscRODReadOutV0.h.

57{ return m_sourceID; }

◆ subDetectorId()

uint16_t CscRODReadOutV0::subDetectorId ( ) const

inline

Definition at line 59 of file CscRODReadOutV0.h.

59{ return m_subDetectorId; }

Member Data Documentation

◆ BODY_ADDRESS

const uint32_t CscRODReadOutV0::BODY_ADDRESS = 0x0000000C

staticprivate

Definition at line 96 of file CscRODReadOutV0.h.

◆ BODY_AMPLITUDE

const uint16_t CscRODReadOutV0::BODY_AMPLITUDE = 0x000A

staticprivate

Definition at line 95 of file CscRODReadOutV0.h.

◆ m_address

uint32_t CscRODReadOutV0::m_address

private

Definition at line 77 of file CscRODReadOutV0.h.

◆ m_amp1

uint16_t CscRODReadOutV0::m_amp1

private

Definition at line 73 of file CscRODReadOutV0.h.

◆ m_amp2

uint16_t CscRODReadOutV0::m_amp2

private

Definition at line 74 of file CscRODReadOutV0.h.

◆ m_amp3

uint16_t CscRODReadOutV0::m_amp3

private

Definition at line 75 of file CscRODReadOutV0.h.

◆ m_amp4

uint16_t CscRODReadOutV0::m_amp4

private

Definition at line 76 of file CscRODReadOutV0.h.

◆ m_CHARGE_TO_ADC_COUNT

double CscRODReadOutV0::m_CHARGE_TO_ADC_COUNT

private

Definition at line 84 of file CscRODReadOutV0.h.

◆ m_cscHelper

const CscIdHelper* CscRODReadOutV0::m_cscHelper

private

Definition at line 68 of file CscRODReadOutV0.h.

◆ m_moduleType

uint16_t CscRODReadOutV0::m_moduleType

private

Definition at line 70 of file CscRODReadOutV0.h.

◆ m_norm

double CscRODReadOutV0::m_norm

private

Definition at line 78 of file CscRODReadOutV0.h.

◆ m_NUMBER_OF_INTEGRATION

int CscRODReadOutV0::m_NUMBER_OF_INTEGRATION

private

Definition at line 83 of file CscRODReadOutV0.h.

◆ m_rodId

uint16_t CscRODReadOutV0::m_rodId

private

Definition at line 71 of file CscRODReadOutV0.h.

◆ m_SAMPLING_TIME

double CscRODReadOutV0::m_SAMPLING_TIME

private

Definition at line 82 of file CscRODReadOutV0.h.

◆ m_SIGNAL_WIDTH

double CscRODReadOutV0::m_SIGNAL_WIDTH

private

Definition at line 81 of file CscRODReadOutV0.h.

◆ m_sourceID

uint16_t CscRODReadOutV0::m_sourceID

private

Definition at line 69 of file CscRODReadOutV0.h.

◆ m_subDetectorId

uint16_t CscRODReadOutV0::m_subDetectorId

private

Definition at line 72 of file CscRODReadOutV0.h.

◆ m_TIME_OFFSET

double CscRODReadOutV0::m_TIME_OFFSET

private

Definition at line 80 of file CscRODReadOutV0.h.

◆ m_Z0

double CscRODReadOutV0::m_Z0

private

Definition at line 85 of file CscRODReadOutV0.h.

◆ MODULE_TYPE

const uint16_t CscRODReadOutV0::MODULE_TYPE = 0x00

staticprivate

Definition at line 93 of file CscRODReadOutV0.h.

◆ ROD_FOOTER_SIZE

const uint32_t CscRODReadOutV0::ROD_FOOTER_SIZE = 0x3

staticprivate

Definition at line 90 of file CscRODReadOutV0.h.

◆ ROD_HEADER

const uint32_t CscRODReadOutV0::ROD_HEADER = 0xEE1234EE

staticprivate

Definition at line 87 of file CscRODReadOutV0.h.

◆ ROD_HEADER_SIZE

const uint32_t CscRODReadOutV0::ROD_HEADER_SIZE = 0x8

staticprivate

Definition at line 88 of file CscRODReadOutV0.h.

◆ ROD_VERSION

const uint32_t CscRODReadOutV0::ROD_VERSION = 0x00000000

staticprivate

Definition at line 89 of file CscRODReadOutV0.h.

◆ SOURCE_ID

const uint16_t CscRODReadOutV0::SOURCE_ID = 0x00

staticprivate

Definition at line 92 of file CscRODReadOutV0.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CscRODReadOutV0()

◆ ~CscRODReadOutV0()

Member Function Documentation

◆ address() [1/2]

◆ address() [2/2]

◆ decodeAddress() [1/3]

◆ decodeAddress() [2/3]

◆ decodeAddress() [3/3]

◆ decodeAmplitude()

◆ decodeSourceID()

◆ encodeFragments()

◆ findCharge()

◆ getAmp1()

◆ getAmp2()

◆ getAmp3()

◆ getAmp4()

◆ getConversion()

◆ getFooterSize()

◆ getFormatVersion()

◆ getHeaderMarker()

◆ getHeaderSize()

◆ getMaxTimeBin()

◆ getSamplingTime()

◆ getSourceID()

◆ getStartTime()

◆ isAddress()

◆ isAmplitude()

◆ isBody()

◆ moduleType()

◆ rodId()

◆ set()

◆ set32bits()

◆ signal()

◆ signal_amplitude()

◆ sourceID()

◆ subDetectorId()

Member Data Documentation

◆ BODY_ADDRESS

◆ BODY_AMPLITUDE

◆ m_address

◆ m_amp1

◆ m_amp2

◆ m_amp3

◆ m_amp4

◆ m_CHARGE_TO_ADC_COUNT

◆ m_cscHelper

◆ m_moduleType

◆ m_norm

◆ m_NUMBER_OF_INTEGRATION

◆ m_rodId

◆ m_SAMPLING_TIME

◆ m_SIGNAL_WIDTH

◆ m_sourceID

◆ m_subDetectorId

◆ m_TIME_OFFSET

◆ m_Z0

◆ MODULE_TYPE

◆ ROD_FOOTER_SIZE

◆ ROD_HEADER

◆ ROD_HEADER_SIZE

◆ ROD_VERSION

◆ SOURCE_ID