User Tools

Site Tools

This version is outdated by a newer approved version.DiffThis version (2020/05/29 15:28) was approved by shaikh.

This is an old revision of the document!


Separate Into Classes : Separates stacks of particle images into stacks for each class and evaluates results.


Usage in command line: input_class_avgs input_image_stack output_directory --align_isac_dir=isac_or_beautifier_dir --filtrad=filter_radius --apix=pixel_size --shrink=shrink_factor --ctf=ctf_mode --nvec=number_of_eigenimages --pca_radius=radius --chains_radius=radius --chains_exe=spchains_executable --applyparams=centering_mode --write_centered --debug --imgformat=image_format --verbosity=verbosity_level

Typical usage

The purpose of is to:

: write particle-membership lists for each class
: write separate stacks for each class, 
: optionally low-pass filter and/or downsample the images, and
: optionally compute eigenimages (basis images) for each class

1. Standard usage: create separate stacks for each class: input_class_avgs input_image_stack output_directory 

2. Apply a low-pass filter to the image stacks: input_class_avgs input_image_stack output_directory --filt=filter_radius --apix=pixel_size

Filter radius is in units of Angstroms. If –apix is not specified, program will assume units of pixels^-1.

3. Downsample output image stack: input_class_avgs input_image_stack output_directory --shrink=shrink_factor

4. Apply ISAC alignments to particles: input_class_avgs input_image_stack output_directory --align_isac_dir=isac_or_beautifier_directory

Alignments used by ISAC or beautification will be applied to the particles. In addition, the average and variance for each map will be written.

5. Compute eigenimages (basis images) for each class: input_class_avgs input_image_stack output_directory --align_isac_dir=isac_directory --nvec=number_of_eigenimages --pca_radius=radius

In addition to the average and variance, the requested number of eigenimages will be computed also. If –pca_radius is not provided, the whole image will be used to compute the eigenimages.

6. Apply centering to each class as determined by input_class_avgs input_image_stack output_directory --align_isac_dir=isac_directory --write_centered --applyparams=centering_mode

If you ran, you can also apply those centering parameters to the individual particles. The –write_centered flag will write out the particles; omitting the flag will simply write out the alignment parameters without applying them. The options for –applyparams are 'intshifts' for integer shifts and no rotation (i.e., no interpolation) and 'combined' (rotation and shifts).


Main Parameters

Set of 2D class averages, with particle-membership information in header. (default required string)
Filtered, aligned particles of TcdA1 corresponding to class #9 below
Particle image stack. (default required string)
Directory where outputs will be written. (default required string)
Gaussian low-pass filter radius, Angstroms if apix specified below, else pixels^-1. (default None)
Angstroms per pixel, might be downsampled already by ISAC2. (default None)
Downsampling factor, e.g., 6 → 1/6 original size. (default None)
If applying alignments, directory for ISAC output (default None)
Number of eigenimages to compute. (default None)
Radius (pixels) to use for computation of eigenimages. (default None)
Applies CTF correction: 'flip' for phase-flipping, 'wiener' for Wiener filter. (default None)

Advanced Parameters

Controls how much information to write to screen. (default 1)
Runs internally to order input class averages. (default None)
Path for if not the default. (default None)
Format of optional output aligned-imaged stacks. (default .mrcs)
Tests –applyparams=intshifts by applying rotation and integer shifts separately and computing average. (default False)


Class-to-particle lookup table, one file for all classes
For each class (from left to right): average, variance, and first 5 eigenimages
List of particles for each class, one file per class
Virtual stacks of particles for each class
(Optional) Virtual stacks of filtered particles for each class
(Optional) Particle alignment parameters, one file per class
(Optional) Montage of class averages and variances
(Optional) Montage of class averages, variances, and eigenimages




Developer Notes

: Should allow filter types other than Gaussian low-pass

Author / Maintainer

Tapu Shaikh





See also


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


There are no known bugs so far.

pipeline/utilities/sp_eval_isac.1590587132.txt.gz · Last modified: 2020/05/27 15:45 by shaikh