GetUserDataFromH5: Reads user data from the HDF5 file.

View source: R/RcppExports.R

GetUserDataFromH5R Documentation

Reads user data from the HDF5 file.

Description

GetUserDataFromH5 reads a row of user data added to the file using the AddUserData function.

Usage

GetUserDataFromH5(Filename, location, rowIndex = -1L)

Arguments

Filename

Path/filename of the HDF5 file.

location

Location of the group or dataset where the attribute is attached to.

rowIndex

Index of row to read. If index is -1 (default), all rows are read.

Details

If you want to access data saved by a registered data source (or a data source plugin, which uses the same mechanism) use the GetRegUserDataFromH5 function.

Value

A list containing the user data and data description.

Examples

## Not run: 
GetUserDataFromH5("path/to/file.h5", "/ImageData/ScanData")

## End(Not run)

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