Differences

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

--- pipeline:utilities:e2display [2016/11/29 19:50]
msaur created
+++ pipeline:utilities:e2display [2019/04/02 09:15]
lusnig
@@ Line 1: / Line 1: @@
 ~~NOTOC~~
-====== e2display ======
+===== e2display =====
 Display Data: Displays images, volumes, or 1D plots.
+\\
 ===== Usage =====
-Usage in command line:
+Usage in command line
   e2display.py  input_data_list  --classmx=CLASSMX  --classes=CLASSES  --pdb=PDB  --singleimage  --plot  --plot3  --fullrange  --newwidget  --ppid=PPID  --verbose=n
+\\
 ===== Typical usage =====
-  * Browser window with more flexible functionality
+e2display exists in non-MPI version.
+The program can be executed in several different modes:
+\\ __1. Browser window with more flexible functionality:__
   e2display.py
-  * Display images
+\\ __2. Display only one image:__
-  e2display.py input_image1 input_image2 ...
+  e2display.py input_image
-e2display exists in non-MPI version.
+\\ __3. Display several images:__
+  e2display.py input_image1 input_image2 ...
+\\
 ===== Input =====
+=== Main Parameters ===
+  ; input_data_list : Input files: List of input images, volumes, plots. Wild cards (e.g *) can be used to select a list of files. Not recommended when the list is too large. (default none)
-  ;input_data_list : Input files - List of input images, volumes, plots. Wild cards (e.g *) can be used to select a list of files. Not recommended when the list is too large. (default none)
+\\
+=== Advanced Parameters ===
+  ; %%--%%classmx : Show particles from a class: Shows particles in one class defined in a classification matrix. The options requires <classmx>,<#>. (default none)
+  ; %%--%%classes : Show class-averages associated with particles: Shows particles associated class averages. Requires <rawptcl>,<classmx>. (default none)
+  ; %%--%%pdb : Show PDB structure: Show PDB structure. (default none)
+  ; %%--%%singleimage : Single image view: Display a stack in a single image view. (default False)
+  ; %%--%%plot : Plot 2D: Data file(s) should be plotted rather than displayed in 2D. (default False)
+  ; %%--%%plot3 : Plot 3D: Data file(s) should be plotted rather than displayed in 3D. (default False)
+  ; %%--%%fullrange : Use full range of pixel values: Instead of default auto-contrast, use full range of pixel values for the display of particles stacks and 2D images. (default False)
+  ; %%--%%newwidget : Use new 3D widget: Highly recommended. (default False)
+  ; %%--%%ppid : Set PPID: Set PPID of the process. (default -2)
+  ; %%--%%verbose : Verbose: Accepted values 0-9. (default 0)
-  ;classmx : Show particles from a class - Shows particles in one class defined in a classification matrix. The options requires <classmx>,<#>. (default none)
+\\
-  ;classes : show class-averages associated with particles:Shows particles associated class averages. Requires <rawptcl>,<classmx>. (default none)
+===== Output =====
-  ;pdb : Show PDB structure: (default none)
-  ;singleimage : Single image view: Displays a stack in a single image view: (default False)
-  ;plot : Plot 2D: Data file(s) should be plotted rather than displayed in 2D. (default False)
-  ;plot3 : Plot 3D: Data file(s) should be plotted rather than displayed in 3D. (default False)
-  ;fullrange :  Skip auto-contrast: Disables the auto contrast for the display of particles stacks and 2D images. (default False)
-  ;newwidget : Use new 3D widget: Highly recommended. (default False)
-  ;ppid : Set PPID: Set PPID of the process. (default -2)
-  ;verbose : Verbose: Accepted values 0-9. (default 0)
+\\
 ===== Description =====
-e2display is a flexible program to display a wide variety of data types. The options listed above are the ones used by SPHIRE. For a description of e2display as a standalone application, please visit its [[http://blake.bcm.edu/emanwiki/EMAN2/Programs/e2display | EMAN2 wiki page]]
+\\
+==== Method ====
+\\
+==== Reference ====
+\\
+==== Developer Notes ====
+\\
 ==== Author / Maintainer ====
 EMAN2 Group
+\\
 ==== Keywords ====
-category 1:: APPLICATIONS
+Category 1:: APPLICATIONS
+\\
 ==== Files ====
-e2display.py
+programs/e2display.py
+\\
+==== See also ====
+\\
+==== Maturity ====
+Stable:: Works for most people, has been tested; test cases/examples available.
+\\
+==== Bugs ====
+There are no known bugs so far.
-==== Known Bugs ====
+\\
-None.

User Tools

Site Tools

Differences

Page Tools