Lorentzian

sans.models.Lorentzian

Provide functionality for a C extension model

WARNING:THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY DO NOT MODIFY THIS FILE, MODIFY ..c_extensionslorentzian.h AND RE-RUN THE GENERATOR SCRIPT

class sans.models.Lorentzian.Lorentzian

Bases: CLorentzian, sans.models.BaseComponent.BaseComponent

Class that evaluates a Lorentzian model. This file was auto-generated from ..c_extensionslorentzian.h. Refer to that file and the structure it contains for details of the model. List of default parameters:

scale = 1.0 gamma = 1.0 center = 0.0

calculate_ER()

Calculate the effective radius for P(q)*S(q)

Returns:the value of the effective radius

clone()

Return a identical copy of self

evalDistribution(x=[])

Evaluate the model in cartesian coordinates

Parameters:

• x – input q[], or [qx[], qy[]]

Returns:

scattering function P(q[])

getDispParamList()

Return a list of all available parameters for the model

getParam(name)

Set the value of a model parameter

Parameters:

• name – name of the parameter

getParamList()

Return a list of all available parameters for the model

getParamListWithToken(token, member)

getParamWithToken(name, token, member)

is_fittable(par_name)

Check if a given parameter is fittable or not

Parameters:

• par_name – the parameter name to check

log

Log

params

Parameters

reset

Reset pair correlation

run(x=0.0)

Evaluate the model

Parameters:

• x – input q, or [q,phi]

Returns:

scattering function P(q)

runXY(x=0.0)

Evaluate the model in cartesian coordinates

Parameters:

• x – input q, or [qx, qy]

Returns:

scattering function P(q)

setParam(name, value)

Set the value of a model parameter

Parameters:

• name – name of the parameter
• value – value of the parameter

setParamWithToken(name, value, token, member)

set_dispersion(parameter, dispersion)

Set the dispersion object for a model parameter

Parameters:

• parameter – name of the parameter [string]
• dispersion – dispersion object of type DispersionModel