tiledbsoma.PointCloudDataFrame.read_spatial_region

PointCloudDataFrame.read_spatial_region(region: Sequence[int] | Sequence[float] | BaseGeometry | None = None, column_names: Sequence[str] | None = None, *, region_transform: CoordinateTransform | None = None, region_coord_space: CoordinateSpace | None = None, batch_size: BatchSize = BatchSize(count=None, bytes=None), partitions: ReadPartitions | None = None, result_order: ResultOrder | Literal['auto', 'row-major', 'column-major'] = ResultOrder.AUTO, value_filter: str | None = None, platform_config: Dict[str, Mapping[str, Any]] | object | None = None) → SpatialRead[ReadIter[Table]]

Reads data intersecting a user-defined region of space into a SpatialRead with data in Arrow tables.

Parameters:

  • region – The region to query. May be a box in the form [x_min, y_min, x_max, y_max] (for 2D images), a box in the form [x_min, y_min, z_min, x_max, y_max, z_max] (for 3D images), or a shapely Geometry.

  • column_names – The named columns to read and return. Defaults to None, meaning no constraint – all column names.

  • region_transform – An optional coordinate transform from the read region to the coordinate system of the spatial dataframe. Defaults to None, meaning an identity transform.

  • region_coord_space – An optional coordinate space for the region being read. Defaults to None, coordinate space will be inferred from transform.

  • batch_size – The size of batched reads. Defaults to _UNBATCHED.

  • partitions – If present, specifies that this is part of a partitioned read, and which part of the data to include.

  • result_order – the order to return results, specified as a ResultOrder or its string value.

  • value_filter – an optional value filter to apply to the results. The default of None represents no filter. Value filter syntax is implementation-defined; see the documentation for the particular SOMA implementation for details.

Returns:

A SpatialRead with ReadIter of :class:`pa.Table`s data.

Lifecycle

Experimental.