pyglaze 0.1.0__py3-none-any.whl

pyglaze/scanning/client.py

@@ -0,0 +1,59 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import TYPE_CHECKING
+
+from serial import serialutil
+from typing_extensions import Self
+
+from ._asyncscanner import _AsyncScanner
+
+if TYPE_CHECKING:
+    from pyglaze.datamodels import UnprocessedWaveform
+    from pyglaze.device.configuration import DeviceConfiguration
+
+
+class ScannerStartupError(Exception):
+    """Raised when the scanner could not be started."""
+
+    def __init__(self: ScannerStartupError) -> None:
+        super().__init__(
+            "Scanner could not be started. Please check the internal server error messages."
+        )
+
+
+@dataclass
+class GlazeClient:
+    """Open a connection to and start continuously scanning using the Glaze device.
+
+    Args:
+        config: Configuration to use for scans
+    """
+
+    config: DeviceConfiguration
+    _scanner: _AsyncScanner = field(init=False)
+
+    def __enter__(self: Self) -> Self:
+        """Start the scanner and return the client."""
+        self._scanner = _AsyncScanner()
+        try:
+            self._scanner.start_scan(self.config)
+        except (TimeoutError, serialutil.SerialException) as e:
+            self.__exit__(e)
+        return self
+
+    def __exit__(self: GlazeClient, *args: object) -> None:
+        """Stop the scanner and close the connection."""
+        if self._scanner.is_scanning:
+            self._scanner.stop_scan()
+        # Exit is only called with arguments when an error occurs - hence raise.
+        if args[0]:
+            raise
+
+    def read(self: GlazeClient, n_pulses: int) -> list[UnprocessedWaveform]:
+        """Read a number of pulses from the Glaze system.
+
+        Args:
+            n_pulses: The number of terahertz pulses to read from the CCS server.
+        """
+        return self._scanner.get_scans(n_pulses)

pyglaze/scanning/scanner.py

@@ -0,0 +1,256 @@
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import TYPE_CHECKING, Generic, TypeVar
+
+import numpy as np
+
+from pyglaze.datamodels import UnprocessedWaveform
+from pyglaze.device.ampcom import _ForceAmpCom, _LeAmpCom
+from pyglaze.device.configuration import (
+    DeviceConfiguration,
+    ForceDeviceConfiguration,
+    LeDeviceConfiguration,
+)
+
+if TYPE_CHECKING:
+    from pyglaze.helpers.types import FloatArray
+
+TConfig = TypeVar("TConfig", bound=DeviceConfiguration)
+
+
+class _ScannerImplementation(ABC, Generic[TConfig]):
+    @abstractmethod
+    def __init__(self: _ScannerImplementation, config: TConfig) -> None:
+        pass
+
+    @property
+    @abstractmethod
+    def config(self: _ScannerImplementation) -> TConfig:
+        pass
+
+    @config.setter
+    @abstractmethod
+    def config(self: _ScannerImplementation, new_config: TConfig) -> None:
+        pass
+
+    @abstractmethod
+    def scan(self: _ScannerImplementation) -> UnprocessedWaveform:
+        pass
+
+    @abstractmethod
+    def update_config(self: _ScannerImplementation, new_config: TConfig) -> None:
+        pass
+
+
+class Scanner:
+    """A synchronous scanner for Glaze terahertz devices."""
+
+    def __init__(self: Scanner, config: TConfig) -> None:
+        self._scanner_impl: _ScannerImplementation[DeviceConfiguration] = (
+            _scanner_factory(config)
+        )
+
+    @property
+    def config(self: Scanner) -> DeviceConfiguration:
+        """Configuration used in the scan."""
+        return self._scanner_impl.config
+
+    @config.setter
+    def config(self: Scanner, new_config: DeviceConfiguration) -> None:
+        self._scanner_impl.config = new_config
+
+    def scan(self: Scanner) -> UnprocessedWaveform:
+        """Perform a scan.
+
+        Returns:
+            UnprocessedWaveform: A raw waveform.
+        """
+        return self._scanner_impl.scan()
+
+    def update_config(self: Scanner, new_config: DeviceConfiguration) -> None:
+        """Update the DeviceConfiguration used in the scan.
+
+        Args:
+            new_config (DeviceConfiguration): New configuration for scanner
+        """
+        self._scanner_impl.update_config(new_config)
+
+
+class ForceScanner(_ScannerImplementation[ForceDeviceConfiguration]):
+    """Perform synchronous terahertz scanning using a given DeviceConfiguration.
+
+    Args:
+        config: A DeviceConfiguration to use for the scan.
+
+    """
+
+    def __init__(self: ForceScanner, config: ForceDeviceConfiguration) -> None:
+        self._config: ForceDeviceConfiguration
+        self._ampcom: _ForceAmpCom
+        self.config = config
+        self._phase_estimator = _LockinPhaseEstimator()
+
+    @property
+    def config(self: ForceScanner) -> ForceDeviceConfiguration:
+        """The device configuration to use for the scan.
+
+        Returns:
+            DeviceConfiguration: a DeviceConfiguration.
+        """
+        return self._config
+
+    @config.setter
+    def config(self: ForceScanner, new_config: ForceDeviceConfiguration) -> None:
+        amp = _ForceAmpCom(new_config)
+        if getattr(self, "_config", None):
+            if (
+                self._config.integration_periods != new_config.integration_periods
+                or self._config.modulation_frequency != new_config.modulation_frequency
+            ):
+                amp.write_period_and_frequency()
+            if self._config.sweep_length_ms != new_config.sweep_length_ms:
+                amp.write_sweep_length()
+            if self._config.modulation_waveform != new_config.modulation_waveform:
+                amp.write_waveform()
+            if (
+                self._config.min_modulation_voltage != new_config.min_modulation_voltage
+                or self._config.max_modulation_voltage
+                != new_config.max_modulation_voltage
+            ):
+                amp.write_modulation_voltage()
+            if self._config.scan_intervals != new_config.scan_intervals:
+                amp.write_list()
+        else:
+            amp.write_all()
+
+        self._config = new_config
+        self._ampcom = amp
+
+    def scan(self: ForceScanner) -> UnprocessedWaveform:
+        """Perform a scan.
+
+        Returns:
+            Unprocessed scan.
+        """
+        _, responses = self._ampcom.start_scan()
+
+        time = responses[:, 0]
+        radius = responses[:, 1]
+        theta = responses[:, 2]
+        self._phase_estimator.update_estimate(radius=radius, theta=theta)
+
+        return UnprocessedWaveform.from_polar_coords(
+            time, radius, theta, self._phase_estimator.phase_estimate
+        )
+
+    def update_config(self: ForceScanner, new_config: ForceDeviceConfiguration) -> None:
+        """Update the DeviceConfiguration used in the scan.
+
+        Args:
+            new_config: A DeviceConfiguration to use for the scan.
+        """
+        self.config = new_config
+
+
+class LeScanner(_ScannerImplementation[LeDeviceConfiguration]):
+    """Perform synchronous terahertz scanning using a given DeviceConfiguration.
+
+    Args:
+        config: A DeviceConfiguration to use for the scan.
+    """
+
+    def __init__(self: LeScanner, config: LeDeviceConfiguration) -> None:
+        self._config: LeDeviceConfiguration
+        self._ampcom: _LeAmpCom
+        self.config = config
+        self._phase_estimator = _LockinPhaseEstimator()
+
+    @property
+    def config(self: LeScanner) -> LeDeviceConfiguration:
+        """The device configuration to use for the scan.
+
+        Returns:
+            DeviceConfiguration: a DeviceConfiguration.
+        """
+        return self._config
+
+    @config.setter
+    def config(self: LeScanner, new_config: LeDeviceConfiguration) -> None:
+        amp = _LeAmpCom(new_config)
+        if getattr(self, "_config", None):
+            if (
+                self._config.integration_periods != new_config.integration_periods
+                or self._config.n_points != new_config.n_points
+            ):
+                amp.write_list_length_and_integration_periods_and_use_ema()
+            if self._config.scan_intervals != new_config.scan_intervals:
+                amp.write_list()
+        else:
+            amp.write_all()
+
+        self._config = new_config
+        self._ampcom = amp
+
+    def scan(self: LeScanner) -> UnprocessedWaveform:
+        """Perform a scan.
+
+        Returns:
+            Unprocessed scan.
+        """
+        _, responses = self._ampcom.start_scan()
+
+        time = responses[:, 0]
+        radius = responses[:, 1]
+        theta = responses[:, 2]
+        self._phase_estimator.update_estimate(radius=radius, theta=theta)
+
+        return UnprocessedWaveform.from_polar_coords(
+            time, radius, theta, self._phase_estimator.phase_estimate
+        )
+
+    def update_config(self: LeScanner, new_config: LeDeviceConfiguration) -> None:
+        """Update the DeviceConfiguration used in the scan.
+
+        Args:
+            new_config: A DeviceConfiguration to use for the scan.
+        """
+        self.config = new_config
+
+
+def _scanner_factory(config: DeviceConfiguration) -> _ScannerImplementation:
+    if isinstance(config, ForceDeviceConfiguration):
+        return ForceScanner(config)
+    if isinstance(config, LeDeviceConfiguration):
+        return LeScanner(config)
+
+    msg = f"Unsupported configuration type: {type(config).__name__}"
+    raise TypeError(msg)
+
+
+class _LockinPhaseEstimator:
+    def __init__(
+        self: _LockinPhaseEstimator, r_threshold_for_update: float = 2.0
+    ) -> None:
+        self.phase_estimate: float | None = None
+        self.r_threshold_for_update = r_threshold_for_update
+        self._radius_of_est: float | None = None
+
+    def update_estimate(
+        self: _LockinPhaseEstimator, radius: FloatArray, theta: FloatArray
+    ) -> None:
+        r_argmax = np.argmax(radius)
+        r_max = radius[r_argmax]
+        theta_at_max = theta[r_argmax]
+        if self._radius_of_est is None:
+            self._set_estimates(theta_at_max, r_max)
+            return
+
+        if r_max > self.r_threshold_for_update * self._radius_of_est:
+            self._set_estimates(theta_at_max, r_max)
+
+    def _set_estimates(
+        self: _LockinPhaseEstimator, phase: float, radius: float
+    ) -> None:
+        self.phase_estimate = phase
+        self._radius_of_est = radius

pyglaze-0.1.0.dist-info/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Glaze Technologies
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

pyglaze-0.1.0.dist-info/METADATA

@@ -0,0 +1,82 @@
+Metadata-Version: 2.1
+Name: pyglaze
+Version: 0.1.0
+Summary: Pyglaze is a library used to operate the devices of Glaze Technologies
+Author: GLAZE Technologies ApS
+License: BSD 3-Clause License
+        
+        Copyright (c) 2024, Glaze Technologies
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+Project-URL: Homepage, https://www.glazetech.dk/
+Project-URL: Documentation, https://glazetech.github.io/pyglaze/latest
+Project-URL: Repository, https://github.com/GlazeTech/pyglaze
+Project-URL: Issues, https://github.com/GlazeTech/pyglaze/issues
+Requires-Python: <3.13,>=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy <2.0.0,>=1.26.4
+Requires-Dist: pyserial >=3.5
+Requires-Dist: scipy >=1.7.3
+Requires-Dist: bitstring >=4.1.2
+Requires-Dist: typing-extensions >=4.12.2
+
+# Pyglaze
+Pyglaze is a python library used to operate the devices of [Glaze Technologies](https://www.glazetech.dk/).
+
+Documentation can be found [here](https://glazetech.github.io/pyglaze/latest/).
+
+# Installation
+
+To install the latest version of the package, simply run 
+
+```
+pip install pyglaze
+```
+
+# Usage 
+See [our documentation](https://glazetech.github.io/pyglaze/latest/) for usage.
+
+# Developers
+
+To install the API with development tools in editable mode, first clone the repository from our [public GitHub repository](https://github.com/GlazeTech/pyglaze). Then, from the root of the project, run
+
+```
+python -m pip install --upgrade pip
+pip install -e . --config-settings editable_mode=strict
+pip install -r requirements-dev.txt
+```
+
+## Documentation - local build
+To build and serve the documentation locally
+
+1. Checkout the repository (or a specific version)
+2. Install `mkdocs`
+3. Run `mkdocs serve` while standing in the project root.
+
+
+# Bug reporting or feature requests
+Please create an issue [here](https://github.com/GlazeTech/pyglaze/issues) and we will look at it ASAP!

pyglaze-0.1.0.dist-info/RECORD

@@ -0,0 +1,32 @@
+pyglaze/__init__.py,sha256=pU56ZDjCDnUbINe39hYuKXHy9UI9Tf4xjWgnxBlxEDk,22
+pyglaze/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyglaze/datamodels/__init__.py,sha256=DJLByl2C7pC4RM4Uh6PW-McM5RIGBjcopzGywCKhSlI,111
+pyglaze/datamodels/pulse.py,sha256=8N0wHHtV2c31E8LKzPOfxWYHialPGXQfXAoX_h7dkBA,20488
+pyglaze/datamodels/waveform.py,sha256=n31DhJHFeBNZ3hHqQUiCGXssm5Dc8wV6tGPkhmFYB4Q,5809
+pyglaze/device/__init__.py,sha256=NbN0I1U3mc_kNz-HyRCGRQQSi5z5peEZOIrH3z-m52Y,445
+pyglaze/device/ampcom.py,sha256=_cPfgXb78uuj-GZkNPNDjifhQvqfkAxYycY8n_E2bvk,16767
+pyglaze/device/configuration.py,sha256=8_q7l4DTsU_dfrZd384XYGyzmA8ZuOho98pFulzByeY,8511
+pyglaze/device/delayunit.py,sha256=TO1FRhB3TepJn4QRNP-AKykWJVD9sx0Q9crL3xMudIk,4415
+pyglaze/device/identifiers.py,sha256=-LBAhlYsxBGSMevUIqW3KxckdOzOT9HcKIBOjT3XN-U,1022
+pyglaze/device/_delayunit_data/carmen-nonuniform-2023-10-20.pickle,sha256=5qcz-YwPfP5s2f5xlQ02er4dtZULWxXXJsac5tQsJRE,20400
+pyglaze/device/_delayunit_data/g1-linearized-2023-04-04.pickle,sha256=N2QX4WSCrh7QihOqfczIYgk_XPx1IxY2zxp0gs9H0RY,209
+pyglaze/device/_delayunit_data/g2-linearized-2023-04-04.pickle,sha256=eJ1A-NsZxN3pDd0UsqCyY9-pEzcXAYdsu_vxBx8ODq0,210
+pyglaze/device/_delayunit_data/g2-nonuniform-2023-04-04.pickle,sha256=1Tyd22YzAqw2r6BPVemfE1XuJ8jZj8XYQik5Ne8-s9g,1784
+pyglaze/device/_delayunit_data/mock_delay.pickle,sha256=tu-Uqytg8bWarBaXXRMD4jVU6MUr1Sz6dswJ6_6nbOA,207
+pyglaze/devtools/__init__.py,sha256=9EW20idoaZv_5GuSgDmfpTPjfCZ-Rl27EV3oJebmwnQ,90
+pyglaze/devtools/mock_device.py,sha256=TglmqvwX3FtdcE8cB_-3RNu2_QFtuJ-1chW8WTED3rc,13049
+pyglaze/devtools/thz_pulse.py,sha256=xp-T9psdOrUMtSUFu8HEwQJVu_aMixJdZHtg_BCVu_k,923
+pyglaze/helpers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyglaze/helpers/types.py,sha256=p9xSAP5Trr1FcCWl7ynCWqDOUZKgMQYzMUXSwDpAKHg,599
+pyglaze/helpers/utilities.py,sha256=n_x9Tqm305MUorS29O6CoJM8Mi4apo2bsN_odrRaVAw,2423
+pyglaze/interpolation/__init__.py,sha256=WCxHPsiI7zvJykp-jfytoEbO4Tla-YIF6A7fjDfcDvU,72
+pyglaze/interpolation/interpolation.py,sha256=rQWzPD7W8TXETps7VZI0gcfAOCWO8pGL1HhhBnyxaMw,735
+pyglaze/scanning/__init__.py,sha256=uCBaeDTufOrC9KWf30ICqcmvFg_YT85olb3M9jkvZRg,99
+pyglaze/scanning/_asyncscanner.py,sha256=n4PhRBSZLFSSeGgBkgVwFsdY4rnduXJnQo6TQ0ujVkw,5224
+pyglaze/scanning/client.py,sha256=3qrQStkeLQzCeu4yMHJ_ENLGQ7E5GMc4CP9J55rk-ug,1817
+pyglaze/scanning/scanner.py,sha256=TGHTO4qoLeKzb_hCuqEEAlKicbDvozY-3GiSfxiatXI,8226
+pyglaze-0.1.0.dist-info/LICENSE,sha256=LCP3sGBX7LxuQopcjeug1fW4tngWCHF4zB7QCgB28xM,1504
+pyglaze-0.1.0.dist-info/METADATA,sha256=OJ_Ck2MLNZ8ropSBGxuzRlDx8akLD_c2sEptwscCHuI,3498
+pyglaze-0.1.0.dist-info/WHEEL,sha256=mguMlWGMX-VHnMpKOjjQidIo1ssRlCFu4a4mBpz1s2M,91
+pyglaze-0.1.0.dist-info/top_level.txt,sha256=X7d5rqVVuWNmtK4-Uh4sgOLlqye8vaHZOr5RYba0REo,8
+pyglaze-0.1.0.dist-info/RECORD,,

pyglaze-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (70.1.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pyglaze-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pyglaze