tiledbsoma.MultiscaleImage.open

classmethod MultiscaleImage.open(uri: str, mode: Literal['r', 'w'] = 'r', *, tiledb_timestamp: int | datetime | None = None, context: SOMATileDBContext | None = None, platform_config: Dict[str, Mapping[str, Any]] | object | None = None, clib_type: str | None = None) → Self

Opens this specific type of SOMA object.

Parameters:

  • uri – The URI to open.

  • mode – The mode to open the object in. - r: Open for reading only (cannot write). - w: Open for writing only (cannot read).

  • tiledb_timestamp – The TileDB timestamp to open this object at, either an int representing milliseconds since the Unix epoch or a datetime.dateime object. When not provided (the default), the current time is used.

Returns:

The opened SOMA object.

Raises:

  • DoesNotExistError – If the object named by URI can not be accessed.

  • SOMAError – If the underlying TileDB object specified by uri is not recognized as a SOMA object.

  • ValueError – If the user-provided mode is invalid.

Lifecycle

Maturing.