RegisterUserDataWrite: Registers a data source to store (synchronous) user supplied...

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

Registers a data source to store (synchronous) user supplied data.

Description

RegisterUserDataWrite registers a data source to store user supplied data synchronously to the TOF data acquistion (every write) into the data file being currently recorded. Creates datasets "TwData" and "TwInfo" at Location.

Usage

RegisterUserDataWrite(
  Location,
  NbrElements,
  ElementDescription = NULL,
  CompressionLevel = 0L
)

Arguments

Location	Location of group in HDF5 file where the datasets are created.
NbrElements	Number of elements to store per write.
ElementDescription	Vector of length NbrElements containing the text description of elements. If ElementDescription is NULL the dataset "TwInfo" is not created.
CompressionLevel	Compression level used for data storage (0: no compression, 1-9: increasing levels of compression (and CPU load)).

Details

Needs to be executed before starting the acquisition. Use UpdateUserData to actually store the data.

See Also

Other Data storage functions: AddAttributeDouble(), AddAttributeInt(), AddAttributeString(), AddLogEntry(), AddUserDataMultiRow(), AddUserData(), GetRegUserDataDesc(), GetRegUserDataSources(), KeepFileOpen(), QueryRegUserDataSize(), ReadRegUserData(), RegisterUserDataBuf(), RegisterUserDataNoStore(), UnregisterUserData(), UpdateUserData()

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