DIY Auto-Correlator 1.0
Auto-Correlator Card implementation using Teensy 4.x microcontrollers.
Public Member Functions | Public Attributes | List of all members
Lin_CrossCorr_RT_Teensy< Series_size > Class Template Reference

This is an implementation of Lin_ACorr_RT_Base for Teensy with (No normalisation or baseline subtraction.) More...

#include <Lin_CrossCorr_RT_Teensy.hpp>

Inheritance diagram for Lin_CrossCorr_RT_Teensy< Series_size >:
Inheritance graph
[legend]
Collaboration diagram for Lin_CrossCorr_RT_Teensy< Series_size >:
Collaboration graph
[legend]

Public Member Functions

void __attribute__ ((flatten)) push_datum(counter_t datum1
 Stores the last active index → Post-increment. More...
 
Series_array2 push_back (datum2)
 
 for (unsigned int i=0;i<=Series_size;i++)
 
void __attribute__ ((flatten)) push_data(const counter_t *container1
 

Public Attributes

counter_t Channel_array12 [Series_size] = {0}
 
counter_t Channel_array21 [Series_size] = {0}
 Stores the Channel output - 12. More...
 
Simpler_Circular_Buffer< counter_t, Series_size > Series_array1
 Stores the Channel output - 21. More...
 
Simpler_Circular_Buffer< counter_t, Series_size > Series_array2
 
index_t Series_index1 = 0
 
index_t Series_index2 = 0
 Stores the last active index → Post-increment. More...
 
void counter_t datum2 override
 
 Series_index1
 
 Series_index2
 
void const counter_tcontainer2
 

Detailed Description

template<index_t Series_size>
class Lin_CrossCorr_RT_Teensy< Series_size >

This is an implementation of Lin_ACorr_RT_Base for Teensy with (No normalisation or baseline subtraction.)

Note
{ Template parameter - Size of the Series and Channel array and indicates the maximum points that can be stored by the correlator object. The circuular buffer will then rewrite the older points to accomodate for the other points. }

Member Function Documentation

◆ __attribute__() [1/2]

template<index_t Series_size>
void Lin_CrossCorr_RT_Teensy< Series_size >::__attribute__ ( (flatten)  ) const

◆ __attribute__() [2/2]

template<index_t Series_size>
void Lin_CrossCorr_RT_Teensy< Series_size >::__attribute__ ( (flatten)  )

Stores the last active index → Post-increment.

◆ for()

template<index_t Series_size>
Lin_CrossCorr_RT_Teensy< Series_size >::for ( unsigned int  i = 0; i <= Series_size; i++)
inline

◆ push_back()

template<index_t Series_size>
Series_array2 Lin_CrossCorr_RT_Teensy< Series_size >::push_back ( datum2  )

Member Data Documentation

◆ Channel_array12

template<index_t Series_size>
counter_t Lin_CrossCorr_RT_Teensy< Series_size >::Channel_array12[Series_size] = {0}

◆ Channel_array21

template<index_t Series_size>
counter_t Lin_CrossCorr_RT_Teensy< Series_size >::Channel_array21[Series_size] = {0}

Stores the Channel output - 12.

◆ container2

template<index_t Series_size>
void const counter_t* Lin_CrossCorr_RT_Teensy< Series_size >::container2

◆ override

template<index_t Series_size>
void counter_t datum2 Lin_CrossCorr_RT_Teensy< Series_size >::override
Initial value:
{
Series_array1.push_back(datum1)
Simpler_Circular_Buffer< counter_t, Series_size > Series_array1
Stores the Channel output - 21.
Definition: Lin_CrossCorr_RT_Teensy.hpp:20

◆ Series_array1

template<index_t Series_size>
Simpler_Circular_Buffer<counter_t, Series_size> Lin_CrossCorr_RT_Teensy< Series_size >::Series_array1

Stores the Channel output - 21.

Stores the data points in a circular Buffer

◆ Series_array2

template<index_t Series_size>
Simpler_Circular_Buffer<counter_t, Series_size> Lin_CrossCorr_RT_Teensy< Series_size >::Series_array2

◆ Series_index1 [1/2]

template<index_t Series_size>
index_t Lin_CrossCorr_RT_Teensy< Series_size >::Series_index1 = 0

◆ Series_index1 [2/2]

template<index_t Series_size>
Lin_CrossCorr_RT_Teensy< Series_size >::Series_index1

◆ Series_index2 [1/2]

template<index_t Series_size>
index_t Lin_CrossCorr_RT_Teensy< Series_size >::Series_index2 = 0

Stores the last active index → Post-increment.

◆ Series_index2 [2/2]

template<index_t Series_size>
Lin_CrossCorr_RT_Teensy< Series_size >::Series_index2

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