Raw data description. More...
Classes | |
class | AuxDetDigit |
class | BeamInfo |
class | DAQHeader |
class | ExternalTrigger |
class | OpDetPulse |
class | OpDetWaveform |
class | RawDigit |
Collection of charge vs time digitized from a single readout channel. More... | |
class | RDTimeStamp |
class | Trigger |
Typedefs | |
typedef enum raw::_compress | Compress_t |
typedef enum raw::_auxdettype | AuxDetType_t |
typedef int | TDCtick_t |
Type representing a TDC tick. More... | |
typedef unsigned int | ChannelID_t |
Type representing the ID of a readout channel. More... | |
typedef long long | TriggerTimeStamp_t |
type of trigger time stamp More... | |
typedef short | ADC_Count_t |
typedef unsigned int | Channel_t |
typedef double | TimeStamp_t |
us since 1970, based on TimeService More... | |
Enumerations | |
enum | _compress { kNone, kHuffman, kZeroSuppression, kZeroHuffman, kDynamicDec, kFibonacci } |
enum | _auxdettype { kUnknownAuxDet, kScintillator, kTimeOfFlight, kCherenkov } |
Functions | |
constexpr bool | isValidChannelID (raw::ChannelID_t channel) |
std::ostream & | operator<< (std::ostream &os, const raw::BeamInfo &o) |
bool | operator< (const OpDetWaveform &lhs, const OpDetWaveform &rhs) |
void | Compress (std::vector< short > &adc, raw::Compress_t compress) |
Compresses a raw data buffer. More... | |
void | Compress (std::vector< short > &adc, raw::Compress_t compress, int &nearestneighbor) |
void | Compress (std::vector< short > &adc, raw::Compress_t compress, unsigned int &zerothreshold) |
void | Compress (std::vector< short > &adc, raw::Compress_t compress, unsigned int &zerothreshold, int &nearestneighbor) |
void | Compress (const boost::circular_buffer< std::vector< short >> &adcvec_neighbors, std::vector< short > &adc, raw::Compress_t compress, unsigned int &zerothreshold, int &nearestneighbor) |
void | Compress (std::vector< short > &adc, raw::Compress_t compress, unsigned int &zerothreshold, int pedestal, int &nearestneighbor, bool fADCStickyCodeFeature) |
void | Compress (const boost::circular_buffer< std::vector< short >> &adcvec_neighbors, std::vector< short > &adc, raw::Compress_t compress, unsigned int &zerothreshold, int pedestal, int &nearestneighbor, bool fADCStickyCodeFeature) |
void | ZeroSuppression (std::vector< short > &adc, unsigned int &zerothreshold) |
void | ZeroSuppression (std::vector< short > &adc, unsigned int &zerothreshold, int &nearestneighbor) |
void | ZeroSuppression (std::vector< short > &adc, unsigned int &zerothreshold, int pedestal, int &nearestneighbor, bool fADCStickyCodeFeature) |
void | ZeroSuppression (const boost::circular_buffer< std::vector< short >> &adcvec_neighbors, std::vector< short > &adc, unsigned int &zerothreshold, int &nearestneighbor) |
void | ZeroSuppression (const boost::circular_buffer< std::vector< short >> &adcvec_neighbors, std::vector< short > &adc, unsigned int &zerothreshold, int pedestal, int &nearestneighbor, bool fADCStickyCodeFeature) |
void | ZeroUnsuppression (const std::vector< short > &adc, std::vector< short > &uncompressed) |
void | ZeroUnsuppression (const std::vector< short > &adc, std::vector< short > &uncompressed, int pedestal) |
void | Uncompress (const std::vector< short > &adc, std::vector< short > &uncompressed, raw::Compress_t compress) |
Uncompresses a raw data buffer. More... | |
void | Uncompress (const std::vector< short > &adc, std::vector< short > &uncompressed, int pedestal, raw::Compress_t compress) |
void | CompressHuffman (std::vector< short > &adc) |
void | UncompressHuffman (const std::vector< short > &adc, std::vector< short > &uncompressed) |
int | ADCStickyCodeCheck (const short adc_value, const int pedestal, bool fADCStickyCodeFeature) |
void | add_to_sequence_terminate (std::vector< bool > array, std::vector< bool > &cmp) |
void | CompressFibonacci (std::vector< short > &wf, std::function< void(int, std::vector< std::vector< bool >> &)> add_to_table) |
void | UncompressFibonacci (const std::vector< short > &adc, std::vector< short > &uncompressed, std::function< int(std::vector< bool > &)> decode_table_chunk) |
void | fibonacci_encode_table (int end, std::vector< std::vector< bool >> &table) |
short | fibonacci_decode (std::vector< bool > &chunk) |
constexpr bool | isValidChannel (Channel_t channel) |
Returns whether the specified one is a valid channel number. More... | |
Variables | |
constexpr ChannelID_t | InvalidChannelID = std::numeric_limits<ChannelID_t>::max() |
ID of an invalid channel. More... | |
const unsigned int | onemask = 0x003f |
constexpr Channel_t | InvalidChannel = std::numeric_limits<Channel_t>::max() |
Mnemonics for an invalid channel number. More... | |
Raw data description.
Raw data description and utilities.
typedef short raw::ADC_Count_t |
Definition at line 21 of file lardataobj/lardataobj/RawData/OpDetWaveform.h.
typedef enum raw::_auxdettype raw::AuxDetType_t |
typedef unsigned int raw::Channel_t |
Definition at line 22 of file lardataobj/lardataobj/RawData/OpDetWaveform.h.
typedef unsigned int raw::ChannelID_t |
Type representing the ID of a readout channel.
Definition at line 28 of file RawTypes.h.
typedef enum raw::_compress raw::Compress_t |
typedef int raw::TDCtick_t |
Type representing a TDC tick.
Definition at line 25 of file RawTypes.h.
typedef double raw::TimeStamp_t |
us since 1970, based on TimeService
Definition at line 23 of file lardataobj/lardataobj/RawData/OpDetWaveform.h.
typedef long long raw::TriggerTimeStamp_t |
type of trigger time stamp
Definition at line 13 of file ExternalTrigger.h.
enum raw::_auxdettype |
Enumerator | |
---|---|
kUnknownAuxDet |
no idea |
kScintillator |
Scintillator paddle. |
kTimeOfFlight |
Time of flight. |
kCherenkov |
Cherenkov counter. |
Definition at line 17 of file RawTypes.h.
enum raw::_compress |
Definition at line 8 of file RawTypes.h.
int raw::ADCStickyCodeCheck | ( | const short | adc_value, |
const int | pedestal, | ||
bool | fADCStickyCodeFeature | ||
) |
|
inline |
void raw::Compress | ( | std::vector< short > & | adc, |
raw::Compress_t | compress | ||
) |
Compresses a raw data buffer.
adc | buffer with uncompressed data |
compress | type of compression to be applied |
This function dispatches the compression to the function appropriate for the specified compression type. The resulting compressed data replaces the input buffer content, which is lost. Compression is expected to reduce the size of the data, so that there is in principle no need for reallocation of the input buffer, adc, to store the result.
Definition at line 19 of file raw.cxx.
void raw::Compress | ( | std::vector< short > & | adc, |
raw::Compress_t | compress, | ||
int & | nearestneighbor | ||
) |
Definition at line 40 of file raw.cxx.
void raw::Compress | ( | std::vector< short > & | adc, |
raw::Compress_t | compress, | ||
unsigned int & | zerothreshold | ||
) |
Definition at line 63 of file raw.cxx.
void raw::Compress | ( | std::vector< short > & | adc, |
raw::Compress_t | compress, | ||
unsigned int & | zerothreshold, | ||
int & | nearestneighbor | ||
) |
Definition at line 81 of file raw.cxx.
void raw::Compress | ( | const boost::circular_buffer< std::vector< short >> & | adcvec_neighbors, |
std::vector< short > & | adc, | ||
raw::Compress_t | compress, | ||
unsigned int & | zerothreshold, | ||
int & | nearestneighbor | ||
) |
Definition at line 102 of file raw.cxx.
void raw::Compress | ( | std::vector< short > & | adc, |
raw::Compress_t | compress, | ||
unsigned int & | zerothreshold, | ||
int | pedestal, | ||
int & | nearestneighbor, | ||
bool | fADCStickyCodeFeature | ||
) |
Definition at line 124 of file raw.cxx.
void raw::Compress | ( | const boost::circular_buffer< std::vector< short >> & | adcvec_neighbors, |
std::vector< short > & | adc, | ||
raw::Compress_t | compress, | ||
unsigned int & | zerothreshold, | ||
int | pedestal, | ||
int & | nearestneighbor, | ||
bool | fADCStickyCodeFeature | ||
) |
Definition at line 147 of file raw.cxx.
void raw::CompressFibonacci | ( | std::vector< short > & | wf, |
std::function< void(int, std::vector< std::vector< bool >> &)> | add_to_table | ||
) |
Definition at line 1208 of file raw.cxx.
void raw::fibonacci_encode_table | ( | int | end, |
std::vector< std::vector< bool >> & | table | ||
) |
constexpr bool raw::isValidChannel | ( | Channel_t | channel | ) |
Returns whether the specified one is a valid channel
number.
Definition at line 32 of file SingleChannelOpticalTriggerGate.h.
|
inline |
Returns whether the specified channel ID is valid
Definition at line 37 of file RawTypes.h.
|
inline |
Definition at line 77 of file lardataobj/lardataobj/RawData/OpDetWaveform.h.
std::ostream& raw::operator<< | ( | std::ostream & | os, |
const raw::BeamInfo & | o | ||
) |
Definition at line 117 of file BeamInfo.cxx.
void raw::Uncompress | ( | const std::vector< short > & | adc, |
std::vector< short > & | uncompressed, | ||
raw::Compress_t | compress | ||
) |
Uncompresses a raw data buffer.
adc | compressed buffer |
uncompressed | buffer to be filled with uncompressed data |
compress | type of compression in the adc buffer |
This function dispatches the uncompression to the correct uncompress function according to compression type in compress.
The uncompressed buffer must be already allocated with enough space to store the full inflated adc data. Uncompressing raw::RawDigit can be done as follows:
std::vector<ADC_t> uncompressed(digit.Samples(), 0); raw::Uncompress(digit.ADC(), uncompressed, digit.ADC());
Definition at line 776 of file raw.cxx.
void raw::Uncompress | ( | const std::vector< short > & | adc, |
std::vector< short > & | uncompressed, | ||
int | pedestal, | ||
raw::Compress_t | compress | ||
) |
Definition at line 805 of file raw.cxx.
void raw::UncompressFibonacci | ( | const std::vector< short > & | adc, |
std::vector< short > & | uncompressed, | ||
std::function< int(std::vector< bool > &)> | decode_table_chunk | ||
) |
void raw::UncompressHuffman | ( | const std::vector< short > & | adc, |
std::vector< short > & | uncompressed | ||
) |
Definition at line 1059 of file raw.cxx.
void raw::ZeroSuppression | ( | std::vector< short > & | adc, |
unsigned int & | zerothreshold | ||
) |
void raw::ZeroSuppression | ( | std::vector< short > & | adc, |
unsigned int & | zerothreshold, | ||
int & | nearestneighbor | ||
) |
void raw::ZeroSuppression | ( | std::vector< short > & | adc, |
unsigned int & | zerothreshold, | ||
int | pedestal, | ||
int & | nearestneighbor, | ||
bool | fADCStickyCodeFeature | ||
) |
Definition at line 354 of file raw.cxx.
void raw::ZeroSuppression | ( | const boost::circular_buffer< std::vector< short >> & | adcvec_neighbors, |
std::vector< short > & | adc, | ||
unsigned int & | zerothreshold, | ||
int & | nearestneighbor | ||
) |
void raw::ZeroSuppression | ( | const boost::circular_buffer< std::vector< short >> & | adcvec_neighbors, |
std::vector< short > & | adc, | ||
unsigned int & | zerothreshold, | ||
int | pedestal, | ||
int & | nearestneighbor, | ||
bool | fADCStickyCodeFeature | ||
) |
Definition at line 590 of file raw.cxx.
void raw::ZeroUnsuppression | ( | const std::vector< short > & | adc, |
std::vector< short > & | uncompressed | ||
) |
void raw::ZeroUnsuppression | ( | const std::vector< short > & | adc, |
std::vector< short > & | uncompressed, | ||
int | pedestal | ||
) |
Mnemonics for an invalid channel number.
Definition at line 29 of file SingleChannelOpticalTriggerGate.h.
constexpr ChannelID_t raw::InvalidChannelID = std::numeric_limits<ChannelID_t>::max() |
ID of an invalid channel.
Definition at line 32 of file RawTypes.h.