lr_parse_spc: Parse SPC binary file

In Bisaloo/lightr: Read Spectrometric Data and Metadata

Parse SPC binary file

Description

Parse SPC binary file. (Used by CRAIC https://www.microspectra.com/ and OceanInsight https://www.oceaninsight.com/)

Usage

lr_parse_spc(filename)

Arguments

filename

Path of the file to parse

Details

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

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

In development

Metadata parsing has not yet been implemented for this file format.

Examples

res <- lr_parse_spc(system.file("testdata", "compare", "CRAIC", "CRAIC.spc",
                                package = "lightr"))
head(res$data)
res$metadata

Bisaloo/lightr documentation built on March 28, 2024, 8:14 p.m.