omero-integration

OMERO Integration - Microscopy Image Data Management Python API

Skills Overview

OMERO Integration provides a complete interface to access and manage the OMERO microscopy image platform through the Python API. It supports image retrieval, pixel data analysis, ROI management, batch processing, and high-content screening workflows.

Use Cases

Centralized Microscopy Data Management: When research teams need to centrally manage microscopy image data, they can use Python interfaces to access the OMERO server’s project, dataset, and image hierarchy, enabling centralized storage and collaboration.

Image Analysis and Processing Workflows: When batch processing microscopy images is required—extracting pixel data for computational analysis, creating and managing ROI regions for quantitative measurements, and storing analysis results back into the OMERO database.

High-Content Screening Automation: When performing large-scale microscopy screening experiments, the OMERO Python API can automatically access screening data (Screen > Plate > Well), batch process images, generate statistical tables, and automate the analysis pipeline.

Core Features

Connection and Session Management: Provides a secure Python interface to connect to the OMERO server, supporting authenticated login, session management, and user group switching. Uses a context manager to automatically manage the connection lifecycle, ensuring resources are released properly.

Data Access and Retrieval: Supports navigating OMERO’s hierarchical data structures (Project > Dataset > Image) and screening data structures (Screen > Plate > Well). Enables querying objects by ID, attributes, or conditions to obtain image metadata and pixel information.

Image Processing and ROI Analysis: Can export pixel data to NumPy arrays for computational analysis, modify channel rendering settings to generate projection images, create multiple geometric-shaped ROI regions and extract intensity statistics, and store measurement results as OMERO tables or file annotations.

Frequently Asked Questions

What environment configuration does the OMERO Python API require?

To use OMERO Integration, install a Python 3.7+ environment and install dependencies with uv pip install omero-py. The system requires Zeroc Ice 3.6+ support. At runtime, configure the OMERO server connection parameters: OMERO_HOST (server hostname, required), OMERO_PORT (port, default 4064), OMERO_USER and OMERO_PASSWORD (user credentials, required). It is recommended to use a context manager mode to ensure the connection is closed correctly.

How to batch export microscopy images from OMERO?

After establishing a connection via BlitzGateway, use conn.getObjects("Image", opts={'dataset': dataset_id}) to retrieve the list of images by dataset, or use conn.listProjects() to traverse the project hierarchy. For each image object, call getPrimaryPixels().getData() to obtain pixel data and save it to a file. For large-scale exports, it is recommended to use OMERO server-side scripts to avoid network transfer bottlenecks, and to implement progress tracking and error handling in the script.

What is the difference between OMERO tables and file annotations?

OMERO tables are suitable for storing structured measurement data. They support multiple column types (integers, floats, strings, booleans) and can be associated with images or datasets, making it easier for later querying and statistical analysis. File annotations are used to store arbitrary file formats (e.g., analysis result charts, processing logs, derived images) and are better suited for unstructured outputs. Suggested selection: use tables for quantitative measurement data, and file annotations for charts and reports. Both can be used together to fully record the analysis workflow.