pywr.recorders.RollingWindowParameterRecorder¶
-
class
pywr.recorders.RollingWindowParameterRecorder(model, Parameter param, int window, *args, **kwargs)¶ Records the mean value of a Parameter for the last N timesteps.
-
__init__(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
Methods
__init__(*args, **kwargs)Initialize self.
after(self)aggregated_value(self)before(self)finish(self)is_constraint_violated(self)Returns true if the value from this Recorder violates its constraint bounds.
load(type cls, model, data)register(type cls)reset(self)setup(self)to_dataframe(self)unregister(type cls)values(self)Attributes
agg_funcchildrencommentcomment: unicode
constraint_lower_boundsconstraint_upper_boundsdataepsilonepsilon: ‘double’
ignore_nanignore_nan: ‘bool’
is_constraintReturns true if either upper or lower constraint bounds is defined.
is_double_bounded_constraintReturns true if upper and lower constraint bounds are both defined and not-equal to one another.
is_equality_constraintReturns true if upper and lower constraint bounds are both defined and equal to one another.
is_lower_bounded_constraintReturns true if lower constraint bounds is defined and upper constraint bounds is not.
is_objectiveis_upper_bounded_constraintReturns true if upper constraint bounds is defined and lower constraint bounds is not.
modelnameparameterparentstemporal_agg_funcwindowwindow: ‘int’
-