User Tools

Site Tools


pipeline:sort3d:sx3dvariability

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
pipeline:sort3d:sx3dvariability [2018/08/22 10:31]
fmerino
pipeline:sort3d:sx3dvariability [2019/04/02 10:51]
lusnig [See also]
Line 1: Line 1:
 ~~NOTOC~~ ~~NOTOC~~
  
-===== sx3dvariability =====+===== sp_3dvariability =====
 3D Variability Estimation: Calculate 3D variability using a set of aligned projection images as an input. 3D Variability Estimation: Calculate 3D variability using a set of aligned projection images as an input.
  
Line 9: Line 9:
 Usage in command line Usage in command line
  
-  sx3dvariability.py  prj_stack  --output_dir=DIRECTORY  --var3D=FILE_NAME  --ave3D=FILE_NAME  --img_per_grp=NUM_OF_IMAGES --sym=SYMMETRY  --CTF  --fl=LPF_CUTOFF_FREQ  --aa=LPF_FALLOFF_WIDTH  --symmetrize  --var2D=FILE_NAME  --ave2D=FILE_NAME  --VAR  --no_norm  --npad=PADDING_FACTOR  --decimate=FACTOR  --window=WINDOW_SIZE  --nvec=NUM_OF_EIGENVECTORS  --VERBOSE+  sp_3dvariability.py  prj_stack  --output_dir=DIRECTORY  --var3D=FILE_NAME  --ave3D=FILE_NAME  --img_per_grp=NUM_OF_IMAGES --sym=SYMMETRY  --CTF  --fl=LPF_CUTOFF_FREQ  --aa=LPF_FALLOFF_WIDTH  --symmetrize  --var2D=FILE_NAME  --ave2D=FILE_NAME  --VAR  --no_norm  --npad=PADDING_FACTOR  --decimate=FACTOR  --window=WINDOW_SIZE  --nvec=NUM_OF_EIGENVECTORS  --overhead=OVERHEAD
  
 \\ \\
 ===== Typical usage ===== ===== Typical usage =====
  
-sx3dvariability exists only in MPI version.+sp_3dvariability exists only in MPI version.
  
 For asymmetric structure: For asymmetric structure:
  
-  mpirun -np 64 sx3dvariability.py stack --var3D=var_vol.hdf --ave3D=vol.hdf --img_per_grp=100 --CTF --fl=0.25 --aa=0.1+  mpirun -np 64 sp_3dvariability.py bdb:data --var3D=var_vol.hdf --ave3D=vol.hdf --output_dir=var3d --img_per_grp=100 --CTF 
  
 For structures that have symmetries (e.g. c2): For structures that have symmetries (e.g. c2):
  
-  sx3dvariability.py stack --symmetrize --sym=c2 +  sp_3dvariability.py stack --symmetrize --sym=c2 
-  mpirun -np 64 sx3dvariability.py bdb:sdata --var3D=var_vol.hdf --ave3D=vol.hdf --img_per_grp=100 --sym=c2 --CTF --fl=0.25 --aaf=0.1+  mpirun -np 64 sp_3dvariability.py bdb:sdata --var3D=var_vol.hdf --ave3D=vol.hdf --img_per_grp=100 --sym=c2 --CTF --fl=0.--aa=0.05  --window=300
  
 \\ \\
Line 33: Line 33:
   ; %%--%%var3D : Output 3D variability: Specify a file name to indicate if the program should write the reconstructed 3D variability map to the disk. The 3D volume will contain, for each voxel, a measure of the variability in the dataset. Careful, time consuming! (default none)   ; %%--%%var3D : Output 3D variability: Specify a file name to indicate if the program should write the reconstructed 3D variability map to the disk. The 3D volume will contain, for each voxel, a measure of the variability in the dataset. Careful, time consuming! (default none)
   ; %%--%%ave3D : Output 3D average: Specify a file name to indicate if the program should write the reconstructed 3D average map to the disk. The 3D map will be reconstructed from projections averaged within respective angular neighbourhood. It should be used to assess the resolvability and possible artifacts of the variability map. (default none)   ; %%--%%ave3D : Output 3D average: Specify a file name to indicate if the program should write the reconstructed 3D average map to the disk. The 3D map will be reconstructed from projections averaged within respective angular neighbourhood. It should be used to assess the resolvability and possible artifacts of the variability map. (default none)
-  ; %%--%%img_per_grp : Number of projections: Specify the number of images from the angular neighbourhood that will be used to estimate 2D variance for each projection data. The larger the number the less noisy the estimate, but the lower the resolution. Usage of large number also results in rotational artifacts in variances that will be visible in 3D variability map. (default 10)+  ; %%--%%img_per_grp : Number of projections: Specify the number of images from the angular neighbourhood that will be used to estimate 2D variance for each projection data. The larger the number the less noisy the estimate, but the lower the resolution. Usage of large number also results in rotational artifacts in variances that will be visible in 3D variability map. (default 100)
   ; %%--%%sym : Point-group symmetry: If the structure has symmetry higher than c1, the command requires symmetrization of the dataset, using %%--%%symmetrize option, before computing 3D variability. (default c1)   ; %%--%%sym : Point-group symmetry: If the structure has symmetry higher than c1, the command requires symmetrization of the dataset, using %%--%%symmetrize option, before computing 3D variability. (default c1)
   ; %%--%%CTF : Use CTF correction: If set to true, CTF correction will be applied using the parameters found in the image headers. (default False value reversed in GUI)    ; %%--%%CTF : Use CTF correction: If set to true, CTF correction will be applied using the parameters found in the image headers. (default False value reversed in GUI) 
-  ; %%--%%fl : Low-pass filter frequency [1/Pixel]: Stop-band frequency of the low-pass filter to be applied to the images prior to variability calculation but after decimation. Specify it in absolute frequency (%%>%% 0.0 and %%<=%% 0.5). By default, no filtering. (default 0.0) 
-  ; %%--%%aa : Low-pass filter fall-off [1/Pixel]: Fall-off width of the low-pass filter to be applied to the images prior to variability calculation but after decimation. Specify it in absolute frequency (%%>%% 0.0 and %%<=%% 0.5). 0.01 works in most of cases. Effective only with %%--%%fl %%>%% 0.0 and %%--%%aa %%>%% 0.0 has to be specified. (default 0.0)  
   ; %%--%%symmetrize : Symmetrise input stack: Prepare input stack for handling symmetry. Please skip this preparation step if the structure is asymmetrical (i.e. c1), since it is required only when the structure has internal symmetry. Notice this step can be run with only one CPU and there is no MPI version for it. (default False)   ; %%--%%symmetrize : Symmetrise input stack: Prepare input stack for handling symmetry. Please skip this preparation step if the structure is asymmetrical (i.e. c1), since it is required only when the structure has internal symmetry. Notice this step can be run with only one CPU and there is no MPI version for it. (default False)
 +  ; %%--%%overhead : Python overhead memory: User estimates python overhead memory per CPU. The default value is 0.5 GB per CPU. (default 0.5)
  
 \\ \\
Line 47: Line 46:
   ; %%--%%no_norm : Apply normalization: Indicate if normalization should be applied or not. By default, apply normalization. (default False question reversed in GUI)   ; %%--%%no_norm : Apply normalization: Indicate if normalization should be applied or not. By default, apply normalization. (default False question reversed in GUI)
   ; %%--%%npad : Image padding factor: The number of time to pad the original images. The images will be padded to achieve the original size times this option. (default 2)   ; %%--%%npad : Image padding factor: The number of time to pad the original images. The images will be padded to achieve the original size times this option. (default 2)
-  ; %%--%%decimate : Image decimate factor: Reduce images by this factor and change the pixel size. Specify a non-zero positive float value smaller than 1.0. By default, it does not change size of images. (default 1.0)+  ; %%--%%decimate : Image decimate factor: Reduce images by this factor and change the pixel size. Specify a non-zero positive float value smaller than 1.0. By default, it does not change size of images. (default 0.25) 
 +  ; %%--%%fl : Low-pass filter frequency : Stop-band frequency of the low-pass filter to be applied to the images prior to variability calculation but after decimation. Specify it in absolute frequency (%%>%% 0.0 and %%<=%% 0.5). By default, no filtering. (default 0.0) 
 +  ; %%--%%aa : Low-pass filter fall-off  : Fall-off width of the low-pass filter to be applied to the images prior to variability calculation but after decimation. Specify it in absolute frequency (%%>%% 0.0 and %%<=%% 0.5). 0.01 works in most of cases. Effective only with %%--%%fl %%>%% 0.0 and %%--%%aa %%>%% 0.0 has to be specified. (default 0.0) : %%--%%fl!=0.0
   ; %%--%%window : Target image size [Pixels]: Window (or clip) images using the specified size without changing pixel size. It is relative to the orignal window size. The target window size cannot be larger than the orignal image size. By default, use the original particle image size. (default 0)   ; %%--%%window : Target image size [Pixels]: Window (or clip) images using the specified size without changing pixel size. It is relative to the orignal window size. The target window size cannot be larger than the orignal image size. By default, use the original particle image size. (default 0)
   ; %%--%%nvec : Number of eigenvectors: By default, no PCA will be calculated. (default 0)   ; %%--%%nvec : Number of eigenvectors: By default, no PCA will be calculated. (default 0)
-  ; %%--%%VERBOSE : Verbose: Print long output which is useful for debugging. (default False) 
  
 \\ \\
Line 57: Line 57:
 \\ \\
 ===== Description ===== ===== Description =====
-The program calculates the variability observed in a collection of image projections. Structures with symmetry require preparing data before calculating the variability. The data preparation step would symmetrise the data and output a bdb:sdata for variability calculation. sx3dvariability.py can be slow.+The program calculates the variability observed in a collection of image projections. Structures with symmetry require preparing data before calculating the variability. The data preparation step would symmetrise the data and output a bdb:sdata for variability calculation. sp_3dvariability.py can be slow.
  
 \\ \\
Line 78: Line 78:
 \\ \\
 ==== Files ==== ==== Files ====
-sparx/bin/sx3dvariability.py+sparx/bin/sp_3dvariability.py
  
 \\ \\
 ==== See also ==== ==== See also ====
-[[pipeline:utilities:sxheader|sxheader]], [[pipeline:sort3d:sxsort3d_depth|sxsort3d_depth]], [[pipeline:localres:sxlocres|sxlocres]]+[[pipeline:utilities:sxheader|sp_header]], [[pipeline:sort3d:sxsort3d_depth|sp_sort3d_depth]], [[pipeline:localres:sxlocres|sp_locres]]
  
 \\ \\
Line 93: Line 93:
  
 \\ \\
 +
pipeline/sort3d/sx3dvariability.txt · Last modified: 2019/04/02 10:51 by lusnig