specparam.sim.params.update_sim_ap_params¶
- specparam.sim.params.update_sim_ap_params(sim_params, delta, field=None)[source]¶
Update the aperiodic parameter definition in a SimParams object.
- Parameters:
- sim_paramsSimParams
Object storing the current parameter definition.
- deltafloat or list of float
Value(s) by which to update the parameters.
- field{‘offset’, ‘knee’, ‘exponent’} or list of string
Field of the aperiodic parameter(s) to update.
- Returns:
- new_sim_paramsSimParams
Updated object storing the new parameter definition.
- Raises:
- InconsistentDataError
If the input parameters and update values are inconsistent.