lamindb.curators.SpatialDataCurator¶

class lamindb.curators.SpatialDataCurator(dataset, schema, *, sample_metadata_key='sample')¶

Curator for SpatialData.

Parameters:

dataset (SpatialData | Artifact) – The SpatialData-like object to validate & annotate.
schema (Schema) – A Schema object that defines the validation constraints.

Example

Attributes¶

property slots: dict[str, DataFrameCurator]¶: Access sub curators by slot.

save_artifact(*, key=None, description=None, revises=None, run=None)¶

Save an annotated artifact.

Parameters:

key (str | None, default: None) – A path-like key to reference artifact in default storage, e.g., "myfolder/myfile.fcs". Artifacts with the same key form a version family.
description (str | None, default: None) – A description.
revises (Artifact | None, default: None) – Previous version of the artifact. Is an alternative way to passing key to trigger a new version.
run (Run | None, default: None) – The run that creates the artifact.

Return type:

Artifact

Returns:

A saved artifact record.

validate()¶

Validate dataset against Schema.