dunedaq::trgdataformats Namespace Reference

Namespaces
namespace	python

Classes
struct	TriggerActivityData
struct	TriggerCandidateData
struct	TriggerObjectOverlay
struct	TriggerPrimitive
	A single energy deposition on a TPC or PDS channel. More...
struct	TypeDefaults

Typedefs
using	tcinfo_t
using	TriggerActivity = TriggerObjectOverlay<TriggerActivityData, TriggerPrimitive>
using	TriggerCandidate = TriggerObjectOverlay<TriggerCandidateData, TriggerActivityData>
using	timestamp_t = uint64_t
using	timestamp_diff_t = int64_t
using	detid_t = uint8_t
using	trigger_number_t = uint64_t
using	channel_t = uint32_t
using	channel_diff_t = int32_t
using	version_t = uint8_t

Functions
const tcinfo_t &	get_trigger_candidate_type_names ()
TriggerCandidateData::Type	string_to_trigger_candidate_type (const std::string &name)
std::string	trigger_candidate_type_to_string (const TriggerCandidateData::Type type)

Variables
constexpr detid_t	g_whole_detector {std::numeric_limits<detid_t>::max() - 1}

Typedef Documentation

channel_diff_t

using dunedaq::trgdataformats::channel_diff_t = int32_t

Definition at line 57 of file Types.hpp.

channel_t

using dunedaq::trgdataformats::channel_t = uint32_t

Definition at line 56 of file Types.hpp.

detid_t

using dunedaq::trgdataformats::detid_t = uint8_t

Definition at line 48 of file Types.hpp.

tcinfo_t

using dunedaq::trgdataformats::tcinfo_t

Initial value:

std::array<std::pair<TriggerCandidateData::Type, std::string_view>,
                 static_cast<size_t>(TriggerCandidateData::Type::kFinalEnum)>

Definition at line 6 of file TriggerCandidateData.hxx.

timestamp_diff_t

using dunedaq::trgdataformats::timestamp_diff_t = int64_t

Definition at line 39 of file Types.hpp.

timestamp_t

using dunedaq::trgdataformats::timestamp_t = uint64_t

Definition at line 38 of file Types.hpp.

trigger_number_t

using dunedaq::trgdataformats::trigger_number_t = uint64_t

Definition at line 53 of file Types.hpp.

TriggerActivity

using dunedaq::trgdataformats::TriggerActivity = TriggerObjectOverlay<TriggerActivityData, TriggerPrimitive>

Definition at line 50 of file TriggerObjectOverlay.hpp.

TriggerCandidate

using dunedaq::trgdataformats::TriggerCandidate = TriggerObjectOverlay<TriggerCandidateData, TriggerActivityData>

Definition at line 52 of file TriggerObjectOverlay.hpp.

version_t

using dunedaq::trgdataformats::version_t = uint8_t

Definition at line 59 of file Types.hpp.

Function Documentation

get_trigger_candidate_type_names()

const tcinfo_t & dunedaq::trgdataformats::get_trigger_candidate_type_names ( )

inline

Definition at line 10 of file TriggerCandidateData.hxx.

  {
    // This container needs to be updated for each new TC type, as this is used
    // when configuring Trigger Bitwords, affecting trigger logic in
    // trigger::MLT
    
    static constexpr tcinfo_t names { {
      { TriggerCandidateData::Type::kUnknown, "kUnknown" },
      { TriggerCandidateData::Type::kTiming, "kTiming" },
    { TriggerCandidateData::Type::kTPCLowE, "kTPCLowE" },
    { TriggerCandidateData::Type::kSupernova, "kSupernova" },
    { TriggerCandidateData::Type::kRandom, "kRandom" },
    { TriggerCandidateData::Type::kPrescale, "kPrescale" },
    { TriggerCandidateData::Type::kADCSimpleWindow, "kADCSimpleWindow" },
    { TriggerCandidateData::Type::kHorizontalMuon, "kHorizontalMuon" },
    { TriggerCandidateData::Type::kMichelElectron, "kMichelElectron" },
    { TriggerCandidateData::Type::kPlaneCoincidence, "kPlaneCoincidence" },
    { TriggerCandidateData::Type::kDBSCAN, "kDBSCAN" },
    { TriggerCandidateData::Type::kChannelDistance, "kChannelDistance" },
    { TriggerCandidateData::Type::kBundle, "kBundle" },
    { TriggerCandidateData::Type::kCTBFakeTrigger, "kCTBFakeTrigger" },
    { TriggerCandidateData::Type::kCTBBeam, "kCTBBeam" },
    { TriggerCandidateData::Type::kCTBBeamChkvHL, "kCTBBeamChkvHL" },
    { TriggerCandidateData::Type::kCTBCustomD, "kCTBCustomD" },
    { TriggerCandidateData::Type::kCTBCustomE, "kCTBCustomE" },
    { TriggerCandidateData::Type::kCTBCustomF, "kCTBCustomF" },
    { TriggerCandidateData::Type::kCTBCustomG, "kCTBCustomG" },
    { TriggerCandidateData::Type::kCTBBeamChkvHLx, "kCTBBeamChkvHLx" },
    { TriggerCandidateData::Type::kCTBBeamChkvHxL, "kCTBBeamChkvHxL" },
    { TriggerCandidateData::Type::kCTBBeamChkvHxLx, "kCTBBeamChkvHxLx" },
    { TriggerCandidateData::Type::kNeutronSourceCalib, "kNeutronSourceCalib" },
    { TriggerCandidateData::Type::kChannelAdjacency, "kChannelAdjacency" },
    { TriggerCandidateData::Type::kCIBFakeTrigger, "kCIBFakeTrigger" },
    { TriggerCandidateData::Type::kCIBLaserTriggerP1, "kCIBLaserTriggerP1" },
    { TriggerCandidateData::Type::kCIBLaserTriggerP2, "kCIBLaserTriggerP2" },
    { TriggerCandidateData::Type::kCIBLaserTriggerP3, "kCIBLaserTriggerP3" },
    { TriggerCandidateData::Type::kCTBOffSpillSnapshot, "kCTBOffSpillSnapshot" },
    { TriggerCandidateData::Type::kCTBOffSpillCosmicJura, "kCTBOffSpillCosmicJura" },
    { TriggerCandidateData::Type::kCTBOffSpillCRTCosmic, "kCTBOffSpillCRTCosmic" },
    { TriggerCandidateData::Type::kCTBBeamSpillStart, "kCTBBeamSpillStart" },
    { TriggerCandidateData::Type::kCTBBeamSpillSnapshot, "kCTBBeamSpillSnapshot" },
    { TriggerCandidateData::Type::kCTBCustomC, "kCTBCustomC" },
    { TriggerCandidateData::Type::kCTBCustomPulseTrain, "kCTBCustomPulseTrain" },
    { TriggerCandidateData::Type::kDTSPulser, "kDTSPulser" },
    { TriggerCandidateData::Type::kDTSCosmic, "kDTSCosmic" },
    { TriggerCandidateData::Type::kSSPLEDCalibration, "kSSPLEDCalibration" },
    { TriggerCandidateData::Type::kProtoDUNEBSMWindow, "kProtoDUNEBSMWindow" }
      }
    };
 
 
    // Check to ensure that if a new TriggerCandidateData::Type is
    // created, this function is updated accordingly
 
    // The string in a default-initialized {type, string} pair will
    // boolean-equal ""
    static_assert(names[names.size() - 1].second != "", "The container providing names for TriggerCandidateData::Type values appears to be incomplete");
 
    return names;
  }

string_to_trigger_candidate_type()

TriggerCandidateData::Type dunedaq::trgdataformats::string_to_trigger_candidate_type ( const std::string & name )

inline

Definition at line 72 of file TriggerCandidateData.hxx.

                                                          {
    for (const auto& [type, type_name] : get_trigger_candidate_type_names()) {
      if (type_name == name)
    return type;
    }
    return TriggerCandidateData::Type::kUnknown;
  }

trigger_candidate_type_to_string()

std::string dunedaq::trgdataformats::trigger_candidate_type_to_string ( const TriggerCandidateData::Type type )

inline

Definition at line 81 of file TriggerCandidateData.hxx.

                                                                        {
    try {
      const auto& [dummy, type_name] { get_trigger_candidate_type_names().at(static_cast<size_t>(type)) };
      return std::string(type_name);
 
    } catch (std::exception &e) {
      return "kUnknown";
    }
  }

Variable Documentation

g_whole_detector

detid_t dunedaq::trgdataformats::g_whole_detector {std::numeric_limits<detid_t>::max() - 1}

constexpr

Definition at line 69 of file Types.hpp.