Skip to main content

TODO

Project description

in silico fate mapping

License BSD-3 PyPI Python Version tests codecov napari hub

Interactive in silico fate mapping from tracking data.

This napari plugin estimates the cell fates from tracking data by building a radial regression model per time point. The user can select an area of interest using a Points layer; the algorithm will advent the probed coordinates forward (or backward) in time, showing the estimated fate.

Video example below:

https://user-images.githubusercontent.com/21022743/216478216-89c1c35f-2ce4-44e8-adb8-9aeea75b5833.mp4

Installation

You can install in-silico-fate-mapping via pip:

pip install in-silico-fate-mapping

To install the latest development version :

pip install git+https://github.com/royerlab/in-silico-fate-mapping.git

IO file format

This plugin does not depend on a specific file format, the only requirement is using a Track layer from napari.

Despite this, we ship a reader and writer interface. It supports .csv files with the following reader TrackID, t, (z), y, x, z is optional. Such that each tracklet has a unique TrackID and it's composed of a sequence o time and spatial coordinates.

This is extremely similar to how napari store tracks, more information can be found here.

Divisions are not supported at the moment.

Usage Example

Minimal example

Minimal example using a track file following the convention described above.

import napari
import pandas as pd
from in_silico_fate_mapping.fate_mapping import FateMapping

tracks = pd.read_csv("tracks.csv")

fate_map = FateMapping(radius=5, n_samples=25, bind_to_existing=False, sigma=1)
fate_map.data = tracks[["TrackID", "t", "z", "y", "x"]]

source = tracks[tracks["t"] == 0].sample(n=1)

tracks = fate_map(source[["t", "z", "y", "x"]])

napari.view_tracks(tracks)
napari.run()

Zebrahub example

Zebrafish embryo tail example. This example requires the package napari-ome-zarr.

import napari
import pandas as pd
from in_silico_fate_mapping import FateMappingWidget

image_path = "http://public.czbiohub.org/royerlab/zebrahub/imaging/single-objective/ZSNS001_tail.ome.zarr"
tracks_path = "http://public.czbiohub.org/royerlab/zebrahub/imaging/single-objective/ZSNS001_tail_tracks.csv"

viewer = napari.Viewer()
viewer.window.add_dock_widget(FateMappingWidget(viewer))

viewer.open(image_path, plugin="napari-ome-zarr")

tracks = pd.read_csv(tracks_path)
viewer.add_tracks(tracks[["TrackID", "t", "z", "y", "x"]])
viewer.add_points(name="Markers")

napari.run()

Citing

If used please cite:

@article{lange2023zebrahub,
  title={Zebrahub-Multimodal Zebrafish Developmental Atlas Reveals the State Transition Dynamics of Late Vertebrate Pluripotent Axial Progenitors},
  author={Lange, Merlin and Granados, Alejandro and VijayKumar, Shruthi and Bragantini, Jordao and Ancheta, Sarah and Santhosh, Sreejith and Borja, Michael and Kobayashi, Hirofumi and McGeever, Erin and Solak, Ahmet Can and others},
  journal={bioRxiv},
  pages={2023--03},
  year={2023},
  publisher={Cold Spring Harbor Laboratory}
}

Issues

If you encounter any problems, please file an issue along with a detailed description.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

in-silico-fate-mapping-0.1.1.tar.gz (24.0 kB view details)

Uploaded Source

Built Distribution

in_silico_fate_mapping-0.1.1-py3-none-any.whl (22.6 kB view details)

Uploaded Python 3

File details

Details for the file in-silico-fate-mapping-0.1.1.tar.gz.

File metadata

File hashes

Hashes for in-silico-fate-mapping-0.1.1.tar.gz
Algorithm Hash digest
SHA256 80e678fb438a05520327621b688c28bc98c38a4c5bcb3bb91db3e17a9a1679fd
MD5 278718c1a0252bd431600e7ea6f49313
BLAKE2b-256 9877e2bb134fa0b40bbf5e348647714323a2bb06311513c1ed2c51b3d962add2

See more details on using hashes here.

File details

Details for the file in_silico_fate_mapping-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for in_silico_fate_mapping-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2913a4bb9f1f5efb9ee6524c7b560a7103ab1e7fda2a05b7a497740e01a18bdf
MD5 064dc00d1ba056c46ee0345da9c0727f
BLAKE2b-256 d8003d13a14d2a720b68cba8951e1d34629ba9ce7d54a9029fe3ba738af768e1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page