cpp_readFCS: FCS data extraction

In gitdemont/IFC: Tools for Imaging Flow Cytometry

FCS data extraction

Description

This function reads data from FCS 3.2 files

Arguments

fname	string, path to file.
offset	std::size_t, offset position of data start
events	uint32_t, number of events to read.
b_typ	Rcpp::IntegerVector, types of values to read. Allowed are 0 for "A", 1 for "F", 2 for "D", and 3 is "I".
b_siz	Rcpp::IntegerVector, number of bytes to extract for each type. Values should be higher than 0. Note that whatever the input is, when 'b_typ' is 1 (float) 'b_siz' will be set to 4 and when 'b_typ' is 2 (double) 'b_siz' will be set to 8. Note also that when 'b_typ' is 3 (integer), the only allowed values for 'b_siz' are [1-8].
b_msk	Rcpp::IntegerVector, bits to masks when 'b_typ' is 3 (integer). Default is R_NilValue. When not NULL, it should be of same length as 'b_siz' and contain only [0-64] values.
swap	bool, whether to swap bytes or not. Default is false.

Value

a numeric vector of extracted values.

Source

FCS 3.2 specifications. See, J. Spidlen et al. Data File Standard for Flow Cytometry, Version FCS 3.2. Cytometry A 99 100–102(2021) \Sexpr[results=rd]{tools:::Rd_expr_doi("10.1002/cyto.a.24225")}

gitdemont/IFC documentation built on Feb. 20, 2025, 12:55 a.m.