doc/SmallTools/mrcImageCorrelation.html

   1 Init Start
   2 <HTML>
   3 <HEAD>
   4 <TITLE>mrcImageCorrelation</TITLE>
   5 </HEAD>
   6 <BODY>
   7 <H1>mrcImageCorrelation</H1>
   8 <H2>Usage</H2>
   9 <PRE>
  10 Usage: mrcImageCorrelation
  11 Options:
  12     [-i[nput]            In                  (NULL      ).as(inFile              ) ] :Essential :InputDataFile
  13     [-o[utput]           Out                 (NULL      ).as(outFile             ) ] :Optional  :OutputDataFile: Correlation Map
  14     [-O[utput]           Out2                (NULL      ).as(outFile             ) ] :Optional  :OutputDataFile: Correlation Map for Refinement
  15     [-r[eference]        Ref                 (NULL      ).as(inFile              ) ] :Essential :ReferenceDataFile
  16     [-cor[relation]Info  OutCor              (stdout    ).as(outFile             ) ] :Optional  :Output: Correlation Info
  17     [-a[verage]          Avg                 (NULL      ).as(outFile             ) ] :Optional  :OutputDataFile: Averaged File
  18     [-s[hit]             Shift               (NULL      ).as(outFile             ) ] :Optional  :OutputDataFile: Shifted InputFile
  19     [-refine             RefineStep          (0.25      ).as(Real                )
  20                          RefineRange         (3.0       ).as(Real                )
  21                          RefineMode          (2         ).as(Integer             ) ] :Optional  :Refinemnet: Step Range[pixelUnit]
  22     [-c[onfig]           configFile          (NULL      ).as(inFile              ) ] :Optional  :ConfigurationFile
  23     [-m[ode]             mode                (0         ).as(Integer             ) ] :Optional  :Mode
  24     [-M[ode2]            mode2               (0         ).as(Integer             ) ] :Optional  :Mode2
  25 ----- Mode:  -m -----
  26 0: Normal Correlation FxG*
  27 1: Phase  Correlation FxG*/     |FxG*|
  28 2: Phase  Correlation FxG*/sqrt(|FxG*|)
  29 3: Normalized Normal Correlation FxG*/|F||G|)
  30 16: (0,0) = 0
  31 Refinement Correlation Map
  32 0: sqrt(Sum |Fi-Gi|^2                 / Sum |Gi|^2)
  33 1:      Sum |Gi||phaseFi - phaseGi|   / Sum |Gi|
  34 2: sqrt(Sum |Gi||phaseFi - phaseGi|^2 / Sum |Gi|  )
  35 ----- Mode2: -M -----
  36 mode 0: Correlation by FFT.  Output is a mrcImage to file.
  37             -a : Averaged image after Shift Transform [pixel unit] and Averaging
  38             -s : Shifted  image after Shift Transform [pixel unit]
  39             -o : Correation Map
  40 mode 1: Correlation by multiplying in normal space.  Output is a real value
  41             Normalized correlation value
  42             No shift transform
  43             No Correlation Map
  44 ----- Refinement:  -refine -----
  45             refineStep[PixelUnit]  : refinement step size
  46             refineRange[PixelUnit] : refinement range
  47             refineMode             : refinement mode
  48             --- search area -----
  49             the position of max correlation +- refineRange / refineStep
  50             Attention: If this option is set, the meaning of -o option is changed to a residual map
  51 </PRE>
  52 </BODY>
  53 </HTML>