Param

class sherpa.astro.io.xstable.Param(name: str, initial: float, delta: float, hardmin: float, hardmax: float, softmin: float | None = None, softmax: float | None = None, values: list[float] = <factory>, loginterp: bool = False)[source] [edit on github]

Bases: BaseParam

Represent an interpolated parameter.

Attributes Summary

loginterp

Are the values logarithmically interpolated (True) or linearly (False).

softmax

The "soft" maximum.

softmin

The "soft" minimum.

values

The parameter values used to create the model spectra.

name

The parameter name.

initial

The default value for the parameter.

delta

The delta value for fitting.

hardmin

The minimum value for the parameter.

hardmax

The maximum value for the parameter.

Attributes Documentation

loginterp: bool = False

Are the values logarithmically interpolated (True) or linearly (False).

Defaults to linear interpolation.

softmax: float | None = None

The “soft” maximum. Defaults to hardmax if not given.

softmin: float | None = None

The “soft” minimum. Defaults to hardmin if not given..

values: list[float]

The parameter values used to create the model spectra.

Is is required that they range from hardmin to hardmax and are in monotonically increasing order (so it can not be an empty list).

name: str

The parameter name.

This must be unique and ideally a valid attribute name in Python, although the latter is not enforced.

initial: float

The default value for the parameter.

delta: float

The delta value for fitting.

If negative then the parameter defaults to being frozen. Sherpa does not use this value (other than checking the sign) but XSPEC does.

hardmin: float

The minimum value for the parameter.

hardmax: float

The maximum value for the parameter.