triggeralgs::TriggerCandidateMaker Class Reference

#include <TriggerCandidateMaker.hpp>

Inheritance diagram for triggeralgs::TriggerCandidateMaker:

Public Member Functions
virtual	~TriggerCandidateMaker ()=default
void	operator() (const TriggerActivity &input_ta, std::vector< TriggerCandidate > &output_tc)
virtual void	process (const TriggerActivity &input_ta, std::vector< TriggerCandidate > &output_tc)=0
	TA processing function that creates & fills TCs.
virtual bool	preprocess (const TriggerActivity &)
	TA pre-processing/filtering.
virtual void	postprocess (std::vector< TriggerCandidate > &output_tc)
	Post-processing/filtering of the TCs, e.g. prescale.
virtual void	flush (timestamp_t, std::vector< TriggerCandidate > &)
virtual void	configure (const nlohmann::json &config)

Public Attributes
std::atomic< uint64_t >	m_data_vs_system_time = 0
std::atomic< uint64_t >	m_initial_offset = 0
uint64_t	m_prescale = 1
	Configurable prescale factor.
uint64_t	m_tc_count = 0
	TC made count for prescaling.
TriggerCandidate::Type	m_tc_type_out = TriggerCandidate::Type::kUnknown
	Configurable TC type output.

Detailed Description

Definition at line 28 of file TriggerCandidateMaker.hpp.

Constructor & Destructor Documentation

~TriggerCandidateMaker()

virtual triggeralgs::TriggerCandidateMaker::~TriggerCandidateMaker ( )

virtualdefault

Member Function Documentation

configure()

virtual void triggeralgs::TriggerCandidateMaker::configure ( const nlohmann::json & config )

inlinevirtual

Reimplemented in triggeralgs::TCMakerADCSimpleWindowAlgorithm, triggeralgs::TCMakerBundleNAlgorithm, triggeralgs::TCMakerChannelAdjacencyAlgorithm, triggeralgs::TCMakerChannelDistanceAlgorithm, triggeralgs::TCMakerDBSCANAlgorithm, triggeralgs::TCMakerHorizontalMuonAlgorithm, triggeralgs::TCMakerMichelElectronAlgorithm, triggeralgs::TCMakerPlaneCoincidenceAlgorithm, and triggeralgs::TCMakerPrescaleAlgorithm.

Definition at line 101 of file TriggerCandidateMaker.hpp.

  {
    // Don't do anyting if the config does not exist
    if (!config.is_object()) {
      return;
    }
 
    if (config.contains("prescale")) {
      m_prescale = config["prescale"];
    }
 
    if (config.contains("tc_type_name")) {
      m_tc_type_out = static_cast<TriggerCandidate::Type>(
          dunedaq::trgdataformats::string_to_trigger_candidate_type(config["tc_type_name"]));
    }
 
    if (m_tc_type_out == TriggerCandidate::Type::kUnknown) {
      // 27-Feb-2025, KAB: moified the following statement to check whether the configuration
      // contains the tc_type_name parameter before trying to add it do the exception message.
      throw(InvalidConfiguration(ERS_HERE, "Provided an unknown output TC type: " +
                                 (config.contains("tc_type_name") ?
                                  std::string(config["tc_type_name"]) : "null")));
    }
 
    TLOG() << "[TCM]: prescale   : " << m_prescale;
    TLOG() << "[TCM]: TC type out: " << config["tc_type_name"];
  }

flush()

virtual void triggeralgs::TriggerCandidateMaker::flush ( timestamp_t , std::vector< TriggerCandidate > &  )

inlinevirtual

Definition at line 100 of file TriggerCandidateMaker.hpp.

{}

operator()()

void triggeralgs::TriggerCandidateMaker::operator() ( const TriggerActivity & input_ta, std::vector< TriggerCandidate > & output_tc )

inline

Definition at line 32 of file TriggerCandidateMaker.hpp.

  {
    // Apply TP filtering
    if (!preprocess(input_ta)) {
      return;
    }
 
    // Process TP, to implement per alg triggeralgs
    process(input_ta, output_tc);
 
    // Postprocess TA, e.g. prescaling
    postprocess(output_tc);
  }

postprocess()

virtual void triggeralgs::TriggerCandidateMaker::postprocess ( std::vector< TriggerCandidate > & output_tc )

inlinevirtual

Post-processing/filtering of the TCs, e.g. prescale.

Takes a vector of TCs and removes ones that we want to filter out, e.g. based on prescaling.

Todo

: Like in preprocessing: implement something more efficient, e.g. vec of tasks

Parameters

output_tc[out]

output trigger candidate vector

Definition at line 78 of file TriggerCandidateMaker.hpp.

  {
    // Don't post-process TCs if there's no TCs made.
    if (output_tc.size() == 0) {
      return;
    }
 
    // Apply prescale by erasing TCs
    if (m_prescale > 1) {
      for (std::vector<TriggerCandidate>::iterator iter = output_tc.begin(); iter != output_tc.end();) {
        m_tc_count++;
 
        if (m_tc_count % m_prescale != 0) {
          iter = output_tc.erase(iter);
          continue;
        }
 
        TLOG_DEBUG(TLVL_DEBUG_10) << "Emitting prescaled TriggerCandidate " << (m_tc_count-1);
        ++iter;
      }
    }
  }

preprocess()

virtual bool triggeralgs::TriggerCandidateMaker::preprocess ( const TriggerActivity & )

inlinevirtual

TA pre-processing/filtering.

Todo

: Implement ta-filtering, e.g. by plane or sub-detector

: Implement something smarter & more efficient if no filtering: vector of functions, or c-o-c

Parameters

[in]

intput_tp

input TP reference for filtering

Returns

bool true if we want to keep the TP

Definition at line 63 of file TriggerCandidateMaker.hpp.

  {
    return true;
  }

process()

virtual void triggeralgs::TriggerCandidateMaker::process ( const TriggerActivity & input_ta, std::vector< TriggerCandidate > & output_tc )

pure virtual

TA processing function that creates & fills TCs.

Parameters

input_ta[in]	Input TA for the triggering algorithm
output_tc[out]	Output vector of TCs to fill by the algorithm

Implemented in triggeralgs::TCMakerADCSimpleWindowAlgorithm, triggeralgs::TCMakerBundleNAlgorithm, triggeralgs::TCMakerChannelAdjacencyAlgorithm, triggeralgs::TCMakerChannelDistanceAlgorithm, triggeralgs::TCMakerDBSCANAlgorithm, triggeralgs::TCMakerHorizontalMuonAlgorithm, triggeralgs::TCMakerMichelElectronAlgorithm, triggeralgs::TCMakerPlaneCoincidenceAlgorithm, triggeralgs::TCMakerPrescaleAlgorithm, and triggeralgs::TCMakerSupernovaAlgorithm.

Member Data Documentation

m_data_vs_system_time

std::atomic<uint64_t> triggeralgs::TriggerCandidateMaker::m_data_vs_system_time = 0

Definition at line 129 of file TriggerCandidateMaker.hpp.

m_initial_offset

std::atomic<uint64_t> triggeralgs::TriggerCandidateMaker::m_initial_offset = 0

Definition at line 130 of file TriggerCandidateMaker.hpp.

m_prescale

uint64_t triggeralgs::TriggerCandidateMaker::m_prescale = 1

Configurable prescale factor.

Definition at line 133 of file TriggerCandidateMaker.hpp.

m_tc_count

uint64_t triggeralgs::TriggerCandidateMaker::m_tc_count = 0

TC made count for prescaling.

Definition at line 135 of file TriggerCandidateMaker.hpp.

m_tc_type_out

TriggerCandidate::Type triggeralgs::TriggerCandidateMaker::m_tc_type_out = TriggerCandidate::Type::kUnknown

Configurable TC type output.

Definition at line 138 of file TriggerCandidateMaker.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/triggeralgs/include/triggeralgs/TriggerCandidateMaker.hpp