StressModelBase#

class StressModelBase(name, tmin, tmax, rfunc=None, up=True, gain_scale_factor=1.0)[source]#

StressModel Base class called by each StressModel object.

Parameters
  • name (str) –

  • tmin (TimestampType) –

  • tmax (TimestampType) –

  • rfunc (Optional[RFunc]) –

  • up (bool) –

  • gain_scale_factor (float) –

name#

Name of this stressmodel object. Used as prefix for the parameters.

Type

str

parameters#

The DataFrame containing the parameters.

Type

pandas.DataFrame

Attributes#

nparam

Methods#

__init__

get_nsplit

Determine in how many time series the contribution can be split.

get_parameters

Get parameters and return as array.

get_settings

Method to obtain the settings of the stresses.

get_stress

Returns the stress(es) of the time series object as a pandas DataFrame.

set_init_parameters

Set the initial parameters (back) to their default values.

to_dict

Method to export the stress model object.

update_stress

Method to update the settings of the all stresses in the stress model.