OnionModel

sans.models.OnionModel

Provide functionality for a C extension model

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

class sans.models.OnionModel.OnionModel

Bases: COnionModel, sans.models.BaseComponent.BaseComponent

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

n_shells = 1.0 scale = 1.0 rad_core0 = 200.0 [A] sld_core0 = 1e-06 [1/A^(2)] sld_solv = 6.4e-06 [1/A^(2)] background = 0.0 [1/cm] sld_out_shell1 = 2e-06 [1/A^(2)] sld_out_shell2 = 2.5e-06 [1/A^(2)] sld_out_shell3 = 3e-06 [1/A^(2)] sld_out_shell4 = 3.5e-06 [1/A^(2)] sld_out_shell5 = 4e-06 [1/A^(2)] sld_out_shell6 = 4.5e-06 [1/A^(2)] sld_out_shell7 = 5e-06 [1/A^(2)] sld_out_shell8 = 5.5e-06 [1/A^(2)] sld_out_shell9 = 6e-06 [1/A^(2)] sld_out_shell10 = 6.2e-06 [1/A^(2)] sld_in_shell1 = 1.7e-06 [1/A^(2)] sld_in_shell2 = 2.2e-06 [1/A^(2)] sld_in_shell3 = 2.7e-06 [1/A^(2)] sld_in_shell4 = 3.2e-06 [1/A^(2)] sld_in_shell5 = 3.7e-06 [1/A^(2)] sld_in_shell6 = 4.2e-06 [1/A^(2)] sld_in_shell7 = 4.7e-06 [1/A^(2)] sld_in_shell8 = 5.2e-06 [1/A^(2)] sld_in_shell9 = 5.7e-06 [1/A^(2)] sld_in_shell10 = 6e-06 [1/A^(2)] A_shell1 = 1.0 A_shell2 = 1.0 A_shell3 = 1.0 A_shell4 = 1.0 A_shell5 = 1.0 A_shell6 = 1.0 A_shell7 = 1.0 A_shell8 = 1.0 A_shell9 = 1.0 A_shell10 = 1.0 thick_shell1 = 50.0 [A] thick_shell2 = 50.0 [A] thick_shell3 = 50.0 [A] thick_shell4 = 50.0 [A] thick_shell5 = 50.0 [A] thick_shell6 = 50.0 [A] thick_shell7 = 50.0 [A] thick_shell8 = 50.0 [A] thick_shell9 = 50.0 [A] thick_shell10 = 50.0 [A] func_shell1 = 2.0 func_shell2 = 2.0 func_shell3 = 2.0 func_shell4 = 2.0 func_shell5 = 2.0 func_shell6 = 2.0 func_shell7 = 2.0 func_shell8 = 2.0 func_shell9 = 2.0 func_shell10 = 2.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.OnionModel.create_OnionModel()