This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
pipeline:cter:sxcter [2018/02/16 10:11] 127.0.0.1 external edit |
pipeline:cter:sxcter [2018/08/22 10:35] fmerino |
||
---|---|---|---|
Line 2: | Line 2: | ||
===== sxcter ===== | ===== sxcter ===== | ||
- | CTF Estimation: Automated estimation of CTF parameters with error assessment. | + | CTF Estimation: Automated estimation of CTF parameters with error assessment, including Volta phase shift. |
\\ | \\ | ||
===== Usage ===== | ===== Usage ===== | ||
+ | |||
Usage in command line | Usage in command line | ||
- | sxcter.py | + | sxcter.py |
\\ | \\ | ||
===== Typical usage ===== | ===== Typical usage ===== | ||
- | sxcter exists in for both MPI and non-MPI versions. Running the MPI version does not require --MPI flag. | ||
- | The program can be executed in several different modes: | + | sxcter exists in for both MPI and non-MPI versions (Running MPI version does not require --MPI flag). |
+ | \\ The program | ||
- | \\ __All Micrographs Mode - Process all micrographs in a directory__: Specify a list of input micrographs using a wild card (*), called | + | \\ __All Micrographs Mode - Process all micrographs in a directory:__ |
+ | \\ Specify a list of input micrographs using a wild card (*), here called input micrographs path pattern. Running from the command line requires enclosing the string by single quotes (\') or double quotes (\"). sxgui.py will automatically adds single quotes to the string. | ||
mpirun -np 16 sxcter.py ' | mpirun -np 16 sxcter.py ' | ||
- | \\ __Selected Micrographs Mode - Process all micrographs in a selection list file__: In addition to input micrographs path pattern and output directry arguments, specify a name of micrograph selection list text file using --selection_list option (e.g. output of sxgui_unblur.py or sxgui_cter.py). The file extension must be " | + | \\ __Selected Micrographs Mode - Process all micrographs in a selection list file:__ |
+ | \\ In addition to input micrographs path pattern and output directry arguments, specify a name of micrograph selection list text file using --selection_list option (e.g. output of sxgui_unblur.py or sxgui_cter.py). The file extension must be " | ||
mpirun -np 16 sxcter.py ' | mpirun -np 16 sxcter.py ' | ||
- | \\ __Single Micrograph Mode - Process a single | + | \\ __Single Micrograph Mode - Process a single |
+ | \\ One can specify a single micrograph name using --selection_list option. In this mode, only the specified single micrograph will be processed. If this micrograph name does not matches the file name part of the pattern (ignoring the directory paths), the process will exit without processing it. If this micrograph name matches the file name part of the pattern but does not exists in the directory which specified by the micrograph path pattern, again the process will exit without processing it. Use single processor for this mode. | ||
sxcter.py ' | sxcter.py ' | ||
- | \\ __Stack Mode - Process | + | \\ __Stack Mode - ProcessProcess |
+ | \\ Use --stack_mode option, then specify the path of particle stack file (without wild card " | ||
sxcter.py bdb:stack outdir_cter --apix=2.29 --Cs=2.0 --voltage=300 --ac=10.0 --stack_mode | sxcter.py bdb:stack outdir_cter --apix=2.29 --Cs=2.0 --voltage=300 --ac=10.0 --stack_mode | ||
+ | |||
+ | \\ __All Micrographs Mode with Phase-Shift Estimation: | ||
+ | \\ defocus_min, | ||
+ | |||
+ | mpirun -np 16 sxcter.py ' | ||
+ | |||
+ | \\ __All Micrographs Mode with the CTF model fitting to power spectrum:__ | ||
+ | |||
+ | mpirun -np 16 sxcter.py ' | ||
+ | |||
\\ | \\ | ||
===== Input ===== | ===== Input ===== | ||
- | === Main Parameters === | + | === Main Parameters === |
- | ; input_image_path : Input micrograph path pattern: Specify input micrographs path pattern with a wild card (*) for any of Micrograph Modes. Images | + | ; input_image_path : Input micrograph path pattern: Specify input micrographs path pattern with a wild card (*) for any of Micrograph Modes. Images |
- | ; selection_list : Micrograph | + | ; output_directory : Output directory: The CTF parameters (partres file), rotationally averaged power spectra (rotinf), and micrograph thumbnails (thumb files) will be written here. It cannot be an existing one. (default required string) |
- | ; wn : CTF window size [pixels]: The size should be slightly larger than particle box size. This will be ignored in Stack Mode. (default 512) | + | |
- | ; apix : Pixel size [A/Pixels]: The pixel size of input micrograph(s) or images in input particle stack. (default -1.0) | + | ; %%--%%selection_list : Micrograph |
- | ; Cs : Microscope spherical aberration (Cs) [mm]: The spherical aberration (Cs) of microscope used for imaging. (default 2.0) | + | ; %%--%%wn : CTF window size [Pixels]: The window |
- | ; voltage : Microscope voltage [kV]: The acceleration voltage of microscope used for imaging. (default 300.0) | + | ; %%--%%apix : Pixel size [A]: The pixel size of input micrograph(s) or images in input particle stack. (default -1.0) |
- | ; ac : Amplitude contrast [%]: The typical | + | ; %%--%%Cs : Microscope spherical aberration (Cs) [mm]: The spherical aberration (Cs) of microscope used for imaging. (default 2.0) |
- | ; f_start : Lowest | + | ; %%--%%voltage : Microscope voltage [kV]: The acceleration voltage of microscope used for imaging. (default 300.0) |
- | ; f_stop : Highest | + | ; %%--%%ac : Amplitude contrast [%]: The amplitude contrast is in the range of 7% - 14%. The value depends on the thickness of the ice embedding the particles, among other factors. (default 10.0) |
- | + | ; %%--%%f_start : Lowest | |
+ | ; %%--%%f_stop : Highest | ||
\\ | \\ | ||
=== Advanced Parameters === | === Advanced Parameters === | ||
- | ; kboot : Number of CTF estimates per micrograph: Used for error assessment. (default 16) | + | ; %%--%%kboot : Number of CTF estimates per micrograph: Used for error assessment. (default 16) |
- | ; overlap_x : X overlap [%]: Overlap between | + | ; %%--%%overlap_x : X overlap [%]: Overlap between |
- | ; overlap_y : Y overlap [%]: Overlap between | + | ; %%--%%overlap_y : Y overlap [%]: Overlap between |
- | ; edge_x : Edge x [pixels]: | + | ; %%--%%edge_x : Edge x [pixels]: |
- | ; edge_y : Edge y [pixels]: | + | ; %%--%%edge_y : Edge y [pixels]: |
- | ; set_ctf_header : Export CTF parameters to header: Exports the estimated CTF parameters to the image header. (default False) | + | ; %%--%%check_consistency : Check consistency of inputs: Create a text file containing the list of inconsistent Micrograph ID entries (i.e. inconsist_mic_list_file.txt). (default False) |
- | ; check_consistency : Check consistency of inputs: Create a text file containing the list of inconsistent Micrograph ID entries (i.e. inconsist_mic_list_file.txt). (default False) | + | ; %%--%%stack_mode : Use stack mode: Use a stack as the input. Please set the file path of a stack as the first argument and output directory for the second argument. This is an advanced option. Not supported by sxgui. (default False) |
- | ; stack_mode : Use stack mode: Use a stack as the input. Please set the file path of a stack as the first argument and output directory for the second argument. This is advanced option. Not supported by sxgui. (default False) | + | ; %%--%%debug_mode : Enable debug mode: Print out debug information. (default False) |
- | ; debug_mode : Enable debug mode: Print out debug information. (default False) | + | |
- | | + | ; %%--%%defocus_min : Minimum defocus search [um]: UNDER DEVELOPMENT! This is applicable only with --vpp option. (default 0.3) |
+ | ; %%--%%defocus_max : Maximum defocus search [um]: UNDER DEVELOPMENT! This is applicable only with --vpp option. (default 9.0) | ||
+ | ; %%--%%defocus_step : Defocus search step [um]: UNDER DEVELOPMENT! This is applicable only with --vpp option. (default 0.1) | ||
+ | ; %%--%%phase_min : Minimum phase search [degrees]: UNDER DEVELOPMENT! This is applicable only with --vpp option. (default 5.0) | ||
+ | ; %%--%%phase_max : Maximum phase search [degrees]: UNDER DEVELOPMENT! This is applicable only with --vpp option. (default 175.0) | ||
+ | ; %%--%%phase_step : Phase search step [degrees]: UNDER DEVELOPMENT! This is applicable only with --vpp option. (default 5.0) | ||
+ | ; %%--%%pap : Use PW spectrum: UNDER DEVELOPMENT! Use power spectrum for CTF parameter search instead of amplitude. (default False) | ||
\\ | \\ | ||
===== Output ===== | ===== Output ===== | ||
- | ; output_directory : Output directory: The CTF parameters (partres file), rotationally averaged power spectra (rotinf), and micrograph thumbnails (thumb files) will be written here. This directory will be created automatically and it must not exist previously. (default required string) | + | After successful execution, sxcter will create in the output_directory: |
- | + | | |
- | + | ||
- | ===== Description ===== | + | |
- | \\ After successful execution, sxcter will create in the output_directory: | + | |
- | + | ||
- | | + | |
- A list of rotationally averaged power spectra, written to '' | - A list of rotationally averaged power spectra, written to '' | ||
- A collection of micrographs Thumbnails (512 x 512 pixels), written to '' | - A collection of micrographs Thumbnails (512 x 512 pixels), written to '' | ||
Line 70: | Line 90: | ||
The CTF parameter file, '' | The CTF parameter file, '' | ||
- | || Column || Parameter || | + | || **Column** || **Parameter** || |
|| 1 || Image defocus [um] || | || 1 || Image defocus [um] || | ||
|| 2 || Microscope spherical aberration [mm] || | || 2 || Microscope spherical aberration [mm] || | ||
|| 3 || Microscope voltage [kV] || | || 3 || Microscope voltage [kV] || | ||
|| 4 || Pixel size [A] || | || 4 || Pixel size [A] || | ||
- | || 5 || B-factor [A<sup>2</ | + | || 5 || B-factor [A%%^%%2] || |
- | || 6 || Amplitude contrast [%] || | + | || 6 || Amplitude contrast [%] (it can include estimated Volta phase shift) |
|| 7 || Astigmatism amplitude [um] || | || 7 || Astigmatism amplitude [um] || | ||
|| 8 || Astigmatism angle [degrees] || | || 8 || Astigmatism angle [degrees] || | ||
|| 9 || Standard deviation of defocus [um] || | || 9 || Standard deviation of defocus [um] || | ||
- | || 10 || Standard deviation of amplitude contrast [%] || | + | || 10 || Standard deviation of total amplitude contrast [%] || |
|| 11 || Standard deviation of astigmatism amplitude [um] || | || 11 || Standard deviation of astigmatism amplitude [um] || | ||
|| 12 || Standard deviation of astigmatism angle [degrees] || | || 12 || Standard deviation of astigmatism angle [degrees] || | ||
- | || 13 || Coefficient of variation of defocus || | + | || 13 || Coefficient of variation of defocus |
- | || 14 || Coefficient of variation of astigmatism amplitude || | + | || 14 || Coefficient of variation of astigmatism amplitude |
|| 15 || Frequency at which the signal drops by 50% due to estimated error of defocus alone [1/A] || | || 15 || Frequency at which the signal drops by 50% due to estimated error of defocus alone [1/A] || | ||
|| 16 || Frequency at which the signal drops by 50% due to estimated error of defocus and astigmatism [1/A] || | || 16 || Frequency at which the signal drops by 50% due to estimated error of defocus and astigmatism [1/A] || | ||
- | || 17 || Frequency at which the CTF oscillation can no longer | + | || 17 || Frequency at which the CTF cannot |
|| 18 || NOT IMPLEMENTED YET! Maximum frequency limit (visual-impression-based)[A] || | || 18 || NOT IMPLEMENTED YET! Maximum frequency limit (visual-impression-based)[A] || | ||
|| 19 || NOT IMPLEMENTED YET! Reserved spot for other means of maximum frequency limit or error criterion. Possibly originated from external program || | || 19 || NOT IMPLEMENTED YET! Reserved spot for other means of maximum frequency limit or error criterion. Possibly originated from external program || | ||
Line 94: | Line 114: | ||
|| 22 || Micrograph name || | || 22 || Micrograph name || | ||
+ | The rotationally averaged power spectra or amplitude (rotinf.txt files) will be written to the pwrot directory. These files contain 6 columns with the following information: | ||
- | The rotationally averaged power spectra (rotinf.txt files) will be written to the pwrot directory. These files contain 6 columns with the following information | + | || **Column** || **Parameter** || |
- | + | ||
- | || Column || Parameter || | + | |
|| 1 || Line number || | || 1 || Line number || | ||
|| 2 || Spatial frequency [1/A] || | || 2 || Spatial frequency [1/A] || | ||
Line 106: | Line 125: | ||
\\ | \\ | ||
+ | ===== Description ===== | ||
- | === Developer Notes === | + | \\ |
+ | ==== Method ==== | ||
+ | |||
+ | \\ | ||
+ | ==== Reference ==== | ||
+ | |||
+ | \\ | ||
+ | === Attachments === | ||
+ | 80S ribosome determined using 35,198 projection images collected with a 300 kV Tecnai Polara (FEI) equipped with the K2 Summit DED camera. | ||
+ | |||
+ | \\ | ||
+ | ==== Developer Notes ==== | ||
+ | === 2017/12/07 Toshio Moriya === | ||
+ | The format of '' | ||
- | == NOTE: 2017/12/07 Toshio Moriya == | ||
- | The format of partres.txt is changed. The old format below is also supported for now but will be removed in near future. | ||
In the new format above, | In the new format above, | ||
- | REMOVED: | + | == REMOVED: |
- | | + | |
- | ADDED: | + | == ADDED: |
- | | + | |
- | | + | |
- | | + | |
- | | + | |
- | The old format of the CTF parameter file, '' | + | The old format of the CTF parameter file, '' |
- | || Column || Parameter || | + | || **Column** || **Parameter** || |
|| 1 || Image defocus [um] || | || 1 || Image defocus [um] || | ||
|| 2 || Microscope spherical aberration [mm] || | || 2 || Microscope spherical aberration [mm] || | ||
|| 3 || Microscope voltage [kV] || | || 3 || Microscope voltage [kV] || | ||
|| 4 || Pixel size [A] || | || 4 || Pixel size [A] || | ||
- | || 5 || B-factor [A<sup>2</ | + | || 5 || B-factor [A%%^%%2] || |
|| 6 || Amplitude contrast [%] || | || 6 || Amplitude contrast [%] || | ||
|| 7 || Astigmatism amplitude [um] || | || 7 || Astigmatism amplitude [um] || | ||
Line 137: | Line 168: | ||
|| 11 || Standard deviation of astigmatism amplitude [um] || | || 11 || Standard deviation of astigmatism amplitude [um] || | ||
|| 12 || Standard deviation of astigmatism angle [degrees] || | || 12 || Standard deviation of astigmatism angle [degrees] || | ||
- | || 13 || Coefficient of variation of defocus [um] || | + | || 13 || Coefficient of variation of defocus [%] || |
- | || 14 || Coefficient of variation of astigmatism amplitude [um] || | + | || 14 || Coefficient of variation of astigmatism amplitude [%] || |
|| 15 || Mean difference between the experimental rotational averages calculated with and without considering astigmatism. The subtraction is only performed at frequencies where the CTF model has a local minimum or maximum. || | || 15 || Mean difference between the experimental rotational averages calculated with and without considering astigmatism. The subtraction is only performed at frequencies where the CTF model has a local minimum or maximum. || | ||
|| 16 || Frequency at which the signal drops by 50% due to estimated error of defocus alone [1/A] || | || 16 || Frequency at which the signal drops by 50% due to estimated error of defocus alone [1/A] || | ||
Line 146: | Line 177: | ||
\\ | \\ | ||
- | + | ==== Author / Maintainer ==== | |
- | ===== Author / Maintainer ==== | + | |
Pawel A. Penczek and Toshio Moriya | Pawel A. Penczek and Toshio Moriya | ||
- | |||
- | \\ | ||
- | ==== Attachments ==== | ||
- | 80S ribosome determined using 35,198 projection images collected with a 300 kV Tecnai Polara (FEI) equipped with the K2 Summit DED camera. | ||
\\ | \\ | ||
Line 163: | Line 189: | ||
\\ | \\ | ||
- | === See also === | + | ==== See also ==== |
- | [[:pipeline: | + | [[pipeline: |
\\ | \\ | ||
Line 171: | Line 197: | ||
\\ | \\ | ||
- | ==== Known Bugs ==== | + | ==== Bugs ==== |
There are no known bugs so far. | There are no known bugs so far. | ||
\\ | \\ |