pred_lines¶
Class attribute.
-
Graphics.
pred_lines
¶ Structure that holds the prediction line objects. Query this structure with power indices. The power indices must have the following order:
pred_lines[var_type, var_name, i, k]
where
var_type
refers to_x
,_u
,_z
,_tvp
,_p
,_aux
var_name
refers to the user-defined names in thedo_mpc.model.Model
- Use
i
to index vector valued variables (choose 0 for scalars). - Use
k
to select the k-th scenario (for robust MPC). Note thek=0
is the nominal case.
Note that (e.g.)
pred_lines['_x']
will return all lines for all states andpred_lines.full
can be used to retrieve all line objects.This property can be used to query and configure specific lines in the current graphic.
Example:
# Update properties for all lines: for line_i in graphics.pred_lines.full: line_i.set_linewidth(2) line_i.set_alpha(0.5)
An extensive list of all line properties can be found here.
Parameters: powerind (tuple) – Tuple of indices (power indices) to obtain the desired line obects Returns: List of line objects. Return type: list
This page is auto-generated. Page source is not available on Github.