Skip to main content

ImageInfo

Struct ImageInfo 

Source
pub struct ImageInfo {
Show 21 fields pub index: u32, pub name: Option<String>, pub size_x: u32, pub size_y: u32, pub size_z: u32, pub size_c: u32, pub size_t: u32, pub dimension_order: String, pub pixel_type: PixelType, pub samples_per_pixel: u32, pub physical_size: PhysicalSize, pub time_increment_s: Option<f64>, pub channels: Vec<ChannelInfo>, pub objective: Option<ObjectiveInfo>, pub instrument: Option<InstrumentInfo>, pub acquired_at: Option<String>, pub mosaic: Option<MosaicInfo>, pub pyramid_levels: u32, pub resolution_levels: Vec<ResolutionLevel>, pub plane_count: u64, pub extra: BTreeMap<String, Value>,
}
Expand description

One image (a scene, series, or position) inside the file.

Fields§

§index: u32

Zero-based index used by --image.

§name: Option<String>

Image (scene, series or position) name, if recorded.

§size_x: u32

Width in pixels.

§size_y: u32

Height in pixels.

§size_z: u32

Number of Z planes (focal slices).

§size_c: u32

Number of channels.

§size_t: u32

Number of time points.

§dimension_order: String

Storage order of planes, e.g. XYCZT (X and Y always first).

§pixel_type: PixelType

Sample type of every plane.

§samples_per_pixel: u32

1 for grayscale channels, 3 for interleaved RGB.

§physical_size: PhysicalSize

Physical size of one pixel (and the Z step).

§time_increment_s: Option<f64>

Interval between time points in seconds.

§channels: Vec<ChannelInfo>

One entry per channel, in channel order.

§objective: Option<ObjectiveInfo>

The objective lens, if recorded.

§instrument: Option<InstrumentInfo>

Instrument and software, if recorded.

§acquired_at: Option<String>

ISO-8601 acquisition start, if recorded.

§mosaic: Option<MosaicInfo>

Tile layout when the image was acquired as a mosaic.

§pyramid_levels: u32

Number of resolution levels stored (1 = no pyramid).

§resolution_levels: Vec<ResolutionLevel>

Size, downsampling and stored tile size of every resolution level, level 0 first. Filled by readers of pyramidal or tiled images (read a level with --level N, a rectangle with --region X,Y,W,H); empty otherwise.

§plane_count: u64

size_z * size_c * size_t.

§extra: BTreeMap<String, Value>

Format-specific extras that have no OME equivalent, in our own vocabulary.

Implementations§

Source§

impl ImageInfo

Source

pub fn new(index: u32, size_x: u32, size_y: u32, pixel_type: PixelType) -> Self

A blank image with the given geometry; callers fill the rest.

Source

pub fn finish(self) -> Self

Recompute plane_count from the dimensions, and fill each channel’s explicit detection band (emission_band_*_nm) from emission_range_nm.

Trait Implementations§

Source§

impl Clone for ImageInfo

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 ImageInfo

Source§

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

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

impl<'de> Deserialize<'de> for ImageInfo

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 ImageInfo

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 Serialize for ImageInfo

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

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.