OSDN Git Service

Document Added
[eos/optional.git] / doc / SmallTools / mrcImageAutoRotationCorrelation.html
index 592e7cc..383873f 100644 (file)
@@ -8,49 +8,62 @@
 <PRE>
 Usage: mrcImageAutoRotationCorrelation
 Options:
-    [-i[nput]            In                  (NULL      )] :Essential :Input: testImage [mrcImage]
-    [-r[eference]        Ref                 (NULL      )] :Essential :Input: refImage [mrcImage]
-    [-nRot1              nRot1               (1         )] :Optional  :Rotation number of Ref for Rot1: Def 1
-    [-nRot2              nRot2               (1         )] :Optional  :Rotation number of Ref for Rot2: Def 1
-    [-nRot3              nRot3               (1         )] :Optional  :Rotation number of Ref for Rot3: Def 1
-    [-dRot1              dRot1               (1.0       )] :Optional  :Delta Angle [Degree] of Ref for Rot1; Def.: 360/nRot1
-    [-dRot2              dRot2               (1.0       )] :Optional  :Delta Angle [Degree] of Ref for Rot2; Def.: 360/nRot2
-    [-dRot3              dRot3               (1.0       )] :Optional  :Delta Angle [Degree] of Ref for Rot3; Def.: 360/nRot3
-    [-startRot1          startRot1           (0.0       )] :Optional  :Start Angle [Degree] of Ref for Rot1; Def.: 0
-    [-startRot2          startRot2           (0.0       )] :Optional  :Start Angle [Degree] of Ref for Rot2; Def.: 0
-    [-startRot3          startRot3           (0.0       )] :Optional  :Start Angle [Degree] of Ref for Rot3; Def.: 0
-    [-StackOrder         StackOrder          (0         )] :Optional  :Stack Order for Stacked 2D of references, refer to attention
-    [-o[utput]           Out                 (NULL      )] :Optional  :Output: Parameter [mrcImage-format]
-    [-O[utput]           OutASC              (stdout    )] :Optional  :Output: Parameter [ASCII] 
-    [-cor[relation]      corFile             (NULL      )] :Optional  :Correation Map at Maximum (Linear) [mrcImage-format]
-    [-cor[relation]2     corFile2            (NULL      )] :Optional  :Correation Map2 at Maximum (Set Mode Correlation)[mrcImage-format]
-    [-cor[relation]All   corAllFile          (NULL      )] :Optional  :Correation Map with All Rotation [mrcImage-format]
-    [-fit[tedToRef]      fitFile             (NULL      )] :Optional  :Output: rotatedImage at Maximum(Linear Correlation) [mrcImage]
-    [-fit[tedToRef]2     fitFile2            (NULL      )] :Optional  :Output: rotatedImage at Maximum(Set Correlation mode) [mrcImage]
-    [-RefineMode         RefineMode          (0         )] :Optional  :RefinementStep: Linear:0 or SetMode:1
-    [-n[umber]           Rot                 (36        )] :Optional  :Input: Rotation around the vertical axis against image plane: dRot = 360/n [degree]
-    [-range              minAngle            (-5.0      )maxAngle            (5.0       )] :Optional  :Input: SearchRange: Rotation around the vertical axis against image plane 
-    [-refStep1           refStep1            (1         )] :Optional  :SearchStep for Ref: Each Image along Rot1
-    [-refStep2           refStep2            (1         )] :Optional  :SearchStep for Ref: Each Image along Rot2
-    [-refStep3           refStep3            (1         )] :Optional  :SearchStep for Ref: Each Image along Rot3
-    [-nRot1Area          nRot1AreaMin        (-360      )nRot1AreaMax        (360       )nRot1AreaStep       (25        )] :Optional  :number of Ref for Rot1
-    [-nRot2Area          nRot2AreaMin        (-360      )nRot2AreaMax        (360       )nRot2AreaStep       (25        )] :Optional  :number of Ref for Rot2
-    [-nRot3Area          nRot3AreaMin        (-360      )nRot3AreaMax        (360       )nRot3AreaStep       (25        )] :Optional  :number of Ref for Rot3
-    [-Iter[ation]        Iter                (1         )] :Optional  :Iteration for Rotation around the vertical axis against image plane
-    [-Method             Method              (0         )] :Optional  :0: Correlation, 1: SSDA
-    [-s[earchRegion]     sminx               (0         )sminy               (0         )smaxx               (0/*N.x-1*/)smaxy               (0/*N.y-1*/)] :Optional  :SearchRegion [pixel]: used in lmrcImageAutoRotationCorrelation 
-    [-Shift              ] :Optional  :Image Shift, when in > ref
-    [-RepeatX            RepeatX             (27.3      )] :Optional  :RepeatX[A]
-    [-RepeatXDelta       RepeatXDelta        (5         )] :Optional  :RepeatXDelta[A]
-    [-RepeatY            RepeatY             (27.3      )] :Optional  :RepeatY[A]
-    [-RepeatYDelta       RepeatYDelta        (5         )] :Optional  :RepeatYDelta[A]
-    [-Xshift             ] :Optional  :X-Shift Only
-    [-NoShift            ] :Optional  :No-Shift
-    [-Log                Log                 (stdout    )] :Optional  :Output: LogFile
-    [-pvm                pvm                 (1         )] :Optional  :Task Number
-    [-pvmList            pvmList             (NULL      )] :Optional  :ConfigurationFile
-    [-c[onfig]           configFile          (NULL      )] :Optional  :ConfigurationFile
-    [-m[ode]             mode                (0         )] :Optional  :Mode
+    [-i[nput]            In                  (NULL      ).as(inFile              ) ] :Essential :Input: testImage [mrcImage]
+    [-r[eference]        Ref                 (NULL      ).as(inFile              ) ] :Essential :Input: refImage [mrcImage]
+    [-nRot1              nRot1               (1         ).as(Integer             ) ] :Optional  :Rotation number of Ref for Rot1: Def 1
+    [-nRot2              nRot2               (1         ).as(Integer             ) ] :Optional  :Rotation number of Ref for Rot2: Def 1
+    [-nRot3              nRot3               (1         ).as(Integer             ) ] :Optional  :Rotation number of Ref for Rot3: Def 1
+    [-dRot1              dRot1               (1.0       ).as(Real                ) ] :Optional  :Delta Angle [Degree] of Ref for Rot1; Def.: 360/nRot1
+    [-dRot2              dRot2               (1.0       ).as(Real                ) ] :Optional  :Delta Angle [Degree] of Ref for Rot2; Def.: 360/nRot2
+    [-dRot3              dRot3               (1.0       ).as(Real                ) ] :Optional  :Delta Angle [Degree] of Ref for Rot3; Def.: 360/nRot3
+    [-startRot1          startRot1           (0.0       ).as(Real                ) ] :Optional  :Start Angle [Degree] of Ref for Rot1; Def.: 0
+    [-startRot2          startRot2           (0.0       ).as(Real                ) ] :Optional  :Start Angle [Degree] of Ref for Rot2; Def.: 0
+    [-startRot3          startRot3           (0.0       ).as(Real                ) ] :Optional  :Start Angle [Degree] of Ref for Rot3; Def.: 0
+    [-StackOrder         StackOrder          (0         ).as(Integer             ) ] :Optional  :Stack Order for Stacked 2D of references, refer to attention
+    [-o[utput]           Out                 (NULL      ).as(outFile             ) ] :Optional  :Output: Parameter [mrcImage-format]
+    [-O[utput]           OutASC              (stdout    ).as(outFile             ) ] :Optional  :Output: Parameter [ASCII] 
+    [-cor[relation]      corFile             (NULL      ).as(outFile             ) ] :Optional  :Correation Map at Maximum (Linear) [mrcImage-format]
+    [-cor[relation]2     corFile2            (NULL      ).as(outFile             ) ] :Optional  :Correation Map2 at Maximum (Set Mode Correlation)[mrcImage-format]
+    [-cor[relation]All   corAllFile          (NULL      ).as(outFile             ) ] :Optional  :Correation Map with All Rotation [mrcImage-format]
+    [-fit[tedToRef]      fitFile             (NULL      ).as(outFile             ) ] :Optional  :Output: rotatedImage at Maximum(Linear Correlation) [mrcImage]
+    [-fit[tedToRef]2     fitFile2            (NULL      ).as(outFile             ) ] :Optional  :Output: rotatedImage at Maximum(Set Correlation mode) [mrcImage]
+    [-RefineMode         RefineMode          (0         ).as(Integer             ) ] :Optional  :RefinementStep: Linear:0 or SetMode:1
+    [-n[umber]           Rot                 (36        ).as(Real                ) ] :Optional  :Input: Rotation around the vertical axis against image plane: dRot = 360/n [degree]
+    [-range              minAngle            (-5.0      ).as(Real                ) 
+                         maxAngle            (5.0       ).as(Real                ) ] :Optional  :Input: SearchRange: Rotation around the vertical axis against image plane 
+    [-refStep1           refStep1            (1         ).as(Integer             ) ] :Optional  :SearchStep for Ref: Each Image along Rot1
+    [-refStep2           refStep2            (1         ).as(Integer             ) ] :Optional  :SearchStep for Ref: Each Image along Rot2
+    [-refStep3           refStep3            (1         ).as(Integer             ) ] :Optional  :SearchStep for Ref: Each Image along Rot3
+    [-nRot1Area          nRot1AreaMin        (-360      ).as(Real                ) 
+                         nRot1AreaMax        (360       ).as(Real                ) 
+                         nRot1AreaStep       (25        ).as(Real                ) ] :Optional  :number of Ref for Rot1
+    [-nRot2Area          nRot2AreaMin        (-360      ).as(Real                ) 
+                         nRot2AreaMax        (360       ).as(Real                ) 
+                         nRot2AreaStep       (25        ).as(Real                ) ] :Optional  :number of Ref for Rot2
+    [-nRot3Area          nRot3AreaMin        (-360      ).as(Real                ) 
+                         nRot3AreaMax        (360       ).as(Real                ) 
+                         nRot3AreaStep       (25        ).as(Real                ) ] :Optional  :number of Ref for Rot3
+    [-MagRange           MagRangeMin         (1.0       ).as(Real                ) 
+                         MagRangeMax         (1.0       ).as(Real                ) 
+                         MagRangeStep        (0.1       ).as(Real                ) ] :Optional  :Magnification Range
+    [-Iter[ation]        Iter                (1         ).as(Integer             ) ] :Optional  :Iteration for Rotation around the vertical axis against image plane
+    [-Method             Method              (0         ).as(Integer             ) ] :Optional  :0: Correlation, 1: SSDA
+    [-s[earchRegion]     sminx               (0         ).as(Real                ) 
+                         sminy               (0         ).as(Real                ) 
+                         smaxx               (0/*N.x-1*/).as(Real                ) 
+                         smaxy               (0/*N.y-1*/).as(Real                ) ] :Optional  :SearchRegion [pixel]: used in lmrcImageAutoRotationCorrelation 
+    [-Shift                                                                        ] :Optional  :Image Shift, when in > ref
+    [-RepeatX            RepeatX             (27.3      ).as(Real                ) ] :Optional  :RepeatX[A]
+    [-RepeatXDelta       RepeatXDelta        (5         ).as(Real                ) ] :Optional  :RepeatXDelta[A]
+    [-RepeatY            RepeatY             (27.3      ).as(Real                ) ] :Optional  :RepeatY[A]
+    [-RepeatYDelta       RepeatYDelta        (5         ).as(Real                ) ] :Optional  :RepeatYDelta[A]
+    [-Xshift                                                                       ] :Optional  :X-Shift Only
+    [-NoShift                                                                      ] :Optional  :No-Shift
+    [-Log                Log                 (stdout    ).as(outFile             ) ] :Optional  :Output: LogFile
+    [-pvm                pvm                 (1         ).as(Integer             ) ] :Optional  :Task Number
+    [-pvmList            pvmList             (NULL      ).as(inFile              ) ] :Optional  :ConfigurationFile
+    [-c[onfig]           configFile          (NULL      ).as(inFile              ) ] :Optional  :ConfigurationFile
+    [-m[ode]             mode                (0         ).as(Integer             ) ] :Optional  :Mode
 ----- Mode -----
 When, -Method 0(Default:Correlation)
 0: Normal Correlation FxG*