Skip to content

Commit 03fbe24

Browse files
authored
Revise template matching documentation and examples
Updated instructions and details for running template matching, including HPC usage and visualization tools.
1 parent d350db3 commit 03fbe24

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

  • docs/03-tutorial/04-template-matching

docs/03-tutorial/04-template-matching/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -112,13 +112,20 @@ For ribosomes (and also other targets), good results were obtained using:
112112
- Angular search: **10°**
113113
- Enable random-phase correction: **YES**
114114
- Enable per-tilt-weighting: **YES**
115-
- `--tomogram-ctf-model phase-flip`: **YES** (even if you tomos are 3D CTF-corrected!)
115+
- `--tomogram-ctf-model phase-flip`: **YES** (even if your tomos are 3D CTF-corrected!)
116116
- Enable non-spherical mask: **YES** (if spherical then leave out. 2x speedup without)
117117
- High-pass filter: **400**
118118
- Random phase correction `-r --rng-seed 69`: **YES** (improves results! but also 2x speedup when left out)
119119

120120
The functionality of the batch submission script is basically the same as for the [RELION5](/03-tutorial/04-template-matching/#rln5tm) one below. Make sure to check the `--help` and the [Github README](https://github.com/Phaips/batch_pytom_aretomo3) and feel free to raise any issues or comments directly on the GitHub page.
121121

122+
If you don't have an HPC or don't use SLURM, you can just run the regular [pytom-match-pick](https://sbc-utrecht.github.io/pytom-match-pick/) similar to the command above. You can run our `batch_pytom.py` script with the flag `--dry-run` in order to generate all the input commands and flags without SLURM submission to then edit and run it the way you like while still having all the per-tomo tilt, defocus, and exposure information.
123+
124+
> Some numbers: ~40 min per subvolume (tomogram is split in 4) so 2.5 to 3h per tomo with 7° angular sampling at bin4 on rtx4090 node (we could have ask for more resources of course).
125+
1.5h when you use the same parameters but a 10° (testing 15000 angles) angular sampling instead of 7° (testing 50000 angles). Random-phase correction will basically double the computation time, but we recommend using it, especially for more challenging targets. Any symmetry assumptions or a spherical mask will further speed up computation time!
126+
127+
You can check the `_scores.mrc` file in IMOD for example to already see if template matching was successful. If you open the `tomogram.mrc` and `_scores.mrc` at the same time you should see bright dots at the center of each of your particles of interest. Later in this section, we'll show you how to **[visualize your particles first with IMOD]**(/03-tutorial/04-template-matching/#checkimod), and then more appealingly using **[ChimeraX & ArtiaX]**(/03-tutorial/04-template-matching/#viz).
128+
122129
### Running template matching on RELION5 tomograms {#rln5tm}
123130

124131
To run template matching in batch (on all the tomograms in your RELION folder), we will use this **[batch_pytom_wRln5](https://github.com/Phaips/batch_pytom_wRln5)** script we wrote. It is intended to create `bash.sh` files for SLURM submission. It will read all necessary information like the defocus per tilt and exposure values from the `tilt-series.star` files in your RELION `Tomograms/jobXXX/` folder. For each tomogram, those values will be provided to the `pytom_match_template.py` script. Alternatively, as always, you can just run template matching using pytom in the conventional way. Our scripts are intended to facilitate the batch submission of jobs in case you want to template match hundreds of tomograms.
@@ -192,13 +199,6 @@ pytom_match_template.py \
192199
--tomogram-mask masks/bmask_1.mrc # from Slabify, for example
193200
```
194201

195-
If you don't have an HPC or don't use SLURM, you can just run the regular [pytom-match-pick](https://sbc-utrecht.github.io/pytom-match-pick/) similar to the command above. You can run `batch_pytom.py` with the flag `--dry-run` in order to generate all the input commands and flags to then run it the way you like while still having all the tilt, defocus, and exposure information read correctly from the RELION .star files.
196-
197-
> Some numbers: ~40 min per subvolume (tomogram is split in 4) so 2.5 to 3h per tomo with 7° angular sampling at bin4 on rtx4090 node (we could have ask for more resources of course).
198-
1.5h when you use the same parameters but a 10° (testing 15000 angles) angular sampling instead of 7° (testing 50000 angles). Random-phase correction will basically double the computation time, but we recommend using it, especially for more challenging targets.
199-
200-
You can check the `_scores.mrc` file in IMOD for example to already see if template matching was successful. If you open the `tomogram.mrc` and `_scores.mrc` at the same time you should see bright dots at the center of each of your particles of interest. Later in this section, we'll show you how to visualize your particles first with IMOD, and then more appealingly using ChimeraX & ArtiaX.
201-
202202

203203
## Extract particles
204204

@@ -245,7 +245,7 @@ pytom_extract_candidates.py -j submission/tomo_24/rec_tomo24_job.json --particle
245245
or you can investigate the `.svg` file that was generated from the extraction job. Based on this you can tweak your `-c` value.
246246

247247

248-
## Check your particle positions with IMOD
248+
## Check your particle positions with IMOD {#checkimod}
249249

250250
We wrote a script called **[rln2mod](https://github.com/Phaips/rln2mod)** which will create IMOD `.mod` point models from your `particle.star` files in RELION5 format. You will need to have IMOD loaded since it will run `point2model`. The script will output `.mod` files for all `.star` files in the directory it is run from:
251251

@@ -276,7 +276,7 @@ To do so, you can use the `pytom_merge_stars.py` script included with pytom. Run
276276

277277
When importing to RELION5, make sure a prefix such as `rec_` is not present in the `rlnTomoName` field of your merged `particles.star` file. Otherwise, do a quick find-and-replace to remove this prefix.
278278

279-
## Visualisation in ChimeraX using ArtiaX
279+
## Visualisation in ChimeraX using ArtiaX {#viz}
280280

281281
We will show you how to use the [ArtiaX](https://github.com/FrangakisLab/ArtiaX) plug-in in [ChimeraX](https://www.cgl.ucsf.edu/chimerax/). This allows you to not only check the position but also the orientation of particles.
282282

0 commit comments

Comments
 (0)