Metadata-Version: 2.1
Name: wormpose
Version: 1.3.0
Summary: WormPose: Image synthesis and convolutional networks for pose estimation in C. elegans
Home-page: https://iteal.github.io/wormpose/
Author: "Laetitia M Hebert, Antonio C Costa"
Author-email: laetitia.m.hebert@gmail.com
License: BSD 3-Clause License
Project-URL: Documentation, https://iteal.github.io/wormpose/documentation.html
Project-URL: Twitter, https://twitter.com/wormpose
Project-URL: GitHub, https://github.com/iteal/wormpose
Project-URL: Bug-Tracker, https://github.com/iteal/wormpose/issues
Keywords: animal pose estimation,c. elegans
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Image Recognition
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: opencv-python
Requires-Dist: tensorflow (>=2)
Requires-Dist: numpy
Requires-Dist: h5py
Requires-Dist: scipy

![](https://i.imgur.com/hcOUEif.png)

[![PyPI status](https://img.shields.io/pypi/status/wormpose.svg)](https://pypi.python.org/pypi/wormpose/)
[![PyPI version](https://badge.fury.io/py/wormpose.svg)](https://pypi.python.org/pypi/wormpose/)
[![Build Status](https://travis-ci.com/iteal/wormpose.svg?branch=main)](https://travis-ci.com/iteal/wormpose)
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/wormpose.svg)](https://pypi.python.org/pypi/wormpose/)
[![Maintainability](https://img.shields.io/codeclimate/maintainability/iteal/wormpose)](https://codeclimate.com/github/iteal/wormpose/maintainability)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

![](https://i.imgur.com/l76dxbM.gif)
![](https://i.imgur.com/4b8zz68.gif)
![](https://i.imgur.com/e4oox2p.gif)

<sub>Results videos adapted from [Open Worm Movement Database](http://movement.openworm.org/) license [CC 4.0](https://creativecommons.org/licenses/by/4.0/legalcode) </sub>


## Overview

The WormPose package estimates the challenging poses of C. elegans in videos including coils and overlaps. 

We train a convolutional neural network with synthetic worm images so that there is no need for human annotated labels. 

## Get started quickly
[Try the tutorial notebook](https://github.com/iteal/wormpose/blob/main/examples/tutorial_sample_data.ipynb)   <a href="https://colab.research.google.com/github/iteal/wormpose/blob/main/examples/tutorial_sample_data.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>

This notebook goes over the whole WormPose pipeline with some sample data and an already trained model. You can run it in Google Colab.

## Read the documentation
Check the [Documentation website](https://iteal.github.io/wormpose/index.html) for detailed instructions.

## Read the paper
[WormPose: Image synthesis and convolutional networks for pose estimation in C. elegans](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1008914)  
Hebert L, Ahamed T, Costa AC, Oâ€™Shaughnessy L, Stephens GJ (2021) WormPose: Image synthesis and convolutional networks for pose estimation in C. elegans. PLOS Computational Biology 17(4): e1008914. https://doi.org/10.1371/journal.pcbi.1008914

## Manuscript data 
Manuscript data is available here: https://wormpose.unit.oist.jp.


