ChannelMapper Class Reference

Provides mapping between electronic channels and pixels. More...

#include <ChannelMapper.h>

Public Types
enum	{   c_numBoardstacks = 4 ,   c_numCarrierBoards = 4 ,   c_numAsics = 4 ,   c_numChannels = 8 ,   c_numRows = 2 ,   c_numColumns = 16 ,   c_numPixelRows = c_numRows * c_numCarrierBoards ,   c_numPixelColumns = c_numColumns * c_numBoardstacks ,   c_numPixels = c_numPixelRows * c_numPixelColumns ,   c_invalidChannel = c_numPixels ,   c_invalidPixelID = 0 }
	Enum for the number of different quantities etc. More...
enum	EType {   c_unknown = 0 ,   c_default = 1 ,   c_IRS3B = 2 ,   c_IRSX = 3 }
	Enum for electornic types. More...

Public Member Functions
	ChannelMapper ()
	constructor
void	initialize (const GearDir &channelMapping)
	Initialize from Gearbox (XML)
void	initialize ()
	Initialize from database.
bool	isValid () const
	Checks if mapping is available.
void	importPayload (const IntervalOfValidity &iov) const
	import mappings to database
EType	getType () const
	Return electornic type (see enum)
const std::string &	getName () const
	Return electornic name.
unsigned	getChannel (int pixel) const
	Converts pixel to hardware channel number (0-based)
int	getPixelID (unsigned channel) const
	Converts hardware channel number to pixel ID (1-based)
void	print () const
	Print mappings to terminal screen.
void	test () const
	test that the conversion and inverse of it gives identity, if not B2ERROR

Static Public Member Functions
static bool	isPixelIDValid (int pixel)
	Checks validity of pixel ID.
static bool	isChannelValid (unsigned channel)
	Checks validity of hardware channel number.
static unsigned	getChannel (unsigned boardstack, unsigned carrier, unsigned asic, unsigned chan)
	Returns hardware channel number (0-based)
static void	splitChannelNumber (unsigned channel, unsigned &boardstack, unsigned &carrier, unsigned &asic, unsigned &chan)
	Splits hardware channel number into boardstack, carrier, asic and asic channel.
static int	getPmtID (int pixel)
	Returns PMT ID (1-based)

Private Member Functions
void	clear ()
	Clear.
void	update ()
	re-do conversion arrays when DBArray has changed

Private Attributes
EType	m_type = c_unknown
	electornic type
std::string	m_typeName
	electronic type name
std::vector< TOPChannelMap >	m_mapping
	mappings from gearbox
DBArray< TOPChannelMap >	m_mappingDB
	mappings from database
bool	m_valid = false
	true if mapping available
bool	m_fromDB = false
	true, if from database
const TOPChannelMap *	m_channels [c_numRows][c_numColumns] = {{0}}
	conversion array
const TOPChannelMap *	m_pixels [c_numAsics][c_numChannels] = {{0}}
	conversion array

Detailed Description

Provides mapping between electronic channels and pixels.

Definition at line 27 of file ChannelMapper.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enum for the number of different quantities etc.

Enumerator
c_numBoardstacks	number of boardstacks per TOP module
c_numCarrierBoards	number of carrier boards per boardstack
c_numAsics	number of ASIC's per carrier board
c_numChannels	number of channels per ASIC
c_numRows	number of pixel rows per carrier board
c_numColumns	number of pixel columns per carrier board
c_numPixelRows	per module
c_numPixelColumns	per module
c_numPixels	per module
c_invalidChannel	value of invalid channel number
c_invalidPixelID	value of invalid pixel ID

Definition at line 33 of file ChannelMapper.h.

           {c_numBoardstacks = 4,   
            c_numCarrierBoards = 4, 
            c_numAsics = 4,         
            c_numChannels = 8,      
            c_numRows = 2,          
            c_numColumns = 16,      
            c_numPixelRows = c_numRows * c_numCarrierBoards, 
            c_numPixelColumns = c_numColumns * c_numBoardstacks, 
            c_numPixels = c_numPixelRows * c_numPixelColumns, 
            c_invalidChannel = c_numPixels, 
            c_invalidPixelID = 0 
           };

EType

enum EType

Enum for electornic types.

Definition at line 49 of file ChannelMapper.h.

                 {c_unknown = 0,
                  c_default = 1,
                  c_IRS3B   = 2,
                  c_IRSX    = 3
                 };

Constructor & Destructor Documentation

ChannelMapper()

ChannelMapper

(

)

constructor

Definition at line 24 of file ChannelMapper.cc.

    {
      static_assert(c_numRows * c_numColumns == c_numAsics * c_numChannels,
                    "TOP::ChannelMapper: bug in coding (enum) - "
                    "number of channels and number of pixels disagree");
 
      for (auto& channels : m_channels) {
        for (auto& channel : channels) channel = 0;
      }
      for (auto& pixels : m_pixels) {
        for (auto& pixel : pixels) pixel = 0;
      }
    }

Member Function Documentation

clear()

void clear ( )

private

Clear.

Definition at line 324 of file ChannelMapper.cc.

    {
      m_mapping.clear();
      for (auto& channels : m_channels) {
        for (auto& channel : channels) channel = 0;
      }
      for (auto& pixels : m_pixels) {
        for (auto& pixel : pixels) pixel = 0;
      }
      m_valid = false;
      m_fromDB = false;
    }

getChannel() [1/2]

unsigned getChannel

(

int

pixel

)

const

Converts pixel to hardware channel number (0-based)

Parameters

pixel

pixel ID (1-based)

Returns

channel number (or c_invalidChannel for invalid pixel)

Definition at line 198 of file ChannelMapper.cc.

    {
      if (!isPixelIDValid(pixel)) return c_invalidChannel; // cppcheck-suppress knownConditionTrueFalse
 
      unsigned pix = pixel - 1;
      unsigned pixRow = pix / c_numPixelColumns;
      unsigned pixCol = pix % c_numPixelColumns;
 
      unsigned carrier = pixRow / c_numRows;
      unsigned row = pixRow % c_numRows;
      unsigned boardstack = pixCol / c_numColumns;
      unsigned col =  pixCol % c_numColumns;
 
      const auto& map = m_channels[row][col];
      if (!map) {
        B2WARNING("TOP::ChannelMapper: no channel mapped to pixel. Return invalid channel."
                  << LogVar("pixelID", pixel));
        return c_invalidChannel;
      }
      unsigned asic = map->getASICNumber();
      unsigned chan = map->getASICChannel();
 
      return getChannel(boardstack, carrier, asic, chan);
    }

getChannel() [2/2]

static unsigned getChannel ( unsigned boardstack, unsigned carrier, unsigned asic, unsigned chan )

inlinestatic

Returns hardware channel number (0-based)

Parameters

boardstack	boardstack number (0-based)
carrier	carrier board number (0-based)
asic	ASIC number (0-based)
chan	ASIC channel number (0-based)

Returns

channel number (or c_invalidChannel for invalid pixel)

Definition at line 131 of file ChannelMapper.h.

      {
        return chan + c_numChannels * (asic + c_numAsics *
                                       (carrier + c_numCarrierBoards * boardstack));
      }

getName()

const std::string & getName ( ) const

inline

Return electornic name.

Returns

name

Definition at line 93 of file ChannelMapper.h.

{return m_typeName;}

getPixelID()

int getPixelID

(

unsigned

channel

)

const

Converts hardware channel number to pixel ID (1-based)

Parameters

channel

hardware channel number (0-based)

Returns

pixel ID (or c_invalidPixelID for invalid channel number)

Definition at line 239 of file ChannelMapper.cc.

    {
 
      if (!isChannelValid(channel)) return c_invalidPixelID;
 
      unsigned boardstack = 0;
      unsigned carrier = 0;
      unsigned asic = 0;
      unsigned chan = 0;
      splitChannelNumber(channel, boardstack, carrier, asic, chan);
 
      const auto& map = m_pixels[asic][chan];
      if (!map) {
        B2ERROR("TOP::ChannelMapper: no pixel mapped to channel. Return invalid pixel."
                << LogVar("channel", channel));
        return c_invalidPixelID;
      }
      unsigned row = map->getRow();
      unsigned col = map->getColumn();
      unsigned pixRow = row + carrier * c_numRows;
      unsigned pixCol = col + boardstack * c_numColumns;
 
      return pixCol + pixRow * c_numPixelColumns + 1;
 
    }

getPmtID()

int getPmtID ( int pixel )

static

Returns PMT ID (1-based)

Parameters

pixel

pixelID (1-based)

Returns

PMT ID (or 0 for invalid pixel)

Definition at line 265 of file ChannelMapper.cc.

    {
      if (not isPixelIDValid(pixel)) return 0; // cppcheck-suppress knownConditionTrueFalse
      pixel--;
      int pmtRow = pixel / 256;
      int pmtCol = (pixel % 64) / 4;
      return pmtRow * 16 + pmtCol + 1;
    }

getType()

EType getType ( ) const

inline

Return electornic type (see enum)

Returns

type

Definition at line 87 of file ChannelMapper.h.

{return m_type;}

importPayload()

void importPayload

(

const IntervalOfValidity &

iov

)

const

import mappings to database

Parameters

iov	Interval of validity.

Definition at line 188 of file ChannelMapper.cc.

    {
      DBImportArray<TOPChannelMap> array;
      for (const auto& map : m_mapping) {
        array.appendNew(map);
      }
      array.import(iov);
    }

initialize() [1/2]

void initialize

(

)

Initialize from database.

Definition at line 168 of file ChannelMapper.cc.

    {
      m_type = c_default;
 
      if (!m_mappingDB.isValid()) {
        clear();
        return;
      }
      update();
 
      m_mappingDB.addCallback(this, &ChannelMapper::update);
 
      const auto& logSystem = LogSystem::Instance();
      if (logSystem.isLevelEnabled(LogConfig::c_Debug, 100, "top")) {
        print();
      }
 
    }

initialize() [2/2]

void initialize

(

const GearDir &

channelMapping

)

Initialize from Gearbox (XML)

Parameters

channelMapping

XML data directory

Definition at line 39 of file ChannelMapper.cc.

    {
      clear();
 
      string path = channelMapping.getPath();
      auto i1 = path.rfind("type='") + 6;
      auto i2 = path.rfind("']");
      m_typeName = path.substr(i1, i2 - i1);
 
      if (m_typeName == "IRS3B") {
        m_type = c_IRS3B;
      } else if (m_typeName == "IRSX") {
        m_type = c_IRSX;
      } else {
        B2ERROR("TOP::ChannelMapper: unknown electronic type."
                << LogVar("type", m_typeName));
      }
 
      // get parameters from Gearbox
      for (const GearDir& map : channelMapping.getNodes("map")) {
        std::vector<double> data = map.getArray("");
        unsigned row = int(data[0]) - 1;
        unsigned col = int(data[1]) - 1;
        unsigned asic = int(data[2]);
        unsigned chan = int(data[3]);
        m_mapping.push_back(TOPChannelMap(row, col, asic, chan));
      }
      if (m_mapping.empty()) {
        B2ERROR("TOP::ChannelMapper: mapping is not available in Gearbox");
        return;
      }
 
      // check the size of the mapping
      if (m_mapping.size() != c_numAsics * c_numChannels)
        B2FATAL("TOP::ChannelMapper: got incorrect map size from xml file for '"
                << m_typeName << "' - expect " <<  c_numAsics * c_numChannels
                << ", got " << m_mapping.size());
 
      // check the mapping for consistency
      bool ok = true;
      unordered_set<unsigned> pixels;
      unordered_set<unsigned> channels;
      for (unsigned ii = 0; ii < m_mapping.size(); ii++) {
        const auto& map = m_mapping[ii];
        unsigned row = map.getRow();
        unsigned col = map.getColumn();
        unsigned asic = map.getASICNumber();
        unsigned chan = map.getASICChannel();
        if (row >= c_numRows) {
          B2ERROR("TOP::ChannelMapper: pixel row out of range."
                  << LogVar("node", ii)
                  << LogVar("row", row)
                  << LogVar("column", col)
                  << LogVar("ASIC", asic)
                  << LogVar("channel", chan));
          ok = false;
        }
        if (col >= c_numColumns) {
          B2ERROR("TOP::ChannelMapper: pixel column out of range."
                  << LogVar("node", ii)
                  << LogVar("row", row)
                  << LogVar("column", col)
                  << LogVar("ASIC", asic)
                  << LogVar("channel", chan));
          ok = false;
        }
        if (asic >= c_numAsics) {
          B2ERROR("TOP::ChannelMapper: ASIC number out of range."
                  << LogVar("node", ii)
                  << LogVar("row", row)
                  << LogVar("column", col)
                  << LogVar("ASIC", asic)
                  << LogVar("channel", chan));
          ok = false;
        }
        if (chan >= c_numChannels) {
          B2ERROR("TOP::ChannelMapper: ASIC channel number out of range."
                  << LogVar("node", ii)
                  << LogVar("row", row)
                  << LogVar("column", col)
                  << LogVar("ASIC", asic)
                  << LogVar("channel", chan));
          ok = false;
        }
        if (!pixels.insert(col + row * c_numColumns).second) {
          B2ERROR("TOP::ChannelMapper: pixel already mapped."
                  << LogVar("node", ii)
                  << LogVar("row", row)
                  << LogVar("column", col)
                  << LogVar("ASIC", asic)
                  << LogVar("channel", chan));
          ok = false;
        }
        if (!channels.insert(chan + asic * c_numChannels).second) {
          B2ERROR("TOP::ChannelMapper: channel already mapped."
                  << LogVar("node", ii)
                  << LogVar("row", row)
                  << LogVar("column", col)
                  << LogVar("ASIC", asic)
                  << LogVar("channel", chan));
          ok = false;
        }
      }
      if (!ok) {
        B2FATAL("TOP::ChannelMapper: errors detected in xml file for '"
                << m_typeName << "'");
        return;
      }
 
      // prepare conversion arrays
      for (const auto& map : m_mapping) {
        m_channels[map.getRow()][map.getColumn()] = &map;
        m_pixels[map.getASICNumber()][map.getASICChannel()] = &map;
      }
      m_valid = true;
 
      B2INFO("TOP::ChannelMapper: " << m_mapping.size() <<
             " channels of carrier board of type '" << m_typeName
             << "' mapped to pixels.");
 
      // print mappings if debug level for package 'top' is set to 100 or larger
      const auto& logSystem = LogSystem::Instance();
      if (logSystem.isLevelEnabled(LogConfig::c_Debug, 100, "top")) {
        print();
      }
 
    }

isChannelValid()

static bool isChannelValid ( unsigned channel )

inlinestatic

Checks validity of hardware channel number.

Parameters

channel

hardware channel number (0-based)

Returns

true for valid ID

Definition at line 111 of file ChannelMapper.h.

      {
        return channel < c_numPixels;
      }

isPixelIDValid()

static bool isPixelIDValid ( int pixel )

inlinestatic

Checks validity of pixel ID.

Parameters

pixel

pixel ID (1-based)

Returns

true for valid ID

Definition at line 100 of file ChannelMapper.h.

      {
        unsigned pix = pixel - 1;
        return pix < c_numPixels; // cppcheck-suppress knownConditionTrueFalse
      }

isValid()

bool isValid ( ) const

inline

Checks if mapping is available.

Returns

true if available

Definition at line 75 of file ChannelMapper.h.

{return m_valid;}

print()

void print

(

)

const

Print mappings to terminal screen.

Definition at line 274 of file ChannelMapper.cc.

    {
      std::vector<std::string> what;
      what.push_back(string("Boardstack numbers (view from the back):"));
      what.push_back(string("Carrier board numbers (view from the back):"));
      what.push_back(string("ASIC numbers (view from the back):"));
      what.push_back(string("ASIC channel numbers (view from the back):"));
      unsigned value[4] = {0, 0, 0, 0};
 
      std::string xaxis("+------phi--------->");
      std::string yaxis("|ohr|||^");
 
      cout << endl;
      cout << "           Mapping of TOP electronic channels to pixels";
      if (!m_typeName.empty()) cout << " for " << m_typeName;
      cout << endl << endl;
 
      for (int i = 0; i < 4; i++) {
        cout << " " << what[i] << endl << endl;
        for (int row = c_numPixelRows - 1; row >= 0; row--) {
          cout << "  " << yaxis[row] << " ";
          for (int col = 0; col < c_numPixelColumns; col++) {
            int pixel = col + c_numPixelColumns * row + 1;
            auto channel = getChannel(pixel);
            if (channel != c_invalidChannel) {
              splitChannelNumber(channel, value[0], value[1], value[2], value[3]);
              cout << value[i];
            } else {
              cout << "?";
            }
          }
          cout << endl;
        }
        cout << "  " << xaxis << endl << endl;
      }
 
    }

splitChannelNumber()

void splitChannelNumber ( unsigned channel, unsigned & boardstack, unsigned & carrier, unsigned & asic, unsigned & chan )

static

Splits hardware channel number into boardstack, carrier, asic and asic channel.

Parameters

channel	hardware channel number (0-based) [input]
boardstack	boardstack number (0-based) [output]
carrier	carrier board number (0-based) [output]
asic	ASIC number (0-based) [output]
chan	ASIC channel number (0-based) [output]

Definition at line 224 of file ChannelMapper.cc.

    {
      chan = channel % c_numChannels;
      channel /= c_numChannels;
      asic = channel % c_numAsics;
      channel /= c_numAsics;
      carrier = channel % c_numCarrierBoards;
      boardstack = channel / c_numCarrierBoards;
    }

test()

void test

(

)

const

test that the conversion and inverse of it gives identity, if not B2ERROR

Definition at line 312 of file ChannelMapper.cc.

    {
      for (int pixel = 1; pixel <= c_numPixels; pixel++)
        if (pixel != getPixelID(getChannel(pixel)))
          B2ERROR("TOP::ChannelMapper: bug, getPixelID is not inverse of getChannel");
 
      for (unsigned channel = 0; channel < c_numPixels; channel++)
        if (channel != getChannel(getPixelID(channel)))
          B2ERROR("TOP::ChannelMapper: bug, getChannel is not inverse of getPixelID");
    }

update()

void update ( )

private

re-do conversion arrays when DBArray has changed

Definition at line 338 of file ChannelMapper.cc.

    {
      clear();
      if (!m_mappingDB.isValid()) return;
 
      for (const auto& map : m_mappingDB) {
        m_channels[map.getRow()][map.getColumn()] = ↦
        m_pixels[map.getASICNumber()][map.getASICChannel()] = ↦
      }
      m_valid = true;
      m_fromDB = true;
    }

Member Data Documentation

m_channels

const TOPChannelMap* m_channels[c_numRows][c_numColumns] = {{0}}

private

conversion array

Definition at line 197 of file ChannelMapper.h.

{{0}}; 

m_fromDB

bool m_fromDB = false

private

true, if from database

Definition at line 195 of file ChannelMapper.h.

m_mapping

std::vector<TOPChannelMap> m_mapping

private

mappings from gearbox

Definition at line 192 of file ChannelMapper.h.

m_mappingDB

DBArray<TOPChannelMap> m_mappingDB

private

mappings from database

Definition at line 193 of file ChannelMapper.h.

m_pixels

const TOPChannelMap* m_pixels[c_numAsics][c_numChannels] = {{0}}

private

conversion array

Definition at line 198 of file ChannelMapper.h.

{{0}}; 

m_type

EType m_type = c_unknown

private

electornic type

Definition at line 190 of file ChannelMapper.h.

m_typeName

std::string m_typeName

private

electronic type name

Definition at line 191 of file ChannelMapper.h.

m_valid

bool m_valid = false

private

true if mapping available

Definition at line 194 of file ChannelMapper.h.

---

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

• top/geometry/include/ChannelMapper.h
• top/geometry/src/ChannelMapper.cc