ReflModel

sans.models.ReflModel

Provide functionality for a C extension model

WARNING:THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY DO NOT MODIFY THIS FILE, MODIFY ..c_extensions

efl.h

AND RE-RUN THE GENERATOR SCRIPT

class sans.models.ReflModel.ReflModel

Bases: CReflModel, sans.models.BaseComponent.BaseComponent

Class that evaluates a ReflModel model. This file was auto-generated from ..c_extensions

efl.h.

Refer to that file and the structure it contains for details of the model. List of default parameters:

n_layers = 1.0 scale = 1.0 thick_inter0 = 1.0 [A] func_inter0 = 0.0 sld_bottom0 = 2.07e-06 [1/A^(2)] sld_medium = 1e-06 [1/A^(2)] background = 0.0 sld_flat1 = 4e-06 [1/A^(2)] sld_flat2 = 3.5e-06 [1/A^(2)] sld_flat3 = 4e-06 [1/A^(2)] sld_flat4 = 3.5e-06 [1/A^(2)] sld_flat5 = 4e-06 [1/A^(2)] sld_flat6 = 3.5e-06 [1/A^(2)] sld_flat7 = 4e-06 [1/A^(2)] sld_flat8 = 3.5e-06 [1/A^(2)] sld_flat9 = 4e-06 [1/A^(2)] sld_flat10 = 3.5e-06 [1/A^(2)] thick_inter1 = 1.0 [A] thick_inter2 = 1.0 [A] thick_inter3 = 1.0 [A] thick_inter4 = 1.0 [A] thick_inter5 = 1.0 [A] thick_inter6 = 1.0 [A] thick_inter7 = 1.0 [A] thick_inter8 = 1.0 [A] thick_inter9 = 1.0 [A] thick_inter10 = 1.0 [A] thick_flat1 = 10.0 [A] thick_flat2 = 100.0 [A] thick_flat3 = 100.0 [A] thick_flat4 = 100.0 [A] thick_flat5 = 100.0 [A] thick_flat6 = 100.0 [A] thick_flat7 = 100.0 [A] thick_flat8 = 100.0 [A] thick_flat9 = 100.0 [A] thick_flat10 = 100.0 [A] func_inter1 = 0.0 func_inter2 = 0.0 func_inter3 = 0.0 func_inter4 = 0.0 func_inter5 = 0.0 func_inter6 = 0.0 func_inter7 = 0.0 func_inter8 = 0.0 func_inter9 = 0.0 func_inter10 = 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

dispersion

Dispersion parameters

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

sans.models.ReflModel.create_ReflModel()