Home > Scripts > Models > lorz.m

iFit/lorz

PURPOSE ^

y = lorz(p, x, [y]) : Lorentzian

SYNOPSIS ^

function y=lorz(varargin)

DESCRIPTION ^

 y = lorz(p, x, [y]) : Lorentzian

   iFunc/lorz Lorentzian fitting function
     y = p(1) ./ (1+ ((x-p(2)).^2/p(3)^2) ) + p(4);

 lorz(width)          creates a model with a specified width
 lorz([ parameters ]) creates a model with specified model parameters

 input:  p: Lorentzian model parameters (double)
            p = [ Amplitude Centre HalfWidth BackGround ]
          or 'guess'
         x: axis (double)
         y: when values are given and p='guess', a guess of the parameters is performed (double)
 output: y: model value
 ex:     y=lorz([1 0 1 1], -10:10); or plot(lorz)

 Version: Mar. 22, 2017
 See also iFunc, iFunc/fits, iFunc/plot
 (c) E.Farhi, ILL. License: EUPL.

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Wed 22-Mar-2017 09:13:30 by m2html © 2005. iFit (c) E.Farhi/ILL EUPL 1.1