pywr.parameters.OffsetParameter

class pywr.parameters.OffsetParameter(model, parameter, offset=0.0, lower_bounds=0.0, upper_bounds=np.inf, *args, **kwargs)

Parameter that offsets another Parameter by a constant value.

This class is a more efficient version of AggregatedParameter where a single Parameter is offset by a constant value.

Parameters:

parameterParameter

The parameter to compare with the float.

offsetfloat (default=0.0)

The offset to apply to the value returned by parameter.

lower_boundsfloat (default=0.0)

The lower bounds of the offset when used during optimisation.

upper_boundsfloat (default=np.inf)

The upper bounds of the offset when used during optimisation.

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)
after(self)
before(self)
finish(self)
get_all_values(self)
get_constant_value(self)	Return a constant value.
get_double_lower_bounds(self)
get_double_upper_bounds(self)
get_double_variables(self)
get_integer_lower_bounds(self)
get_integer_upper_bounds(self)
get_integer_variables(self)
get_value(self, ScenarioIndex scenario_index)
load(cls, model, data)
register(cls)
reset(self)
set_double_variables(self, double[)
set_integer_variables(self, int[)
setup(self)
unregister(cls)
value(self, Timestep ts, ...)

Attributes

children
comment	comment: str
double_size	double_size: 'int'
integer_size	integer_size: 'int'
is_constant
is_variable	is_variable: 'bool'
model
name
offset	offset: 'double'
parameter	parameter: pywr.parameters._parameters.Parameter
parents
size
tags	tags: dict