lightr (version 1.9.0)

lr_parse_procspec: Parse OceanOptics ProcSpec file

Description

Parse OceanOptics/OceanInsight ProcSpec file. https://www.oceanoptics.com/

Usage

lr_parse_procspec(filename, verify_checksum = FALSE, ...)

Value

A named list of two elements:

• data: a dataframe with columns "wl", "dark", "white", "scope" and "processed", in this order.

• metadata: a character vector with metadata including:

  • user: Name of the spectrometer operator

  • datetime: Timestamp of the recording in format '%Y-%m-%d %H:%M:%S' and UTC timezone. If timezone is missing in source file, UTC time will be assumed (for reproducibility purposes across computers with different localtimes).

  • spec_model: Model of the spectrometer

  • spec_ID: Unique ID of the spectrometer

  • white_inttime: Integration time of the white reference (in ms)

  • dark_inttime: Integration time of the dark reference (in ms)

  • sample_inttime: Integration time of the sample (in ms)

  • white_avgs: Number of averaged measurements for the white reference

  • dark_avgs: Number of averaged measurements for the dark reference

  • sample_avgs: Number of averaged measurements for the sample

  • white_boxcar: Boxcar width for the white reference

  • dark_boxcar: Boxcar width for the dark reference

  • sample_boxcar: Boxcar width for the sample reference

Arguments

filename

Path of the file to parse

verify_checksum

Logical (defaults to FALSE). Should we check if the file has been modified since its creation by the spectrometer? An error will be returned if the check fails.

...

ignored

Details

'processed' column computed by official software and provided as is.

References

https://www.oceanoptics.com/software/

Examples

res <- lr_parse_procspec(system.file("testdata", "procspec_files",
                                     "OceanOptics_Linux.ProcSpec",
                                     package = "lightr"),
                         verify_checksum = TRUE)
head(res$data)
res$metadata