Skip to content
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

Expand spatial dataframe docstrings #230

Merged
merged 3 commits into from
Sep 26, 2024
Merged

Expand spatial dataframe docstrings #230

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a8862e0
Expand PointCloud doc string
aaronwolen Sep 26, 2024
3c370e1
Expand GeometryDataFrame docstring
aaronwolen Sep 26, 2024
9a3e819
Double back ticks
aaronwolen Sep 26, 2024
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
12 changes: 9 additions & 3 deletions python-spec/src/somacore/spatial.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,11 @@


class PointCloud(base.SOMAObject, metaclass=abc.ABCMeta):
"""A multi-column table with point data and a user-defined schema.
"""A specialized SOMA DataFrame for storing collections of points in multi-dimensional space.

The ``PointCloud`` class is designed to efficiently store and query point data, where each
point is represented by coordinates in one or more spatial dimensions (e.g., x, y, z) and
may have additional columns for associated attributes.

Lifecycle: experimental
"""
Expand Down Expand Up @@ -259,8 +263,10 @@ def domain(self) -> Tuple[Tuple[Any, Any], ...]:


class GeometryDataFrame(base.SOMAObject, metaclass=abc.ABCMeta):
"""A multi-column table of geometries with spatial indexing and a user-defined
schema.
"""A specialized SOMA object for storing complex geometries with spatial indexing.

The ``GeometryDataFrame`` class is designed to store and manage geometric shapes such as
polygons, lines, and multipoints, along with additional columns for associated attributes.

Lifecycle: experimental
"""
Expand Down