Visitar URL original
BioRxiv link, fix to relative path in GUIs · mathang/DeepLabCut@c5c5d97 · GitHub
Skip to content

Commit c5c5d97

Browse files
committed
BioRxiv link, fix to relative path in GUIs
1 parent 751255c commit c5c5d97

15 files changed

Lines changed: 58 additions & 23 deletions

‎README.md‎

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ This package includes graphical user interfaces to label your data, and take you
1313
VERSION 1.0: The initial, Nature Neuroscience version of **DeepLabCut** can be found in the history of git, or the latest version here: https://github.com/AlexEMG/DeepLabCut/releases/tag/1.11
1414

1515
<p align="center">
16-
<img src="docs/images/MATHIS_2018_odortrail.gif" width="36.4%">
17-
<img src="docs/images/rat-grasp.gif" width="24.95%">
18-
<img src="docs/images/MATHIS_2018_fly.gif" width="31.5%">
16+
<img src="http://www.people.fas.harvard.edu/~amathis/dlc/MATHIS_2018_odortrail.gif" height="220">
17+
<img src="docs/images/rat-grasp.gif" width="24.89%">
18+
<img src="http://www.people.fas.harvard.edu/~amathis/dlc/MATHIS_2018_fly.gif" height="220">
1919
</p>
2020

2121
Please check out [www.mousemotorlab.org/deeplabcut](https://www.mousemotorlab.org/deeplabcut/) for more video demonstrations of automated tracking. Above: courtesy of the Murthy (mouse), Leventhal (rat), and Axel (fly) labs!
@@ -29,10 +29,11 @@ Please check out [www.mousemotorlab.org/deeplabcut](https://www.mousemotorlab.or
2929
</p>
3030

3131
# [DEMO the code](/examples)
32-
We provide several Jupyter Notebooks: one that walks you through a demo dataset to test your installation, and another Notebook to run DeepLabCut from the begining on your own data. We also show you how to use the code in Docker, and on Google Colab.
32+
We provide several Jupyter Notebooks: one that walks you through a demo dataset to test your installation, and another Notebook to run DeepLabCut from the begining on your own data. We also show you how to use the code in Docker, and on Google Colab. Please also read the [user-guide](https://www.biorxiv.org/content/early/2018/10/30/457242).
3333

3434
# News (and in the news):
3535

36+
- Nov 2018: We posted a detailed guide for DeepLabCut 2.0 on [BioRxiv](https://www.biorxiv.org/content/early/2018/10/30/457242). It also contains a case study for 3D pose estimation in cheetahs.
3637
- Nov 2018: Various (post-hoc) analysis scripts contributed by users (and us) will be gathered at [DLCutils](https://github.com/AlexEMG/DLCutils). Feel free to contribute! In particular, there is a script guiding you through
3738
importing a project into the new data format for DLC 2.0
3839
- Oct 2018: new pre-print on the speed video-compression and robustness of DeepLabCut on [BioRxiv](https://www.biorxiv.org/content/early/2018/10/30/457242)
@@ -49,20 +50,23 @@ importing a project into the new data format for DLC 2.0
4950

5051
- Top Right: Video anlysis is fast (see [Mathis/Warren](https://www.biorxiv.org/content/early/2018/10/30/457242) for details)
5152

52-
- Bottom Left: The feature detectors are robust to video compression (see [Mathis/Warren](https://www.biorxiv.org/content/early/2018/10/30/457242) for details)
53+
- Mid Left: The feature detectors are robust to video compression (see [Mathis/Warren](https://www.biorxiv.org/content/early/2018/10/30/457242) for details)
5354

54-
- Bottom Right: It allows 3D pose estimation with a single network and camera (see [Mathis/Warren](https://www.biorxiv.org/content/early/2018/10/30/457242) for details)
55+
- Mid Right: It allows 3D pose estimation with a single network and camera (see [Mathis/Warren](https://www.biorxiv.org/content/early/2018/10/30/457242) for details)
56+
57+
- Bottom: It allows 3D pose estimation with a single network trained on data from multple cameras together with standard triangulation methods (see [Nath* and Mathis* et al.](https://www.biorxiv.org/content/early/2018/11/24/476531) for details)
5558

5659
<p align="center">
5760
<img src="docs/images/ErrorvsTrainingsetSize.png" width="50%">
5861
<img src="docs/images/inferencespeed.png" width="30%">
5962
<img src="docs/images/compressionrobustness.png" width="40%">
60-
<img src="docs/images/MouseLocomotion_warren.gif" width="30%">
63+
<img src="docs/images/MouseLocomotion_warren.gif" width="30%">
64+
<img src="docs/images/cheetah.jpg" width="75%">
6165
</p>
6266

6367
## Code contributors:
6468

65-
[Alexander Mathis](https://github.com/AlexEMG), [Tanmay Nath](http://www.mousemotorlab.org/team), [Mackenzie Mathis](https://github.com/MMathisLab), and especially the authors of DeeperCut authors for the feature detector code. The feature detector code is based on Eldar Insafutdinov's TensorFlow implementation of [DeeperCut](https://github.com/eldar/pose-tensorflow). DeepLabCut is an open-source tool and has benefited from suggestions and edits by many individuals including Richard Warren, Ronny Eichler, Jonas Rauber, Hao Wu, Taiga Abe, and Jonny Saunders. In particular, the authors thank Ronny Eichler for input on the modularized version. We are also grateful to all the beta testers!
69+
[Alexander Mathis](https://github.com/AlexEMG), [Tanmay Nath](http://www.mousemotorlab.org/team), [Mackenzie Mathis](https://github.com/MMathisLab), and especially the authors of DeeperCut authors for the feature detector code. The feature detector code is based on Eldar Insafutdinov's TensorFlow implementation of [DeeperCut](https://github.com/eldar/pose-tensorflow). DeepLabCut is an open-source tool and has benefited from suggestions and edits by many individuals including Richard Warren, Ronny Eichler, Jonas Rauber, Hao Wu, Federico Claudi, Taiga Abe, and Jonny Saunders as well as the [contributors](https://github.com/AlexEMG/DeepLabCut/graphs/contributors). In particular, the authors thank Ronny Eichler for input on the modularized version. We are also grateful to all the beta testers!
6670

6771
This is an actively developed package and we welcome community development and involvement! If you would like to join the [DeepLabCut Slack group](https://deeplabcut.slack.com), please drop us a note to be invited by emailing: mackenzie@post.harvard.edu
6872

@@ -85,7 +89,7 @@ Please check out the following references for more details:
8589
url = {http://arxiv.org/abs/1605.03170}
8690
}
8791

88-
Our open source pre-prints:
92+
Our open-access pre-prints:
8993

9094
@article{mathis2018markerless,
9195
title={Markerless tracking of user-defined features with deep learning},
@@ -94,6 +98,17 @@ Our open source pre-prints:
9498
year={2018}
9599
}
96100

101+
@article {NathMathis2018,
102+
author = {Nath*, Tanmay and Mathis*, Alexander and Chen, An Chi and Patel, Amir and Bethge, Matthias and Mathis, Mackenzie W},
103+
title = {Using DeepLabCut for 3D markerless pose estimation across species and behaviors},
104+
year = {2018},
105+
doi = {10.1101/476531},
106+
publisher = {Cold Spring Harbor Laboratory},
107+
URL = {https://www.biorxiv.org/content/early/2018/11/24/476531},
108+
eprint = {https://www.biorxiv.org/content/early/2018/11/24/476531.full.pdf},
109+
journal = {bioRxiv}
110+
}
111+
97112
@article {MathisWarren2018speed,
98113
author = {Mathis, Alexander and Warren, Richard A.},
99114
title = {On the inference speed and video-compression robustness of DeepLabCut},

‎deeplabcut/generate_training_dataset/labeling_toolbox.py‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,6 @@ def __init__(self, parent, config,Screens,scale_w,scale_h, winHack, img_scale):
5656

5757
wx.Frame.__init__(self, None, title="DeepLabCut2.0 - Labeling GUI", size=(self.gui_width*winHack, self.gui_height*winHack), style= wx.DEFAULT_FRAME_STYLE)
5858

59-
60-
61-
6259
self.statusbar = self.CreateStatusBar()
6360
self.statusbar.SetStatusText("")
6461
self.Bind(wx.EVT_CHAR_HOOK, self.OnKeyPressed)
@@ -230,7 +227,9 @@ def browseDir(self, event):
230227
self.index = glob.glob(os.path.join(self.dir,'*.png'))
231228
print('Working on folder: {}'.format(os.path.split(str(self.dir))[-1]))
232229

233-
self.relativeimagenames=self.index ##[n.split(self.project_path+'/')[1] for n in self.index]
230+
#self.relativeimagenames=self.index ##[n.split(self.project_path+'/')[1] for n in self.index]
231+
#self.relativeimagenames=[n.split(self.project_path+'/')[1] for n in self.index]
232+
self.relativeimagenames=['labeled'+n.split('labeled')[1] for n in self.index]
234233

235234
self.fig1, (self.ax1f1) = plt.subplots(figsize=self.img_size,facecolor = "None")
236235
self.iter = 0
@@ -342,7 +341,6 @@ def saveEachImage(self):
342341
plt.close(self.fig1)
343342

344343
for idx, bp in enumerate(self.updatedCoords):
345-
346344
self.dataFrame.loc[self.relativeimagenames[self.iter]][self.scorer, bp[0][-2],'x' ] = bp[-1][0]
347345
self.dataFrame.loc[self.relativeimagenames[self.iter]][self.scorer, bp[0][-2],'y' ] = bp[-1][1]
348346

‎deeplabcut/refine_training_dataset/refinement.py‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -458,7 +458,18 @@ def save(self, event):
458458
if Path(self.dir,'CollectedData_'+self.humanscorer+'.h5').is_file():
459459
print("A training dataset file is already found for this video. The refined machine labels are merged to this data!")
460460
DataU1 = pd.read_hdf(os.path.join(self.dir,'CollectedData_'+self.humanscorer+'.h5'), 'df_with_missing')
461-
DataCombined = pd.concat([DataU1, self.Dataframe])
461+
#combine datasets Original Col. + corrected machinefiles:
462+
DataCombined = pd.concat([self.Dataframe,DataU1])
463+
# Now drop redundant ones keeping the first one [this will make sure that the refined machine file gets preference]
464+
DataCombined = DataCombined[~DataCombined.index.duplicated(keep='first')]
465+
'''
466+
if len(self.droppedframes)>0: #i.e. frames were dropped/corrupt. also remove them from original file (if they exist!)
467+
for fn in self.droppedframes:
468+
try:
469+
DataCombined.drop(fn,inplace=True)
470+
except KeyError:
471+
pass
472+
'''
462473
DataCombined.to_hdf(os.path.join(self.dir,'CollectedData_'+ self.humanscorer +'.h5'), key='df_with_missing', mode='w')
463474
DataCombined.to_csv(os.path.join(self.dir,'CollectedData_'+ self.humanscorer +'.csv'))
464475
else:

‎deeplabcut/version.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@
77
88
"""
99

10-
__version__ = '2.0.0'
10+
__version__ = '2.0.1'
1111
VERSION = __version__

‎docs/UseOverviewGuide.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ TIP: for every function there is a associated help document that can be viewed b
4444
**mini-demo:** create project and edit the yaml file
4545

4646
<p align="center">
47-
<img src="/docs/images/startdeeplabcut.gif" width="90%">
47+
<img src="http://www.people.fas.harvard.edu/~amathis/dlc/startdeeplabcut.gif" width="90%">
4848
</p>
4949

5050
### Select Frames to Label:
@@ -62,7 +62,7 @@ TIP: for every function there is a associated help document that can be viewed b
6262
**mini-demo:** using the GUI to label
6363

6464
<p align="center">
65-
<img src="/docs/images/guiexample.gif" width="90%">
65+
<img src="http://www.people.fas.harvard.edu/~amathis/dlc/guiexample.gif" width="90%">
6666
</p>
6767

6868
### Check Annotated Frames:
@@ -113,7 +113,7 @@ TIP: for every function there is a associated help document that can be viewed b
113113
**mini-demo:** using the refinement GUI, a user can load the file then zoom, pan, and edit and/or remove points:
114114

115115
<p align="center">
116-
<img src="/docs/images/refinelabels.gif" width="90%">
116+
<img src="http://www.people.fas.harvard.edu/~amathis/dlc/refinelabels.gif" width="90%">
117117
</p>
118118

119119
When done editing the labels, merge:
@@ -132,3 +132,6 @@ In ipython/Jupyter notebook:
132132
In Python:
133133

134134
``help(deeplabcut.nameofthefunction)``
135+
136+
137+
Return to [readme](../README.md).

‎docs/functionDetails.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -381,3 +381,8 @@ labeled data. The example project, named as Reaching-Mackenzie-2018-08-30 consis
381381
with default parameters and 20 images, which are cropped around the region of interest as an example dataset. These
382382
images are extracted from a video, which was recorded in a study of skilled motor control in mice. Some example
383383
labels for these images are also provided. See more details [here](/examples).
384+
385+
386+
Return to [User guide overview](UseOverviewGuide.md).
387+
388+
Return to [readme](../README.md).

‎docs/images/MATHIS_2018_fly.gif‎

-4.24 MB
Binary file not shown.
-1.08 MB
Binary file not shown.

‎docs/images/cheetah.jpg‎

157 KB
Loading

‎docs/images/guiexample.gif‎

-659 KB
Binary file not shown.

0 commit comments

Comments
 (0)