specparam.modes.modes.Modes

class specparam.modes.modes.Modes(aperiodic, periodic, model=None)

Defines a set of fit modes.

Parameters:

aperiodicstr or Mode

Aperiodic mode.

periodicstr or Mode

Periodic mode.

modelSpectralModel, optional

The model object this object is linked to, to provide access to other attributes.

__init__(aperiodic, periodic, model=None)

Initialize modes.

Methods

__init__(aperiodic, periodic[, model])	Initialize modes.
get_modes()	Get the modes definition.
get_params([param_type])	Get a description of the parameters, across modes.
print([description, concise])	Print out the current fit modes.

get_modes()

Get the modes definition.

Returns:

modes_defModelModes

Modes definition.

get_params(param_type='list')

Get a description of the parameters, across modes.

Parameters:

param_type{‘list’, ‘dict’}

The output type for the parameters.

Returns:

paramsdict

Parameter definition for the set of modes. Each key is a component label. Each set of values if the parameters, with type specified by ‘param_type’.

print(description=False, concise=False)

Print out the current fit modes.

Parameters:

descriptionbool, optional, default: False

Whether to print out a description with current fit modes.

concisebool, optional, default: False

Whether to print a concise version of the report.

Examples using specparam.modes.modes.Modes

Model Sub-Objects

Model Sub-Objects