#[non_exhaustive]pub struct PreviewOptions {Show 30 fields
pub image: Option<u32>,
pub select: Vec<String>,
pub mip: Option<Axis>,
pub view: Option<View>,
pub sum: Option<Axis>,
pub fft: bool,
pub composite: bool,
pub level: Option<u32>,
pub region: Option<Region>,
pub max_size: Option<u32>,
pub axes: Option<Axes>,
pub title: Option<String>,
pub caption: Option<String>,
pub contrast: Option<String>,
pub lut: Option<Lut>,
pub trace: Option<u32>,
pub sweep: Option<u32>,
pub channels: Vec<u32>,
pub x_range: Option<[f64; 2]>,
pub run: Option<u32>,
pub spectrum: Option<u64>,
pub scan: Option<u64>,
pub centroid: bool,
pub table: Option<u32>,
pub columns: Vec<String>,
pub marks: Option<Marks>,
pub objects: Option<ObjectsRequest>,
pub lanes: Option<LanesRequest>,
pub annotations: Vec<Annotation>,
pub dark: bool,
}Expand description
Preview options by name. Every field is optional; PreviewOptions::request fills in the
defaults. The MCP tool openreadout_preview takes these fields as its arguments, so their
documentation is also what an agent reads.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.image: Option<u32>Image index (default 0).
select: Vec<String>Plane selection such as c=1, z=4, t=0 or combined c=0,1,z=2. Default: c=0, the
middle z, t=0. Several channels imply a composite.
mip: Option<Axis>Maximum-intensity projection, over the selected range if any.
view: Option<View>Volumes: the plane to show. axial, coronal, sagittal (radiological orientation),
orthogonal (all three, crossing at the middle or the selected z), xz, yz, or
native (as stored). Default: medical images in their acquisition plane, others native.
With a view, z and mip: z count slices of that view.
sum: Option<Axis>Sum projection, over the selected range if any: a movie’s frames added up (e.g. sum t, select t=0-39).
fft: boolImages: a power-spectrum (FFT) inset in the top-right corner: Thon rings of a cryo-EM micrograph, the spots of a lattice.
composite: boolBlend all (or the selected) channels additively in their colours.
level: Option<u32>Pyramid level to read (default: the level nearest max_size, or the level at which
region renders at about max_size).
region: Option<Region>Zoom: only this rectangle, {x, y, width, height} in full-resolution pixels (or in the
pixels of level when a level is given). Whole-slide images: look at the overview
first, then at regions of it.
max_size: Option<u32>Longest side in pixels, rulers included (MCP: default 768, at most 2048).
axes: Option<Axes>Image previews: what frames the picture.
title: Option<String>Image previews with axes scale-bar: a title above the picture.
caption: Option<String>Image previews with axes scale-bar: a caption under the picture (what it shows, the stain, the sample).
contrast: Option<String>auto (default; the file’s display window when it has one, log:90,99.95 on diffraction
images), min-max, percentile:LO,HI (e.g. percentile:1,99), log (log:50,99.9)
or log:LO,HI, raw, or a display window window:CENTER,WIDTH (window:40,400),
window:file, or a CT preset window:soft-tissue, brain, subdural, stroke, bone,
lung, mediastinum, liver.
lut: Option<Lut>Colour lookup. Default: gray for one channel (inverted on diffraction images), channel colours for composites.
trace: Option<u32>Trace preview: trace index (see openreadout_info traces[]).
sweep: Option<u32>Trace preview: sweep index.
channels: Vec<u32>Trace preview: channel indices (default: the first 8).
x_range: Option<[f64; 2]>Trace preview: only this window of the x axis, [a, b] in its units (bp of a sized electropherogram, base positions of a Sanger read, minutes, ppm, …).
run: Option<u32>Spectrum preview: run index.
spectrum: Option<u64>Spectrum preview: zero-based spectrum index.
scan: Option<u64>Spectrum preview: instrument scan number instead of an index.
centroid: boolSpectrum preview: the instrument’s centroid list instead of the profile.
table: Option<u32>Plate or flow-cytometry preview: table index.
columns: Vec<String>Table columns: a plate’s value column, or the x and y parameters of a flow-cytometry density plot (one gives a histogram; default FSC-A, SSC-A).
marks: Option<Marks>Marks from the data. Default auto: the prominent peaks of spectra and chromatograms are labelled; diffraction images get resolution rings.
objects: Option<ObjectsRequest>Images: how objects are found for marks: objects (as openreadout_stats objects).
lanes: Option<LanesRequest>Gels and blots: how lanes are found for marks: lanes (as openreadout_stats lanes).
annotations: Vec<Annotation>Your own marks, drawn on top and reported back with their pixel positions. Coordinates as the picture shows them: full-resolution pixels on images (the ruler numbers), axis units on plots, wells on plates.
dark: boolDraw in the dark theme.
Implementations§
Source§impl PreviewOptions
impl PreviewOptions
Sourcepub fn from_json(text: &str) -> Result<PreviewOptions>
pub fn from_json(text: &str) -> Result<PreviewOptions>
Parse options from JSON text; empty text gives the defaults.
Trait Implementations§
Source§impl Clone for PreviewOptions
impl Clone for PreviewOptions
Source§impl Debug for PreviewOptions
impl Debug for PreviewOptions
Source§impl Default for PreviewOptions
impl Default for PreviewOptions
Source§impl<'de> Deserialize<'de> for PreviewOptions
impl<'de> Deserialize<'de> for PreviewOptions
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl JsonSchema for PreviewOptions
impl JsonSchema for PreviewOptions
Source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Source§fn inline_schema() -> bool
fn inline_schema() -> bool
$ref keyword. Read moreAuto Trait Implementations§
impl Freeze for PreviewOptions
impl RefUnwindSafe for PreviewOptions
impl Send for PreviewOptions
impl Sync for PreviewOptions
impl Unpin for PreviewOptions
impl UnsafeUnpin for PreviewOptions
impl UnwindSafe for PreviewOptions
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
impl<T> ErasedDestructor for Twhere
T: 'static,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more