This class maps FEB IDs to/from COOL channel ids. More...

#include <LArCondFEBIdChanMap.h>

Collaboration diagram for LArCondFEBIdChanMap:

Public Types
enum	CorrectionType { Original = 0 , PSBA = 1001 , PSBC = 1002 , PSECA = 1003 , PSECC = 1004 , EMBA = 1005 , EMBC = 1006 , EMECA = 1007 , EMECC = 1008 , HECA = 1009 , HECC = 1010 , FCALA = 1011 , FCALC = 1012 , NCORRTYPE = 12 }
	Correction type. More...
typedef unsigned int	FEBId
	Public typedefs.
typedef std::vector< FEBId >	FEBIdVector
typedef std::vector< FEBIdVector >	ChannelMap
typedef std::map< FEBId, unsigned int >	FEBIdMap

Public Member Functions
	LArCondFEBIdChanMap ()
	Default constructor.
	LArCondFEBIdChanMap (unsigned int nChanPerGain, unsigned int minGain, unsigned int nGain)
	Constructor defining the number of channels per gain, min gain value, and the number of gain values.
virtual	~LArCondFEBIdChanMap ()=default
	destructor
const FEBIdVector &	febIdVector (unsigned int gain, unsigned int coolChannel) const
	Access to a FEB ID vector for a given gain and COOL channel.
bool	getChannel (FEBId febId, unsigned int gain, unsigned int &coolChannel) const
	Access to the cool channel number for a given FEB ID and gain - bool == false if not found.
bool	getCorrectionSetChannels (unsigned int gain, std::vector< unsigned int > &coolChannels) const
	Access to the cool channel numbers for the correction sets of a particular gain - bool == false if not found.
unsigned int	nGroups () const
	Number of groups - minimum is 2 (1 correction group, 1 FEB ID group)
unsigned int	groupNumber (unsigned int coolChannel) const
	Group number of a cool channel (0 - correction group, 1-N for FEB ID groups)
unsigned int	channelsPerGain () const
	Number of cool channels per gain.
unsigned int	minGain () const
	Mininum gain value.
unsigned int	nGains () const
	Number of gain values.
unsigned int	nOffsetChannels () const
	Number of offset channels - i.e. correction channels.
unsigned int	totalChannels () const
	Total number of channels for all gains and includes special offset channels.
void	addFEBIdVector (unsigned int channel, const FEBIdVector &febIdVec)
	Add in a FEBIdVector - channel number should be from 0 to NChannelsPerGain-1.
void	dump (std::ostream &o, const LArOnlineID *onlineID=NULL) const

Private Types
enum	ChanMapOffets { NUMOFFSETCHANNELSPERGAIN = 1 , CORRECTIONSETCHANNEL = 0 }
	Offsets for the special channels. More...

Private Member Functions
void	fillMap (unsigned int channel, const FEBIdVector &febIdVec)
	Fill map from chan/febid vec - channel here is 0 to chansPerGain-1.

Private Attributes
ChannelMap	m_febIdVecs
	File map from existing ChannelMap - e.g. on read back.
FEBIdMap	m_channelMap
unsigned int	m_chansPerGain
unsigned int	m_totalChannels
unsigned int	m_minGain
unsigned int	m_maxGain
unsigned int	m_nGains
unsigned int	m_numOffsetChannels
FEBIdVector	m_empty

Detailed Description

This class maps FEB IDs to/from COOL channel ids.

This class is needed to store LAr conditions data into multiple channels in COOL. Each COOL channel will correspond to a subset of the FEB ids, and this class allows to lookup in either direction.

The COOL channel mapping works as follows: there are N groups of FEB IDs which are each mapped into a different channel. Then the overall channel mapping has:

ngain special channels to store the correction subsets for each gain N*ngain channels for each FEB ID group, repeated for each of the possible gains

One may identify which channels belong to the same group via the "group number". Here 0 signifies the corrections group and 1 to N for each of the groups of FEB IDs.

Note that the default is have all FEB IDs with in a single group

Definition at line 48 of file LArCondFEBIdChanMap.h.

Member Typedef Documentation

◆ ChannelMap

typedef std::vector<FEBIdVector> LArCondFEBIdChanMap::ChannelMap

Definition at line 55 of file LArCondFEBIdChanMap.h.

◆ FEBId

typedef unsigned int LArCondFEBIdChanMap::FEBId

Public typedefs.

Definition at line 53 of file LArCondFEBIdChanMap.h.

◆ FEBIdMap

typedef std::map<FEBId, unsigned int> LArCondFEBIdChanMap::FEBIdMap

Definition at line 56 of file LArCondFEBIdChanMap.h.

◆ FEBIdVector

typedef std::vector<FEBId> LArCondFEBIdChanMap::FEBIdVector

Definition at line 54 of file LArCondFEBIdChanMap.h.

Member Enumeration Documentation

◆ ChanMapOffets

enum LArCondFEBIdChanMap::ChanMapOffets

private

Offsets for the special channels.

Enumerator
NUMOFFSETCHANNELSPERGAIN
CORRECTIONSETCHANNEL

Definition at line 139 of file LArCondFEBIdChanMap.h.

                       {
    NUMOFFSETCHANNELSPERGAIN    = 1, // Number of special channels per gain
    CORRECTIONSETCHANNEL        = 0  // Channel for the correction sets
    };

◆ CorrectionType

enum LArCondFEBIdChanMap::CorrectionType

Correction type.

Enumerator
Original
PSBA
PSBC
PSECA
PSECC
EMBA
EMBC
EMECA
EMECC
HECA
HECC
FCALA
FCALC
NCORRTYPE

Definition at line 59 of file LArCondFEBIdChanMap.h.

                        {
        Original      = 0,
        PSBA          = 1001,
        PSBC          = 1002,
        PSECA         = 1003,
        PSECC         = 1004,
        EMBA          = 1005,
        EMBC          = 1006,
        EMECA         = 1007,
        EMECC         = 1008,
        HECA          = 1009,
        HECC          = 1010,
        FCALA         = 1011,
        FCALC         = 1012,
        NCORRTYPE     = 12
    };

Constructor & Destructor Documentation

◆ LArCondFEBIdChanMap() [1/2]

LArCondFEBIdChanMap::LArCondFEBIdChanMap ( )

inline

Default constructor.

Definition at line 167 of file LArCondFEBIdChanMap.h.

    :
    m_febIdVecs(1),
    m_chansPerGain(1),
    m_totalChannels(PSBA + 3*NCORRTYPE),
    m_minGain(0),
    m_maxGain(2),
    m_nGains(3),
    m_numOffsetChannels(3)
 
 
{}

◆ LArCondFEBIdChanMap() [2/2]

LArCondFEBIdChanMap::LArCondFEBIdChanMap	(	unsigned int	nChanPerGain,
		unsigned int	minGain,
		unsigned int	nGain )

inline

Constructor defining the number of channels per gain, min gain value, and the number of gain values.

nchannels input should NOT include the special offset channels

Definition at line 181 of file LArCondFEBIdChanMap.h.

    :
    m_febIdVecs(chansPerGain),
    m_chansPerGain(chansPerGain),
    m_totalChannels(PSBA + 3*NCORRTYPE),
    m_minGain(minGain),
    m_maxGain(minGain + nGains),
    m_nGains(nGains),
    m_numOffsetChannels(nGains*NUMOFFSETCHANNELSPERGAIN)
 
{}

◆ ~LArCondFEBIdChanMap()

virtual LArCondFEBIdChanMap::~LArCondFEBIdChanMap ( )

virtualdefault

destructor

Member Function Documentation

◆ addFEBIdVector()

void LArCondFEBIdChanMap::addFEBIdVector	(	unsigned int	channel,
		const FEBIdVector &	febIdVec )

inline

Add in a FEBIdVector - channel number should be from 0 to NChannelsPerGain-1.

Definition at line 344 of file LArCondFEBIdChanMap.h.

{
    // Make sure vector is large enough - should have been sized in
    // constructor!! 
    if (channel >= m_chansPerGain) m_febIdVecs.resize(channel + 1);
    m_febIdVecs[channel] = febIdVec; 
    fillMap(channel, febIdVec);
}

◆ channelsPerGain()

unsigned int LArCondFEBIdChanMap::channelsPerGain ( ) const

inline

Number of cool channels per gain.

Definition at line 308 of file LArCondFEBIdChanMap.h.

{
    return (m_chansPerGain);
}

◆ dump()

void LArCondFEBIdChanMap::dump	(	std::ostream &	o,
		const LArOnlineID *	onlineID = NULL ) const

Definition at line 7 of file LArCondFEBIdChanMap.cxx.

                                                                                 {
 
  //FEBIdMap::const_iterator itmap->
  //ChannelMap::const_iterator itmap=m_febIdVecs->begin();
  //ChannelMap::const_iterator itmap_e=m_febIdVecs->end();
  for (unsigned int iCoolChannel=0;iCoolChannel<m_febIdVecs.size();iCoolChannel++) {
    out << "Cool Channel #:" << std::setw(3) << iCoolChannel << " FEB id:"  <<  std::endl;
    const FEBIdVector& febIdVec=m_febIdVecs[iCoolChannel];
    FEBIdVector::const_iterator it=febIdVec.begin();
    FEBIdVector::const_iterator it_e=febIdVec.end();
    for (;it!=it_e;++it) {
      out << "                   " << (*it) << "(0x" << std::hex << *it << std::dec << ")";
      if (onlineID) {
    const HWIdentifier hwid((*it));
    int barrel_ec = onlineID->barrel_ec(hwid);
    std::string bc;
    if (barrel_ec==0)
      bc="Barrel";
    else if (barrel_ec==1)
      bc="Endcap";
    else
      bc="unknown";
    
    int pos_neg   = onlineID->pos_neg(hwid);
    std::string pn;
    if (pos_neg==0) 
      pn="C-Side";
    else if (pos_neg==1) 
      pn="A-Side";
    else
      pn="unknown";
    int FT        = onlineID->feedthrough(hwid);
    int slot      = onlineID->slot(hwid);
    out << " (" << bc << "/" << pn << "/FT=" << FT << "/Slot=" << slot << ")";
      }
      out << std::endl;
    }
    out << std::endl;
  }
  out.flush();
}

◆ febIdVector()

const LArCondFEBIdChanMap::FEBIdVector & LArCondFEBIdChanMap::febIdVector	(	unsigned int	gain,
		unsigned int	coolChannel ) const

inline

Access to a FEB ID vector for a given gain and COOL channel.

Definition at line 226 of file LArCondFEBIdChanMap.h.

{
 
    unsigned int channel = m_chansPerGain;
    if (coolChannel >= (gain - m_minGain)*m_chansPerGain + m_numOffsetChannels) {
    channel =  coolChannel - (gain - m_minGain)*m_chansPerGain - m_numOffsetChannels;
    }
    if (channel < m_chansPerGain) {
    return (m_febIdVecs[channel]);
    }
    return (m_empty);
}

◆ fillMap()

void LArCondFEBIdChanMap::fillMap	(	unsigned int	channel,
		const FEBIdVector &	febIdVec )

inlineprivate

Fill map from chan/febid vec - channel here is 0 to chansPerGain-1.

Definition at line 197 of file LArCondFEBIdChanMap.h.

{
    // add channel to map for each feb id
    for (unsigned int i = 0; i < febIdVec.size(); ++i) {
    m_channelMap[febIdVec[i]] = channel;
    }
}

◆ getChannel()

bool LArCondFEBIdChanMap::getChannel	(	FEBId	febId,
		unsigned int	gain,
		unsigned int &	coolChannel ) const

inline

Access to the cool channel number for a given FEB ID and gain - bool == false if not found.

Definition at line 241 of file LArCondFEBIdChanMap.h.

{
    if (1 == m_chansPerGain) {
    // All FEB IDs in the same group
    coolChannel = (gain - m_minGain) + m_numOffsetChannels;
    return (true);
    }
    coolChannel = 9999;
    FEBIdMap::const_iterator it = m_channelMap.find(febId);
    if (it != m_channelMap.end()) {
    if (m_minGain <= gain && gain <= m_maxGain) {
        coolChannel = (gain - m_minGain)*m_chansPerGain + (*it).second + m_numOffsetChannels;
        return (true);
    }
    }
    return (false);
}

◆ getCorrectionSetChannels()

bool LArCondFEBIdChanMap::getCorrectionSetChannels	(	unsigned int	gain,
		std::vector< unsigned int > &	coolChannels ) const

inline

Access to the cool channel numbers for the correction sets of a particular gain - bool == false if not found.

Definition at line 263 of file LArCondFEBIdChanMap.h.

{
    coolChannels.clear();
    if (m_minGain <= gain && gain <= m_maxGain) {
        coolChannels.reserve(1 + NCORRTYPE);
        // loop over all correction types, including the "old" first
        // one which included everything 
    coolChannels.push_back( (gain - m_minGain) + CORRECTIONSETCHANNEL);
        unsigned int gainOffset = (gain - m_minGain)*NCORRTYPE;
    coolChannels.push_back(PSBA  + gainOffset);
        coolChannels.push_back(PSBC  + gainOffset);
        coolChannels.push_back(PSECA + gainOffset);
        coolChannels.push_back(PSECC + gainOffset);
        coolChannels.push_back(EMBA  + gainOffset);
        coolChannels.push_back(EMBC  + gainOffset);
        coolChannels.push_back(EMECA + gainOffset);
        coolChannels.push_back(EMECC + gainOffset);
        coolChannels.push_back(HECA  + gainOffset);
        coolChannels.push_back(HECC  + gainOffset);
        coolChannels.push_back(FCALA + gainOffset);
        coolChannels.push_back(FCALC + gainOffset);
    return (true);
    }
    return (false);
}

◆ groupNumber()

unsigned int LArCondFEBIdChanMap::groupNumber ( unsigned int coolChannel ) const

inline

Group number of a cool channel (0 - correction group, 1-N for FEB ID groups)

Definition at line 300 of file LArCondFEBIdChanMap.h.

{
    return (coolChannel/m_nGains);
}

◆ minGain()

unsigned int LArCondFEBIdChanMap::minGain ( ) const

inline

Mininum gain value.

Definition at line 315 of file LArCondFEBIdChanMap.h.

{
    return (m_minGain);
}

◆ nGains()

unsigned int LArCondFEBIdChanMap::nGains ( ) const

inline

Number of gain values.

Definition at line 322 of file LArCondFEBIdChanMap.h.

{
    return (m_nGains);
}

◆ nGroups()

unsigned int LArCondFEBIdChanMap::nGroups ( ) const

inline

Number of groups - minimum is 2 (1 correction group, 1 FEB ID group)

Definition at line 292 of file LArCondFEBIdChanMap.h.

{
    return (m_chansPerGain+NUMOFFSETCHANNELSPERGAIN);
}

◆ nOffsetChannels()

unsigned int LArCondFEBIdChanMap::nOffsetChannels ( ) const

inline

Number of offset channels - i.e. correction channels.

Definition at line 329 of file LArCondFEBIdChanMap.h.

{
    return (m_numOffsetChannels);
}

◆ totalChannels()

unsigned int LArCondFEBIdChanMap::totalChannels ( ) const

inline

Total number of channels for all gains and includes special offset channels.

Definition at line 337 of file LArCondFEBIdChanMap.h.

{
    return (m_totalChannels);
}

Member Data Documentation

◆ m_channelMap

FEBIdMap LArCondFEBIdChanMap::m_channelMap

private

Definition at line 153 of file LArCondFEBIdChanMap.h.

◆ m_chansPerGain

unsigned int LArCondFEBIdChanMap::m_chansPerGain

private

Definition at line 154 of file LArCondFEBIdChanMap.h.

◆ m_empty

FEBIdVector LArCondFEBIdChanMap::m_empty

private

Definition at line 160 of file LArCondFEBIdChanMap.h.

◆ m_febIdVecs

ChannelMap LArCondFEBIdChanMap::m_febIdVecs

private

File map from existing ChannelMap - e.g. on read back.

Definition at line 152 of file LArCondFEBIdChanMap.h.

◆ m_maxGain

unsigned int LArCondFEBIdChanMap::m_maxGain

private

Definition at line 157 of file LArCondFEBIdChanMap.h.

◆ m_minGain

unsigned int LArCondFEBIdChanMap::m_minGain

private

Definition at line 156 of file LArCondFEBIdChanMap.h.

◆ m_nGains

unsigned int LArCondFEBIdChanMap::m_nGains

private

Definition at line 158 of file LArCondFEBIdChanMap.h.

◆ m_numOffsetChannels

unsigned int LArCondFEBIdChanMap::m_numOffsetChannels

private

Definition at line 159 of file LArCondFEBIdChanMap.h.

◆ m_totalChannels

unsigned int LArCondFEBIdChanMap::m_totalChannels

private

Definition at line 155 of file LArCondFEBIdChanMap.h.

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

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ChannelMap

◆ FEBId

◆ FEBIdMap

◆ FEBIdVector

Member Enumeration Documentation

◆ ChanMapOffets

◆ CorrectionType

Constructor & Destructor Documentation

◆ LArCondFEBIdChanMap() [1/2]

◆ LArCondFEBIdChanMap() [2/2]

◆ ~LArCondFEBIdChanMap()

Member Function Documentation

◆ addFEBIdVector()

◆ channelsPerGain()

◆ dump()

◆ febIdVector()

◆ fillMap()

◆ getChannel()

◆ getCorrectionSetChannels()

◆ groupNumber()

◆ minGain()

◆ nGains()

◆ nGroups()

◆ nOffsetChannels()

◆ totalChannels()

Member Data Documentation

◆ m_channelMap

◆ m_chansPerGain

◆ m_empty

◆ m_febIdVecs

◆ m_maxGain

◆ m_minGain

◆ m_nGains

◆ m_numOffsetChannels

◆ m_totalChannels