tiledbsoma.PointCloudDataFrame¶

class tiledbsoma.PointCloudDataFrame(handle: PointCloudDataFrameWrapper, **kwargs: Any)¶

A specialized SOMA DataFrame for storing collections of points in multi-dimensional space.

The PointCloudDataFrame class is designed to efficiently store and query point data, where each point is represented by coordinates in one or more spatial dimensions (e.g., x, y, z) and may have additional columns for associated attributes.

Lifecycle

Experimental.

__init__(handle: PointCloudDataFrameWrapper, **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, *, schema[, coordinate_space, ...])	Creates a new `PointCloudDataFrame` 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.
`keys`()	Returns the names of the columns when read back as a spatial dataframe.
`read`([coords, column_names, batch_size, ...])	Reads a user-defined slice of data into Arrow tables.
`write`(values, *[, platform_config])	Writes the data from an Arrow table to the persistent object.
`config_options_from_schema`()	Returns metadata about the array that is not encompassed within the Arrow Schema, in the form of a PlatformConfig (deprecated).
`non_empty_domain`()	Retrieves the non-empty domain for each dimension, namely the smallest and largest indices in each dimension for which the array/dataframe has data occupied.
`read_spatial_region`([region, column_names, ...])	Reads data intersecting a user-defined region of space into a `SpatialRead` with data in Arrow tables.

Attributes

`uri`	Accessor for the object's storage URI.
`closed`	True if the object has been closed.
`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`.
`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.
`axis_names`	The names of the axes of the coordinate space the data is defined on.
`coordinate_space`	Coordinate space for this point cloud dataframe.
`count`	Returns the number of rows in the dataframe.
`domain`	Returns a tuple of minimum and maximum values, inclusive, storable on each index column of the dataframe.
`index_column_names`	Returns index (dimension) column names.
`schema`	Returns data schema, in the form of an Arrow Schema.