BinaryOpModel

class sherpa.models.model.BinaryOpModel(lhs, rhs, op, opstr)[source] [edit on github]

Bases: sherpa.models.model.CompositeModel, sherpa.models.model.RegriddableModel

Combine two model expressions.

Parameters
  • lhs (Model instance) – The left-hand sides of the expression.

  • rhs (Model instance) – The right-hand sides of the expression.

  • op (function reference) – The ufunc which combines two array values.

  • opstr (str) – The symbol used to represent the operator.

lhs

The left-hand sides of the expression.

Type

Model instance

rhs

The right-hand sides of the expression.

Type

Model instance

op
Type

function reference

See also

UnaryOpModel

Examples

>>> m1 = Gauss1d()
>>> m2 = Polynom1D()
>>> m = BinaryOpModel(m1, m2, numpy.add, '+')

Attributes Summary

ndim

thawedparhardmaxes

The hard maximum values for the thawed parameters.

thawedparhardmins

The hard minimum values for the thawed parameters.

thawedparmaxes

Access to the maximum limits for the thawed parameters

thawedparmins

Access to the minimum limits for the thawed parameters

thawedpars

Access to the thawed parameters of the model

Methods Summary

apply(outer, *otherargs, **otherkwargs)

calc(p, *args, **kwargs)

Evaluate the model on a grid.

get_center()

guess(dep, *args, **kwargs)

Set an initial guess for the parameter values.

regrid(*args, **kwargs)

reset()

Reset the parameter values.

set_center(*args, **kwargs)

startup([cache])

Called before a model may be evaluated multiple times.

teardown()

Called after a model may be evaluated multiple times.

wrapobj(obj)

Attributes Documentation

ndim = None
thawedparhardmaxes

The hard maximum values for the thawed parameters.

thawedparhardmins

The hard minimum values for the thawed parameters.

thawedparmaxes

Access to the maximum limits for the thawed parameters

thawedparmins

Access to the minimum limits for the thawed parameters

thawedpars

Access to the thawed parameters of the model

Methods Documentation

apply(outer, *otherargs, **otherkwargs) [edit on github]
calc(p, *args, **kwargs)[source] [edit on github]

Evaluate the model on a grid.

Parameters
  • p (sequence of numbers) – The parameter values to use. The order matches the pars field.

  • *args – The model grid. The values can be scalar or arrays, and the number depends on the dimensionality of the model and whether it is being evaluated over an integrated grid or at a point (or points).

get_center() [edit on github]
guess(dep, *args, **kwargs) [edit on github]

Set an initial guess for the parameter values.

Attempt to set the parameter values, and ranges, for the model to match the data values. This is intended as a rough guess, so it is expected that the model is only evaluated a small number of times, if at all.

regrid(*args, **kwargs)[source] [edit on github]
reset() [edit on github]

Reset the parameter values.

set_center(*args, **kwargs) [edit on github]
startup(cache=False)[source] [edit on github]

Called before a model may be evaluated multiple times.

Parameters

cache (bool, optional) – Should a cache be used when evaluating the models.

See also

teardown()

teardown()[source] [edit on github]

Called after a model may be evaluated multiple times.

See also

setup()

static wrapobj(obj)[source] [edit on github]