Merge pull request #234 from clbarnes/landmark_match

Landmark match
navis-org · Jan 15, 2024 · 9d4ca69 · 9d4ca69
2 parents 0f05a46 + 1ad5965
commit 9d4ca69
Show file tree

Hide file tree

Showing 6 changed files with 368 additions and 15 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -160,6 +160,8 @@ Functions to fetch data about landmarks.
 
     pymaid.get_landmarks
     pymaid.get_landmark_groups
+    pymaid.LandmarkMatcher
+    pymaid.CrossProjectLandmarkMatcher
 
 Reconstruction samplers
 -----------------------

diff --git a/docs/source/whats_new.rst b/docs/source/whats_new.rst
@@ -17,6 +17,9 @@ What's new?
          like in the CATMAID frontend.
        - :func:`pymaid.get_stacks`, :func:`pymaid.get_stack_info`, :func:`pymaid.get_mirror_info` functions for getting information about image data
        - :class:`pymaid.stack.Stack` class for accessing N5 and JPEG tile image data as a :class:`xarray.DataArray`
+     - - :class:`pymaid.LandmarkMatcher` and :class:`pymaid.CrossProjectLandmarkMatcher`
+       for matching paired landmarks for use in transformations within a project
+       (e.g. left-right or segmental) or between projects (e.g. different animals)
    * - 2.4.0
      - 27/05/23
      - - :func:`pymaid.get_annotation_graph` deprecated in favour of the new

diff --git a/pymaid/fetch/__init__.py b/pymaid/fetch/__init__.py
@@ -54,7 +54,7 @@
 
 from .. import core, utils, config, cache
 from navis import in_volume
-from .landmarks import get_landmarks, get_landmark_groups
+from .landmarks import get_landmarks, get_landmark_groups, LandmarkMatcher, CrossProjectLandmarkMatcher
 from .skeletons import get_skeleton_ids
 from .annotations import get_annotation_graph, get_entity_graph, get_annotation_id
 from .stack import get_stacks, get_stack_info, get_mirror_info
@@ -91,8 +91,8 @@
                   'get_origin', 'get_skids_by_origin',
                   'get_sampler', 'get_sampler_domains', 'get_sampler_counts',
                   'get_skeleton_change',
-                  'get_landmarks',
-                  'get_landmark_groups',
+                  'get_landmarks', 'get_landmark_groups',
+                  'LandmarkMatcher', 'CrossProjectLandmarkMatcher',
                   'get_skeleton_ids',
                   'get_stacks', 'get_stack_info', 'get_mirror_info',
     ]