aind-dynamic-foraging-basic-analysis 0.3.26__tar.gz → 0.3.27__tar.gz

{aind_dynamic_foraging_basic_analysis-0.3.26 → aind_dynamic_foraging_basic_analysis-0.3.27}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aind-dynamic-foraging-basic-analysis
-Version: 0.3.26
+Version: 0.3.27
 Summary: Generated from aind-library-template
 Author: Allen Institute for Neural Dynamics
 License: MIT

{aind_dynamic_foraging_basic_analysis-0.3.26 → aind_dynamic_foraging_basic_analysis-0.3.27}/pyproject.toml

@@ -73,7 +73,7 @@ exclude = '''
 '''
 
 [tool.coverage.run]
-omit = ["*__init__*"]
+omit = ["*__init__*","*style*"]
 source = ["aind_dynamic_foraging_basic_analysis", "tests"]
 
 [tool.coverage.report]

{aind_dynamic_foraging_basic_analysis-0.3.26 → aind_dynamic_foraging_basic_analysis-0.3.27}/src/aind_dynamic_foraging_basic_analysis/__init__.py

@@ -1,6 +1,6 @@
 """Init package"""
 
-__version__ = "0.3.26"
+__version__ = "0.3.27"
 
 from .metrics.foraging_efficiency import compute_foraging_efficiency  # noqa: F401
 from .plot.plot_foraging_session import plot_foraging_session  # noqa: F401

aind_dynamic_foraging_basic_analysis-0.3.27/src/aind_dynamic_foraging_basic_analysis/plot/style.py

@@ -0,0 +1,92 @@
+"""
+    Defines a dictionary of styles
+"""
+
+import matplotlib.pyplot as plt
+import numpy as np
+
+# General plotting style
+STYLE = {
+    "axis_ticks_fontsize": 12,
+    "axis_fontsize": 16,
+    "data_color_all": "blue",
+    "data_alpha": 1,
+    "axline_color": "k",
+    "axline_linestyle": "-",
+    "axline_alpha": 0.5,
+}
+
+# Colorscheme for photostim
+PHOTOSTIM_EPOCH_MAPPING = {
+    "after iti start": "cyan",
+    "before go cue": "cyan",
+    "after go cue": "green",
+    "whole trial": "blue",
+}
+
+# Colorscheme for FIP channels
+FIP_COLORS = {
+    "G": "g",
+    "R": "r",
+    "Iso": "gray",
+    "goCue_start_time": "b",
+    "left_lick_time": "m",
+    "right_lick_time": "r",
+    "left_reward_delivery_time": "b",
+    "right_reward_delivery_time": "r",
+}
+
+
+def get_colors(labels, cmap_name="hsv", offset=None):
+    """
+    Returns a dictionary of colors for each label.
+    Colors are equally spaced from a matplotlib colormap
+
+    Args:
+        labels (list of strings): keys for dictionary of colors
+        cmap_name (str): The name of matplotlib colormapt to use
+            (e.g., 'viridis', 'plasma', 'coolwarm').
+        offset (mixed): None, 'random', or float
+            None, equivalent to 0
+            'random', draw a random offset from 0 to 1
+            used to get a random mix of colors
+
+    Returns:
+        dictionary: a list of label/RGB-alpha tuple key/value pairs
+    """
+    colors = get_n_colors(len(labels), cmap_name, offset)
+    return {labels[i]: colors[i] for i in range(len(labels))}
+
+
+def get_n_colors(n, cmap_name="hsv", offset=None):
+    """
+    Returns n equally spaced colors from a matplotlib colormap.
+
+    Args:
+        n (int): The number of colors to generate.
+        cmap_name (str): The name of the matplotlib colormap to use
+            (e.g., 'viridis', 'plasma', 'coolwarm').
+        offset (mixed): None, 'random', or float
+            None, equivalent to 0
+            'random', draw a random offset from 0 to 1
+            used to get a random mix of colors
+
+    Returns:
+        list: A list of RGB tuples representing the equally spaced colors.
+    """
+    cmap = plt.get_cmap(cmap_name)
+
+    if cmap_name in ["twilight", "twilight_shifted", "hsv"]:
+        # cyclical color maps, so we need one extra spacing point for unique colors
+        n_spacing = n
+    else:
+        n_spacing = n - 1
+
+    # determine offset for mixing up colors
+    if offset is None:
+        offset = 0
+    elif offset == "random":
+        offset = np.random.rand()
+
+    colors = [cmap(np.mod(i / n_spacing + offset, 1)) for i in range(n)]
+    return colors

{aind_dynamic_foraging_basic_analysis-0.3.26 → aind_dynamic_foraging_basic_analysis-0.3.27}/src/aind_dynamic_foraging_basic_analysis.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aind-dynamic-foraging-basic-analysis
-Version: 0.3.26
+Version: 0.3.27
 Summary: Generated from aind-library-template
 Author: Allen Institute for Neural Dynamics
 License: MIT

aind_dynamic_foraging_basic_analysis-0.3.26/src/aind_dynamic_foraging_basic_analysis/plot/style.py

@@ -1,34 +0,0 @@
-"""
-    Defines a dictionary of styles
-"""
-
-# General plotting style
-STYLE = {
-    "axis_ticks_fontsize": 12,
-    "axis_fontsize": 16,
-    "data_color_all": "blue",
-    "data_alpha": 1,
-    "axline_color": "k",
-    "axline_linestyle": "-",
-    "axline_alpha": 0.5,
-}
-
-# Colorscheme for photostim
-PHOTOSTIM_EPOCH_MAPPING = {
-    "after iti start": "cyan",
-    "before go cue": "cyan",
-    "after go cue": "green",
-    "whole trial": "blue",
-}
-
-# Colorscheme for FIP channels
-FIP_COLORS = {
-    "G": "g",
-    "R": "r",
-    "Iso": "gray",
-    "goCue_start_time": "b",
-    "left_lick_time": "m",
-    "right_lick_time": "r",
-    "left_reward_delivery_time": "b",
-    "right_reward_delivery_time": "r",
-}