Function: lorentzian

Home

List of PyCrysFML08 Dictionaries

List of PyCrysFML08 Functions

USE

lorentzian returns the value of the lorentzian function:

f = (1 /pi) * (0.5 * fwhm) / (x**2 + (0.5*fwhm)**2)

r = lorentzian(x : float,fwhm : float)

Variable	Type	Description
x	float	Value at which the function is evaluated.
fwhm	float	Full width at half maximum; fwhm
r	tuple	The tuple returned by the function. r[0] : int, error code. If non-zero, an error has occurred. r[1] : str, error message. r[2]: float, value of the function at x.

Variable

Type

Description

float

Value at which the function is evaluated.

fwhm

float

Full width at half maximum; fwhm

tuple

The tuple returned by the function.

r[0] : int, error code. If non-zero, an error has occurred.

r[1] : str, error message.

r[2]: float, value of the function at x.