specparam.modes.ParamDefinition

class specparam.modes.ParamDefinition(params)

Defines a parameter definition for a fit mode.

Parameters:

paramsOrderedDict

Parameter information, in which:

keys should be the name of the parameters values should have the description of each parameter the order should match the function definition

__init__(params)

Initialize a parameter definition.

Methods

__init__(params)	Initialize a parameter definition.
print([description, concise])	Print out the fit mode parameters.

Attributes

descriptions	Define property attribute for parameter descriptions.
indices	Define property attribute for parameter indices.
labels	Define property attribute for parameter labels.
n_params	Define property attribute for the number of parameters.

property descriptions

Define property attribute for parameter descriptions.

property indices

Define property attribute for parameter indices.

property labels

Define property attribute for parameter labels.

property n_params

Define property attribute for the number of parameters.

print(description=False, concise=False)

Print out the fit mode parameters.

Parameters:

descriptionbool, optional, default: False

Whether to print out a description of the fit mode parameters.

concisebool, optional, default: False

Whether to print a concise version of the report.

Examples using specparam.modes.ParamDefinition

Custom Modes

Custom Modes