tiledbsoma.Scene.set_transform_to_point_cloud_dataframe

Scene.set_transform_to_point_cloud_dataframe(key: str, subcollection: str | Sequence[str] = 'obsl', *, transform: CoordinateTransform, coordinate_space: CoordinateSpace | None = None) → PointCloudDataFrame

Adds the coordinate transform for the scene coordinate space to a point cloud dataframe stored in the scene.

If the subcollection the point cloud dataframe is inside of is more than one layer deep, the input should be provided as a sequence of names. For example, to set a transform for a point named transcripts in the var/RNA collection:

scene.set_transform_to_point_cloud_dataframe(

‘transcripts’, transform, subcollection=[‘var’, ‘RNA’],

)

Parameters:

• key – The name of the point cloud dataframe.

• transform – The coordinate transformation from the scene to the dataframe.

• subcollection – The name, or sequence of names, of the subcollection the dataframe is stored in. Defaults to 'obsl'.

• coordinate_space – Optional coordinate space for the dataframe. This will replace the existing coordinate space of the dataframe. Defaults to None.

Returns:

The point cloud dataframe, opened for writing.

Lifecycle: experimental