Document density-fit cross-correlation in .mdp options
authorChristian Blau <cblau@gwdg.de>
Tue, 25 Feb 2020 09:25:02 +0000 (10:25 +0100)
committerChristian Blau <cblau@gwdg.de>
Tue, 25 Feb 2020 09:25:02 +0000 (10:25 +0100)
Add missing documentation about cross-correlation as
similarity measure for density-guided simulations.

Though documented in the reference manual, it was until now
not mentioned in the .mdp options.

Change-Id: I2a5a13ca6fb0a15e8c2ff1cba6a6edbe0182053d

docs/user-guide/mdp-options.rst

index f44286dbfb1fcdc9e1acf0a544d71cbd4708faf9..d68588f6cfb8a266175f6b7401ee53e4061ebd69 100644 (file)
@@ -3240,6 +3240,11 @@ electron-microscopy experiments. (See the `reference manual`_ for details)
       between reference density and simulated density as similarity measure.
       Negative density values are ignored.
 
+   .. mdp-value:: cross-correlation
+
+      Uses the Pearson correlation coefficient between reference density and
+      simulated density as similarity measure.
+
 .. mdp:: density-guided-simulation-atom-spreading-weight
 
    (unity) Determines the multiplication factor for the Gaussian kernel when