Home > Scripts > Models > voigt.m

iFit/voigt

PURPOSE ^

y = voigt(p, x, [y]) : Voigt function

SYNOPSIS ^

function y=voigt(varargin)

DESCRIPTION ^

 y = voigt(p, x, [y]) : Voigt function

   iFunc/voigt Voigt fitting function, including Bose factor.
     The Width parameters of the Gaussian and Lorentzian are the Half Widths.

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

 Reference: http://en.wikipedia.org/wiki/Voigt_profile

 input:  p: Voigt model parameters (double)
            p = [ Amplitude Centre Width_Gauss Width_Lorz 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=voigt([1 0 1 1], -10:10); or plot(voigt);

 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