BaseModel

sans.models.BaseModel

Provide base functionality for all model components

The following has changed since going from BaseComponent to BaseModel:

  • Arithmetic operation between models is no longer supported. It was found to be of little use and not very flexible.
  • Parameters are now stored as Parameter object to provide the necessary extra information like limits, units, etc...
class sans.models.BaseModel.BaseModel

Bases: sans.models.ModelAdaptor.ModelAdaptor

Basic model component

calculate_ER()
clone()

Returns a new object identical to the current object

getParam(name)

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(token, member)
getParamWithToken(name, token, member)
run(x=0)
runXY(x=0)
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)
class sans.models.BaseModel.Parameter(name, value)

Bases: object

Parameter class

sans.models.BaseModel.ParameterProperty

Parameter property allow direct access to the parameter values

Table Of Contents

Previous topic

BaseComponent

Next topic

BCCrystalModel

This Page