tiledbsoma.PointCloudDataFrame.create

classmethod PointCloudDataFrame.create(uri: str, *, schema: Schema, coordinate_space: Sequence[str] | CoordinateSpace = ('x', 'y'), domain: Sequence[None | Tuple[Any, Any] | List[Any]] | None = None, platform_config: Dict[str, Mapping[str, Any]] | object | None = None, context: SOMATileDBContext | None = None, tiledb_timestamp: int | datetime | None = None) → Self

Creates a new PointCloudDataFrame at the given URI.

The schema of the created point cloud dataframe will include a column named soma_joinid of type pyarrow.int64, with negative values disallowed, and at least one axis with numeric type. If a soma_joinid column is present in the provided schema, it must be of the correct type. If the soma_joinid column is not provided, one will be added.

The schema of the created point cloud must contain columns for the axes in the coordinate_space. These columns followed by the soma_joinid will be index columns for the point cloud dataframe.

Parameters:

  • uri – The URI where the dataframe will be created.

  • schema – Arrow schema defining the per-column schema. This schema must define all columns, including columns to be named as index columns. If the schema includes types unsupported by the SOMA implementation, a ValueError will be raised.

  • coordinate_space – Either the coordinate space or the axis names for the coordinate space the point cloud is defined on.

  • domain – An optional sequence of tuples specifying the domain of each index column. Each tuple must be a pair consisting of the minimum and maximum values storable in the index column. For example, if there is a single int64-valued index column, then domain might be [(100, 200)] to indicate that values between 100 and 200, inclusive, can be stored in that column. If provided, this sequence must have the same length as index_column_names, and the index-column domain will be as specified. If omitted entirely, or if None in a given dimension, the corresponding index-column domain will use an empty range, and data writes after that will fail with “A range was set outside of the current domain”. Unless you have a particular reason not to, you should always provide the desired domain at create time: this is an optional but strongly recommended parameter.

Returns:

The newly created point cloud, opened for writing.

Lifecycle

Experimental.