DIY Auto-Correlator 1.0
Auto-Correlator Card implementation using Teensy 4.x microcontrollers.
Public Member Functions | Public Attributes | Private Attributes | List of all members
Accumulator Class Reference

Adapter object responsible for accumulating the points and coarsening the time-series as per the relavent linear-correlator time-resolution. More...

#include <accumulator.hpp>

Public Member Functions

void do_accumulate (unsigned int buffer_cnt)
 Sets the number of points to buffer(accumulate) before pushing to Correlator object. More...
 
template<typename LinCorrType >
void pipe (LinCorrType &channel, const counter_t datum)
 Accumulates data points until the BufferPoints criteria is satisfied, after which the points are pushed to the channel. More...
 

Public Attributes

unsigned int Buffer_count = 0
 Number of points accumulated and binned together. More...
 

Private Attributes

counter_t Accumulate = 0
 Stores the value of the accumulate. More...
 
unsigned int Update_count = 0
 Maintains a counter of the items to accumuate. More...
 

Detailed Description

Adapter object responsible for accumulating the points and coarsening the time-series as per the relavent linear-correlator time-resolution.

Member Function Documentation

◆ do_accumulate()

void Accumulator::do_accumulate ( unsigned int  buffer_cnt)
inline

Sets the number of points to buffer(accumulate) before pushing to Correlator object.

◆ pipe()

template<typename LinCorrType >
void Accumulator::pipe ( LinCorrType &  channel,
const counter_t  datum 
)
inline

Accumulates data points until the BufferPoints criteria is satisfied, after which the points are pushed to the channel.

Member Data Documentation

◆ Accumulate

counter_t Accumulator::Accumulate = 0
private

Stores the value of the accumulate.

◆ Buffer_count

unsigned int Accumulator::Buffer_count = 0

Number of points accumulated and binned together.

◆ Update_count

unsigned int Accumulator::Update_count = 0
private

Maintains a counter of the items to accumuate.


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