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

Template specialization. More...

#include <monitor_channel.hpp>

Public Member Functions

template<typename DataType >
void push_back (DataType data)
 Adds datum to the channel. More...
 
float_t mean () const __attribute__((always_inline))
 Returns the estimated mean. More...
 
AccumulateType accumulate () const __attribute__((always_inline))
 Returns the Accumulate so far. More...
 
void reset ()
 

Public Attributes

volatile AccumulateType Accumulate = 0.0
 Sum of the received values. More...
 
volatile uint32_t Count = 0
 Count of the received values (Initialized to prevent DivideByZero error) More...
 

Private Types

using AccumulateType = float
 

Detailed Description

Template specialization.

Member Typedef Documentation

◆ AccumulateType

using MonitorChannel< true >::AccumulateType = float
private

Member Function Documentation

◆ accumulate()

AccumulateType MonitorChannel< true >::accumulate ( ) const
inline

Returns the Accumulate so far.

◆ mean()

float_t MonitorChannel< true >::mean ( ) const
inline

Returns the estimated mean.

◆ push_back()

template<typename DataType >
void MonitorChannel< true >::push_back ( DataType  data)
inline

Adds datum to the channel.

◆ reset()

void MonitorChannel< true >::reset ( )
inline

Member Data Documentation

◆ Accumulate

volatile AccumulateType MonitorChannel< true >::Accumulate = 0.0

Sum of the received values.

◆ Count

volatile uint32_t MonitorChannel< true >::Count = 0

Count of the received values (Initialized to prevent DivideByZero error)


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