Differences

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

--- pipeline:utilities:sxsummovie [2018/02/16 10:11]
127.0.0.1 external edit
+++ pipeline:utilities:sxsummovie [2018/06/20 13:12]
@@ Line 1: / Line 1: @@
-~~NOTOC~~
-===== sxsummovie =====
-Micrograph movie summation: Sum micrograph movies with SumMovie.
-\\
-===== Usage =====
-Usage in command line
-  sxsummovie.py  summovie_path  input_micrograph_pattern  input_shift_pattern  output_directory  --selection_list=SELECTION_LIST  --nr_frames=nr_frames  --first=FIRST  --last=LAST  --pixel_size=pixel_size  --nr_threads=NR_THREADS  --apply_dose_filter  --voltage=voltage  --exposure_per_frame=exposure_per_frame  --pre_exposure=pre_exposure  --dont_restore_noise
-=== Typical usage ===
-sxsummovie exists only in non-MPI version.
-__Perform summovie without dose filtering__:
-  sxsummovie.py ~/my_app/summovie 'outdir_unblur/corrsum/micrograph_*_frames_sum.mrc' 'outdir_unblur/shift/micrograph_*_frames_shift.txt' outdir_summovie --nr_frames=24 --pixel_size=1.19 --nr_threads=1
-\\
-__Perform summovie without dose filtering and with less frames__:
-  sxsummovie.py ~/my_app/summovie 'outdir_unblur/corrsum/micrograph_*_frames_sum.mrc' 'outdir_unblur/shift/micrograph_*_frames_shift.txt' outdir_summovie --nr_frames=24 --first=3 --last=15 --pixel_size=1.19 --nr_threads=1
-\\
-__Perform summovie with dose filtering and with less frames__:
-  sxsummovie.py ~/my_app/summovie 'outdir_unblur/corrsum/micrograph_*_frames_sum.mrc' 'outdir_unblur/shift/micrograph_*_frames_shift.txt' outdir_summovie --nr_frames=24 --first=3 --last=15 --pixel_size=1.19 --nr_threads=1 --apply_dose_filter --voltage=300 --exposure_per_frame=2 --pre_exposure=0
-\\
-===== Input =====
-=== Main Parameters ===
-  ; summovie_path : summovie executable path: Specify the file path of summovie executable. (This argument is specific to SPHIRE, and not directly used by summovie executable.) (default required string)
-  ; input_micrograph_pattern : Input micrograph path pattern: Specify path pattern of input micrographs with a wild card (*). Use the wild card to indicate the place of variable part of the file names (e.g. serial number, time stamp, and etc). The path pattern must be enclosed by single quotes (') or double quotes ("). (Note: sxgui.py automatically adds single quotes (')). bdb files can not be selected as input micrographs. (This argument is specific to SPHIRE, and not directly used by summovie executable.) (default required string)
-  ; input_shift_pattern : Input shift path pattern: Specify path pattern of input shift files with a wild card (*). Use the wild card to indicate the place of variable part of the file names (e.g. serial number, time stamp, and etc). The path pattern must be enclosed by single quotes (') or double quotes ("). (Note: sxgui.py automatically adds single quotes (')). The substring at the variable part must be same between the associated pair of input micrograph and shift file. (This argument is specific to SPHIRE, and not directly used by summovie executable.) (default required string)
-  ; selection_list : Micrograph selecting list: Specify a name of micrograph selection list text file. The file extension must be '.txt'. If this is not provided, all files matched with the micrograph name pattern will be processed. (This option is specific to SPHIRE, and not directly used by summovie executable.) (default none)
-  ; nr_frames : Number of movie frames: The number of movie frames in each input micrograph. (default 3)
-  ; first : First movie frame: First movie frame for summing. (default 1)
-  ; last : Last movie frame: Last movie frame for summing. (default -1)
-  ; pixel_size : Pixel size [A]: The pixel size of input micrographs. (default required float)
-  ; nr_threads : Number of threads: The number of threads summovie can use. The higher the faster, but it requires larger memory. (default 1)
-\\
-=== Advanced Parameters ===
-  ; apply_dose_filter : Apply dose filter step: Requires voltage, exposure per frame, and pre exposure options. (default False)
-  ; voltage : Microscope voltage [kV]: The acceleration voltage of microscope used for imaging. Effective only when apply_dose_filter option is used. (default 300.0)
-  ; exposure_per_frame : Per frame exposure [e/A^2]: The electron dose per frame in e/A^2. Effective only when apply_dose_filter option is used. (default 2.0)
-  ; pre_exposure : Pre-exposure [e/A^2]: The electron does in e/A^2 used for exposure prior to imaging. Effective only when apply_dose_filter option is used. (default 0.0)
-  ; dont_restore_noise : Do not restore noise power: Do not restore noise power. (default False)
-\\
-===== Output =====
-  ; output_directory : Output directory: The results will be written here. This directory will be created automatically and it must not exist previously. (This argument is specific to SPHIRE, and not directly used by summovie executable.) (default required string)
-\\
-The program automatically creates the following subdirectories in the specified output directory.
-\\ __Without dose-filtering__:
-Sum files will be written to the "corrsum" directory.
-Log files will be written to the "logfiles" directory.
-FRC files will be written to the "frc" directory.
-\\ __With dose-filtering__:
-Dose filtered sum files will be written to the "corrsum_dose_filtered" directory.
-Log files will be written to the "logfiles" directory
-FRC files will be written to the "frc" directory.
-\\
-===== Description =====
-\\
-==== Author / Maintainer ====
-Markus Stabrin
-\\
-==== Keywords ====
-Category 1:: APPLICATIONS
-\\
-==== Files ====
-sxsummovie.py
-\\
-==== See also ====
-\\
-==== Maturity ====
-No bugs known so far.
-\\

User Tools

Site Tools

Differences

Page Tools