Skip to main content

aicssegmentation

Build Status Documentation Code Coverage

Part 1 of Allen Cell and Structure Segmenter


This repository only has the code for the "Classic Image Segmentation Workflow" of Segmenter. The deep learning part can be found at https://github.com/AllenCell/aics-ml-segmentation

We welcome feedback and submission of issues. Users are encouraged to sign up on our Allen Cell Discussion Forum for quesitons and comments.

Installation

Our package is implemented in Python 3.7. Detailed instructions as below:

Installation on Linux (Ubuntu 16.04.5 LTS is the OS we used for development)

Installation on MacOS

Installation on Windows

Use the package

Our package is designed (1) to provide a simple tool for cell biologists to quickly obtain intracellular structure segmentation with reasonable accuracy and robustness over a large set of images, and (2) to facilitate advanced development and implementation of more sophisticated algorithms in a unified environment by more experienced programmers.

Visualization is a key component in algorithm development and validation of results (qualitatively). Right now, our toolkit utilizes itk-jupyter-widgets, which is a very powerful visualization tool, primarily for medical data, which can be used in-line in Jupyter notebooks. Some cool demo videos can be found here.

Part 1: Quick Start

After following the installation instructions above, users will find that the classic image segmentation workflow in the toolkit is:

  1. formulated as a simple 3-step workflow for solving 3D intracellular structure segmentation problem using restricted number of selectable algorithms and tunable parameters
  2. accompanied by a "lookup table" with 20+ representative structure localization patterns and their results as a reference, as well as the Jupyter notebook for these workflows as a starting point.

Typically, we use Jupyter notebook as a "playground" to explore different algorithms and adjust the parameters. After determining the algorithms and parameters, we use Python scritps to do batch processing/validation on a large number of data.

You can find a DEMO on a real example on our tutorial page

Part 2: API

The list of high-level wrappers/functions used in the package can be found at AllenCell.github.io/aics-segmentation.

Object Identification: Bridging the gap between binary image (segmentation) and analysis

The current version of the Allen Cell Segmenter is primarily focusing on converting fluorescent images into binary images, i.e., the mask of the target structures separated from the background (a.k.a segmentation). But, the binary images themselves are not always useful, with perhaps the exception of visualization of the entire image, until they are converted into statistically sound numbers that are then used for downstream analysis. Often the desired numbers do not refer to all masked voxels in an entire image but instead to specific "objects" or groups of objects within the image. In our python package, we provide functions to bridge the gap between binary segmentation and downstream analysis via object identification.

What is object identification?

See a real demo in jupyter notebook to learn how to use the object identification functions

Citing Segmenter

If you find our segmenter useful in your research, please cite our bioRxiv paper:

J. Chen, L. Ding, M.P. Viana, M.C. Hendershott, R. Yang, I.A. Mueller, S.M. Rafelski. The Allen Cell Structure Segmenter: a new open source toolkit for segmenting 3D intracellular structures in fluorescence microscopy images. bioRxiv. 2018 Jan 1:491035.

Development

See CONTRIBUTING.md for information related to developing the code.

Free software: Allen Institute Software License

Metadata

Release files for aicssegmentation 0.5.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aicssegmentation 0.5.3
File Size Uploaded
aicssegmentation-0.5.3.tar.gz 5.8 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for aicssegmentation 0.5.3
File Interpreter ABI Platform
aicssegmentation-0.5.3-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 11.0 MB

Release files / aicssegmentation-0.5.3.tar.gz

Download URL aicssegmentation-0.5.3.tar.gz
Size 5.8 MB
Tags Source
SHA-256 checksum
How to use checksums
b9d7a8f4a84177e776653248bd5343e37856d5bbeba75d3fdf34774bc586c318
BLAKE2b-256 checksum
How to use checksums
850f7c9a68fd2ad64bc4a762ed6e11f11759cf12e4bd562a59c69b9d8ccd6925
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.17

Release files / aicssegmentation-0.5.3-py2.py3-none-any.whl

Download URL aicssegmentation-0.5.3-py2.py3-none-any.whl
Size 5.2 MB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
d021ca68e915db6224befe01ed449af972148710128f85659f539d112d0244f4
BLAKE2b-256 checksum
How to use checksums
12234ea5b972cf3ba156b1c2e5b7bec6ce178d8e4bb0273e304bdf9389f8374e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.17

Release history Release notifications | RSS feed

This release

0.5.3 This release

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.22

2 release files

0.1.21

2 release files

0.1.20

1 release file

0.1.19

1 release file

0.1.18

1 release file

0.1.17

1 release file

0.1.16

1 release file

0.1.15

1 release file

0.1.14

1 release file

0.1.13

1 release file

0.1.12

1 release file

0.1.11

1 release file

0.1.10

1 release file

0.1.9

1 release file

0.1.8

1 release file

0.1.7

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page