Helper struct to represent the High-voltage pins and a possible connection between them. More...

#include <HedgehogBoard.h>

Collaboration diagram for Muon::HedgehogBoard:

Classes
struct	TubeLayer
	Helper struct to return a tube & tube layer pair. More...

Public Types
using	HedgehogBoardPtr = std::shared_ptr<const HedgehogBoard>
using	Mapping = std::array<uint8_t, nChPerBoard>

Public Member Functions
	HedgehogBoard ()=default
	Default constructor.
	HedgehogBoard (const Mapping &map, const uint8_t nTubeLay, const uint16_t boardId)
	Standard constructor.
bool	operator< (const HedgehogBoard &other) const
	Ordering of hedgehog boards, performed by Identifier.
uint16_t	boardId () const
	Returns the identifier of the hedgehog board.
uint8_t	numTubeLayers () const
	Returns the number of tube layers 3 or 4.
uint8_t	numTubesPerLayer () const
	Returns the number of tubes per layer.
uint8_t	pinNumber (const TubeLayer &tubeLay) const
	Returns the pinNumber of the tubeLayer.
uint8_t	pinNumber (uint8_t layer, uint8_t tube) const
	Returns the pin number of the layer - tube pair.
uint8_t	pairPin (const TubeLayer &tubeLay) const
	Returns the number of the pin that's twin to the tubeLayer If the pin is not short circuited, then the actual tube, layer pair is returned.
uint8_t	pairPin (uint8_t layer, uint8_t tube) const
	Returns the number of the pin that's twin to the tubeLayer If the pin is not short circuited, then the actual tube, layer pair is returned.
TubeLayer	twinPair (const TubeLayer &tubeLay) const
	Returns the tube & layer short circuited with the given tubeLayer.
TubeLayer	twinPair (uint8_t layer, uint8_t tube) const
	Returns the tube & layer short circuited with the given tubeLayer.
void	setHVDelayTime (const double hvTime)
	Define a HV delay in the time of arrival between the primary & twin electronics signal.
bool	hasHVDelayTime () const
	Returns whether the HedgehogBoard has a specifc delay time.
double	hvDelayTime () const
	Returns the HV delay time.
const Mapping &	data () const
	Returns the underlying map.

Static Public Attributes
static constexpr unsigned	nChPerBoard = 24

Private Attributes
Mapping	m_hedgePins {make_array<uint8_t, nChPerBoard>(-1)}
uint8_t	m_nTubeLay {0}
uint8_t	m_nTubePerLay {0}
uint16_t	m_id {0}
std::optional< double >	m_hvDelay {std::nullopt}

Detailed Description

Helper struct to represent the High-voltage pins and a possible connection between them.

Likewise the MdtMezzanine Card, the HedgehogBoard covers exactly 24 tubes and the tube numbering layout may differ depending on whether the Mdt chamber has 3 or 4 multilayers

                (16) (17) (18) (19) (20) (21) (22) (23)
                  (08) (09) (10) (11) (12) (13) (14) (15)
               (00) (01) (02) (03) (04) (05) (06) (07)

                  (18) (19) (20) (21) (22) (23)
                (12) (13) (14) (15) (16) (17)
                  (06) (07) (08) (09) (10) (11)
               (00) (01) (02) (03) (04) (05)

If the Hedgehogboard is moounted onto a twin chamber, i.e. two HV pins are connected with a time impedance between, the n-th entry of the array indicates to which k-th tube, the n-th tube is actually connected and the k-th tube contains an n in order to close the connection.

Definition at line 32 of file HedgehogBoard.h.

Member Typedef Documentation

◆ HedgehogBoardPtr

using Muon::HedgehogBoard::HedgehogBoardPtr = std::shared_ptr<const HedgehogBoard>

Definition at line 34 of file HedgehogBoard.h.

◆ Mapping

using Muon::HedgehogBoard::Mapping = std::array<uint8_t, nChPerBoard>

Definition at line 37 of file HedgehogBoard.h.

Constructor & Destructor Documentation

◆ HedgehogBoard() [1/2]

Muon::HedgehogBoard::HedgehogBoard ( )

default

Default constructor.

◆ HedgehogBoard() [2/2]

Muon::HedgehogBoard::HedgehogBoard	(	const Mapping &	map,
		const uint8_t	nTubeLay,
		const uint16_t	boardId )

Standard constructor.

Parameters

map	Encoding of the hedgehog pins
nTubeLay	Number of tube layers 3 or 4
boardId	Identifier number of the Hedgehog board

Definition at line 28 of file HedgehogBoard.cxx.

                                                        :
        m_hedgePins{map},
        m_nTubeLay{nTubeLay},
        m_id{boardId} {
        assert(nTubeLay == 3 || nTubeLay == 4);
        m_nTubePerLay = m_hedgePins.size() / nTubeLay;    
    }

Member Function Documentation

◆ boardId()

uint16_t Muon::HedgehogBoard::boardId ( ) const

Returns the identifier of the hedgehog board.

Definition at line 40 of file HedgehogBoard.cxx.

40{ return m_id; }

◆ data()

const HedgehogBoard::Mapping & Muon::HedgehogBoard::data ( ) const

Returns the underlying map.

Definition at line 43 of file HedgehogBoard.cxx.

43{ return m_hedgePins; }

◆ hasHVDelayTime()

bool Muon::HedgehogBoard::hasHVDelayTime ( ) const

Returns whether the HedgehogBoard has a specifc delay time.

Definition at line 78 of file HedgehogBoard.cxx.

                                             {
        return m_hvDelay.has_value();
    }           

◆ hvDelayTime()

double Muon::HedgehogBoard::hvDelayTime ( ) const

Returns the HV delay time.

If not set 0 is returned

Definition at line 81 of file HedgehogBoard.cxx.

                                            {
        return m_hvDelay.value_or(0.);
    }

◆ numTubeLayers()

uint8_t Muon::HedgehogBoard::numTubeLayers ( ) const

Returns the number of tube layers 3 or 4.

Definition at line 41 of file HedgehogBoard.cxx.

41{ return m_nTubeLay; }

◆ numTubesPerLayer()

uint8_t Muon::HedgehogBoard::numTubesPerLayer ( ) const

Returns the number of tubes per layer.

Definition at line 42 of file HedgehogBoard.cxx.

42{ return m_nTubePerLay; }

◆ operator<()

bool Muon::HedgehogBoard::operator< ( const HedgehogBoard & other ) const

Ordering of hedgehog boards, performed by Identifier.

Definition at line 37 of file HedgehogBoard.cxx.

                                                                  {
        return boardId() < other.boardId();
    }

◆ pairPin() [1/2]

uint8_t Muon::HedgehogBoard::pairPin ( const TubeLayer & tubeLay ) const

Returns the number of the pin that's twin to the tubeLayer If the pin is not short circuited, then the actual tube, layer pair is returned.

Parameters

tubeLay Helper struct encoding the tube & layer number

Definition at line 52 of file HedgehogBoard.cxx.

                                                                 {
        return m_hedgePins[pinNumber(tubeLay)];
    }

◆ pairPin() [2/2]

uint8_t Muon::HedgehogBoard::pairPin	(	uint8_t	layer,
		uint8_t	tube ) const

Returns the number of the pin that's twin to the tubeLayer If the pin is not short circuited, then the actual tube, layer pair is returned.

Parameters

layer	Tube layer number [1-numTubeLayers()]
tube	Tube number [1-nTubes()]

Definition at line 55 of file HedgehogBoard.cxx.

                                                                    {
        return m_hedgePins[pinNumber(layer, tube)];
    }

◆ pinNumber() [1/2]

uint8_t Muon::HedgehogBoard::pinNumber ( const TubeLayer & tubeLay ) const

Returns the pinNumber of the tubeLayer.

Parameters

tubeLay Helper struct encoding the tube & layer number

Definition at line 44 of file HedgehogBoard.cxx.

                                                                   {
        return pinNumber(tubeLay.layer, tubeLay.tube);
    }

◆ pinNumber() [2/2]

uint8_t Muon::HedgehogBoard::pinNumber	(	uint8_t	layer,
		uint8_t	tube ) const

Returns the pin number of the layer - tube pair.

Parameters

layer	Tube layer number [1-numTubeLayers()]
tube	Tube number [1-nTubes()]

Definition at line 47 of file HedgehogBoard.cxx.

                                                                      {
        uint8_t pin = (layer-1) * m_nTubePerLay + (tube -1) % m_nTubePerLay;
        assert(pin < m_hedgePins.size()); 
        return pin;
    }

◆ setHVDelayTime()

void Muon::HedgehogBoard::setHVDelayTime ( const double hvTime )

Define a HV delay in the time of arrival between the primary & twin electronics signal.

Parameters

hvTime Delay time in ns

Definition at line 75 of file HedgehogBoard.cxx.

                                                          {
        m_hvDelay = std::make_optional<double>(hvTime);
    }

◆ twinPair() [1/2]

TubeLayer Muon::HedgehogBoard::twinPair ( const TubeLayer & tubeLay ) const

Returns the tube & layer short circuited with the given tubeLayer.

Parameters

tubeLay Helper struct encoding the tube & layer number

Definition at line 59 of file HedgehogBoard.cxx.

                                                                    {
        return twinPair(tubeLay.layer, tubeLay.tube);
    }

◆ twinPair() [2/2]

TubeLayer Muon::HedgehogBoard::twinPair	(	uint8_t	layer,
		uint8_t	tube ) const

Returns the tube & layer short circuited with the given tubeLayer.

Parameters

layer	Tube layer number [1-numTubeLayers()]
tube	Tube number [1-nTubes()]

Definition at line 62 of file HedgehogBoard.cxx.

                                                                       {
        const uint8_t pin = pinNumber(layer, tube);
        const uint8_t twin = m_hedgePins[pin];
        TubeLayer result{};
        if (pin != twin) {
            result.layer = (twin - twin%m_nTubePerLay) / m_nTubePerLay + 1;
            result.tube = (twin % m_nTubePerLay) + 1;
        } else {
            result.tube = tube;
            result.layer = layer;
        }
        return result;
    }

Member Data Documentation

◆ m_hedgePins

Mapping Muon::HedgehogBoard::m_hedgePins {make_array<uint8_t, nChPerBoard>(-1)}

private

Definition at line 112 of file HedgehogBoard.h.

112{make_array<uint8_t, nChPerBoard>(-1)};

make_array

constexpr std::array< T, N > make_array(const T &def_val)

Helper function to initialize in-place arrays with non-zero values.

Definition ArrayHelper.h:10

◆ m_hvDelay

std::optional<double> Muon::HedgehogBoard::m_hvDelay {std::nullopt}

private

Definition at line 116 of file HedgehogBoard.h.

116{std::nullopt};

◆ m_id

uint16_t Muon::HedgehogBoard::m_id {0}

private

Definition at line 115 of file HedgehogBoard.h.

115{0};

◆ m_nTubeLay

uint8_t Muon::HedgehogBoard::m_nTubeLay {0}

private

Definition at line 113 of file HedgehogBoard.h.

113{0};

◆ m_nTubePerLay

uint8_t Muon::HedgehogBoard::m_nTubePerLay {0}

private

Definition at line 114 of file HedgehogBoard.h.

114{0};

◆ nChPerBoard

unsigned Muon::HedgehogBoard::nChPerBoard = 24

staticconstexpr

Definition at line 36 of file HedgehogBoard.h.

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

Classes

Public Types

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ HedgehogBoardPtr

◆ Mapping

Constructor & Destructor Documentation

◆ HedgehogBoard() [1/2]

◆ HedgehogBoard() [2/2]

Member Function Documentation

◆ boardId()

◆ data()

◆ hasHVDelayTime()

◆ hvDelayTime()

◆ numTubeLayers()

◆ numTubesPerLayer()

◆ operator<()

◆ pairPin() [1/2]

◆ pairPin() [2/2]

◆ pinNumber() [1/2]

◆ pinNumber() [2/2]

◆ setHVDelayTime()

◆ twinPair() [1/2]

◆ twinPair() [2/2]

Member Data Documentation

◆ m_hedgePins

◆ m_hvDelay

◆ m_id

◆ m_nTubeLay

◆ m_nTubePerLay

◆ nChPerBoard