User Tools

Site Tools

This version (2021/03/16 11:33) is a draft.
Approvals: 0/1


3D classification : Apply relion 3D classficaton using SPHIRE GUI.


Usage in command line post_refine_folder output_folder reference_map --reference_mask --abs_greyscale_map --ini_high --sym --do_ctf --ctf_corr_ref --ctf_ignore_peak --no_of_class --tau_val --no_of_iter --use_fast_sets --mask_diam --mask_zeros --limit_resol_estep --skip_img_align --heal_pix_order --off_range --off_step --ang_search --ang_search_range --ang_search_relax_sym --coarse_sampling --para_io --no_of_pool_part --skip_pad --skip_grid --pre_read_img --scratch_dir --combine_iter_disc --use_gpu --which_gpu --submission_template --submission_command --relion_mpirun_executable --relion_3dclassification_executable --mpi_procs --no_of_threads --mrc_reloc_folder --helical_recons --inner_diam --outer_diam --sig_tilt --sig_psi --sig_rot --sigma_dist --keep_tilt_fix --apply_helical_sym --unique_asym_unit --initial_twist --initial_rise --z_percent --do_local_search --twist_min --twist_max --twist_inistep --rise_min --rise_max --rise_inistep

Typical usage

sp_relion_3dclassifi exists in both MPI and non-MPI versions (Running MPI version does not require –MPI flag).

The purpose of is to :

: Apply 3D classification from relion using the SPHIRE GUI.

: The SPHIRE module provides a wrapper around the 3d classification command.

: After running the 3d classification routine, the wrapper automatically converts the star file so that it can be used directly for further processing. (still in test phase). 


Main Parameters

Input folder is the directory where the results of the post refiner are present and python routine automatically locates all the required files used for relion 3d classification. (default required string)
Output folder is the directory where all the results of the relion 3d classification are saved. (default required string)
Reference map to be used. (default required string)
Reference mask (optional) . In case reference mask is provided by user . (default none)
initial low pass filter in angstroms. (default 60)
symmetry use for classification. (default C1)
Whether to apply CTF correction or not. (default True)
Whether reference was CTF correction or not. (default False)
Whether or not the first peak should be ignored or not .(default False)
Number of classes to have. (default 1)
Regularized parameter T adjusted. (default 4)
Number of iterations to be performed. (default 25)
The diameter of the mask (A) which use. (default 200)
in case padding with zeros is required. (default True)
to limit the resolution E-step to (A) for fitting (default -1)
Angular sampling interval in degrees. output value can be from 8 to 0 depends on selection of values from 0.1 to 30 degrees (default 7.5)
Offset search range (pix). Probabilities will be calculated only for translations in a circle with this radius in pixels. (default 5)
Offset search step (pix). Translations will be sampled with this step size in pixels. (default 1)
Allow coarser sampling . flag only. (default False)
Number of pooled particles parameter controls how many particles are read together for each thread. (default 3)
Whether to use gpu for computation or not. (default False)
the index value of the GPU to use. (default None)
Submission template for MPI command. In case of running this tool on a cluster, always a submission template. The number of MPI processors and threads in the submission template should be the same as the one specified below in the MPI procs and threads value.(default none)
Submission commmand for cluster (default sbatch)
Since there can be more than one mpirun environment installed on a workstation or on a cluster. It can be sometimes necessary to provide the relion specific mpirun executable. Just type which mpirun -a in a terminal and choose the one which relion requires. (default mpirun)
Similar to the issue of relion mpirun executable, it can be sometime necessary to provide the specific relion polishing executable also. Just type which relion_ctf_refine_mpi and copy the path here. (default relion_ctf_refine_mpi)
The number of MPI processors used for Relion multiprocessing. For training part only one MPI processors is used. In case when running the program on cluster, the MPI processors value should be same as used in the submission template.(default 1)
The number of threads use during the polishing. In case when running the program on cluster, the thread value should be same as used in the submission template.(default 1)

Advanced Parameters

Ref map is on absolute greyscale . Whether the reference map is on absolute greyscale level or not. (default False)
Use fast subsets for large datasets . if selected the first 5 iterations will be done with random subsets of only K*1500 particles. (default False)
Skip image alignment . Whether to skip image alignment or not . (default False)
Perform local angular searches . Whether to perform angular search or not. (default False)
Local angular search range . in case if is set to Yes, value is multiplied by 0.33333. (default 5)
to relax symmetry . (default None)
Use parallel disc I/O. (default True)
depends on the answer for skip padding, if set to No , then pad is 2 , if set to yes then pad is 1. (default False)
Whether to skip the grid or not. (default True)
Pre-read all particles in memory. (default False)
Copy particles to search directory. if –preread_images is set to No and if a directory link is provided in Copy particles to scratch directory (default None)
Combine iterations through disc. Whether to combine iterations or not. (default False)
mrc relocation folder
In case if the mrcs images were moved from original location where they were generated to a new location. Then the user has to provide a path directory link to the new location . (default None)
Do helical reconstruction.(default False)
Helical tube inner diameter (A). (default -1)
Helical tube outer diameter (A). (default -1)
angular search range value in degrees for tilt. (default 15)
angular search range value in degrees for psi. (default 10)
angular search range value in degrees for rot. (default -1)
Range factor of local averaging
Local averaging of orientations and translations will be performed within a range of +/- this value * the box size.(default 1.5)
Tilt prior will not change during the optimization. (default True)
Whether to apply helical symmetry or not . (default False)
Number of unique asymmetrical units in each segment box. (default 1)
Initial twist (deg) set to positive value if it is a right-handed helix. (default 0)
Initial rise (A) set to positivie value .(default 0)
Central Z length (%) for information from the central part of the box is used for search and imposing helical symmetry in real space. (default 30)
Peform local searches of helical twist and rise within given range . (default False)
Miniumum value for twist search (deg). Set it to a positive value if it is a right-handed helix. (default 0)
Maxiumum value for twist search (deg). (default 0)
Need to set manually set if the default value (deg) does not guarantee convergence. (default 0)
Rise search minimum value (A) . Set is to a positive value in angstorms. (default 0)
Rise search maxiumum value (A). (default 0)
Rise search initial step (A). Need to set manually set if the default value does not guarantee convergence. (default 0)

Output star file.
: 3dclassified stack. (still in test phase)
Using sphire2relion tool , the bdb stack is converted to star file so that it can be used in relion. The star file is saved in BDB2STAR folder.
Since the input to the tool is Post refiner directory, the tool can automatically create the necessary file in PostProcess folder which is necessary to provide for ctf refinement.

To run it properly on cluster. Do the following task before running in case if you are running from MPI dortmund. These settings can be different if you are using it outside.

module unload sphire (unload the module sphire) 

module load sphire/clem/Polishing_SPHIRE_v1.2 or sphire/clr/Polishing_SPHIRE_v1.2 (this has to be done only in case if you have a different installation then the default one, since this tool is still not released, the git branch is different). 

module load relion

Then go to the directory where you have all the data folders. Like Meridien , Post Refiner, ISAC etc etc. It is recommended to start SPHIRE in the folder structure where all the output folders are present e.g Post refinenment output folder, motioncorr output folder , ISAC substack output folder.




Developer Notes

Apply relion 3D classification using SPHIRE GUI.

Author / Maintainer

Adnan Ali





See also


Beta:: Under evaluation and testing. Please let us know if there are any bugs.


pipeline/meridien/sp_relion_3dclassifi.txt · Last modified: 2021/03/16 11:33 by aali