GetSegmentProfileFromH5: Segment profile from HDF5 data file.

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

Segment profile from HDF5 data file.

Description

GetSegmentProfileFromH5 reads a segment profile for a given peak (or all peaks) and averaged over a given buf and write range.

Usage

GetSegmentProfileFromH5(
  Filename,
  PeakIndex,
  BufStartIndex,
  BufEndIndex,
  WriteStartIndex,
  WriteEndIndex,
  BufWriteLinked = FALSE
)

Arguments

Filename	Path/filename of the HDF5 file.
PeakIndex	Index of peak to fetch segment profile from. All peaks are read if PeakIndex = -1.
BufStartIndex	Buf start index of data to fetch.
BufEndIndex	Buf end index of data to fetch.
WriteStartIndex	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 WriteStartIndex != WriteEndIndex). Default is FALSE.

Value

A vector containing the segment profile(s).

Examples

## Not run: 
GetSegmentProfileFromH5("path/to/file.h5", PeakIndex = -1, BufStartIndex = 0,
BufEndIndex = 0, WriteStartIndex = 0, WriteEndIndex = 0)

## End(Not run)

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