tpglibs::NaiveRunSumProcessor Class Reference

Naive signal processor: Calculates the running sum of the signal. More...

#include <NaiveRunSumProcessor.hpp>

Inheritance diagram for tpglibs::NaiveRunSumProcessor:

Collaboration diagram for tpglibs::NaiveRunSumProcessor:

Public Member Functions
naive_array_t	process (const naive_array_t &signal) override
	Calculate and store the running sum.
void	configure (const nlohmann::json &config, const int16_t *plane_numbers) override
	Configures the R factor and S factor according to plane.
Public Member Functions inherited from tpglibs::NaiveProcessor
Public Member Functions inherited from tpglibs::AbstractProcessor< std::array< int16_t, 16 > >
virtual	~AbstractProcessor ()=default
ProcessorInternalStateBufferManager< std::array< int16_t, 16 > > *	_get_internal_state_buffer_manager ()
ProcessorInternalStateNameRegistry< std::array< int16_t, 16 > > *	_get_internal_state_name_registry ()
virtual void	configure_internal_state_collection (const nlohmann::json &config)
	Configure common internal state collection parameters.
void	set_next_processor (std::shared_ptr< AbstractProcessor< std::array< int16_t, 16 > > > next_processor)
	Setter for next processor.
std::shared_ptr< AbstractProcessor< std::array< int16_t, 16 > > >	get_next_processor ()
	Getter for next processor.
virtual std::vector< std::string >	get_requested_internal_state_names () const
	Get the names of requested internal states (delegates to registry).
virtual ProcessorMetricArray< std::array< int16_t, 16 > >	read_internal_states_as_integer_array ()

Private Attributes
naive_array_t	m_memory_factor
	The R factor in the model equation.
naive_array_t	m_scale_factor
	The S factor in the model equation.
naive_array_t	m_running_sum
	The RS in the model equation.

Additional Inherited Members
Public Types inherited from tpglibs::NaiveProcessor
using	naive_array_t = std::array<int16_t, 16>
	The naive version uses a standard array instead of __m256i.
Public Types inherited from tpglibs::AbstractProcessor< std::array< int16_t, 16 > >
using	signal_type_t
	Signal type to process on. General __m256i.
Protected Attributes inherited from tpglibs::AbstractProcessor< std::array< int16_t, 16 > >
ProcessorInternalStateBufferManager< std::array< int16_t, 16 > >	m_internal_state_buffer_manager
ProcessorInternalStateNameRegistry< std::array< int16_t, 16 > >	m_internal_state_name_registry
std::atomic< uint64_t >	m_samples
bool	m_collect_internal_state_flag
uint64_t	m_sample_period

Detailed Description

Naive signal processor: Calculates the running sum of the signal.

Calculates the running sum of the signal with some factors. This tries to model the following equation: RS = R * RS + S * signal, where

• RS is the on-going running sum,
• R is the memory factor of the on-going running sum,
• S is the scale factor for the incoming signal to avoid overflowing,
• signal is the incoming signal. Division is intentionally unorthodox to match what is possible in AVX.

Definition at line 29 of file NaiveRunSumProcessor.hpp.

Member Function Documentation

configure()

void tpglibs::NaiveRunSumProcessor::configure ( const nlohmann::json & config, const int16_t * plane_numbers )

overridevirtual

Configures the R factor and S factor according to plane.

Parameters

config	JSON of the R and S factors to use per plane.
plane_numbers	Array of plane numbers. Gives the channels to apply the R and S factors.

Implements tpglibs::AbstractProcessor< std::array< int16_t, 16 > >.

Definition at line 15 of file NaiveRunSumProcessor.cpp.

                                                                                             {
  // Configure common metric collection parameters
  // Register pointers to the ACTUAL member variables, not copies
  // Use shared_ptr with no-op deleter to avoid double-free
  m_internal_state_name_registry.register_internal_state("r", 
    std::shared_ptr<naive_array_t>(&m_memory_factor, [](auto*){}));
  m_internal_state_name_registry.register_internal_state("s", 
    std::shared_ptr<naive_array_t>(&m_scale_factor, [](auto*){}));
  m_internal_state_name_registry.register_internal_state("rs", 
    std::shared_ptr<naive_array_t>(&m_running_sum, [](auto*){}));
    
  configure_internal_state_collection(config);
 
  int16_t config_memory[3] = {config["memory_factor_plane0"],
                              config["memory_factor_plane1"],
                              config["memory_factor_plane2"]};
  int16_t config_scale[3]  = {config["scale_factor_plane0"],
                              config["scale_factor_plane1"],
                              config["scale_factor_plane2"]};
 
  for (int i = 0; i < 16; i++) {
    m_memory_factor[i] = config_memory[plane_numbers[i]];
    m_scale_factor[i] = config_scale[plane_numbers[i]];
  }
}

process()

NaiveRunSumProcessor::naive_array_t tpglibs::NaiveRunSumProcessor::process ( const naive_array_t & signal )

overridevirtual

Calculate and store the running sum.

Parameters

signal

The input signal to process on.

Returns

The calculated running sum.

Reimplemented from tpglibs::NaiveProcessor.

Definition at line 41 of file NaiveRunSumProcessor.cpp.

                                                                                           {
  // Update sample counter and write internal states to buffer for harvesting
  m_samples++;
  if (m_collect_internal_state_flag && (m_samples % m_sample_period == 0)) {
    m_internal_state_buffer_manager.write_to_active_buffer();
  }
 
  for (int i = 0; i < 16; i++) {
    int32_t scaled_rs = _naive_div_int16(m_running_sum[i], 10);
    scaled_rs *= m_memory_factor[i];
 
    int32_t scaled_signal = _naive_div_int16(signal[i], 10);
    scaled_signal *= m_scale_factor[i];
 
    int32_t intermediate = scaled_signal + scaled_rs;
    m_running_sum[i] = std::min(intermediate, INT16_MAX);
  }
  return NaiveProcessor::process(m_running_sum);
}

Member Data Documentation

m_memory_factor

naive_array_t tpglibs::NaiveRunSumProcessor::m_memory_factor

private

The R factor in the model equation.

Definition at line 31 of file NaiveRunSumProcessor.hpp.

m_running_sum

naive_array_t tpglibs::NaiveRunSumProcessor::m_running_sum

private

The RS in the model equation.

Definition at line 37 of file NaiveRunSumProcessor.hpp.

m_scale_factor

naive_array_t tpglibs::NaiveRunSumProcessor::m_scale_factor

private

The S factor in the model equation.

Definition at line 34 of file NaiveRunSumProcessor.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/tpglibs/include/tpglibs/NaiveRunSumProcessor.hpp
• /github/workspace/dunedaq/sourcecode/tpglibs/src/NaiveRunSumProcessor.cpp