Skip to main content

Crate openreadout_hcs

Crate openreadout_hcs 

Source
Expand description

Clean-room readers for high-content screening (HCS) plates.

Three plate-imager families, each an index file plus one TIFF per plane:

  • Revvity/PerkinElmer Harmony exports of the Opera Phenix, Operetta and Operetta CLS (format id opera-harmony): Images/Index.idx.xml (also Index.xml, Index.ref.xml), and Columbus exports (ImageIndex.ColumbusIDX.xml with multi-page TIFF or .flex planes).
  • Molecular Devices ImageXpress / MetaXpress (format id imagexpress): an .HTD plate description, or a plate folder without one.
  • Yokogawa CellVoyager CV7000/CV8000/CQ1 (format id cellvoyager): MeasurementData.mlf with MeasurementDetail.mrf, the .mes setting and .wpi/.wpp.

Every field of view of every well is one image (images[i].extra.well, field); the plate (id, type, wells, completeness of the copy on disk) is reported by openreadout_core::Dataset::plate. info reads the index and lists the plate folder once; it opens at most one plane file (for the sample type), however many the plate has.

Layout and vocabulary: docs/formats/hcs.md, docs/formats/opera-harmony.md, docs/formats/imagexpress.md, docs/formats/cellvoyager.md. Provenance: docs/provenance/opera-harmony.md, imagexpress.md, cellvoyager.md.

§Example

use openreadout_core::FormatReader;
use openreadout_hcs::HarmonyReader;

let format = HarmonyReader.descriptor();
assert_eq!(format.id, openreadout_hcs::HARMONY_FORMAT_ID);
println!("{} ({}): {}", format.name, format.family, format.extensions.join(", "));

Reading a plate:

use std::path::Path;

use openreadout_core::{FormatReader, PlaneIndex};
use openreadout_hcs::HarmonyReader;

let mut dataset = HarmonyReader.open(Path::new("Measurement 1/Images/Index.idx.xml"))?;
let plate = dataset.plate().expect("a plate");
println!("{} wells imaged, {} planes missing", plate.wells.len(), plate.planes_missing);
let well = plate.well("C05").expect("C05 was imaged");
// First field of view of well C05, channel 0.
let plane = dataset.read_plane(well.images[0], PlaneIndex { c: 0, z: 0, t: 0 })?;
assert_eq!(plane.data.len(), plane.expected_len());

§API stability

The supported API is what this page documents. The parser modules are public only so that tests and fuzz targets can reach them: they are hidden from this documentation and may change in any release.

Structs§

CellVoyagerReader
Yokogawa CellVoyager measurements (CV7000, CV8000, CQ1).
HarmonyReader
Revvity/PerkinElmer Harmony exports (Opera Phenix, Operetta, Operetta CLS).
ImageXpressReader
Molecular Devices ImageXpress / MetaXpress plates.

Constants§

CELLVOYAGER_FORMAT_ID
Format id.
FAMILY
Format family of the three readers.
HARMONY_FORMAT_ID
Format id.
IMAGEXPRESS_FORMAT_ID
Format id.