tiledbarray package

Submodules

tiledbarray.TileDBArraySeed module

class tiledbarray.TileDBArraySeed.TileDbArray(path: str | TileDbArraySeed, attribute_name: str | None)

Bases: DelayedArray

Sparse or Dense arrays from TileDB file as a DelayedArray.

This subclass allows developers to implement custom methods for tiledb-backed sparse or dense matrices.

property attribute_name: str | None

Returns: Name of the TileDB attribute containing the matrix contents.

property path: str

Returns: Path to the TileDB file.

class tiledbarray.TileDBArraySeed.TileDbArraySeed(path: str, attribute_name: str)

Bases: object

TileDB-backed dataset as a DelayedArray array seed.

property attribute_name: str

Returns: Attribute name inside the TileDB file that contains the array.

property dimnames: List[str]

Returns: Names of each dimension of the matrix.

property dtype: dtype

Returns: NumPy type of this array.

property is_sparse: bool

Returns: Whether the Array is sparse.

property path: str

Returns: Path to the HDF5 file.

property shape: Tuple[int, ...]

Returns: Tuple containing the dimensions of this array.

tiledbarray.TileDBArraySeed.chunk_grid_TileDbArraySeed(x: TileDbArraySeed)

See chunk_grid().

The cost factor is set to 20 to reflect the computational work involved in extracting data from disk.

tiledbarray.TileDBArraySeed.extract_dense_array_TileDbArraySeed(x: TileDbArraySeed, subset: Tuple[Sequence[int], ...]) → ndarray

See extract_dense_array().

Subset parameter is passed to tiledb’s multi_index operation.

tiledbarray.TileDBArraySeed.extract_sparse_array_TileDbArraySeed(x: TileDbArraySeed, subset: Tuple[Sequence[int], ...]) → SparseNdarray

See extract_sparse_array().

Subset parameter is passed to tiledb’s multi_index operation.

tiledbarray.TileDBArraySeed.is_masked_TileDbArraySeed(x: TileDbArraySeed)

See is_masked().

tiledbarray.TileDBArraySeed.is_sparse_TileDbArraySeed(x: TileDbArraySeed)

See is_sparse().

tiledbarray.TileDBArraySeed.wrap_Hdf5CompressedSparseMatrixSeed(x: TileDbArraySeed)

See wrap().

Module contents