跳转到主要内容

大规模多假设细胞追踪

项目描述

ULTRACK

tests codecov PyPI version Downloads Downloads Python version Licence: BSD-3 Contributors GitHub stars GitHub forks

在分割不确定性下的大规模细胞追踪。

概述

Ultrack是一种通用且可扩展的细胞追踪方法,旨在解决在2D、3D和多通道时间推移记录中追踪细胞所面临的挑战,特别是在分割通常模糊的复杂和拥挤组织中。通过评估多个候选分割并采用时间一致性,Ultrack确保在分割不确定性下的稳健性能。Ultrack的方法在此进行解释。

https://github.com/royerlab/ultrack/assets/21022743/10aace9c-0e0e-4310-a103-f846683cfc77

使用DaXi全胚胎追踪技术成像的斑马鱼。

功能

  • 通用细胞追踪:支持2D、3D和多通道数据集。
  • 分割不确定性下的鲁棒性:评估多个候选分割。
  • 高性能:从小型体外数据集扩展到千兆级发育时间推移。
  • 集成:通过SLURM与FiJi、napari和高性能集群兼容。

安装

安装或更新conda

为了避免不同包之间的冲突,我们建议使用conda创建隔离环境

conda create --name tracking -c conda-forge python=3.10 pyqt
conda activate tracking
pip install ultrack

使用

注意:每次运行此软件时,您都需要激活此环境

conda activate tracking

以下是一个基本示例,供您开始使用

import napari
from ultrack import MainConfig, Tracker

# __main__ is recommended to avoid multi-processing errors
if __name__ == "__main__":
      # Load your data
      foreground = ...
      contours = ...

      # Create config
      config = MainConfig()

      # Run tracking
      tracker = Tracker(config)
      tracker.track(foreground=foreground, edges=contours)

      # Visualize results in napari
      tracks, graph = tracker.to_tracks_layer()
      napari.view_tracks(tracks[["track_id", "t", "z", "y", "x"]], graph=graph)
      napari.run()

更多使用示例可以在此处找到,包括它们的配置文件和安装说明。

文档

全面文档可在此处找到。

以下额外的开发者文档可供使用

Gurobi设置

使用Conda安装Gurobi

在您的现有Conda环境中,使用以下命令安装Gurobi

conda install -c gurobi gurobi

获取并激活学术许可证

  1. 使用您的学术邮箱在Gurobi网站上注册。
  2. 导航到Gurobi的命名学术许可证页面
  3. 按照说明获取您的许可证密钥。
  4. 激活您的许可证,在您的Conda环境中运行
grbgetkey YOUR_LICENSE_KEY
  1. 将YOUR_LICENSE_KEY替换为您收到的密钥。按照提示完成激活。

验证安装

通过以下命令验证Gurobi的安装

ultrack check_gurobi

根据操作系统,gurobi库可能缺失,您需要从这里安装它。

谁在使用Ultrack?

以下是一些使用过和正在使用ultrack的项目和论文列表

  • DaXi项目:Ultrack被用于DaXi项目中,通过高分辨率光片显微镜跟踪斑马鱼胚胎,展示了其处理大规模数据集的效率。参见论文这里
  • Zebrahub.org项目:Ultrack在ZebraHub.org上托管的项目中用于跟踪和分析斑马鱼胚胎发育。参见预印本这里
  • 活脊椎动物中的单细胞转录动力学:Ultrack被用于分割和跟踪光片显微镜数据集中发育中的斑马鱼胚胎的细胞核。参见预印本这里

贡献

我们欢迎社区的贡献!要开始,请阅读我们的贡献指南。然后,在GitHub上报告问题和提交拉取请求。

许可证

本项目采用BSD-3许可证 - 有关详细信息,请参阅LICENSE文件。

引用

如果您在研究中使用了ultrack,请引用以下论文

@misc{bragantini2023ucmtracking,
      title={Large-Scale Multi-Hypotheses Cell Tracking Using Ultrametric Contours Maps},
      author={Jordão Bragantini and Merlin Lange and Loïc Royer},
      year={2023},
      eprint={2308.04526},
      archivePrefix={arXiv},
      primaryClass={cs.CV}
}

根据您的使用情况,包括辅助方法(例如Cellpose、napari)的引用。

致谢

我们感谢社区和特定个人的贡献。详细的致谢可以在我们的文档中找到。

项目详情


下载文件

下载适用于您平台的自定义文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分布

ultrack-0.6.0.tar.gz (157.5 kB 查看散列)

上传时间:

构建分布

ultrack-0.6.0-py3-none-any.whl (229.6 kB 查看散列)

上传时间: Python 3

支持

AWSAWS云计算和安全赞助商DatadogDatadog监控FastlyFastlyCDNGoogleGoogle下载分析MicrosoftMicrosoftPSF赞助商PingdomPingdom监控SentrySentry错误日志StatusPageStatusPage状态页面