source: sasview/sansmodels/src/sans/models/c_extensions/lorentzian.h @ 1aaa579

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 1aaa579 was 96672c0, checked in by Gervaise Alina <gervyh@…>, 16 years ago

code for description modified

  • Property mode set to 100644
File size: 949 bytes
RevLine 
[ae3ce4e]1#if !defined(lorentzian_h)
2#define lorentzian_h
3
4/** Structure definition for Lorentzian parameters.
5 * The Lorentzian is normalized to the 'scale' parameter.
6 * 
7 * f(x)=scale * 1/pi 0.5gamma / [ (x-x_0)^2 + (0.5gamma)^2 ]
8 *
9 * [PYTHONCLASS] = Lorentzian
[96672c0]10 * [DESCRIPTION] = <text>f(x)=scale * 1/pi 0.5gamma / [ (x-x_0)^2 + (0.5gamma)^2 ]</text>
[ae3ce4e]11 */
12typedef struct {
13    /// Scale factor
14    //  [DEFAULT]=scale=1.0
15    double scale;
16    /// Width
17    //  [DEFAULT]=gamma=1.0
18    double gamma;
19    /// Center of the Lorentzian distribution
20    //  [DEFAULT]=center=0.0
21    double center;
22} LorentzianParameters;
23
24/// 1D lorentzian function
25double lorentzian_analytical_1D(LorentzianParameters *pars, double x);
26
27/// 2D lorentzian function
28double lorentzian_analytical_2D(LorentzianParameters *pars, double x, double phi);
29double lorentzian_analytical_2DXY(LorentzianParameters *pars, double x, double y);
30
31#endif
Note: See TracBrowser for help on using the repository browser.