Skip to main content

Crate openreadout_biophys

Crate openreadout_biophys 

Source
Expand description

Clean-room readers for biophysical bench instruments.

  • MicroCal isothermal titration calorimetry (microcal-itc, .itc: VP-ITC, iTC200 and the MicroCal ITC software): the thermogram (differential power and cell temperature against time) as a trace, the injections (volume, duration, spacing, filter period, start) as a table, and the method (cell and syringe concentrations, cell volume, temperature, stirring, reference power) in the experiment model. Notes: docs/formats/microcal-itc.md.
  • Cytiva Biacore surface plasmon resonance (cytiva-biacore-blr, .blr result files of the Biacore T200 Control Software): every stored sensorgram (raw flow cells and reference-subtracted curves, per cycle) as a trace, the control software’s report points, the cycles and the event log as tables, chip and run in the vendor tree and experiment model. Notes: docs/formats/cytiva-biacore.md.
  • Agilent Seahorse XF (agilent-seahorse-asyr, .asyr assay results of Wave): the O2 and pH sensors’ corrected emission per well at every plate reading as traces, the plate map, measurements, injections and executed protocol as tables, and the oxygen consumption, extracellular acidification and proton efflux rates computed with the published compartment model where the plate and settings are those validated against Wave’s own rates. Notes: docs/formats/agilent-seahorse.md.
  • GenePix Results (genepix-gpr, .gpr of GenePix Pro): the microarray feature table (every column GenePix wrote) and the scan settings. Notes: docs/formats/genepix-gpr.md.
  • Sartorius Octet (sartorius-octet-frd, .frd biolayer-interferometry results): one biosensor’s sensorgram through every assay step as a trace, the steps as a table, the instrument and run in the experiment model. Notes: docs/formats/sartorius-octet.md.
  • Malvern Zetasizer (malvern-zetasizer-dts, .dts measurement files): one row per record with the sample, date and temperature and the stored zeta results (zeta potential, mobility, conductivity, peaks); size results are withheld until validated. Notes: docs/formats/malvern-zetasizer.md.

§Example

use openreadout_core::FormatReader;
use openreadout_biophys::ItcReader;

assert_eq!(ItcReader.descriptor().id, openreadout_biophys::ITC_FORMAT_ID);

Reading a file:

use std::path::Path;

use openreadout_core::FormatReader;
use openreadout_biophys::ItcReader;

let mut dataset = ItcReader.open(Path::new("run.itc"))?;
let thermogram = dataset.read_trace(0, 0, 0, u64::MAX)?; // µcal/s, °C
let injections = dataset.read_table(0, 0, u64::MAX)?;
println!("{} samples, {} injections", thermogram.channels[0].len(), injections.columns[0].len());

§API stability

The supported API is what this page documents: the readers, their format ids and the datasets they return.

Structs§

BiacoreDataset
An opened .blr file.
BiacoreEvaluationReader
The Cytiva Biacore T200 evaluation-file reader (.bme): the sensorgrams of the result files it holds, and the evaluation software’s fits.
BiacoreReader
The Cytiva Biacore result-file reader (.blr).
GprDataset
An opened .gpr file.
GprReader
The GenePix Results reader (.gpr).
ItcDataset
An opened .itc file.
ItcReader
The MicroCal ITC reader (.itc).
OctetReader
The Sartorius Octet .frd reader (one biosensor’s sensorgram and assay steps).
SeahorseDataset
An opened .asyr file.
SeahorseReader
The Agilent Seahorse XF assay-result reader (.asyr).
ZetasizerReader
The Malvern Zetasizer .dts reader.

Constants§

BIACORE_BME_FORMAT_ID
Format id of Cytiva Biacore T200 evaluation files (.bme).
BIACORE_FORMAT_ID
Format id of Cytiva Biacore .blr result files.
GPR_FORMAT_ID
Format id of GenePix Results .gpr files.
ITC_FORMAT_ID
Format id of MicroCal .itc files.
OCTET_FORMAT_ID
Format id of Sartorius (ForteBio) Octet .frd biolayer-interferometry result files.
SEAHORSE_FORMAT_ID
Format id of Agilent Seahorse XF .asyr assay result files.
ZETASIZER_FORMAT_ID
Format id of Malvern Zetasizer .dts measurement files.