Orion
high-rate readout
Public Member Functions | List of all members
itk::itkpix::endec::codec::StreamDecoder< OutPut, EnableLogging > Class Template Reference

Decode a ITK pixel data stream. More...

#include <decoder.hpp>

Public Member Functions

 StreamDecoder (const std::span< const uint64_t > data_, OutPut &proc, Options opt=Options())
 
void decode ()
 Decode the ITK pixel data stream. More...
 
std::size_t bits_processed () const
 

Detailed Description

template<itk::itkpix::endec::concepts::EventCallback OutPut, bool EnableLogging = false>
class itk::itkpix::endec::codec::StreamDecoder< OutPut, EnableLogging >

Decode a ITK pixel data stream.

Template Parameters
TData buffer type
OutPutThe type of output processor
OptsDecoder options

Member Function Documentation

◆ decode()

template<itk::itkpix::endec::concepts::EventCallback OutPut, bool EnableLogging = false>
void itk::itkpix::endec::codec::StreamDecoder< OutPut, EnableLogging >::decode ( )
inline

Decode the ITK pixel data stream.

This function decodes the ITK pixel data stream by reading the compressed data and generating events for each code word and hit map.

Note
This function assumes that the data buffer is valid and has enough data to be processed.
This function uses lambda functions to simplify the code and improve readability.
The function guarantees that the bits_processed() function returns the correct number of processed bits after the function finishes.

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