You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/design_doc.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -231,16 +231,16 @@ Coordinates of points for single molecule data. Each observation is a point, and
231
231
Current implementation represent points as a Parquet file and a [`dask.dataframe.DataFrame`](https://docs.dask.org/en/stable/dataframe.html) in memory.
232
232
The requirements are the following:
233
233
234
-
- The table MUST contains axis name to represent the axes.
234
+
- The dataframe MUST contains axis name to represent the axes.
235
235
- If it's 2D, the axes should be `["x","y"]`.
236
236
- If it's 3D, the axes should be `["x","y","z"]`.
237
-
- It MUST also contains coordinates transformations in `dask.dataframe.DataFrame().attrs["transform"]`.
237
+
- It MUST also contain coordinate transformations in `dask.dataframe.DataFrame().attrs["transform"]`. This information will be saved on-disk in JSON under a `"coordinateTransformations"` key in a `.zattrs` file (Zarr v2), or `zarr.json` file (Zarr v3), in a Zarr Group containing the Element. The specific way this information is stored in disk is described by the NGFF specification (the implementaiton of the latest version of the specs is ongoing). Precisely, the NGFF specification dscribes coordinate transformations for images, but we will reuse it also for Points and Shapes.
238
238
239
-
Additional information is stored in `dask.dataframe.DataFrame().attrs["spatialdata_attrs"]`
239
+
Additional information is stored in `dask.dataframe.DataFrame().attrs["spatialdata_attrs"]` (or on-disk in `.attrs["spatialdata_attrs"]` for the Zarr Group containing the Element).
240
240
241
-
- It MAY also contains `"feature_key"`, that is, the column name of the table that refers to the features. This `Series` MAY be of type `pandas.Categorical`.
241
+
- It MAY also contains `"feature_key"`, that is, the column name of the dataframe that refers to the features. This `Series` MAY be of type `pandas.Categorical`.
242
242
- It MAY contains additional information in `dask.dataframe.DataFrame().attrs["spatialdata_attrs"]`, specifically:
243
-
-`"instance_key"`: the column name of the table where unique instance ids that this point refers to are stored, if available.
243
+
-`"instance_key"`: the column name of the dataframe where unique instance ids that this point refers to are stored, if available.
0 commit comments