tiledbsoma.Scene

class tiledbsoma.Scene(handle: SOMAGroupWrapper[Any], **kwargs: Any)

A collection subtype representing spatial assets that can all be stored on a single coordinate space.

Lifecycle

Experimental.

__init__(handle: SOMAGroupWrapper[Any], **kwargs: Any)

Internal-only common initializer steps.

This function is internal; users should open TileDB SOMA objects using the create() and open() factory class methods.

Methods

__init__(handle, **kwargs)	Internal-only common initializer steps.
exists(uri[, context, tiledb_timestamp])	Finds whether an object of this type exists at the given URI.
create(uri, *[, coordinate_space, ...])	Creates a new scene at the given URI.
open(uri[, mode, tiledb_timestamp, context, ...])	Opens this specific type of SOMA object.
reopen(mode[, tiledb_timestamp])	Return a new copy of the SOMAObject with the given mode at the current Unix timestamp.
close()	Release any resources held while the object is open.
verify_open_for_writing()	Raises an error if the object is not open for writing.
items()
keys()
values()
members()	Get a mapping of {member_name: (uri, soma_object_type)}
get(k[,d])
set(key, value, *[, use_relative_uri])	Adds an element to the collection.
setdefault(k[,d])
update([E, ]**F)	If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
clear()
pop(k[,d])	If key is not found, d is returned if given, otherwise KeyError is raised.
popitem()	as a 2-tuple; but raise KeyError if D is empty.
add_new_collection(key[, kind, uri, ...])	Adds a new sub-collection to this collection.
add_new_dataframe(key, *[, uri, ...])	Adds a new DataFrame to this collection.
add_new_dense_ndarray(key, *, cls[, uri, ...])	Adds a new DenseNDArray to this Collection.
add_new_geometry_dataframe(key, ...[, uri, ...])	Adds a GeometryDataFrame to the scene and sets a coordinate transform between the scene and the dataframe.
add_new_multiscale_image(key, subcollection, ...)	Adds a MultiscaleImage to the scene and sets a coordinate transform between the scene and the dataframe.
add_new_point_cloud_dataframe(key, ...[, ...])	Adds a point cloud to the scene and sets a coordinate transform between the scene and the dataframe.
add_new_sparse_ndarray(key, *, cls[, uri, ...])	Adds a new SparseNDArray to this Collection.
get_transform_from_geometry_dataframe(key[, ...])	Returns the coordinate transformation from the requested geometry dataframe to the scene.
get_transform_from_multiscale_image(key[, ...])	Returns the coordinate transformation from the requested multiscale image to the scene.
get_transform_from_point_cloud_dataframe(key)	Returns the coordinate transformation from the requested point cloud dataframe to the scene.
get_transform_to_geometry_dataframe(key[, ...])	Returns the coordinate transformation from the scene to a requested geometery dataframe.
get_transform_to_multiscale_image(key[, ...])	Returns the coordinate transformation from the scene to a requested multiscale image.
get_transform_to_point_cloud_dataframe(key)	Returns the coordinate transformation from the scene to a requested point cloud dataframe.
set_transform_to_geometry_dataframe(key[, ...])	Adds the coordinate transform for the scene coordinate space to a geometry dataframe stored in the scene.
set_transform_to_multiscale_image(key[, ...])	Adds the coordinate transform for the scene coordinate space to a multiscale image stored in the scene.
set_transform_to_point_cloud_dataframe(key)	Adds the coordinate transform for the scene coordinate space to a point cloud dataframe stored in the scene.

Attributes

uri	Accessor for the object's storage URI.
context	A value storing implementation-specific configuration information.
metadata	The metadata of this SOMA object.
mode	The mode this object was opened in, either r or w.
closed	True if the object has been closed.
soma_type	A string describing the SOMA type of this object.
tiledb_timestamp	The time that this object was opened in UTC.
tiledb_timestamp_ms	The time this object was opened, as millis since the Unix epoch.
coordinate_space	Coordinate system for this scene.
img	A collection of multiscale images backing the spatial data.
obsl	A collection of observation location data.
varl	A collection of collections of variable location data.