forked from davidmashburn/SeedWaterSegmenter
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMARKDOWN_README
181 lines (112 loc) · 6.79 KB
/
MARKDOWN_README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
SeedWater Segmenter
===================
Seedwater Segmenter (SWS) is a graphical Python program to interactively segment
image stacks of cells in tissue with edge-labels (aka. white outlines).
The interactions are entirely based on the editing of seeds,
which in turn are expanded by a watershed algorithm.
The major difference between SWS and other tools is that you can place more than one seed per cell,
which can help you adjust the boundaries of difficult cells.
SWS is built on top of wxPython, matplotlib, numpy, scipy, PIL, and mahotas.
At its core, it uses a lightning-fast watershed algorithm (thanks to the mahotas project) and allows real-time updates.
It has a simple (if cluttered) UI and is fully interactive, even including 1-level undo.
The publication about SWS that gives all these details and more in Cytometry Part A:
http://onlinelibrary.wiley.com/doi/10.1002/cyto.a.22034/abstract
Source code is mirrored to four repositories and to PyPI:
- GitHub: http://github.com/davidmashburn/SeedWaterSegmenter/
- Bitbucket: http://bitbucket.org/davidmashburn/seedwatersegmenter
- Gitorious: http://gitorious.org/seedwatersegmenter
- Google Code: http://code.google.com/p/seedwater/
- PyPI: http://pypi.python.org/pypi/SeedWaterSegmenter
You may also want to read the manual, but be aware that it needs updating: "SeedWaterSegmenter V x.x Manual.txt"
* * * * *
Installing and Running
----------------------
SeedWater is now pure-python. In fact, with just python and setuptools installed, you could install it with just::
easy_install SeedWaterSegmenter
The big caveat to this is that SeedWater also depends on a number of binary/compiled dependencies which must be installed separately, the trickiest usually being mahotas.
It also depends on the standard scientific python packages (like numpy, scipy, matplotlib, PIL, etc), so those must also be installed.
Pretty much any method of obtaining those should work.
In short, you will need to install all of these dependencies either with binary installers, package managers, or by compiling from source.
Many great Python Distributions exist for installing Python and most of these dependencies all at once.
My current favorite is Anaconda which is free and works on both Windows and Mac.
One other important point is that SeedWater does NOT run on Python 3.x at this time, because not all of these dependencies have been ported over.
For the near future, please use Python 2.7 only.
### Windows:
#### Download and install Anaconda Python Distribution:
http://continuum.io/downloads
Download either 32 or 64 bit (to match your version of Windows).
Double-click on the downloaded file and install it.
I *highly* recommend doing a single-user (non-system-wide) install to save headaches with permissions.
#### Install wxPython and SeedWater Segmenter:
Now, from the Start Menu (aka, the Windows Button) select the Anaconda Command Prompt inside the Anaconda folder.
Here, run these two commands (and you may need to disable your antivirus before proceeding):
conda install wxpython
pip install SeedWaterSegmenter
#### Run SeedWater:
Now, from this same Anaconda command prompt, you can run SeedWater with the following command:
python -m SeedWaterSegmenter.SeedWaterSegmenter
#### Make a desktop launcher (with an icon):
To make running SeedWater easier, you can install a desktop shortcut with the included script.
Just run one of these two command from the Anaconda Command Prompt
(depending on whether you did a single-user or system-wide install):
python C:\Users\<your username>\Anaconda\Scripts\create_sws_shortcut.py -install
python C:\Anaconda\Scripts\create_sws_shortcut.py -install
That's it!
### Mac OS X:
#### Obtain a C compiler:
Download XCode from the Mac App Store or from https://developer.apple.com/xcode/
Install it and run it.
To get gcc, you must install command line tools, a package for XCode.
You can access this from: XCode menu \> Preferences \> Downloads.
Check "command line tools" and install.
Reboot your system to make sure everything is loaded.
#### Download and install Anaconda Python Distribution:
http://continuum.io/downloads
Download either the bash installer or the GUI installer.
To run the bash installer, download the file to the Downloads folder and run this command in the Terminal:
cd ~/Downloads
bash Anaconda*.sh
If you used the "pkg" download, just double-click it to install.
In either case, you can then choose either a single-user of system-wide install.
#### Install wxPython:
Now, open a NEW Terminal window, and run this command to install wxPython:
conda install wxpython
This failed for me on Mac OS X Snow Leopard, so I had to download this file
(http://repo.continuum.io/pkgs/free/osx-64/wxpython-3.0-py27_0.tar.bz2)
to the Downloads folder, and then run these commands:
cd ~/Downloads
conda install wxpython-3.0-py27_0.tar.bz2
#### Install SeedWater Segmenter:
In the Terminal, run the following:
pip install SeedWaterSegmenter
#### Run SeedWater:
Now you can run SeedWater with the following command, noting that you HAVE to use "pythonw" and not just "python":
pythonw -m SeedWaterSegmenter.SeedWaterSegmenter
#### Download the App:
Now also, thanks to Sveinbjorn Thordarson's Platypus tool, a packaged app is available for download:
https://github.com/davidmashburn/SeedWaterSegmenter/blob/master/MacOSX/SeedWaterSegmenterApp.zip
Just extract the zip file and place the App on the Desktop or in the Applications folder.
Be aware that this is only a link to the python scripts and will not work by itself without the above installation.
(There is also a ".command" file that can serve the same purpose if the App does not work at
https://github.com/davidmashburn/SeedWaterSegmenter/blob/master/MacOSX/SeedWaterSegementer.command)
That's it!
### Ubuntu/Debian:
#### Install:
Run these two commands in the terminal:
sudo apt-get install python-setuptools python-wxtools python-numpy python-scipy python-matplotlib python-imaging python-xlrd python-xlwt
sudo easy_install -U SeedWaterSegmenter
#### Run SeedWater:
In the terminal, run:
python2.7 -m SeedWaterSegmenter.SeedWaterSegmenter
(just "python" may also work, depending on your system)
#### Make a desktop launcher:
Look at this to get you started:
https://github.com/davidmashburn/SeedWaterSegmenter/blob/master/desktop/SeedWaterSegmenter.desktop
This is how I created the symlinks that make this work:
ln -s /usr/local/lib/python2.7/dist-packages/SeedWaterSegmenter*/seedwatersegmenter/SeedWaterSegmenter.py /usr/local/bin/seedwatersegmenter
ln -s /usr/local/lib/python2.7/dist-packages/SeedWaterSegmenter*/seedwatersegmenter/icons/SeedWaterSegmenter.svg /usr/local/share/pixmaps/SeedWaterSegmenter.svg
That's it!
* * * * *
Screenshot
----------
