Changes between Version 5 and Version 6 of API

Timestamp:

Oct 4, 2013, 2:21:51 PM (11 years ago)

Author:

jkaspar

Comment:

--

API

@@ -17 +17 @@
 == Coulomb and Coulomb-interference ==
 
+The code related to the Coulomb amplitude and the Coulomb-hadronic interference is grouped in the `CoulombInterference` class.
+
+The choice of the [[FormFactors|form factor parametrisation]] is made by `ffType` data member (possibilities are given by the `FFType` enum). The methods `FF_e(t)`, `FF_m(t)` and `FF_sq(t)` return the electric, magnetic and square of the effective form factor.
+
+The amplitude due to Coulomb, hadronic or both interactions can be obtained from the `Amp(t)` method. The type of the amplitude is chosen via the `mode` data member (choices given by the `CIMode` enum).
 
 
 == Generator class ==
 
+The `Generator` class implements a Monte-Carlo generator of elastic nucleon-nucleon scattering events according to a given cumulative distribution function (can be built by `ElegentTDistributionSampler` program). The constructor takes these parameters:
+{{{
+        Generator(file, path, t_min, t_max, verbosity)
+}}}
+where `file` refers to a ROOT file with the cumulative distribution function. `path` gives the path of the distribution within the file. `t_min` and `t_max` can be used to constrain the t-range of the generated events. `verbosity` sets the verbosity level.
+
+After creation of a `Generator` instance, its `Init` method shall be called to load and prepare all necessary data.
+
+Finally, a random event in HepMC format can be generated as follows:
+{{{
+                GenEvent* gEv = new GenEvent();
+                gEv->set_event_number(...);
+                generator.Generate(gEv);
+}}}