imswitchclient

ImSwitchClient Documentation

ImSwitchClient is a Python package designed to connect to the ImSwitch REST API, enabling remote control of ImSwitchUC2 functionalities directly from Jupyter Notebooks. This client facilitates easy integration with the ImSwitch ecosystem, offering programmable access to various features like laser control, stage manipulation, and image acquisition.

Features

• Remote Control: Interact with ImSwitchUC2 from Jupyter Notebooks via fastapi endpoints.
• Comprehensive Documentation: Access detailed documentation and explore API endpoints at https://imswitchclient.readthedocs.io.
• API Exploration: Utilize FastAPI's interface at http://localhost:8000/docs for an interactive API experience.
• Broad Functionality: Current implementations include laser control, stage manipulation, and image acquisition, with the possibility for future expansion based on user requests.
• Global API Testing: Test the client using the globally hosted API at https://youseetoo.github.io/imswitch/api.html.
• Open Source: Inspired by the OpenFlexure Client, ImSwitchClient is freely available for modification and distribution under the MIT license.
• Implemented functions (so far, please file an issue for feature requests):
  • Laser
  • Stage
  • Image Acquisition
• You can test the client with the globally hosted api here: https://youseetoo.github.io/imswitch/api.html
• It is inspired by the OpenFlexure Client: https://gitlab.com/openflexure/openflexure-microscope-pyclient/-/blob/master/openflexure_microscope_client/microscope_client.py
• The source files can be found here: https://github.com/openUC2/imswitchclient/

Installation

To install ImSwitchClient, use the following pip command:

pip install imswitchclient

Quick Start Example

This example demonstrates basic usage of ImSwitchClient for moving a positioner and acquiring an image.

import imswitchclient.ImSwitchClient as imc 
import numpy as np
import matplotlib.pyplot as plt
import time

# Initialize the client
client = imc.ImSwitchClient()

# Retrieve the first positioner's name and current position
positioner_names = client.positionersManager.getAllDeviceNames()
positioner_name = positioner_names[0]
currentPositions = client.positionersManager.getPositionerPositions()[positioner_name]
initialPosition = (currentPositions["X"], currentPositions["Y"])

# turn on illumination
mLaserName = client.lasersManager.getLaserNames()[0]
client.lasersManager.setLaserActive(mLaserName, True)
client.lasersManager.setLaserValue(mLaserName, 512)

for ix in range(10):
    for iy in range(10):
        # Define and move to a new position
        newPosition = (initialPosition[0] + ix*50, initialPosition[1] + iy*50)
        client.positionersManager.movePositioner(positioner_name, "X", newPosition[0], is_absolute=True, is_blocking=True)
        client.positionersManager.movePositioner(positioner_name, "Y", newPosition[1], is_absolute=True, is_blocking=True)
        
        # Acquire and display an image
        #time.sleep(0.5)  # Allow time for the move
        lastFrame = client.recordingManager.snapNumpyToFastAPI()
        plt.imshow(lastFrame)
        plt.show()
        
        # Return the positioner to its initial position
        client.positionersManager.movePositioner(positioner_name, "X", initialPosition[0], is_absolute=True, is_blocking=True)
        client.positionersManager.movePositioner(positioner_name, "Y", initialPosition[1], is_absolute=True, is_blocking=True)

Contributing

Contributions to ImSwitchClient are welcome! Please refer to the project's GitHub repository for contribution guidelines: https://github.com/openUC2/imswitchclient/.

License

ImSwitchClient is licensed under the MIT License. For more details, see the LICENSE file in the project repository.