Skip to content

Commit

Permalink
Issue 502 visually distinguish forecasts from measurements (#503)
Browse files Browse the repository at this point in the history 
Create a visual distinction between forecasts/schedules (dashed lines) and measurements (solid lines). It also expands the tooltip with timing info regarding the forecast/schedule horizon or measurement lag.


* Add vega formatter for timedeltas

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Add JSON column with belief horizons

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Separate lines for measurements (solid) and forecasts (dashed)

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Add human-readable horizon to tooltip

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Changelog entry

Signed-off-by: F.N. Claessen <felix@seita.nl>

* flake8

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Support formatting negative timedeltas

Signed-off-by: F.N. Claessen <felix@seita.nl>

* clarify the meaning of timedeltaFormat parameters

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Speed up asset chart loading by not looking up the timerange of sensors to show

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Use bin instead of extra layers with filters, so a legend can be shown

Signed-off-by: F.N. Claessen <felix@seita.nl>

* black, flake8

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Remove dev code

Signed-off-by: F.N. Claessen <felix@seita.nl>

* flake8

Signed-off-by: F.N. Claessen <felix@seita.nl>

Signed-off-by: F.N. Claessen <felix@seita.nl>
  • Loading branch information
@Flix6x
Flix6x committed Oct 13, 2022
1 parent f6ad242 commit 6b9d882
Show file tree
Hide file tree
Showing 4 changed files with 78 additions and 22 deletions.
1 change: 1 addition & 0 deletions documentation/changelog.rst
View file
Expand Up @@ -9,6 +9,7 @@ New features
-------------

* Hit the replay button to replay what happened, available on the sensor and asset pages [see `PR #463 <http://www.github.com/FlexMeasures/flexmeasures/pull/463>`_]
* Visually distinguish forecasts/schedules (dashed lines) from measurements (solid lines), and expand the tooltip with timing info regarding the forecast/schedule horizon or measurement lag [see `PR #503 <http://www.github.com/FlexMeasures/flexmeasures/pull/503>`_]
* The asset page also allows to show sensor data from other assets that belong to the same account [see `PR #500 <http://www.github.com/FlexMeasures/flexmeasures/pull/500>`_]
* Improved import of time series data from CSV file: 1) drop duplicate records with warning, and 2) allow configuring which column contains explicit recording times for each data point (use case: import forecasts) [see `PR #501 <http://www.github.com/FlexMeasures/flexmeasures/pull/501>`_]

Expand Down
64 changes: 49 additions & 15 deletions flexmeasures/data/models/charts/belief_charts.py
View file
Expand Up @@ -99,34 +99,68 @@ def chart_for_multiple_sensors(
}
shared_tooltip = [
FIELD_DEFINITIONS["full_date"],
dict(
field="belief_horizon",
type="quantitative",
title="Horizon",
format=["d", 4],
formatType="timedeltaFormat",
),
{
**event_value_field_definition,
**dict(title=f"{capitalize(sensor.sensor_type)}"),
},
FIELD_DEFINITIONS["source_name"],
FIELD_DEFINITIONS["source_model"],
]
line_layer = {
"mark": {
"type": "line",
"interpolate": "step-after"
if sensor.event_resolution != timedelta(0)
else "linear",
"clip": True,
},
"encoding": {
"x": event_start_field_definition,
"y": event_value_field_definition,
"color": FIELD_DEFINITIONS["source_name"],
"strokeDash": {
"field": "belief_horizon",
"type": "quantitative",
"bin": {
# Divide belief horizons into 2 bins by setting a very large bin size.
# The bins should be defined as follows: ex ante (>0) and ex post (<=0),
# but because the bin anchor is included in the ex-ante bin,
# and 0 belief horizons should be attributed to the ex-post bin,
# (and belief horizons are given with 1 ms precision,)
# the bin anchor is set at 1 ms before knowledge time to obtain: ex ante (>=1) and ex post (<1).
"anchor": 1,
"step": 8640000000000000, # JS max ms for a Date object (NB 10 times less than Python max ms)
# "step": timedelta.max.total_seconds() * 10**2,
},
"legend": {
# Belief horizons binned as 1 ms contain ex-ante beliefs; the other bin contains ex-post beliefs
"labelExpr": "datum.label > 0 ? 'ex ante' : 'ex post'",
"title": "Recorded",
},
"scale": {
# Positive belief horizons are clamped to 1, negative belief horizons are clamped to 0
"domain": [1, 0],
# belief horizons >= 1 ms get a dashed line, belief horizons < 1 ms get a solid line
"range": [[1, 2], [1, 0]],
},
},
"detail": FIELD_DEFINITIONS["source"],
},
}
sensor_specs = {
"title": capitalize(sensor.name)
if sensor.name != sensor.sensor_type
else None,
"transform": [{"filter": f"datum.sensor.id == {sensor.id}"}],
"layer": [
{
"mark": {
"type": "line",
"interpolate": "step-after"
if sensor.event_resolution != timedelta(0)
else "linear",
"clip": True,
},
"encoding": {
"x": event_start_field_definition,
"y": event_value_field_definition,
"color": FIELD_DEFINITIONS["source_name"],
"detail": FIELD_DEFINITIONS["source"],
},
},
line_layer,
{
"mark": {
"type": "rect",
Expand Down
1 change: 1 addition & 0 deletions flexmeasures/data/models/generic_assets.py
View file
Expand Up @@ -394,6 +394,7 @@ def search_beliefs(
for sensor, bdf in bdf_dict.items():
if bdf.event_resolution > timedelta(0):
bdf = bdf.resample_events(minimum_non_zero_resolution)
bdf["belief_horizon"] = bdf.belief_horizons.to_numpy()
df = simplify_index(
bdf,
index_levels_to_columns=["source"]
Expand Down
34 changes: 27 additions & 7 deletions flexmeasures/ui/static/js/flexmeasures.js
View file
Expand Up @@ -311,13 +311,33 @@ function submit_sensor_type() {
$("#sensor_type-form").attr("action", empty_location).submit();
}

/** Tooltips: Register custom formatter for quantities incl. units
Usage:
{
'format': [<d3-format>, <sensor unit>],
'formatType': 'quantityWithUnitFormat'
}
*/
/** Tooltips: Register custom formatters
*
* - Quantities incl. units
* Usage:
* {
* 'format': [<d3-format>, <sensor unit>],
* 'formatType': 'quantityWithUnitFormat'
* }
* - Timedeltas measured in human-readable quantities (usually not milliseconds)
* Usage:
* {
* 'format': [<d3-format>, <breakpoint>],
* 'formatType': 'timedeltaFormat'
* }
* <d3-format> is a d3 format identifier, e.g. 'd' for decimal notation, rounded to integer.
* See https://github.com/d3/d3-format for more details.
* <breakpoint> is a scalar that decides the breakpoint from one duration unit to the next larger unit.
* For example, a breakpoint of 4 means we format 4 days as '4 days', but 3.96 days as '95 hours'.
*/
vega.expressionFunction('quantityWithUnitFormat', function(datum, params) {
return d3.format(params[0])(datum) + " " + params[1];
});
vega.expressionFunction('timedeltaFormat', function(timedelta, params) {
return (Math.abs(timedelta) > 1000 * 60 * 60 * 24 * 365.2425 * params[1] ? d3.format(params[0])(timedelta / (1000 * 60 * 60 * 24 * 365.2425)) + " years"
: Math.abs(timedelta) > 1000 * 60 * 60 * 24 * params[1] ? d3.format(params[0])(timedelta / (1000 * 60 * 60 * 24)) + " days"
: Math.abs(timedelta) > 1000 * 60 * 60 * params[1] ? d3.format(params[0])(timedelta / (1000 * 60 * 60)) + " hours"
: Math.abs(timedelta) > 1000 * 60 * params[1] ? d3.format(params[0])(timedelta / (1000 * 60)) + " minutes"
: Math.abs(timedelta) > 1000 * params[1] ? d3.format(params[0])(timedelta / 1000) + " seconds"
: d3.format(params[0])(timedelta) + " milliseconds");
});

0 comments on commit 6b9d882

Please sign in to comment.