Poly_GaussCoil

sans.models.Poly_GaussCoil

Provide functionality for a C extension model

WARNING:THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY DO NOT MODIFY THIS FILE, MODIFY ..c_extensionspolygausscoil.h AND RE-RUN THE GENERATOR SCRIPT
class sans.models.Poly_GaussCoil.Poly_GaussCoil

Bases: CPoly_GaussCoil, sans.models.BaseComponent.BaseComponent

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

scale = 1.0 rg = 60.0 [A] poly_m = 2.0 [Mw/Mn] background = 0.001 [1/cm]
__add__()
__class__

alias of type

__delattr__

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

__dict__ = <dictproxy object at 0x0231B270>
__div__()
__getattribute__

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

__hash__

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

__init__()

Initialization

__module__ = 'sans.models.Poly_GaussCoil'
__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.Poly_GaussCoil.create_Poly_GaussCoil()

Table Of Contents

Previous topic

PolymerExclVolume

Next topic

PorodModel

This Page