Skip to content

Commit c221a9a

Browse files
authored
Small updates, link fixes (#106)
1 parent fe64327 commit c221a9a

11 files changed

+32
-10
lines changed

AdvancedSegmentation/BBBC022_Analysis_Final.cppipe

+1-1
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,7 @@ MeasureColocalization:[module_num:14|svn_version:'Unknown'|variable_revision_num
355355
Calculate the Rank Weighted Colocalization coefficients?:Yes
356356
Calculate the Overlap coefficients?:Yes
357357
Calculate the Manders coefficients using Costes auto threshold?:Yes
358-
Method for Costes thresholding:Fast
358+
Method for Costes thresholding:Faster
359359

360360
MeasureObjectIntensity:[module_num:15|svn_version:'Unknown'|variable_revision_number:4|show_window:False|notes:[]|batch_state:array([], dtype=uint8)|enabled:True|wants_pause:False]
361361
Select images to measure:ER, Mito, Hoechst, Ph_golgi, Syto

AdvancedSegmentation/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ They are fields of U2OS cells (10 sites imaged in 5 channels), and
88
represent 5 mock treated wells from a single 384 well plate experiment.
99

1010
The download bundle for this tutorial lives in a public google drive folder:
11-
https://drive.google.com/drive/folders/1t6h2e4ifjRISQaXvFg-Mr9mOfc0vET9C?usp=sharing
11+
https://drive.google.com/file/d/18YB8RhfFNKZmYFBd2I0mujJNkcxxEuIZ/view?usp=sharing

BeginnerSegmentation/Archive_EN.zip

94 Bytes
Binary file not shown.

BeginnerSegmentation/Archive_ES.zip

37 Bytes
Binary file not shown.

BeginnerSegmentation/Archive_PT.zip

37 Bytes
Binary file not shown.
169 KB
Binary file not shown.
Binary file not shown.

BeginnerSegmentation/segmentation_final.cppipe

+1-1
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ MeasureColocalization:[module_num:14|svn_version:'Unknown'|variable_revision_num
239239
Calculate the Rank Weighted Colocalization coefficients?:Yes
240240
Calculate the Overlap coefficients?:Yes
241241
Calculate the Manders coefficients using Costes auto threshold?:No
242-
Method for Costes thresholding:Fast
242+
Method for Costes thresholding:Faster
243243

244244
RelateObjects:[module_num:15|svn_version:'Unknown'|variable_revision_number:5|show_window:True|notes:['This module relates a larger "Parent object" to another smaller "Child object/s". In this case, this allows us to identify which Nucleoli belong to which Nuclei.', 'The output is a new object called NucleoliChildObjects that has all of the nucleoli belonging to a single nucleus ']|batch_state:array([], dtype=uint8)|enabled:True|wants_pause:False]
245245
Parent objects:Nuclei

Instructions_for_adding_tutorials.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
1. Gather all the necessary files in a folder. Give the folder a descriptive name with no spaces. Note that files > 25 MB (and especially >100 MB) may not be uploadable to GitHub. If your tutorial requires large files, please do the following:
44
1. Add the files to a folder with a descriptive name (no spaces)
55
2. Zip the folder (on mac, right click > Compress...)
6-
3. Add the .zip file to google drive in the `Outreach` > `Workshops_Webinars_Tutorials` folder on the shared g drive
6+
3. Add the .zip file to google drive in the `Outreach` > `Workshops_Webinars_Tutorials`> `GithubLinkedTutorialFiles` folder on the shared g drive
77
4. Make sure the folder is public and copy the link to share the folder to use for the download link later.
88

99
2. Make a PR adding the folder of materials to the tutorial repo. In addition to the materials, please also
1010
1) write a short description of the tutorial to add to the readme and
11-
2) create a gif (tips on making one [here](https://docs.google.com/document/d/1G5odCSbX1fW8vReKH5ubgvWc1sIGquLisUe7t5pR7d8/edit#heading=h.kjidkmwv6jq3)) and add that gif to to the `assets` > `img` folder.
11+
2) create a gif (tips on making one [here](https://docs.google.com/document/d/1G5odCSbX1fW8vReKH5ubgvWc1sIGquLisUe7t5pR7d8/edit#heading=h.kjidkmwv6jq3); in 2024 on Mac, Beth likes Gifski) and add that gif to to the `assets` > `img` folder.
1212
3) add the tutorial to the `internal_use/docs/source/index.rst` file, and the index file of whatever language that tutorial is in (ie if English, `internal_use/docs/source/toc_en/index.rst`)
1313

14-
3. Update the readme with the description and gif. If there is an associated blogpost or video, please link that using the appropriate badge. If the tutorial is particularly geared toward beginners, add the beginner badge. If the tutorial is advanced such that a user should definitely do a beginner tutorial first, use the advanced badge.
14+
3. Update the top-level readme with the description and gif. If there is an associated blogpost or video, please link that using the appropriate badge. If the tutorial is particularly geared toward beginners, add the beginner badge. If the tutorial is advanced such that a user should definitely do a beginner tutorial first, use the advanced badge.
1515

1616
## Here's an example of what the markdown looks like for the Translocation tutorial:
1717
```

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ This exercise will guide you through setting segmentation parameters that will b
4040

4141
<img class="imggif" src="assets/img/advancedsegmentation.gif" alt="example segmentation" align="right" width="250">
4242

43-
<a href="https://drive.google.com/file/d/1zB6Cye3nlXN3J4oc4r32upn175v0jYg_/view?usp=sharing" target="_blank"><img src="assets/img/download-button.png" alt="Download materials" width="140px"> </a>
43+
<a href="https://drive.google.com/file/d/1qVaQiPZKqOPEsa62lYEpm7ot3th7ADqE/view?usp=sharing" target="_blank"><img src="assets/img/download-button.png" alt="Download materials" width="140px"> </a>
4444

4545
En español:
4646

47-
<a href="https://drive.google.com/file/d/1s6GrMSBwoyu67-VCPDxz9okM518JsHHq/view?usp=sharing" target="_blank"><img src="assets/img/download-button-es.png" alt="Materiales para descargar" width="140px"></a>
47+
<a href="https://drive.google.com/file/d/1LlmSZif9gOyn31xPLftzpJSflMukEFZU/view?usp=sharing" target="_blank"><img src="assets/img/download-button-es.png" alt="Materiales para descargar" width="140px"></a>
4848

4949
## Translocation
5050

internal_use/docs/source/BeginnerSegmentation/BeginnerSegmentationPlugins.md

+24-2
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ Cell masks were made by navigating into the image folder and then running the co
100100
1. Open up a clean copy of CellProfiler (or run File -> New Project) and drag `bonus_1_import_masks.cppipe` into the pipeline panel.
101101
1. Drag the `images_Illum-corrected` subfolder from the main Beginner Segmentation exercise and also the `cellpose_masks_cells` subfolder from this exercise. *Do not drag in the `cellpose_masks_nuclei` folder.*
102102
1. Put CellProfiler into TestMode <img src="./TutorialImages/startTestMode.png" width="120"/>, open the eye icon <img src="./TutorialImages/EyeOpen.png" width="50"/> next to OverlayOutlines, and then hit <img src="./TutorialImages/Step.png" width="120"/> 3 times to create a classical segmentation and compare it with the Cellpose-generated version. You can check the settings in the OverlayOutlines module to see which outline color corresponds to which segmentation in the output.
103-
1. Optionally, open the Workspace Viewer using <img src="./TutorialImages/WorkspaceViewer.png" width="120"/> to create easily on-the-fly customizable overlays.
103+
1. Optionally, open the Workspace Viewer using <img src="./TutorialImages/ViewWorkspace.png" width="120"/> to create easily on-the-fly customizable overlays.
104104
1. Hit <img src="./TutorialImages/NextImageSet.png" width="120"/> and repeat a couple of times to examine the segmentations on more images.
105105

106106
```{admonition} Question for you
@@ -120,7 +120,7 @@ Visualization of images and objects in the Workspace Viewer
120120

121121
### Bonus-to-the-Bonus - add the provided nuclear segmentations as well
122122
1. Drag and drop the `cellpose_masks_nuclei` folder in the Images module to add the nuclear masks to the image list.
123-
1. Go to the NamesAndTypes module and configure it so both kinds of masks can be loaded (hint: there's a duplicate button!)
123+
1. Go to the NamesAndTypes module and configure it so both kinds of masks can be loaded (hint: there's a duplicate button you can use to make a second copy of a channel!)
124124
- You'll probably have to modify the existing settings for loading the cell masks by changing its rule or adding a second rule. Do you understand how/why?
125125

126126
## **Exercise 2: Running ilastik locally or from a Docker container**
@@ -242,6 +242,28 @@ The output of the RunCellpose module
242242
4. As before, using OverlayOutlines and/or the WorkspaceViewer, evaluate segmentation on a few images. Where is CellProfiler doing better, and where is Cellpose doing better?
243243
5. Use the <img src="./TutorialImages/Info.png" width="35"> button to learn more about the different parameters you can pass to Cellpose (we don't offer all of them, but many!) - how does tweaking these affect your output? How about changing the model you're using, and/or the image you're segmenting?
244244

245+
### Bonus-to-the-Bonus 1 - test on a more varied data set
246+
247+
The data we gave you in this exercise was all very clean, and all from the negative control wells of this experiment. The [folder linked here](https://drive.google.com/file/d/10kZMhr2bVR14vMP7kG5iZGujjUI3Nn3Y/view?usp=sharing) contains images with a broader variety of phenotypes - try replacing the images in the `Images` module with this folder instead and see how well the two kinds of segmentation work in different conditions!
248+
249+
```{figure} ../AdvancedSegmentation/TutorialImages/Fig2.png
250+
:width: 700
251+
:align: center
252+
A broader range of phenotypes can be harder to consistently account for in conducting segmentation.
253+
```
254+
255+
```{tip}
256+
You’re encouraged to explore the performance in some random images on your own (you can do this from the `Test` menu with the `Random Image Set` option), but if you find yourself consistently ending up with images that look similar you can try examining images from the following list of wells- A08, A12, B12, B18, C7, D6, D19, D22, E3. You can pick these with `Test` -> `Choose Image Set`
257+
```
258+
259+
### Bonus-to-the-Bonus 2 - improve Cellpose segmentation
260+
261+
Based on your evaluations above, can you identify some places where additional training might help fix some issues in the Cellpose model? If you happen to have Cellpose on your computer (or want to try installing it - see Exercise 1 for a link to the official install instructions), open Cellpose with some of the `Ch1` images and see if you can train a model that will perform better.
262+
263+
### Bonus-to-the-Bonus 3 - test your classical segmentation skills
264+
265+
The classical segmentation parameters provided here are based on expert tuning from a very experienced CellProfiler user - how close can you get? Add another IdentifyPrimaryObjects module to the pipeline, tune it yourself, and then look in the workspace viewer to see how it performs, especially in the more diverse image set from Bonus-to-the-Bonus 1. Compare your parameters to the expert ones - how do they differ? Do you understand why some of these settings may have been chosen?
266+
245267
## What next? Want to know more about CellProfliler plugins and modules?
246268
1. Read the [CellProfiler-plugins paper](https://pubmed.ncbi.nlm.nih.gov/37690102/)
247269
2. Watch this [video](https://www.youtube.com/watch?v=fgF_YueM1b8) to learn how to write a module

0 commit comments

Comments
 (0)