GetTofSpectrumFromH5: Single (averaged) TOF spectrum from HDF5 data file.

In pasturm/TofDaqR: R Interface to the TOFWERK TofDaq API

Single (averaged) TOF spectrum from HDF5 data file.

Description

GetTofSpectrumFromH5 reads a single mass spectrum (or an averaged/summed hyperslab) from the HDF5 file.

Usage

GetTofSpectrumFromH5(
  Filename,
  SegmentIndex,
  SegmentEndIndex,
  BufIndex,
  BufEndIndex,
  WriteIndex,
  WriteEndIndex,
  BufWriteLinked = FALSE,
  Normalize = TRUE
)

Arguments

Filename	Path/filename of the HDF5 file.
SegmentIndex	Segment start index of data to fetch.
SegmentEndIndex	Segment end index of data to fetch.
BufIndex	Buf start index of data to fetch.
BufEndIndex	Buf end index of data to fetch.
WriteIndex	Write start index of data to fetch.
WriteEndIndex	Write end index of data to fetch.
BufWriteLinked	Indicating whether the buf and write dimension should be considered linked or treated as independent dimensions (relevant only if WriteIndex != WriteEndIndex). Default is FALSE.
Normalize	If FALSE the spectrum is reported as sum, if TRUE (default) the spectrum is normalized to counts per extraction.

Details

If SegmentIndex == SegmentEndIndex and BufIndex == BufEndIndex and WriteIndex == WriteEndIndex and Normalize == FALSE no averaging/summing of spectra is done and the spectrum is reported as stored in the dataset.

Value

A vector containing the mass spectrum.

Examples

## Not run: 
GetTofSpectrumFromH5("path/to/file.h5")

## End(Not run)

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