tiledbsoma.Scene.add_new_dense_ndarray

Scene.add_new_dense_ndarray(key: str, *, cls: Type[_NDArr], uri: str | None = None, type: pa.DataType, shape: Sequence[int | None], platform_config: options.PlatformConfig | None = None) → DenseNDArray

Adds a new DenseNDArray to this Collection.

For details about the behavior of key and uri, see add_new_collection(). The remaining parameters are passed to the DenseNDArray.create() method unchanged.

Examples

>>> # create a collection and add a (4, 4) dense matrix to it
>>> with tiledbsoma.Collection.create("./test_collection") as my_collection:
...     # collection created. You can now add SOMA objects, e.g., a DenseNDArray
...     my_dense_ndarray = my_collection.add_new_dense_ndarray(
...         "my_dense_ndarray", type=pa.int32(), shape=(4, 4)
...     )
...     data = pa.Tensor.from_numpy(np.eye(4, 4, dtype=np.int32))
...     my_dense_ndarray.write((slice(None), slice(None)), data)
...
... # example of opening collection to read an object back
... with tiledbsoma.open("./test_collection") as my_collection:
...     data = my_collection["my_dense_ndarray"].read()
...
>>> data
<pyarrow.Tensor>
type: int32
shape: (4, 4)
strides: (16, 4)
>>> data.to_numpy()
array([[1, 0, 0, 0],
    [0, 1, 0, 0],
    [0, 0, 1, 0],
    [0, 0, 0, 1]], dtype=int32)

Lifecycle

Maturing.