pub struct Dataset { /* private fields */ }Expand description
A validated dataset loaded from a bundle conforming to dataset_spec.md.
Implementations§
Source§impl Dataset
impl Dataset
Sourcepub fn new(
measurements: MeasurementStack,
configuration: SimulationConfiguration,
) -> Result<Self>
pub fn new( measurements: MeasurementStack, configuration: SimulationConfiguration, ) -> Result<Self>
Constructs a dataset from already-loaded values.
Sourcepub fn measurements(&self) -> &MeasurementStack
pub fn measurements(&self) -> &MeasurementStack
Borrows the resident measured-intensity stack.
Sourcepub fn source_path(&self) -> Option<&Path>
pub fn source_path(&self) -> Option<&Path>
Root directory of the loaded bundle, or None for programmatic data.
Sourcepub fn configuration(&self) -> &SimulationConfiguration
pub fn configuration(&self) -> &SimulationConfiguration
Borrows the validated true/assumed experiment configuration.
Sourcepub fn ground_truth_object(&self) -> Option<&Array2<Complex64>>
pub fn ground_truth_object(&self) -> Option<&Array2<Complex64>>
Borrows optional high-resolution complex ground truth shaped (height, width).
Sourcepub fn valid_object_mask(&self) -> Option<&Array2<u8>>
pub fn valid_object_mask(&self) -> Option<&Array2<u8>>
Borrows an optional same-shaped binary validity mask for object metrics.
Sourcepub fn provenance(&self) -> &BTreeMap<String, String>
pub fn provenance(&self) -> &BTreeMap<String, String>
Borrows provenance metadata from the dataset manifest.
Sourcepub fn measurement_units(&self) -> Option<&str>
pub fn measurement_units(&self) -> Option<&str>
Borrows optional semantic measurement units.
Sourcepub fn reconstruction_problem(
&self,
) -> Result<ReconstructionProblem<MeasurementStack>>
pub fn reconstruction_problem( &self, ) -> Result<ReconstructionProblem<MeasurementStack>>
Clones measurements and the assumed model into a validated reconstruction problem.
Sourcepub fn subset(&self) -> DatasetSubsetBuilder<'_>
pub fn subset(&self) -> DatasetSubsetBuilder<'_>
Starts a deterministic frame-selection and spatial-cropping builder.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Dataset
impl RefUnwindSafe for Dataset
impl Send for Dataset
impl Sync for Dataset
impl Unpin for Dataset
impl UnsafeUnpin for Dataset
impl UnwindSafe for Dataset
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
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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> ⓘ
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 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> ⓘ
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