MultiplicationModel

sans.models.MultiplicationModel

class sans.models.MultiplicationModel.MultiplicationModel

Bases: sans.models.BaseComponent.BaseComponent

Use for P(Q)*S(Q); function call must be in the order of P(Q) and then S(Q): The model parameters are combined from both models, P(Q) and S(Q), except 1) ‘effect_radius’ of S(Q) which will be calculated from P(Q) via calculate_ER(), and 2) ‘scale’ in P model which is synchronized w/ volfraction in S then P*S is multiplied by a new param, ‘scale_factor’. The polydispersion is applicable only to P(Q), not to S(Q). Note: P(Q) refers to ‘form factor’ model while S(Q) does to ‘structure factor’.

__add__()

__div__()

__init__()

__module__ = 'sans.models.MultiplicationModel'

__mul__()

__str__()

Returns:string representatio

__sub__()

_clone()

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

_setParamHelper()

Helper function to setparam

_set_details()

Concatenate details of the two models to create this model details

_set_dispersion()

combined the two models dispersions Polydispersion should not be applied to s_model

_set_effect_radius()

Set effective radius to S(Q) model

_set_fixed_params()

fill the self.fixed list with the p_model fixed list

_set_params()

Concatenate the parameters of the two models to create this model parameters

_set_scale_factor()

Set scale=volfraction to P model

calculate_ER()

clone()

Returns a new object identical to the current object

evalDistribution()

Evaluate the model in cartesian coordinates @param x: input q[], or [qx[], qy[]] @return: scattering function P(q[])

fill_description()

Fill the description for P(Q)*S(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()

getProfile()

Get SLD profile of p_model if exists

: return: (r, beta) where r is a list of radius of the transition points

beta is a list of the corresponding SLD values

: Note: This works only for func_shell# = 2 (exp function).

is_fittable()

Check if a given parameter is fittable or not

Parameters:par_name – the parameter name to check

run()

Evaluate the model @param x: input q-value (float or [float, float] as [r, theta]) @return: (scattering function value)

runXY()

Evaluate the model @param x: input q-value (float or [float, float] as [qx, qy]) @return: scattering function value

setParam()

Set the value of a model parameter

@param name: name of the parameter @param value: value of the parameter

setParamWithToken()

set_dispersion()

Set the dispersion object for a model parameter @param parameter: name of the parameter [string] @dispersion: dispersion object of type DispersionModel