Struct Dataset 

#[non_exhaustive]
pub struct Dataset {
    pub id: DatasetId,
    pub scenes: Vec<Scene>,
    pub associated_images: HashMap<String, AssociatedImage>,
    pub properties: Properties,
    pub icc_profiles: HashMap<IccProfileKey, Vec<u8>>,
    pub source_icc_profiles: Vec<SourceIccProfile>,
}

A whole-slide image file (or set of files for DICOM).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: DatasetId

scenes: Vec<Scene>

associated_images: HashMap<String, AssociatedImage>

properties: Properties

icc_profiles: HashMap<IccProfileKey, Vec<u8>>

source_icc_profiles: Vec<SourceIccProfile>

Source ICC profiles with provenance and optional source-specific refinements.

Implementations

impl Dataset

pub fn new(id: DatasetId, scenes: Vec<Scene>) -> Self

pub fn with_associated_images( self, associated_images: HashMap<String, AssociatedImage>, ) -> Self

pub fn with_properties(self, properties: Properties) -> Self

pub fn with_icc_profiles( self, icc_profiles: HashMap<IccProfileKey, Vec<u8>>, ) -> Self

pub fn push_source_icc_profile( &mut self, profile: SourceIccProfile, ) -> Result<(), SourceIccProfileConflict>

Adds a source ICC profile and keeps legacy ICC metadata in sync.

Profiles with no optical_path and no channel are unqualified scene/series profiles, so their bytes are also written to Dataset::icc_profiles. Qualified profiles are appended only to Dataset::source_icc_profiles.

If an unqualified profile would overwrite different existing legacy bytes for the same typed IccProfileKey, this returns SourceIccProfileConflict and leaves both ICC collections unchanged. Identical unqualified bytes are accepted because they do not create legacy-map ambiguity.

pub fn source_icc_profiles_for_series( &self, scene: impl Into<SceneId>, series: impl Into<SeriesId>, ) -> impl Iterator<Item = &SourceIccProfile>

Iterates over source ICC profiles for a normalized scene/series pair.

Matching is limited to the scene and series fields. Optional optical_path and channel refinements remain available on each returned SourceIccProfile.

Trait Implementations

impl Debug for Dataset

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

Formats the value using the given formatter.