Skip to content

Design doc: Add note about on-disk locations of point metadata attributes #957

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Design doc: Add note about on-disk locations of point metadata attributes #957

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
447771f
Add note about on-disk locations of point attributes
keller-mark Jul 18, 2025
0c9c95c
Update design_doc.md
keller-mark Jul 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/design_doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,9 +234,9 @@ The requirements are the following:
- The table MUST contains axis name to represent the axes.
- If it's 2D, the axes should be `["x","y"]`.
- If it's 3D, the axes should be `["x","y","z"]`.
- It MUST also contains coordinates transformations in `dask.dataframe.DataFrame().attrs["transform"]`.
- It MUST also contain coordinate transformations in `dask.dataframe.DataFrame().attrs["transform"]` (or on-disk in `.attrs["coordinateTransformations"]` for the Zarr Group containing the Element).

Additional information is stored in `dask.dataframe.DataFrame().attrs["spatialdata_attrs"]`
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).

- 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`.
- It MAY contains additional information in `dask.dataframe.DataFrame().attrs["spatialdata_attrs"]`, specifically:
Expand Down
Loading