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

Landmark match #234

Merged
merged 4 commits into from
Jan 15, 2024
+368 −15
Merged

Landmark match #234

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
45bf7db
LandmarkMatcher class
clbarnes Jun 13, 2023
b68d062
Document landmark matchers
clbarnes Jun 13, 2023
30e6726
improve landmarks docs
clbarnes Jul 5, 2023
1ad5965
Landmarks: minor docs changes
clbarnes Nov 14, 2023
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
Prev Previous commit
Next Next commit
improve landmarks docs
@clbarnes
clbarnes committed Jan 15, 2024
commit 30e6726a810a83efead7a75d4c00ab7e7995a8da
22 changes: 12 additions & 10 deletions pymaid/fetch/landmarks.py
View file
Original file line number Diff line number Diff line change
@@ -26,11 +26,11 @@ def get_landmarks(

Returns
-------
2-tuple of (DataFrame, optional DataFrame)
The first element is a DataFrame with columns
landmarks : pd.DataFrame
DataFrame with columns
landmark_id, name, user_id, project_id, creation_time, edition_time.

The second element is optionally a DataFrame with columns
locations : pd.DataFrame, optional (default None)
DataFrame with columns
location_id, x, y, z, landmark_id.

Examples
@@ -108,12 +108,14 @@ def get_landmark_groups(

Returns
-------
3-tuple of (dataframe, optional dataframe, optional dict[int, int])
The first element is a DataFrame with columns group_id, name, user_id, project_id, creation_time, edition_time.

The second element is optionally a DataFrame with columns location_id, x, y, z, group_id.

The third element is optionally a dict mapping group ID to a list of landmark IDs (members of that group).
groups : pd.DataFrame
A DataFrame with columns
group_id, name, user_id, project_id, creation_time, edition_time.
locations : pd.DataFrame, optional (default None)
A DataFrame with columns
location_id, x, y, z, group_id.
members : dict[int, int], optional (default None)
A dict mapping group ID to a list of landmark IDs (members of that group).

Examples
--------