Static pattern matching framework, orientation similarity map and crystal map merging

doc/reference.rst

@@ -224,18 +224,14 @@ indexing
 .. currentmodule:: kikuchipy.indexing
 
 .. autosummary::
-    pattern_matching
+    merge_crystal_maps
+    orientation_similarity_map
+    StaticDictionaryIndexing
     similarity_metrics
 
-pattern_matching
-----------------
-
-.. currentmodule:: kikuchipy.indexing.pattern_matching
-
-.. autosummary::
-    pattern_match
-
-.. automodule:: kikuchipy.indexing.pattern_matching
+.. autofunction:: merge_crystal_maps
+.. autofunction:: orientation_similarity_map
+.. autoclass:: StaticDictionaryIndexing
     :members:
     :undoc-members:
     :show-inheritance:
@@ -257,7 +253,7 @@ similarity_metrics
 ....
 
 io
-==
+===
 
 .. automodule:: kikuchipy.io
 

kikuchipy/conftest.py

@@ -19,11 +19,12 @@
 import gc
 import os
 import tempfile
+from typing import Tuple
 
 from diffpy.structure import Atom, Lattice, Structure
 from diffsims.crystallography import ReciprocalLatticePoint
 import numpy as np
-from orix.crystal_map import Phase
+from orix.crystal_map import CrystalMap, Phase, PhaseList
 from orix.quaternion.rotation import Rotation
 from orix.vector import Vector3d, neo_euler
 import pytest
@@ -40,8 +41,8 @@
 
 @pytest.fixture
 def dummy_signal():
-    """Dummy signal of shape <3, 3|3, 3>. If this is changed, all tests
-    using this signal will fail since they compare the output from
+    """Dummy signal of shape <(3, 3)|(3, 3)>. If this is changed, all
+    tests using this signal will fail since they compare the output from
     methods using this signal (as input) to hard-coded outputs.
     """
     # fmt: off
@@ -292,3 +293,59 @@ def nickel_zone_axes(nickel_kikuchi_band, nickel_rotations, pc1):
         in_pattern=uvw_in_pattern,
         gnomonic_radius=detector.r_max,
     )
+
+
+@pytest.fixture
+def rotations():
+    return Rotation([(2, 4, 6, 8), (-1, -3, -5, -7)])
+
+
+@pytest.fixture
+def get_single_phase_xmap(rotations):
+    def _get_single_phase_xmap(
+        nav_shape,
+        rotations_per_point=5,
+        prop_names=["scores", "simulation_indices"],
+        name="a",
+        phase_id=0,
+    ):
+        d, map_size = _get_spatial_array_dicts(nav_shape)
+        rot_idx = np.random.choice(
+            np.arange(rotations.size), map_size * rotations_per_point
+        )
+        data_shape = (map_size,)
+        if rotations_per_point > 1:
+            data_shape += (rotations_per_point,)
+        d["rotations"] = rotations[rot_idx].reshape(*data_shape)
+        d["phase_id"] = np.ones(map_size) * phase_id
+        d["phase_list"] = PhaseList(Phase(name=name))
+        # Scores and simulation indices
+        d["prop"] = {
+            prop_names[0]: np.ones(data_shape, dtype=np.float32),
+            prop_names[1]: np.arange(np.prod(data_shape)).reshape(data_shape),
+        }
+        return CrystalMap(**d)
+
+    return _get_single_phase_xmap
+
+
+def _get_spatial_array_dicts(
+    nav_shape: Tuple[int, int], step_sizes: Tuple[int, int] = (1.5, 1)
+) -> Tuple[dict, int]:
+    ny, nx = nav_shape
+    dy, dx = step_sizes
+    d = {"x": None, "y": None, "z": None}
+    map_size = 1
+    if nx > 1:
+        if ny > 1:
+            d["x"] = np.tile(np.arange(nx) * dx, ny)
+        else:
+            d["x"] = np.arange(nx) * dx
+        map_size *= nx
+    if ny > 1:
+        if nx > 1:
+            d["y"] = np.sort(np.tile(np.arange(ny) * dy, nx))
+        else:
+            d["y"] = np.arange(ny) * dy
+        map_size *= ny
+    return d, map_size

kikuchipy/indexing/__init__.py

@@ -16,16 +16,24 @@
 # You should have received a copy of the GNU General Public License
 # along with kikuchipy. If not, see <http://www.gnu.org/licenses/>.
 
-"""Indexing of EBSD patterns."""
+"""Indexing of EBSD patterns and useful related tools."""
 
+from kikuchipy.indexing._merge_crystal_maps import merge_crystal_maps
+from kikuchipy.indexing.orientation_similarity_map import (
+    orientation_similarity_map,
+)
 from kikuchipy.indexing.similarity_metrics import (
     make_similarity_metric,
     MetricScope,
 )
-from kikuchipy.indexing.pattern_matching import pattern_match
+from kikuchipy.indexing._static_dictionary_indexing import (
+    StaticDictionaryIndexing,
+)
 
 __all__ = [
+    "merge_crystal_maps",
+    "orientation_similarity_map",
     "make_similarity_metric",
     "MetricScope",
-    "pattern_match",
+    "StaticDictionaryIndexing",
 ]