DecodeEventListThreshold: Decodes an event list using thresholding.

View source: R/RcppExports.R

DecodeEventListThresholdR Documentation

Decodes an event list using thresholding.

Description

DecodeEventListThreshold decodes an event list read with GetEventList...FromH5 functions into a time stamp vector and a data vector. Only event data which is above the threshold (plus pre-trigger and post-trigger samples) are returned.

Usage

DecodeEventListThreshold(
  events,
  clockPeriod,
  sampleInterval,
  threshold,
  presamples,
  postsamples
)

Arguments

events

Event data, e.g. from GetEventList...FromH5.

clockPeriod

Clock period (in s or ns), e.g. from GetFloatAttributeFromH5(filename, "FullSpectra", "ClockPeriod").

sampleInterval

Sampling interval (in same units as clockPeriod), e.g. from GetH5Descriptor.

threshold

Threshold value (mV).

presamples

Number of pre-trigger samples.

postsamples

Number of post-trigger samples.

Details

Note: this function is not part of the TofDaq API, but is included in the package for convenience.

Value

A list with sample indices and data values (in mV).


pasturm/TofDaqR documentation built on March 29, 2024, 12:10 a.m.