tiledbarray package

Submodules

tiledbarray.TileDBArraySeed module

class tiledbarray.TileDBArraySeed.TileDbArray(path, attribute_name)

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.

__init__(path, attribute_name)

To construct a TileDbArray from an existing TileDbArraySeed, use wrap() instead.

Parameters:

• path (Union[str, TileDbArraySeed]) – Path to the TileDB file or a TileDbArraySeed object.

• attribute_name (Optional[str]) – Name of the attribute containing the array.

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, attribute_name)

Bases: object

TileDB-backed dataset as a DelayedArray array seed.

__init__(path, attribute_name)

Parameters:

• path (str) – Path or URI to the TileDB file.

• name – Attribute name inside the TileDB file that contains the array.

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)

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, subset)

See extract_dense_array().

Subset parameter is passed to tiledb’s multi_index operation.

Return type:

ndarray

tiledbarray.TileDBArraySeed.extract_sparse_array_TileDbArraySeed(x, subset)

See extract_sparse_array().

Subset parameter is passed to tiledb’s multi_index operation.

Return type:

SparseNdarray

tiledbarray.TileDBArraySeed.is_masked_TileDbArraySeed(x)

See is_masked().

tiledbarray.TileDBArraySeed.is_sparse_TileDbArraySeed(x)

See is_sparse().

tiledbarray.TileDBArraySeed.wrap_TileDbArraySeed(x)

See wrap().

Module contents