spatialdata.models.Labels2DModel#

Attributes table#

parse(data[, dims, transformations, ...])

Validate (or parse) raster data.

to_json(**dumps_kws)

Validate data.

Labels2DModel.array_type = <xarray_schema.components.ArrayTypeSchema object>#

classmethod Labels2DModel.parse(data, dims=None, transformations=None, scale_factors=None, method=None, chunks=None, **kwargs)#

Validate (or parse) raster data.

Parameters:

data (ndarray[Any, dtype[float64]] | DataArray | Array) – Data to validate (or parse). The shape of the data should be c(z)yx for 2D (3D) images and (z)yx for 2D ( 3D) labels. If you have a 2D image with shape yx, you can use numpy.expand_dims() (or an equivalent function) to add a channel dimension.
dims (Optional[Sequence[str]] (default: None)) – Dimensions of the data.
transformations (Optional[dict[str, BaseTransformation]] (default: None)) – Transformations to apply to the data.
scale_factors (Optional[Sequence[Union[dict[str, int], int]]] (default: None)) – Scale factors to apply for multiscale. If not None, a multiscale_spatial_image.MultiscaleSpatialImage is returned.
method (Optional[Methods] (default: None)) – Method to use for multiscale.
chunks (Union[int, tuple[int, ...], tuple[tuple[int, ...], ...], Mapping[Any, Union[None, int, tuple[int, ...]]], None] (default: None)) – Chunks to use for dask array.
kwargs (Any) – Additional arguments for to_spatial_image(). In particular the c_coords kwargs argument (an iterable) can be used to set the channel coordinates for image data. c_coords is not available for labels data as labels do not have channels.

Return type:

SpatialImage | MultiscaleSpatialImage

Returns:

: spatial_image.SpatialImage or multiscale_spatial_image.MultiscaleSpatialImage.

Labels2DModel.to_json(**dumps_kws)#

Labels2DModel.validate(data)#

Validate data.