Skip to main content

ChannelInfo

Struct ChannelInfo 

Source
pub struct ChannelInfo {
    pub index: u32,
    pub name: Option<String>,
    pub fluorophore: Option<String>,
    pub excitation_nm: Option<f64>,
    pub emission_nm: Option<f64>,
    pub emission_range_nm: Option<[f64; 2]>,
    pub emission_band_start_nm: Option<f64>,
    pub emission_band_end_nm: Option<f64>,
    pub emission_band_center_nm: Option<f64>,
    pub color: Option<String>,
    pub acquisition_mode: Option<String>,
    pub exposure_ms: Option<f64>,
}
Expand description

One acquisition channel.

Fields§

§index: u32

Zero-based channel index (the c of a plane).

§name: Option<String>

Channel name as the acquisition software shows it.

§fluorophore: Option<String>

Fluorescent dye or protein imaged in this channel (e.g. DAPI, GFP), if recorded.

§excitation_nm: Option<f64>

Excitation wavelength in nanometres: the light used to make the sample fluoresce.

§emission_nm: Option<f64>

Emission wavelength in nanometres: the light collected from the sample. What the file records varies by format (a dye’s emission peak, a filter’s centre, the start of a spectral detection window for Leica λ scans); docs/formats/<fmt>.md says which. When a detection band is known, emission_band_*_nm give it explicitly.

§emission_range_nm: Option<[f64; 2]>

Detection band [start_nm, end_nm] when the instrument records a range instead of a single emission wavelength.

§emission_band_start_nm: Option<f64>

Short-wavelength edge of the detection band in nanometres (spectral detector window or emission filter), when the file records the band.

§emission_band_end_nm: Option<f64>

Long-wavelength edge of the detection band in nanometres.

§emission_band_center_nm: Option<f64>

Centre of the detection band in nanometres: (start + end) / 2.

§color: Option<String>

Display colour as #RRGGBB if the file records one.

§acquisition_mode: Option<String>

Acquisition mode as a readable label, <technique>[ <contrast>] (e.g. Laser Scanning Confocal, Widefield Fluorescence, Brightfield, Phase Contrast); OME enumeration tokens (WideField) are turned into these labels, other vendor wording is kept.

§exposure_ms: Option<f64>

Exposure (integration) time of the detector in milliseconds.

Implementations§

Source§

impl ChannelInfo

Source

pub fn set_band(&mut self, start_nm: f64, end_nm: f64)

Set the detection band: emission_range_nm and emission_band_{start,end,center}_nm. Ignored unless both edges are finite, positive and ordered.

Source

pub fn fill_band(&mut self)

Fill emission_band_*_nm from emission_range_nm when a reader set only the range.

Trait Implementations§

Source§

impl Clone for ChannelInfo

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ChannelInfo

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ChannelInfo

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ChannelInfo

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for ChannelInfo

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for ChannelInfo

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for ChannelInfo

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ChannelInfo

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts 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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.