NewCylinderModel

sans.models.NewCylinderModel

This software was developed by the University of Tennessee as part of the Distributed Data Analysis of Neutron Scattering Experiments (DANSE) project funded by the US National Science Foundation.

If you use DANSE applications to do scientific research that leads to publication, we ask that you acknowledge the use of the software with the following sentence:

“This work benefited from DANSE software developed under NSF award DMR-0520547.”

copyright 2008, University of Tennessee

class sans.models.NewCylinderModel.CylinderModel

Bases: CCylinderModel, sans.models.BaseModel.BaseModel

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

scale = 1.0 radius = 20.0 A length = 400.0 A contrast = 3e-006 A-2 background = 0.0 cm-1 cyl_theta = 1.0 rad cyl_phi = 1.0 rad

__add__()

__call__()

Evaluate the model. Equivalent to runXY(x)

Parameters:x – input value Returns:value of the model

__class__

alias of type

__delattr__

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

__dict__ = <dictproxy object at 0x0279BE50>

__div__()

__getattribute__

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

__hash__

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

__init__()

Initialization

__module__ = 'sans.models.NewCylinderModel'

__mul__()

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

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__

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

__setattr__

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

__str__

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

__sub__()

__weakref__

list of weak references to the object (if defined)

calculate_ER()

Evaluate the model at a given Q or Q, phi

clone()

Return a identical copy of self

dispersion

Dispersion parameters

evalDistribution()

Evaluate the model at a given Q or Qx, Qy vector

getParam()

Set the value of a model parameter

Parameters:

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

getParamList()

Return a list of all available parameters for the model

getParamListWithToken()

getParamWithToken()

log

Log

name = 'BaseModel'

params

Parameters

reset()

Reset pair correlation

run()

Evaluate the model @param x: input q, or [q,phi] @return: scattering function P(q)

runXY()

Evaluate the model in cartesian coordinates @param x: input q, or [qx, qy] @return: 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 @param parameter: name of the parameter [string] @dispersion: dispersion object of type DispersionModel