triggeralgs::TriggerActivityMaker Class Reference

#include <TriggerActivityMaker.hpp>

Inheritance diagram for triggeralgs::TriggerActivityMaker:

Public Member Functions
virtual	~TriggerActivityMaker ()=default
void	operator() (const TriggerPrimitive &input_tp, std::vector< TriggerActivity > &output_ta)
virtual void	process (const TriggerPrimitive &input_tp, std::vector< TriggerActivity > &output_ta)=0
	TP processing function that creates & fills TAs.
virtual bool	preprocess (const TriggerPrimitive &input_tp)
	TP pre-processing/filtering.
virtual void	postprocess (std::vector< TriggerActivity > &output_ta)
	Post-processing/filtering of the TAs, e.g. prescale.
virtual void	flush (timestamp_t, std::vector< TriggerActivity > &)
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_ta_count = 0
	TA made count for prescaling.
uint32_t	m_max_samples_over_threshold = std::numeric_limits<uint32_t>::max()
	Time-over-threshold TP filtering.

Detailed Description

Definition at line 28 of file TriggerActivityMaker.hpp.

Constructor & Destructor Documentation

~TriggerActivityMaker()

virtual triggeralgs::TriggerActivityMaker::~TriggerActivityMaker ( )

virtualdefault

Member Function Documentation

configure()

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

inlinevirtual

Reimplemented in triggeralgs::TAMakerADCSimpleWindowAlgorithm, triggeralgs::TAMakerBundleNAlgorithm, triggeralgs::TAMakerChannelAdjacencyAlgorithm, triggeralgs::TAMakerChannelDistanceAlgorithm, triggeralgs::TAMakerDBSCANAlgorithm, triggeralgs::TAMakerHorizontalMuonAlgorithm, triggeralgs::TAMakerMichelElectronAlgorithm, triggeralgs::TAMakerPlaneCoincidenceAlgorithm, and triggeralgs::TAMakerPrescaleAlgorithm.

Definition at line 111 of file TriggerActivityMaker.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("max_samples_over_threshold"))
      m_max_samples_over_threshold = config["max_samples_over_threshold"];
 
    TLOG() << "[TAM]: max sot   : " << m_max_samples_over_threshold;
    TLOG() << "[TAM]: prescale  : " << m_prescale;
  }

flush()

virtual void triggeralgs::TriggerActivityMaker::flush ( timestamp_t , std::vector< TriggerActivity > &  )

inlinevirtual

Reimplemented in triggeralgs::TAMakerSupernovaAlgorithm.

Definition at line 110 of file TriggerActivityMaker.hpp.

{}

operator()()

void triggeralgs::TriggerActivityMaker::operator() ( const TriggerPrimitive & input_tp, std::vector< TriggerActivity > & output_ta )

inline

Definition at line 32 of file TriggerActivityMaker.hpp.

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

postprocess()

virtual void triggeralgs::TriggerActivityMaker::postprocess ( std::vector< TriggerActivity > & output_ta )

inlinevirtual

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

Takes a vector of TAs 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_ta[out]

output triggeractivity vector

Definition at line 85 of file TriggerActivityMaker.hpp.

  {
    // Don't post-process TAs if there's no TAs made.
    if (output_ta.size() == 0) {
      return;
    }
 
    // Apply prescale by erasing TAs
    if (m_prescale > 1) {
      for (std::vector<TriggerActivity>::iterator iter = output_ta.begin(); iter != output_ta.end();) {
        m_ta_count++;
 
        if (m_ta_count % m_prescale != 0) {
          iter = output_ta.erase(iter);
          continue;
        }
 
        TLOG_DEBUG(TLVL_DEBUG_MEDIUM) << "Emitting prescaled TriggerActivity " << (m_ta_count-1)
                                      << " with time start/end/activity: " << iter->time_start
                                      << " " << iter->time_end << " " << iter->time_activity;
        ++iter;
      }
    }
  }

preprocess()

virtual bool triggeralgs::TriggerActivityMaker::preprocess ( const TriggerPrimitive & input_tp )

inlinevirtual

TP pre-processing/filtering.

Takes a TP and returns true or false depending whether we want to process that TP into a TA algorithm.

Todo

: Implement tp-filtering, e.g. SOT, plane, channel and whatnot

: 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 66 of file TriggerActivityMaker.hpp.

  {
    if (input_tp.samples_over_threshold > m_max_samples_over_threshold) {
      return false;
    }
 
    return true;
  }

process()

virtual void triggeralgs::TriggerActivityMaker::process ( const TriggerPrimitive & input_tp, std::vector< TriggerActivity > & output_ta )

pure virtual

TP processing function that creates & fills TAs.

Parameters

input_tp[in]	Input TP for the triggering algorithm
output_ta[out]	Output vector of TAs to fill by the algorithm

Implemented in triggeralgs::TAMakerADCSimpleWindowAlgorithm, triggeralgs::TAMakerBundleNAlgorithm, triggeralgs::TAMakerChannelAdjacencyAlgorithm, triggeralgs::TAMakerChannelDistanceAlgorithm, triggeralgs::TAMakerDBSCANAlgorithm, triggeralgs::TAMakerHorizontalMuonAlgorithm, triggeralgs::TAMakerMichelElectronAlgorithm, triggeralgs::TAMakerPlaneCoincidenceAlgorithm, triggeralgs::TAMakerPrescaleAlgorithm, and triggeralgs::TAMakerSupernovaAlgorithm.

Member Data Documentation

m_data_vs_system_time

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

Definition at line 127 of file TriggerActivityMaker.hpp.

m_initial_offset

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

Definition at line 128 of file TriggerActivityMaker.hpp.

m_max_samples_over_threshold

uint32_t triggeralgs::TriggerActivityMaker::m_max_samples_over_threshold = std::numeric_limits<uint32_t>::max()

Time-over-threshold TP filtering.

Definition at line 136 of file TriggerActivityMaker.hpp.

m_prescale

uint64_t triggeralgs::TriggerActivityMaker::m_prescale = 1

Configurable prescale factor.

Definition at line 131 of file TriggerActivityMaker.hpp.

m_ta_count

uint64_t triggeralgs::TriggerActivityMaker::m_ta_count = 0

TA made count for prescaling.

Definition at line 133 of file TriggerActivityMaker.hpp.

---

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

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