sl-shared-assets 3.0.0rc11__tar.gz → 3.0.0rc13__tar.gz

{sl_shared_assets-3.0.0rc11 → sl_shared_assets-3.0.0rc13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sl-shared-assets
-Version: 3.0.0rc11
+Version: 3.0.0rc13
 Summary: Provides data acquisition and processing assets shared between Sun (NeuroAI) lab libraries.
 Project-URL: Homepage, https://github.com/Sun-Lab-NBB/sl-shared-assets
 Project-URL: Documentation, https://sl-shared-assets-api-docs.netlify.app/

{sl_shared_assets-3.0.0rc11 → sl_shared_assets-3.0.0rc13}/pyproject.toml

@@ -8,7 +8,7 @@ build-backend = "hatchling.build"
 # Project metdata section. Provides the genral ID information about the project.
 [project]
 name = "sl-shared-assets"
-version = "3.0.0rc11"
+version = "3.0.0rc13"
 description = "Provides data acquisition and processing assets shared between Sun (NeuroAI) lab libraries."
 readme = "README.md"
 license = { file = "LICENSE" }

{sl_shared_assets-3.0.0rc11 → sl_shared_assets-3.0.0rc13}/src/sl_shared_assets/__init__.py

@@ -35,6 +35,7 @@ from .data_classes import (
     RunTrainingDescriptor,
     LickTrainingDescriptor,
     MesoscopeHardwareState,
+    WindowCheckingDescriptor,
     MesoscopeMicroControllers,
     MesoscopeAdditionalFirmware,
     MesoscopeSystemConfiguration,
@@ -83,6 +84,7 @@ __all__ = [
     "ExperimentTrial",
     "SessionTypes",
     "AcquisitionSystems",
+    "WindowCheckingDescriptor",
     # Tools package
     "resolve_p53_marker",
     "transfer_directory",

{sl_shared_assets-3.0.0rc11 → sl_shared_assets-3.0.0rc13}/src/sl_shared_assets/__init__.pyi

@@ -31,6 +31,7 @@ from .data_classes import (
     RunTrainingDescriptor as RunTrainingDescriptor,
     LickTrainingDescriptor as LickTrainingDescriptor,
     MesoscopeHardwareState as MesoscopeHardwareState,
+    WindowCheckingDescriptor as WindowCheckingDescriptor,
     MesoscopeMicroControllers as MesoscopeMicroControllers,
     MesoscopeAdditionalFirmware as MesoscopeAdditionalFirmware,
     MesoscopeSystemConfiguration as MesoscopeSystemConfiguration,
@@ -73,6 +74,7 @@ __all__ = [
     "ExperimentTrial",
     "SessionTypes",
     "AcquisitionSystems",
+    "WindowCheckingDescriptor",
     "resolve_p53_marker",
     "transfer_directory",
     "calculate_directory_checksum",

{sl_shared_assets-3.0.0rc11 → sl_shared_assets-3.0.0rc13}/src/sl_shared_assets/data_classes/__init__.py

@@ -9,6 +9,7 @@ from .runtime_data import (
     RunTrainingDescriptor,
     LickTrainingDescriptor,
     MesoscopeHardwareState,
+    WindowCheckingDescriptor,
     MesoscopeExperimentDescriptor,
 )
 from .session_data import RawData, SessionData, SessionTypes, ProcessedData, ProcessingTracker
@@ -63,4 +64,5 @@ __all__ = [
     "ExperimentTrial",
     "AcquisitionSystems",
     "SessionTypes",
+    "WindowCheckingDescriptor",
 ]

{sl_shared_assets-3.0.0rc11 → sl_shared_assets-3.0.0rc13}/src/sl_shared_assets/data_classes/__init__.pyi

@@ -4,6 +4,7 @@ from .runtime_data import (
     RunTrainingDescriptor as RunTrainingDescriptor,
     LickTrainingDescriptor as LickTrainingDescriptor,
     MesoscopeHardwareState as MesoscopeHardwareState,
+    WindowCheckingDescriptor as WindowCheckingDescriptor,
     MesoscopeExperimentDescriptor as MesoscopeExperimentDescriptor,
 )
 from .session_data import (
@@ -64,4 +65,5 @@ __all__ = [
     "ExperimentTrial",
     "AcquisitionSystems",
     "SessionTypes",
+    "WindowCheckingDescriptor",
 ]

{sl_shared_assets-3.0.0rc11 → sl_shared_assets-3.0.0rc13}/src/sl_shared_assets/data_classes/runtime_data.py

@@ -257,13 +257,13 @@ class MesoscopePositions(YamlConfig):
     """
 
     mesoscope_x: float = 0.0
-    """The Mesoscope objective X-axis position, in centimeters."""
+    """The Mesoscope objective X-axis position, in micrometers."""
     mesoscope_y: float = 0.0
-    """The Mesoscope objective Y-axis position, in centimeters."""
+    """The Mesoscope objective Y-axis position, in micrometers."""
     mesoscope_roll: float = 0.0
     """The Mesoscope objective Roll-axis position, in degrees."""
     mesoscope_z: float = 0.0
-    """The Mesoscope objective Z-axis position, in centimeters."""
+    """The Mesoscope objective Z-axis position, in micrometers."""
     mesoscope_fast_z: float = 0.0
     """The ScanImage FastZ (virtual Z-axis) position, in micrometers."""
     mesoscope_tip: float = 0.0
@@ -272,3 +272,5 @@ class MesoscopePositions(YamlConfig):
     """The ScanImage Tip position, in degrees."""
     laser_power_mw: float = 0.0
     """The laser excitation power at the sample, in milliwatts."""
+    red_dot_alignment_z: float = 0.0
+    """The Mesoscope objective Z-axis position, in micrometers, used for red-dot alignment procedure."""

{sl_shared_assets-3.0.0rc11 → sl_shared_assets-3.0.0rc13}/src/sl_shared_assets/data_classes/runtime_data.pyi

@@ -151,3 +151,4 @@ class MesoscopePositions(YamlConfig):
     mesoscope_tip: float = ...
     mesoscope_tilt: float = ...
     laser_power_mw: float = ...
+    red_dot_alignment_z: float = ...

{sl_shared_assets-3.0.0rc11 → sl_shared_assets-3.0.0rc13}/src/sl_shared_assets/data_classes/session_data.py

@@ -553,6 +553,10 @@ class SessionData(YamlConfig):
         origin.raw_data = None  # type: ignore
         origin.processed_data = None  # type: ignore
 
+        # Converts StringEnum instances to strings
+        origin.session_type = str(origin.session_type)
+        origin.animal_id = str(origin.acquisition_system)
+
         # Saves instance data as a .YAML file
         origin.to_yaml(file_path=self.raw_data.session_data_path)