Skip to content

Commit 241b717

Browse files
authored
Start numeric headers with bold, small typo fixes (#183)
1 parent b9352d0 commit 241b717

File tree

4 files changed

+43
-43
lines changed

4 files changed

+43
-43
lines changed

internal_use/docs/source/AdvancedSegmentation/BBBC022_AnalysisExercise.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ a similar introductory exercise.
7474

7575
## **Input images and configure metadata**
7676

77-
### 1. **Load images and metadata**
77+
### **1. Load images and metadata**
7878

7979
- Start CellProfiler by double-clicking the desktop icon <img src="./TutorialImages/CellProfilerLogo.png" alt="CellProfiler icon" width="35"/>
8080

@@ -86,7 +86,7 @@ a similar introductory exercise.
8686
images (with a file extension of ‘.npy’) are included in this data
8787
set.
8888

89-
### 2. **Import metadata from the CSV**
89+
### **2. Import metadata from the CSV**
9090

9191
So that we can explore what cells treated with different drugs look like later in the exercise, we must add this information into CellProfiler from the CSV. Provided with this exercise is a CSV called ‘20585_AE.csv’ detailing drug treatment
9292
info for each image.
@@ -113,7 +113,7 @@ info for each image.
113113
- Image_Metadata_PlateID (from the spreadsheet) is matched to Plate (extracted from the folder name by the second extraction step)
114114
- Image_Metadata_CPD_WELL_POSITION (from the spreadsheet) is matched to Well (extracted from the file name by the first extraction step)
115115

116-
### 3. **Examine the channel mappings in NamesAndTypes (optional)**
116+
### **3. Examine the channel mappings in NamesAndTypes (optional)**
117117

118118
The channel mapping here is a bit more complicated than anything we've worked with before- we have a single set of illumination correction images that map to each and every well and site. We can use the metadata we extracted in the last module to make that association possible.
119119

@@ -154,7 +154,7 @@ The channel mapping here is a bit more complicated than anything we've worked wi
154154
```
155155
## **Illumination correction**
156156

157-
### 4. **Examine the output of the CorrectIlluminationApply module (optional)**
157+
### **4. Examine the output of the CorrectIlluminationApply module (optional)**
158158

159159
Since microscope objectives don't typically have a completely uniform illumination
160160
pattern, applying an illumination correction function can help make segmentation
@@ -183,9 +183,9 @@ to the top of the field of view to see the greatest effect.
183183
*Figure 4: Application of the illumination correction functions.*
184184
```
185185

186-
## **Segmenet Nuclei, Cells and Cytoplasm**
186+
## **Segment Nuclei, Cells and Cytoplasm**
187187

188-
### 5. **IdentifyPrimaryObjects- Nuclei**
188+
### **5. IdentifyPrimaryObjects- Nuclei**
189189

190190
Next we'll take a first pass at identifying nuclei and cells in our initial image.
191191

@@ -202,7 +202,7 @@ Next we'll take a first pass at identifying nuclei and cells in our initial imag
202202
the parameters for robustness later, however, the identification
203203
should be good but doesn’t need to be perfect before you move on.
204204

205-
### 6. **IdentifySecondaryObjects- Cells**
205+
### **6. IdentifySecondaryObjects- Cells**
206206

207207
- **After** the IdentifyPrimaryObjects module but **before** the
208208
EnhanceOrSuppressFeatures module, add an IdentifySecondaryObjects
@@ -215,7 +215,7 @@ Next we'll take a first pass at identifying nuclei and cells in our initial imag
215215
you feel you’re ready to test them on another image; they need not be
216216
perfect before you move on.
217217

218-
### 7. **Test the robustness of your segmentation parameters across multiple compounds**
218+
### **7. Test the robustness of your segmentation parameters across multiple compounds**
219219

220220
It's (relatively!) easy to come up with a good set of segmentation parameters for a single image or a set of similar images; this data set however contains images from cells treated with many different classes of drugs, many of which have very different phenotypes. It's valuable to learn how to create a set of parameters that can segment cells that display a variety of morphologies since you may come across a similar problem in your own experiments!
221221

@@ -259,7 +259,7 @@ It's (relatively!) easy to come up with a good set of segmentation parameters fo
259259
\- In IdentifyPrimaryObjects, adjusting the declumping settings (make sure to turn 'Use advanced settings?' on) will probably be necessary for a robust segmentation
260260
\- In IdentifySecondaryObjects, you will want to test the effects of using the various methods for identifying secondary objects (Propagation, Watershed-Image, Distance-N, etc) and, if using Propagation, the regularization factor.
261261

262-
### 8. **IdentifyTertiaryObjects- Cytoplasm**
262+
### **8. IdentifyTertiaryObjects- Cytoplasm**
263263

264264
- **After** the IdentifySecondaryObjects module but **before** the
265265
EnhanceOrSuppressFeatures module, add an IdentifyTertiaryObjects
@@ -269,7 +269,7 @@ It's (relatively!) easy to come up with a good set of segmentation parameters fo
269269

270270
## **Segment Nucleoli inside the Nuclei**
271271

272-
### 9. **Examine the steps used to segment the Nucleoli**
272+
### **9. Examine the steps used to segment the Nucleoli**
273273

274274
- The next 3 modules have to do with the creation of the Nucleoli
275275
objects. Look at the output from each to see how the image is
@@ -308,7 +308,7 @@ It's (relatively!) easy to come up with a good set of segmentation parameters fo
308308

309309
## **Segment the Mitochondria inside the Cytoplasm**
310310

311-
### 10. **Mask the Mito image by the Cytoplasm object**
311+
### **10. Mask the Mito image by the Cytoplasm object**
312312

313313
Now that you’ve seen an example of how to segment an organelle, you
314314
will do so for Mitochondria in the following steps.
@@ -335,7 +335,7 @@ will do so for Mitochondria in the following steps.
335335
```
336336

337337

338-
### 12. **IdentifyPrimaryObjects- Mitochondria**
338+
### **11. IdentifyPrimaryObjects- Mitochondria**
339339

340340
- **After** your MaskImage module but **before** the RelateObjects
341341
modules, add an IdentifyPrimary Objects module to identify
@@ -350,7 +350,7 @@ will do so for Mitochondria in the following steps.
350350

351351
## **Perform Measurements**
352352

353-
### 13. **Add measurement modules to your pipeline**
353+
### **12. Add measurement modules to your pipeline**
354354

355355
- **After** your segmentation of the mitochondria but **before** the
356356
RelateObjects modules, add as many object measurement modules as you
@@ -426,7 +426,7 @@ only be able to examine one object at a time in CellProfiler Analyst.*
426426

427427
## **Relate Nucleoli and Mitochondria to their respective nuclei/cells**
428428

429-
### 14. Examine the settings of RelateObjects
429+
### **13. Examine the settings of RelateObjects**
430430

431431
- **After** your Measurement and **before** your Export modules you
432432
should find two RelateObjects modules. One relates Nucleoli to
@@ -439,7 +439,7 @@ only be able to examine one object at a time in CellProfiler Analyst.*
439439

440440
## **Perform the analysis on ALL the images**
441441

442-
### 15. **Run the pipeline (optional)**
442+
### **14. Run the pipeline (optional)**
443443

444444
- If you have time and/or if you’d like to play with the data in
445445
CellProfiler Analyst later, exit test mode, close the eyes next to

internal_use/docs/source/BeginnerSegmentation/CPbeginner_Segmentation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Read through the steps below and follow instructions where stated. Steps where y
5858
:width: 700
5959
:align: center
6060
61-
Figure 2: **Main CellProfiler window**. To load images, drag and drop images into the right area. To load a pipeline (.ccpipe or .ccproj files), drag and drop the pipeline file into the left area.
61+
Figure 2: **Main CellProfiler window**. To load images, drag and drop images into the right area. To load a pipeline (.cppipe or .cpproj files), drag and drop the pipeline file into the left area.
6262
```
6363

6464
- Drag and drop the `‘segmentation_start.cppipe’` file into the `‘Analysis modules’` pane on the left.
@@ -94,9 +94,9 @@ Read through the steps below and follow instructions where stated. Steps where y
9494
> **TIP** you can manually adjust brightness and contrast in the image display by right-clicking on it and going to `'Adjust Contrast'`
9595
9696
-------------------------------------------------------------------------------------------------------------------------
97-
### 3. [OPTIONAL STEP] Set up the input modules
97+
### **3. [OPTIONAL STEP] Set up the input modules**
9898

99-
> *We suggest you skip this step for now, it will not affect the rest of the pipeline, as these modules have been properly set up in the starting pipeline (`segmentation_start.cpipe`).*
99+
> *We suggest you skip this step for now, it will not affect the rest of the pipeline, as these modules have been properly set up in the starting pipeline (`segmentation_start.cppipe`).*
100100
101101
> *At the end of this tutorial you will find instructions on how to set up the input modules*
102102

internal_use/docs/source/QualityControl/BBBC022_QualityControlExercise.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ tools in CellProfiler and CellProfiler Analyst, preferably after
4646
completing the Translocation tutorial or a similar introductory
4747
exercise.
4848

49-
## 1. **Start the provided QC pipeline on the BBBC022 dataset**
49+
## **1. Start the provided QC pipeline on the BBBC022 dataset**
5050

5151
In order to do quality control, we need to first measure the images in many ways.
5252
This will allow us to do machine learning to use the measurements to identify the
@@ -73,7 +73,7 @@ good images from the bad.
7373
three files should be created- a .db database file, a .properties
7474
text file, and a .workspace text file.
7575

76-
## 2. **Examine the QC pipeline (~15 minutes)**
76+
## **2. Examine the QC pipeline (~15 minutes)**
7777

7878
- While the pipeline is running, take some time to look over the
7979
pipeline and make sure you understand the various parts. You will
@@ -150,7 +150,7 @@ good images from the bad.
150150
table, etc). As we are not identifying any objects, we don’t
151151
need to worry about these.
152152

153-
## 3. **Open the CellProfiler Analyst workspace and determine reasonable parameter cutoffs (~20 minutes)**
153+
## **3. Open the CellProfiler Analyst workspace and determine reasonable parameter cutoffs (~20 minutes)**
154154

155155
In the first step of the quality control pipeline, we'll look at graphs of how
156156
various measurements are distributed in the population. This allows us to get
@@ -211,7 +211,7 @@ in later steps.
211211
different/smaller subset or delete it altogether by using the Gate
212212
Inspector (‘gate’-> ‘MANAGE GATES’).
213213

214-
## 4. **Optional — use the PlateViewer tool to check for other features to gate on (~10 minutes)**
214+
## **4. Optional — use the PlateViewer tool to check for other features to gate on (~10 minutes)**
215215

216216
If you want to see if you can find additional features that might distinguish good
217217
images from bad images, feel free to explore the feature set more thoroughly.
@@ -239,7 +239,7 @@ images from bad images, feel free to explore the feature set more thoroughly.
239239
ImageNumber on the X-axis as in the Workspace plots, but feel free to play around).
240240
If you find a gate that seems logical to make, proceed as in Step 3.
241241

242-
## 5. **Create filters based on the cutoffs you’ve determined (~10 minutes)**
242+
## **5. Create filters based on the cutoffs you’ve determined (~10 minutes)**
243243

244244
Now that we've created gates around our poor quality images, we need to convert
245245
them into filters so that we can access them in the Classifier tool. This
@@ -317,7 +317,7 @@ presented in case you cannot or will not edit the properties file.
317317
*Figure 3: Creating filters inside CPA*
318318
```
319319

320-
## 6. **Create classifier rules to distinguish good from bad images (~30 minutes)**
320+
## **6. Create classifier rules to distinguish good from bad images (~30 minutes)**
321321

322322
Creating gates based on the 12 measurements we graphed has helped us identify
323323
some low quality images so far, but we are not utilizing the rest of our
@@ -359,7 +359,7 @@ low quality images.
359359
- Save your training set for future reference if desired, then close
360360
CellProfiler Analyst.
361361

362-
## 7. **Add quality control steps to an analysis pipeline (~15 minutes)**
362+
## **7. Add quality control steps to an analysis pipeline (~15 minutes)**
363363

364364
If you have time, you can add the list of rules you identified in your machine
365365
learning classifier to the CellProfiler pipeline that corresponds to this data

0 commit comments

Comments
 (0)