BinaryHSModel

sans.models.BinaryHSModel

Provide functionality for a C extension model

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

class sans.models.BinaryHSModel.BinaryHSModel

Bases: CBinaryHSModel, sans.models.BaseComponent.BaseComponent

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

l_radius = 100.0 [A] s_radius = 25.0 [A] vol_frac_ls = 0.1 vol_frac_ss = 0.2 ls_sld = 3.5e-06 [1/A^(2)] ss_sld = 5e-07 [1/A^(2)] solvent_sld = 6.36e-06 [1/A^(2)] background = 0.001 [1/cm]

__add__()

__class__

alias of type

__delattr__

x.__delattr__(‘name’) <==> del x.name

__dict__ = <dictproxy object at 0x01EB1730>

__div__()

__getattribute__

x.__getattribute__(‘name’) <==> x.name

__hash__

x.__hash__() <==> hash(x)

__init__()

Initialization

__module__ = 'sans.models.BinaryHSModel'

__mul__()

static __new__(S, ...) → a new object with type S, a subtype of T

__reduce__()

helper for pickle

__reduce_ex__()

Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of c model.

__repr__

x.__repr__() <==> repr(x)

__setattr__

x.__setattr__(‘name’, value) <==> x.name = value

__setstate__()

restore the state of a model from pickle

__str__

x.__str__() <==> str(x)

__sub__()

__weakref__

list of weak references to the object (if defined)

_clone()

Internal utility function to copy the internal data members to a fresh copy.

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()

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()

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()

getParamWithToken()

is_fittable()

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()

Evaluate the model

Parameters:x – input q, or [q,phi] Returns:scattering function P(q)

runXY()

Evaluate the model in cartesian coordinates

Parameters:x – input q, or [qx, qy] Returns:scattering function P(q)

setParam()

Set the value of a model parameter

Parameters:

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

setParamWithToken()

set_dispersion()

Set the dispersion object for a model parameter

Parameters:

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

sans.models.BinaryHSModel.create_BinaryHSModel()