imswitchclient 0.1.2__tar.gz → 0.1.4__tar.gz

imswitchclient-0.1.4/PKG-INFO

@@ -0,0 +1,189 @@
+Metadata-Version: 2.4
+Name: imswitchclient
+Version: 0.1.4
+Summary: This is a package that connects ImSwitch's REST API to the rest of the world (e.g. jupyter lab)
+Home-page: https://github.com/openuc2/imswitchclient
+Author: Benedict Diederich
+Author-email: benedictdied@gmail.com
+License: MIT license
+Keywords: imswitchclient
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: Pillow
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: opencv-python
+Requires-Dist: python-socketio==5.12.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# ImSwitchClient Documentation
+
+## Introduction
+
+`ImSwitchClient` is a Python wrapper designed for interacting with the ImSwitch REST API, enabling remote control over ImSwitch functionalities, such as stage positioning, laser control, and image acquisition. This client simplifies API interactions and allows seamless integration into Python scripts and Jupyter Notebooks.
+
+[![PyPI Version](https://img.shields.io/pypi/v/imswitchclient.svg)](https://pypi.python.org/pypi/imswitchclient)
+
+## Try on GOOGLE COLAB:
+
+Hit this link and test: 
+
+<a target="_blank" href="https://colab.research.google.com/drive/1W3Jcw4gFn0jtQXa3_2aCtJYJglMNGkXr?usp=sharing">
+  <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
+</a>
+
+
+<a target="_blank" href="https://colab.research.google.com/github/openUC2/imswitchclient/blob/main/examples/StageCalibration.ipynb">
+  <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
+</a>
+
+## Features
+
+- **Remote Control**: Interface with ImSwitch through REST API endpoints.
+- **Comprehensive API Access**: Easily control positioners, lasers, detectors, and imaging settings.
+- **Interactive API Exploration**: Utilize the FastAPI Swagger UI at `http://localhost:8000/docs`.
+- **Modular Design**: Includes managers for lasers, positioners, image acquisition, and more.
+- **Open Source**: Inspired by OpenFlexure Client, freely available under the MIT license.
+
+## Installation
+
+You can install `ImSwitchClient` via pip:
+
+```bash
+pip install imswitchclient
+```
+
+## Getting Started
+
+### Initializing the Client
+
+```python
+import imswitchclient.ImSwitchClient as imc
+
+# Initialize the client
+client = imc.ImSwitchClient(host="0.0.0.0", isHttps=True, port=8001)
+```
+
+### Example: Moving a Stage and Acquiring an Image
+
+```python
+import numpy as np
+import matplotlib.pyplot as plt
+import time
+
+# Retrieve positioner names
+positioner_names = client.positionersManager.getAllDeviceNames()
+positioner_name = positioner_names[0]
+
+# Get current position
+current_positions = client.positionersManager.getPositionerPositions()[positioner_name]
+initial_position = (current_positions["X"], current_positions["Y"])
+
+# Turn on illumination
+laser_name = client.lasersManager.getLaserNames()[0]
+client.lasersManager.setLaserActive(laser_name, True)
+client.lasersManager.setLaserValue(laser_name, 512)
+
+# Move the stage and capture an image
+def capture_image_at_position(x, y):
+    client.positionersManager.movePositioner(positioner_name, "X", x, is_absolute=True, is_blocking=True)
+    client.positionersManager.movePositioner(positioner_name, "Y", y, is_absolute=True, is_blocking=True)
+    last_frame = client.recordingManager.snapNumpyToFastAPI()
+    plt.imshow(last_frame)
+    plt.show()
+
+# Example scanning
+for ix in range(5):
+    for iy in range(5):
+        new_x = initial_position[0] + ix * 50
+        new_y = initial_position[1] + iy * 50
+        capture_image_at_position(new_x, new_y)
+
+# Return stage to initial position
+client.positionersManager.movePositioner(positioner_name, "X", initial_position[0], is_absolute=True, is_blocking=True)
+client.positionersManager.movePositioner(positioner_name, "Y", initial_position[1], is_absolute=True, is_blocking=True)
+```
+
+### Laser Control Example
+
+```python
+laser_name = client.lasersManager.getLaserNames()[0]
+client.lasersManager.setLaserActive(laser_name, True)
+client.lasersManager.setLaserValue(laser_name, 800)
+
+# Verify laser status
+print(client.lasersManager.getLaserNames())
+client.lasersManager.setLaserActive(laser_name, False)
+```
+
+### Recording an Image
+
+```python
+# Take a snapshot
+image = client.recordingManager.snapNumpyToFastAPI()
+plt.imshow(image)
+plt.show()
+```
+
+### Setting Live View
+
+```python
+client.viewManager.setLiveViewActive(True)
+client.viewManager.setLiveViewCrosshairVisible(True)
+client.viewManager.setLiveViewGridVisible(False)
+```
+
+## API Overview
+
+The ImSwitch API provides access to various components:
+
+### Positioners Manager
+- `getAllDeviceNames()` - Get all available positioners.
+- `getPositionerPositions()` - Get current position.
+- `movePositioner(name, axis, value, is_absolute, is_blocking)` - Move the stage.
+- `homeAxis(name, axis, is_blocking)` - Home the positioner.
+
+### Lasers Manager
+- `getLaserNames()` - Get available lasers.
+- `setLaserActive(name, status)` - Turn laser on/off.
+- `setLaserValue(name, value)` - Set laser intensity.
+
+### Recording Manager
+- `snapNumpyToFastAPI()` - Capture an image.
+- `startRecording()` - Begin recording.
+- `stopRecording()` - Stop recording.
+
+### View Manager
+- `setLiveViewActive(status)` - Enable live view.
+- `setLiveViewCrosshairVisible(status)` - Show/hide crosshair.
+- `setLiveViewGridVisible(status)` - Show/hide grid.
+
+## Contributing
+
+Contributions are welcome! Visit the GitHub repository for details: [https://github.com/openUC2/imswitchclient](https://github.com/openUC2/imswitchclient)
+
+## License
+
+This project is licensed under the MIT License.
+

imswitchclient-0.1.4/README.md

@@ -0,0 +1,150 @@
+# ImSwitchClient Documentation
+
+## Introduction
+
+`ImSwitchClient` is a Python wrapper designed for interacting with the ImSwitch REST API, enabling remote control over ImSwitch functionalities, such as stage positioning, laser control, and image acquisition. This client simplifies API interactions and allows seamless integration into Python scripts and Jupyter Notebooks.
+
+[![PyPI Version](https://img.shields.io/pypi/v/imswitchclient.svg)](https://pypi.python.org/pypi/imswitchclient)
+
+## Try on GOOGLE COLAB:
+
+Hit this link and test: 
+
+<a target="_blank" href="https://colab.research.google.com/drive/1W3Jcw4gFn0jtQXa3_2aCtJYJglMNGkXr?usp=sharing">
+  <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
+</a>
+
+
+<a target="_blank" href="https://colab.research.google.com/github/openUC2/imswitchclient/blob/main/examples/StageCalibration.ipynb">
+  <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
+</a>
+
+## Features
+
+- **Remote Control**: Interface with ImSwitch through REST API endpoints.
+- **Comprehensive API Access**: Easily control positioners, lasers, detectors, and imaging settings.
+- **Interactive API Exploration**: Utilize the FastAPI Swagger UI at `http://localhost:8000/docs`.
+- **Modular Design**: Includes managers for lasers, positioners, image acquisition, and more.
+- **Open Source**: Inspired by OpenFlexure Client, freely available under the MIT license.
+
+## Installation
+
+You can install `ImSwitchClient` via pip:
+
+```bash
+pip install imswitchclient
+```
+
+## Getting Started
+
+### Initializing the Client
+
+```python
+import imswitchclient.ImSwitchClient as imc
+
+# Initialize the client
+client = imc.ImSwitchClient(host="0.0.0.0", isHttps=True, port=8001)
+```
+
+### Example: Moving a Stage and Acquiring an Image
+
+```python
+import numpy as np
+import matplotlib.pyplot as plt
+import time
+
+# Retrieve positioner names
+positioner_names = client.positionersManager.getAllDeviceNames()
+positioner_name = positioner_names[0]
+
+# Get current position
+current_positions = client.positionersManager.getPositionerPositions()[positioner_name]
+initial_position = (current_positions["X"], current_positions["Y"])
+
+# Turn on illumination
+laser_name = client.lasersManager.getLaserNames()[0]
+client.lasersManager.setLaserActive(laser_name, True)
+client.lasersManager.setLaserValue(laser_name, 512)
+
+# Move the stage and capture an image
+def capture_image_at_position(x, y):
+    client.positionersManager.movePositioner(positioner_name, "X", x, is_absolute=True, is_blocking=True)
+    client.positionersManager.movePositioner(positioner_name, "Y", y, is_absolute=True, is_blocking=True)
+    last_frame = client.recordingManager.snapNumpyToFastAPI()
+    plt.imshow(last_frame)
+    plt.show()
+
+# Example scanning
+for ix in range(5):
+    for iy in range(5):
+        new_x = initial_position[0] + ix * 50
+        new_y = initial_position[1] + iy * 50
+        capture_image_at_position(new_x, new_y)
+
+# Return stage to initial position
+client.positionersManager.movePositioner(positioner_name, "X", initial_position[0], is_absolute=True, is_blocking=True)
+client.positionersManager.movePositioner(positioner_name, "Y", initial_position[1], is_absolute=True, is_blocking=True)
+```
+
+### Laser Control Example
+
+```python
+laser_name = client.lasersManager.getLaserNames()[0]
+client.lasersManager.setLaserActive(laser_name, True)
+client.lasersManager.setLaserValue(laser_name, 800)
+
+# Verify laser status
+print(client.lasersManager.getLaserNames())
+client.lasersManager.setLaserActive(laser_name, False)
+```
+
+### Recording an Image
+
+```python
+# Take a snapshot
+image = client.recordingManager.snapNumpyToFastAPI()
+plt.imshow(image)
+plt.show()
+```
+
+### Setting Live View
+
+```python
+client.viewManager.setLiveViewActive(True)
+client.viewManager.setLiveViewCrosshairVisible(True)
+client.viewManager.setLiveViewGridVisible(False)
+```
+
+## API Overview
+
+The ImSwitch API provides access to various components:
+
+### Positioners Manager
+- `getAllDeviceNames()` - Get all available positioners.
+- `getPositionerPositions()` - Get current position.
+- `movePositioner(name, axis, value, is_absolute, is_blocking)` - Move the stage.
+- `homeAxis(name, axis, is_blocking)` - Home the positioner.
+
+### Lasers Manager
+- `getLaserNames()` - Get available lasers.
+- `setLaserActive(name, status)` - Turn laser on/off.
+- `setLaserValue(name, value)` - Set laser intensity.
+
+### Recording Manager
+- `snapNumpyToFastAPI()` - Capture an image.
+- `startRecording()` - Begin recording.
+- `stopRecording()` - Stop recording.
+
+### View Manager
+- `setLiveViewActive(status)` - Enable live view.
+- `setLiveViewCrosshairVisible(status)` - Show/hide crosshair.
+- `setLiveViewGridVisible(status)` - Show/hide grid.
+
+## Contributing
+
+Contributions are welcome! Visit the GitHub repository for details: [https://github.com/openUC2/imswitchclient](https://github.com/openUC2/imswitchclient)
+
+## License
+
+This project is licensed under the MIT License.
+

{imswitchclient-0.1.2 → imswitchclient-0.1.4}/imswitchclient/ImSwitchClient.py

@@ -10,10 +10,12 @@ import os
 from .positionersManager import positionersManager
 from .recordingManager import recordingManager
 from .lasersManager import lasersManager
-
+from .histoscanManager import histoscanManager
+from .objectiveController import objectiveController
+from .socketClient import socketClient
 
 class ImSwitchClient(object):
-    def __init__(self, host="0.0.0.0", isHttps=True, port=8001):
+    def __init__(self, host="0.0.0.0", isHttps=True, port=8001, socket_port=8002):
         self.host = host
         self.port = port
         self.isHttps = isHttps
@@ -25,6 +27,12 @@ class ImSwitchClient(object):
         self.positionersManager = positionersManager(self)
         self.recordingManager = recordingManager(self)
         self.lasersManager = lasersManager(self)
+        self.histoscanManager = histoscanManager(self)
+        self.objectiveController = objectiveController(self)
+
+        # initialize Socket.IO client
+        self.socketClient = socketClient(host=self.host, port=socket_port, isHttps=self.isHttps)
+
         
     @property
     def base_uri(self):

{imswitchclient-0.1.2 → imswitchclient-0.1.4}/imswitchclient/__init__.py

@@ -3,4 +3,4 @@ from imswitchclient import *
 
 __author__ = """Benedict Diederich"""
 __email__ = 'benedictdied@gmail.com'
-__version__ = "v0.1.2"#'0.1.2'
+__version__ = "v0.1.4"#'0.1.3'

imswitchclient-0.1.4/imswitchclient/histoscanManager.py

@@ -0,0 +1,132 @@
+from PIL import Image
+import numpy as np
+import io
+import json
+
+class histoscanManager(object):
+    
+    '''
+    http://localhost:8001/HistoScanController/startHistoScanTileBasedByParameters?numberTilesX=2&numberTilesY=2&stepSizeX=100&stepSizeY=100&nTimes=1&tPeriod=1&initPosX=0&initPosY=0
+    http://localhost:8001/HistoScanController/startStageMapping
+    http://localhost:8001/HistoScanController/stopHistoScan
+    '''
+    
+    def __init__(self, parent):
+        self.parent = parent
+        
+    def stopHistoScan(self):
+        url = f"{self.parent.base_uri}/HistoScanController/stopHistoScan"
+        headers = {'accept': 'application/json'}
+        response = self.parent.get_json(url, headers=headers)
+        return response
+    
+    def startStageScanningPositionlistbased(self, positionList:list, nTimes:int=1, tPeriod:int=1, illuSource:str=None):
+        url = f"{self.parent.base_uri}/HistoScanController/startStageScanningPositionlistbased"
+
+        payload = {
+            "positionList": str(positionList),
+            "nTimes": nTimes,
+            "tPeriod": tPeriod,
+            "illuSource": illuSource
+        }
+        if nTimes < 1:
+            raise ValueError("nTimes must be greater than 0")
+        response = self.parent.get_json(url, payload=payload)
+        return response
+            
+
+    def startStageScanningPositionlistbased(self, positionList:str, nTimes:int=1, tPeriod:int=1, illuSource:str=None):
+        '''
+        https://localhost:8001/HistoScanController/startStageScanningPositionlistbased?positionList=dadf&nTimes=1&tPeriod=0
+        
+        positionList: list of tuples with X/Y positions (e.g. "[(10, 10, 100), (100, 100, 100)]")
+        nTimes: number of times to repeat the scan
+        tPeriod: time between scans
+        '''
+        
+        url = f"{self.parent.base_uri}/HistoScanController/startStageScanningPositionlistbased"
+        payload = {
+            "positionList": positionList,
+            "nTimes": nTimes,
+            "tPeriod": tPeriod,
+            "illuSource": illuSource
+        }
+        if nTimes < 1:
+            raise ValueError("nTimes must be greater than 0")
+        response = self.parent.get_json(url, payload=payload)
+        return response
+    
+
+    def startHistoScanTileBasedByParameters(self, numberTilesX, numberTilesY, stepSizeX, stepSizeY, initPosX, initPosY, nTimes=1, tPeriod=1):
+        url = f"{self.parent.base_uri}/HistoScanController/startHistoScanTileBasedByParameters"
+        payload = {
+            "numberTilesX": numberTilesX,
+            "numberTilesY": numberTilesY,
+            "stepSizeX": stepSizeX,
+            "stepSizeY": stepSizeY,
+            "nTimes": nTimes,
+            "tPeriod": tPeriod,
+            "initPosX": initPosX,
+            "initPosY": initPosY
+        }
+        if nTimes < 1:
+            raise ValueError("nTimes must be greater than 0")
+        response = self.parent.get_json(url, payload=payload)
+        return response
+
+    def startStageMapping(self):
+        url = f"{self.parent.base_uri}/HistoScanController/startStageMapping"
+        payload = {
+        }
+        response = self.parent.get_json(url, payload=payload)
+        return response
+    
+    def getStatusScanRunning(self):
+        url = f"{self.parent.base_uri}/HistoScanController/getStatusScanRunning"
+        payload = {
+        }
+        response = self.parent.get_json(url, payload=payload)
+        return response
+    
+    def getLastStitchedImage(self):
+        '''
+        https://localhost:8001/HistoScanController/
+        Retrieve numpy image based on 
+        return Response(im_bytes, headers=headers, media_type='image/png')
+        '''
+        url = f"{self.parent.base_uri}/HistoScanController/getLastStitchedImage"
+        headers = {'accept': 'application/json'}
+        response = self.parent.get_json(url, headers=headers)
+        content_type = response.headers.get('content-type')
+        if content_type == 'image/png':
+            image_data = response.content
+            image = Image.open(io.BytesIO(image_data))
+            return np.array(image)
+        else:
+            raise ValueError("Unexpected response content-type. Expected 'image/png'.")
+        
+        
+    def startStageScanning(self, minPosX:float=None, maxPosX:float=None, minPosY:float=None, maxPosY:float=None, 
+                           overlap:float=None, nTimes:int=1, tPeriod:int=0, positionList:list=None, 
+                           isStitchAshlar:bool=False, isStitchAshlarFlipX:bool=False, isStitchAshlarFlipY:bool=False, 
+                           resizeFactor=0.25):
+        '''
+        generic stage scan, rather low-level
+        '''
+        url = f"{self.parent.base_uri}/HistoScanController/startStageScanning"
+        payload = {
+            "minPosX": minPosX,
+            "maxPosX": maxPosX,
+            "minPosY": minPosY,
+            "maxPosY": maxPosY,
+            "overlap": overlap,
+            "nTimes": nTimes,
+            "tPeriod": tPeriod,
+            "positionList": json.dumps(positionList),
+            "isStitchAshlar": isStitchAshlar,
+            "isStitchAshlarFlipX": isStitchAshlarFlipX,
+            "isStitchAshlarFlipY": isStitchAshlarFlipY,
+            "resizeFactor": resizeFactor
+        }
+        response = self.parent.get_json(url, payload=payload)
+        return response

imswitchclient-0.1.4/imswitchclient/objectiveController.py

@@ -0,0 +1,45 @@
+class objectiveController(object):
+
+    def __init__(self, parent):
+        self.parent = parent
+
+    def calibrateObjective(self, homeDirection=None, homePolarity=None):
+        url = f"{self.parent.base_uri}/ObjectiveController/calibrateObjective"
+        params = {}
+        if homeDirection is not None:
+            params['homeDirection'] = homeDirection
+        if homePolarity is not None:
+            params['homePolarity'] = homePolarity
+        response = self.parent.get_json(url, payload=params)
+        return response
+
+    def getCurrentObjective(self):
+        url = f"{self.parent.base_uri}/ObjectiveController/getCurrentObjective"
+        response = self.parent.get_json(url)
+        return response
+
+    def getStatus(self):
+        url = f"{self.parent.base_uri}/ObjectiveController/getstatus"
+        response = self.parent.get_json(url)
+        return response
+
+    def moveToObjective(self, slot):
+        url = f"{self.parent.base_uri}/ObjectiveController/moveToObjective"
+        payload = {"slot": slot}
+        response = self.parent.get_json(url, payload=payload)
+        return response
+
+    def setPositions(self, x1=None, x2=None, z1=None, z2=None, isBlocking=False):
+        url = f"{self.parent.base_uri}/ObjectiveController/setPositions"
+        payload = {}
+        if x1 is not None:
+            payload["x1"] = x1
+        if x2 is not None:
+            payload["x2"] = x2
+        if z1 is not None:
+            payload["z1"] = z1
+        if z2 is not None:
+            payload["z2"] = z2
+        payload["isBlocking"] = isBlocking
+        response = self.parent.get_json(url, payload=payload)
+        return response

{imswitchclient-0.1.2 → imswitchclient-0.1.4}/imswitchclient/positionersManager.py

@@ -3,6 +3,7 @@ class positionersManager(object):
     
     def __init__(self, parent):
         self.parent = parent
+        self.allStageNames = self.getAllDeviceNames()
         
     def getAllDeviceNames(self):
         url = f"{self.parent.base_uri}/PositionerController/getPositionerNames"
@@ -10,10 +11,26 @@ class positionersManager(object):
 
         response = self.parent.get_json(url, headers=headers)
         return response
-    
+
+    def stop(self, positioner_name, axis):
+        if positioner_name is None:
+            positioner_name = self.allStageNames[0]
+        
+        url = f"{self.parent.base_uri}/PositionerController/stop"
+        payload = {
+            'positionerName': positioner_name,
+            'axis': axis
+        }
+        response = self.parent.get_json(url, payload=payload)
+        return response           
+
     def movePositionerForever(self, speed=(0, 0, 0, 0), is_stop=False):
+        if positioner_name is None:
+            positioner_name = self.allStageNames[0]
+        
         url = f"{self.parent.base_uri}/PositionerController/movePositionerForever"
         payload = {
+            'positionerName': positioner_name,
             'speed': speed,
             'isStop': is_stop
         }
@@ -21,6 +38,9 @@ class positionersManager(object):
         return response       
             
     def setPositionerSpeed(self, positioner_name, axis, speed):
+        if positioner_name is None:
+            positioner_name = self.allStageNames[0]
+        
         url = f"{self.parent.base_uri}/PositionerController/setPositionerSpeed"
         payload = {
             'positionerName': positioner_name,
@@ -31,6 +51,9 @@ class positionersManager(object):
         return response
         
     def movePositioner(self, positioner_name, axis, dist, is_absolute=True, is_blocking=True, speed=10000):
+        if positioner_name is None:
+            positioner_name = self.allStageNames[0]
+
         url = f"{self.parent.base_uri}/PositionerController/movePositioner"
         payload = {
             'positionerName': positioner_name,
@@ -45,9 +68,24 @@ class positionersManager(object):
         response = self.parent.get_json(url, payload=payload)
         return response
 
-    def getPositionerPositions(self):
+    def getPositionerPositions(self, id=None):       
         url = f"{self.parent.base_uri}/PositionerController/getPositionerPositions"
         payload = {
         }
         response = self.parent.get_json(url, payload=payload)
+        if type(id) == int:
+            return response[id]
+        return response
+    
+    def homeAxis(self, positioner_name, axis, is_blocking=False):
+        url = f"{self.parent.base_uri}/PositionerController/homeAxis"        
+        if positioner_name is None:
+            positioner_name = self.allStageNames[0]
+            
+        payload = {
+            'positionerName': positioner_name,
+            'axis': axis, 
+            'isBlocking': is_blocking
+        }
+        response = self.parent.get_json(url, payload=payload)
         return response