sbn::bits Namespace Reference

Simple utilities to deal with bit enumerators. More...

Classes
struct	mask_t

Functions
Generic bit functions
template<typename EnumType >
mask_t< EnumType >	makeMask (typename mask_t< EnumType >::maskbits_t bits) noexcept
	Converts a integral type into a mask. More...
template<typename EnumType >
constexpr auto	value (EnumType bit)
	Returns the value of specified bit (conversion like enum to int). More...
template<typename EnumType , typename... OtherBits>
constexpr mask_t< EnumType >	mask (EnumType bit, OtherBits...otherBits)
	Returns a mask with all specified bits set. More...
template<typename EnumType >
constexpr bool	hasBitSet (mask_t< EnumType > bitMask, EnumType bit)
	Returns whether the specified bit is set in bitMask. More...
template<typename EnumType >
std::string	name (EnumType bit)
	Returns the name of the specified bit. Delegates to bitName(). More...
template<typename EnumType >
std::vector< std::string >	names (mask_t< EnumType > mask)

Beam bits
enum	triggerSource : unsigned int {   triggerSource::Unknown, triggerSource::BNB, triggerSource::NuMI, triggerSource::OffbeamBNB,   triggerSource::OffbeamNuMI, triggerSource::Calib, triggerSource::NBits }
	Type of beam or beam gate or other trigger source. More...
enum	triggerLocation : unsigned int {   triggerLocation::CryoEast, triggerLocation::CryoWest, triggerLocation::TPCEE, triggerLocation::TPCEW,   triggerLocation::TPCWE, triggerLocation::TPCWW, triggerLocation::NBits }
	Location or locations generating a trigger. More...
enum	triggerType : unsigned int { triggerType::Majority, triggerType::MinimumBias, triggerType::NBits }
	Type representing the type(s) of this trigger. More...
enum	triggerWindowMode : unsigned int { triggerWindowMode::Separated, triggerWindowMode::Overlapping, triggerWindowMode::NBits }
	Trigger window mode. More...
enum	gateSelection : unsigned int {   gateSelection::GateBNB, gateSelection::DriftGateBNB, gateSelection::GateNuMI, gateSelection::DriftGateNuMI,   gateSelection::GateOffbeamBNB, gateSelection::DriftGateOffbeamBNB, gateSelection::GateOffbeamNuMI, gateSelection::DriftGateOffbeamNuMI,   gateSelection::GateCalibration, gateSelection::DriftGateCalibration, gateSelection::MinbiasGateBNB, gateSelection::MinbiasGateNuMI,   gateSelection::MinbiasGateOffbeamBNB, gateSelection::MinbiasGateOffbeamNuMI, gateSelection::MinbiasGateCalibration, gateSelection::MinbiasDriftGateBNB,   gateSelection::MinbiasDriftGateNuMI, gateSelection::MinbiasDriftGateOffbeamBNB, gateSelection::MinbiasDriftGateOffbeamNuMI, gateSelection::MinbiasDriftGateCalibration,   gateSelection::NBits }
	Enabled gates in the trigger configuration. See register 0X00050008 in docdb SBN-doc-23778-v1. More...
using	triggerSourceMask = mask_t< triggerSource >
	Type of mask with triggerSource bits. More...
using	triggerLocationMask = mask_t< triggerLocation >
	Type of mask with triggerLocation bits. More...
using	triggerTypeMask = mask_t< triggerType >
	Type of mask with triggerType bits. More...
using	gateSelectionMask = mask_t< gateSelection >
std::string	bitName (triggerSource bit)
	Returns a mnemonic short name of the beam type. More...
std::string	bitName (triggerLocation bit)
	Returns a mnemonic short name of the trigger location. More...
std::string	bitName (triggerType bit)
	Returns a mnemonic short name of the trigger type. More...
std::string	bitName (triggerWindowMode bit)
	Returns a mnemonic short name for the trigger window mode. More...
std::string	bitName (gateSelection bit)
	Returns a mnemonic short name for the trigger window mode. More...

Detailed Description

Simple utilities to deal with bit enumerators.

A few simple concepts:

• a bit is identified by its position (integral number: 0, 1, 2...)
• representation of a bit is via a enumerator (enum class)
• bits may be associated with a name (name())
• to test bits, mask(), value() and hasBitSet() help with the conversions between enum class and the underlying integral type

Typedef Documentation

using sbn::bits::gateSelectionMask = typedef mask_t<gateSelection>

Definition at line 174 of file BeamBits.h.

using sbn::bits::triggerLocationMask = typedef mask_t<triggerLocation>

Type of mask with triggerLocation bits.

Definition at line 125 of file BeamBits.h.

using sbn::bits::triggerSourceMask = typedef mask_t<triggerSource>

Type of mask with triggerSource bits.

Definition at line 109 of file BeamBits.h.

using sbn::bits::triggerTypeMask = typedef mask_t<triggerType>

Type of mask with triggerType bits.

Definition at line 136 of file BeamBits.h.

Enumeration Type Documentation

enum sbn::bits::gateSelection : unsigned int

strong

Enabled gates in the trigger configuration. See register 0X00050008 in docdb SBN-doc-23778-v1.

Enumerator
GateBNB	Enable receiving BNB early warning signal (gatedBES) to open BNB gates.
DriftGateBNB	Enable BNB early-early warning signal ($1D) for light out-of-time in BNB gates.
GateNuMI	Enable NuMI early warning signal (MIBS$74) to open NuMI gates.
DriftGateNuMI	Enable receiving NuMI early-early warning signal ($AD) for light out-of-time in NuMI gates.
GateOffbeamBNB	Enable Offbeam gate for BNB.
DriftGateOffbeamBNB	Enable Offbeam drift gate BNB (for light out-of-time in offbeam gates)
GateOffbeamNuMI	Enable Offbeam gate for NuMI.
DriftGateOffbeamNuMI	Enable Offbeam drift gate NuMI (for light out-of-time in offbeam gates)
GateCalibration	Enable Calibration gate.
DriftGateCalibration	Enable Calibration drift gate (for light out-of-time in calibration gates)
MinbiasGateBNB	Enable MinBias triggers for the BNB stream.
MinbiasGateNuMI	Enable MinBias triggers for the NuMI stream.
MinbiasGateOffbeamBNB	Enabke MinBias triggers for the Offbeam BNB stream.
MinbiasGateOffbeamNuMI	Enable MinBias triggers for the Offbeam NuMI stream.
MinbiasGateCalibration	Enable MinBias triggers for the Calibration stream.
MinbiasDriftGateBNB	Enable light out-of-time for MinBias triggers in BNB stream.
MinbiasDriftGateNuMI	Enable light out-of-time for MinBias triggers in NuMI stream.
MinbiasDriftGateOffbeamBNB	Enable light out-of-time for MinBias triggers in Offbeam BNB stream.
MinbiasDriftGateOffbeamNuMI	Enable light out-of-time for MinBias triggers in Offbeam NuMI stream.
MinbiasDriftGateCalibration	Enable light out-of-time for MinBias triggers in Calibration stream.
NBits

Definition at line 149 of file BeamBits.h.

                            : unsigned int {
      GateBNB,                     ///<Enable receiving BNB early warning signal (gatedBES) to open BNB gates
      DriftGateBNB,                ///<Enable BNB early-early warning signal ($1D) for light out-of-time in BNB gates
      GateNuMI,                    ///<Enable NuMI early warning signal (MIBS$74) to open NuMI gates
      DriftGateNuMI,               ///<Enable receiving NuMI early-early warning signal ($AD) for light out-of-time in NuMI gates
      GateOffbeamBNB,              ///<Enable Offbeam gate for BNB
      DriftGateOffbeamBNB,         ///<Enable Offbeam drift gate BNB (for light out-of-time in offbeam gates)
      GateOffbeamNuMI,             ///<Enable Offbeam gate for NuMI
      DriftGateOffbeamNuMI,        ///<Enable Offbeam drift gate NuMI (for light out-of-time in offbeam gates)
      GateCalibration,             ///<Enable Calibration gate
      DriftGateCalibration,        ///<Enable Calibration drift gate (for light out-of-time in calibration gates)
      MinbiasGateBNB,              ///<Enable MinBias triggers for the BNB stream
      MinbiasGateNuMI,             ///<Enable MinBias triggers for the NuMI stream
      MinbiasGateOffbeamBNB,       ///<Enabke MinBias triggers for the Offbeam BNB stream
      MinbiasGateOffbeamNuMI,      ///<Enable MinBias triggers for the Offbeam NuMI stream
      MinbiasGateCalibration,      ///<Enable MinBias triggers for the Calibration stream
      MinbiasDriftGateBNB,         ///<Enable light out-of-time for MinBias triggers in BNB stream
      MinbiasDriftGateNuMI,        ///<Enable light out-of-time for MinBias triggers in NuMI stream
      MinbiasDriftGateOffbeamBNB,  ///<Enable light out-of-time for MinBias triggers in Offbeam BNB stream
      MinbiasDriftGateOffbeamNuMI, ///<Enable light out-of-time for MinBias triggers in Offbeam NuMI stream
      MinbiasDriftGateCalibration, ///<Enable light out-of-time for MinBias triggers in Calibration stream
      // ==> add here if more are needed <==
      NBits
    }; // gateSelection

enum sbn::bits::triggerLocation : unsigned int

strong

Location or locations generating a trigger.

Enumerator
CryoEast	A trigger happened in the east cryostat.
CryoWest	A trigger happened in the west cryostat.
TPCEE	A trigger happened in the east cryostat, east TPC.
TPCEW	A trigger happened in the east cryostat, west TPC.
TPCWE	A trigger happened in the west cryostat, east TPC.
TPCWW	A trigger happened in the west cryostat, west TPC.
NBits	Number of bits currently supported.

Definition at line 113 of file BeamBits.h.

                              : unsigned int {
      CryoEast,    ///< A trigger happened in the east cryostat.
      CryoWest,    ///< A trigger happened in the west cryostat.
      TPCEE,       ///< A trigger happened in the east cryostat, east TPC.
      TPCEW,       ///< A trigger happened in the east cryostat, west TPC.
      TPCWE,       ///< A trigger happened in the west cryostat, east TPC.
      TPCWW,       ///< A trigger happened in the west cryostat, west TPC.
      // ==> add here if more are needed <==
      NBits    ///< Number of bits currently supported.
    }; // triggerLocation

enum sbn::bits::triggerSource : unsigned int

strong

Type of beam or beam gate or other trigger source.

Enumerator
Unknown	Type of beam unknown.
BNB	Type of beam: BNB.
NuMI	Type of beam: NuMI.
OffbeamBNB	Type of Offbeam: BNB.
OffbeamNuMI	Type of Offbeam: NuMI.
Calib	Type of source: calibration trigger.
NBits	Number of bits currently supported.

Definition at line 97 of file BeamBits.h.

                            : unsigned int {
      Unknown,     ///< Type of beam unknown.
      BNB,         ///< Type of beam: BNB.
      NuMI,        ///< Type of beam: NuMI.
      OffbeamBNB,  ///< Type of Offbeam: BNB.
      OffbeamNuMI, ///< Type of Offbeam: NuMI.
      Calib,       ///< Type of source: calibration trigger.
      // ==> add here if more are needed <==
      NBits    ///< Number of bits currently supported.
    }; // triggerSource

enum sbn::bits::triggerType : unsigned int

strong

Type representing the type(s) of this trigger.

Enumerator
Majority	A minimum number of close-by PMT pairs above threshold was reached.
MinimumBias	Data collected at gate opening with no further requirement imposed.
NBits	Number of bits currently supported.

Definition at line 128 of file BeamBits.h.

                          : unsigned int {
      Majority,    ///< A minimum number of close-by PMT pairs above threshold was reached.
      MinimumBias, ///< Data collected at gate opening with no further requirement imposed.
      // ==> add here if more are needed <==
      NBits    ///< Number of bits currently supported.
    }; // triggerType

enum sbn::bits::triggerWindowMode : unsigned int

strong

Trigger window mode.

Enumerator
Separated	Separated, non-overlapping contigous window.
Overlapping	Overlaping windows.
NBits	Number of Bits currently supported.

Definition at line 139 of file BeamBits.h.

                                : unsigned int {
      Separated,    ///< Separated, non-overlapping contigous window
      Overlapping,  ///< Overlaping windows
      //==> add here if more are needed <==
      NBits     ///< Number of Bits currently supported
    };

Function Documentation

std::string sbn::bits::bitName ( triggerSource  bit )

inline

Returns a mnemonic short name of the beam type.

Todo:

Move into an implementation file once this header in the final location.

Definition at line 267 of file BeamBits.h.

                                                   {
  
  using namespace std::string_literals;
  switch (bit) {
    case triggerSource::Unknown:     return "unknown"s;
    case triggerSource::BNB:         return "BNB"s;
    case triggerSource::NuMI:        return "NuMI"s;
    case triggerSource::OffbeamBNB:  return "OffbeamBNB"s;
    case triggerSource::OffbeamNuMI: return "OffbeamNuMI"s;
    case triggerSource::Calib:       return "Calib"s;
    case triggerSource::NBits:       return "<invalid>"s;
  } // switch
  throw std::runtime_error("sbn::bits::bitName(triggerSource{ "s
    + std::to_string(value(bit)) + " }): unknown bit"s);
} // sbn::bitName()

std::string sbn::bits::bitName ( triggerLocation  bit )

inline

Returns a mnemonic short name of the trigger location.

Definition at line 285 of file BeamBits.h.

                                                     {

  using namespace std::string_literals;
  switch (bit) {
    case triggerLocation::CryoEast: return "Cryo E"s;
    case triggerLocation::CryoWest: return "Cryo W"s;
    case triggerLocation::TPCEE:    return "TPC EE"s;
    case triggerLocation::TPCEW:    return "TPC EW"s;
    case triggerLocation::TPCWE:    return "TPC WE"s;
    case triggerLocation::TPCWW:    return "TPC WW"s;
    case triggerLocation::NBits:    return "<invalid>"s;
  } // switch
  throw std::runtime_error("sbn::bits::bitName(triggerLocation{ "s
    + std::to_string(value(bit)) + " }): unknown bit"s);
} // sbn::bitName(triggerLocation)

std::string sbn::bits::bitName ( triggerType  bit )

inline

Returns a mnemonic short name of the trigger type.

Definition at line 302 of file BeamBits.h.

                                                 {

  using namespace std::string_literals;
  switch (bit) {
    case triggerType::Majority:    return "majority"s;
    case triggerType::MinimumBias: return "minimum bias"s;
    case triggerType::NBits:       return "<invalid>"s;
  } // switch
  throw std::runtime_error("sbn::bits::bitName(triggerType{ "s
    + std::to_string(value(bit)) + " }): unknown bit"s);
} // sbn::bitName(triggerType)

std::string sbn::bits::bitName ( triggerWindowMode  bit )

inline

Returns a mnemonic short name for the trigger window mode.

Definition at line 314 of file BeamBits.h.

                                                       {

  using namespace std::string_literals;
  switch (bit) {
    case sbn::bits::triggerWindowMode::Separated:    return "Separated Window"s;
    case sbn::bits::triggerWindowMode::Overlapping:  return "Overlapping Window"s;
    case sbn::bits::triggerWindowMode::NBits:    return "<invalid>"s;
  } // switch
  throw std::runtime_error("sbn::bits::bitName(triggerWindowMode{ "s
    + std::to_string(value(bit)) + " }): unknown bit"s);
} // triggerWindowMode

std::string sbn::bits::bitName ( gateSelection  bit )

inline

Returns a mnemonic short name for the trigger window mode.

Definition at line 327 of file BeamBits.h.

                                                   {

  using namespace std::string_literals;
  switch (bit) {
    case gateSelection::GateBNB:                     return "GateBNB"s;
    case gateSelection::DriftGateBNB:                return "DriftGateBNB"s;
    case gateSelection::GateNuMI:                    return "GateNuMI"s;
    case gateSelection::DriftGateNuMI:               return "DriftGateNuMI"s;
    case gateSelection::GateOffbeamBNB:              return "GateOffbeamBNB"s;
    case gateSelection::DriftGateOffbeamBNB:         return "DriftGateOffbeamBNB"s;
    case gateSelection::GateOffbeamNuMI:             return "GateOffbeamNuMI"s;
    case gateSelection::DriftGateOffbeamNuMI:        return "DriftGateOffbeamNuMI"s;
    case gateSelection::GateCalibration:             return "GateCalibration"s;
    case gateSelection::DriftGateCalibration:        return "DriftGateCalibration"s;
    case gateSelection::MinbiasGateBNB:              return "MinbiasGateBNB"s;
    case gateSelection::MinbiasGateNuMI:             return "MinbiasGateNuMI"s;
    case gateSelection::MinbiasGateOffbeamBNB:       return "MinbiasGateOffbeamBNB"s;
    case gateSelection::MinbiasGateOffbeamNuMI:      return "MinbiasGateOffbeamNuMI"s;
    case gateSelection::MinbiasGateCalibration:      return "MinbiasGateCalibration"s;
    case gateSelection::MinbiasDriftGateBNB:         return "MinbiasDriftGateBNB"s;
    case gateSelection::MinbiasDriftGateNuMI:        return "MinbiasDriftGateNuMI"s;
    case gateSelection::MinbiasDriftGateOffbeamBNB:  return "MinbiasDriftGateOffbeamBNB"s;
    case gateSelection::MinbiasDriftGateOffbeamNuMI: return "MinbiasDriftGateOffbeamNuMI"s;
    case gateSelection::MinbiasDriftGateCalibration: return "MinbiasDriftGateCalibration"s;
    case gateSelection::NBits:                       return "NBits"s;
  } // switch
  throw std::runtime_error("sbn::bits::bitName(gateSelection{ "s
    + std::to_string(value(bit)) + " }): unknown bit"s);
} // sbn::bitName()

template<typename EnumType >

constexpr bool sbn::bits::hasBitSet	(	mask_t< EnumType >	bitMask,
		EnumType	bit
	)

Returns whether the specified bit is set in bitMask.

Definition at line 232 of file BeamBits.h.

  { return bitMask & mask(bit); }

template<typename EnumType >

mask_t<EnumType> sbn::bits::makeMask ( typename mask_t< EnumType >::maskbits_t  bits )

noexcept

Converts a integral type into a mask.

template<typename EnumType , typename... OtherBits>

constexpr mask_t<EnumType> sbn::bits::mask	(	EnumType	bit,
		OtherBits...	otherBits
	)

Returns a mask with all specified bits set.

template<typename EnumType >

std::string sbn::bits::name

(

EnumType

bit

)

Returns the name of the specified bit. Delegates to bitName().

Definition at line 238 of file BeamBits.h.

  { return bitName(bit); }

template<typename EnumType >

std::vector< std::string > sbn::bits::names

(

mask_t< EnumType >

mask

)

Returns a list of the names of all the bits set in mask. Mask is interpreted as made of only bits of type EnumType.

Definition at line 244 of file BeamBits.h.

                                                         {
  static_assert(value(EnumType::NBits) >= 0);
  
  using namespace std::string_literals;
  
  constexpr std::size_t MaxBits = sizeof(mask) * 8U;
  constexpr std::size_t NSupportedBits = value(EnumType::NBits);
  
  std::vector<std::string> names;
  for (std::size_t bit = 0U; bit < MaxBits; ++bit) {
    auto const typedBit = static_cast<EnumType>(bit);
    if (!hasBitSet(mask, typedBit)) continue;
    names.push_back((bit > NSupportedBits)
      ? "<unsupported ["s + std::to_string(bit) + "]>"s: name(typedBit)
      );
  } // for
  return names;
  
} // sbn::bits::names()

template<typename EnumType >

constexpr auto sbn::bits::value

(

EnumType

bit

)

Returns the value of specified bit (conversion like enum to int).

Definition at line 215 of file BeamBits.h.

  { return static_cast<std::underlying_type_t<EnumType>>(bit); }