View Javadoc
1   package org.opentrafficsim.draw.graphs;
2   
3   import java.util.ArrayList;
4   import java.util.Arrays;
5   import java.util.LinkedHashMap;
6   import java.util.LinkedHashSet;
7   import java.util.List;
8   import java.util.Map;
9   import java.util.Set;
10  
11  import org.djunits.unit.SpeedUnit;
12  import org.djunits.value.vdouble.scalar.Duration;
13  import org.djunits.value.vdouble.scalar.Length;
14  import org.djunits.value.vdouble.scalar.Speed;
15  import org.djunits.value.vdouble.scalar.Time;
16  import org.djutils.exceptions.Throw;
17  import org.djutils.logger.CategoryLogger;
18  import org.opentrafficsim.draw.egtf.Converter;
19  import org.opentrafficsim.draw.egtf.DataSource;
20  import org.opentrafficsim.draw.egtf.DataStream;
21  import org.opentrafficsim.draw.egtf.Egtf;
22  import org.opentrafficsim.draw.egtf.EgtfEvent;
23  import org.opentrafficsim.draw.egtf.EgtfListener;
24  import org.opentrafficsim.draw.egtf.Filter;
25  import org.opentrafficsim.draw.egtf.Quantity;
26  import org.opentrafficsim.draw.egtf.typed.TypedQuantity;
27  import org.opentrafficsim.draw.graphs.GraphPath.Section;
28  import org.opentrafficsim.kpi.interfaces.LaneData;
29  import org.opentrafficsim.kpi.sampling.SamplerData;
30  import org.opentrafficsim.kpi.sampling.Trajectory;
31  import org.opentrafficsim.kpi.sampling.Trajectory.SpaceTimeView;
32  import org.opentrafficsim.kpi.sampling.TrajectoryGroup;
33  
34  /**
35   * Class that contains data for contour plots. One data source can be shared between contour plots, in which case the
36   * granularity, path, sampler, update interval, and whether the data is smoothed (EGTF) are equal between the plots.
37   * <p>
38   * By default the source contains traveled time and traveled distance per cell.
39   * <p>
40   * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
41   * BSD-style license. See <a href="https://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
42   * </p>
43   * @author <a href="https://github.com/averbraeck">Alexander Verbraeck</a>
44   * @author <a href="https://github.com/peter-knoppers">Peter Knoppers</a>
45   * @author <a href="https://github.com/wjschakel">Wouter Schakel</a>
46   */
47  public class ContourDataSource
48  {
49  
50      // *************************
51      // *** GLOBAL PROPERTIES ***
52      // *************************
53  
54      /** Space granularity values. */
55      protected static final double[] DEFAULT_SPACE_GRANULARITIES = {10, 20, 50, 100, 200, 500, 1000};
56  
57      /** Index of the initial space granularity. */
58      protected static final int DEFAULT_SPACE_GRANULARITY_INDEX = 3;
59  
60      /** Time granularity values. */
61      protected static final double[] DEFAULT_TIME_GRANULARITIES = {1, 2, 5, 10, 20, 30, 60, 120, 300, 600};
62  
63      /** Index of the initial time granularity. */
64      protected static final int DEFAULT_TIME_GRANULARITY_INDEX = 3;
65  
66      /** Initial lower bound for the time scale. */
67      protected static final Time DEFAULT_LOWER_TIME_BOUND = Time.ZERO;
68  
69      /**
70       * Total kernel size relative to sigma and tau. This factor is determined through -log(1 - p) with p ~= 99%. This means that
71       * the cumulative exponential distribution has 99% at 5 times sigma or tau. Note that due to a coordinate change in the
72       * Adaptive Smoothing Method, the actual cumulative distribution is slightly different. Hence, this is just a heuristic.
73       */
74      private static final int KERNEL_FACTOR = 5;
75  
76      /** Spatial kernel size. Larger value may be used when using a large granularity. */
77      private static final Length SIGMA = Length.instantiateSI(300);
78  
79      /** Temporal kernel size. Larger value may be used when using a large granularity. */
80      private static final Duration TAU = Duration.instantiateSI(30);
81  
82      /** Maximum free flow propagation speed. */
83      private static final Speed MAX_C_FREE = new Speed(80.0, SpeedUnit.KM_PER_HOUR);
84  
85      /** Factor on speed limit to determine vc, the flip over speed between congestion and free flow. */
86      private static final double VC_FACRTOR = 0.8;
87  
88      /** Congestion propagation speed. */
89      private static final Speed C_CONG = new Speed(-18.0, SpeedUnit.KM_PER_HOUR);
90  
91      /** Delta v, speed transition region around threshold. */
92      private static final Speed DELTA_V = new Speed(10.0, SpeedUnit.KM_PER_HOUR);
93  
94      // *****************************
95      // *** CONTEXTUAL PROPERTIES ***
96      // *****************************
97  
98      /** Sampler data. */
99      private final SamplerData<?> samplerData;
100 
101     /** Update interval. */
102     private final Duration updateInterval;
103 
104     /** Delay so critical future events have occurred, e.g. GTU's next move's to extend trajectories. */
105     private final Duration delay;
106 
107     /** Path. */
108     private final GraphPath<? extends LaneData<?>> path;
109 
110     /** Space axis. */
111     final Axis spaceAxis;
112 
113     /** Time axis. */
114     final Axis timeAxis;
115 
116     /** Registered plots. */
117     private Set<AbstractContourPlot<?>> plots = new LinkedHashSet<>();
118 
119     // *****************
120     // *** PLOT DATA ***
121     // *****************
122 
123     /** Total distance traveled per cell. */
124     private float[][] distance;
125 
126     /** Total time traveled per cell. */
127     private float[][] time;
128 
129     /** Data of other types. */
130     private final Map<ContourDataType<?, ?>, float[][]> additionalData = new LinkedHashMap<>();
131 
132     // ****************************
133     // *** SMOOTHING PROPERTIES ***
134     // ****************************
135 
136     /** Free flow propagation speed. */
137     private Speed cFree;
138 
139     /** Flip-over speed between congestion and free flow. */
140     private Speed vc;
141 
142     /** Smoothing filter. */
143     private Egtf egtf;
144 
145     /** Data stream for speed. */
146     private DataStream<Speed> speedStream;
147 
148     /** Data stream for travel time. */
149     private DataStream<Duration> travelTimeStream;
150 
151     /** Data stream for travel distance. */
152     private DataStream<Length> travelDistanceStream;
153 
154     /** Quantity for travel time. */
155     private final Quantity<Duration, double[][]> travelTimeQuantity = new Quantity<>("travel time", Converter.SI);
156 
157     /** Quantity for travel distance. */
158     private final Quantity<Length, double[][]> travelDistanceQuantity = new Quantity<>("travel distance", Converter.SI);
159 
160     /** Data streams for any additional data. */
161     private Map<ContourDataType<?, ?>, DataStream<?>> additionalStreams = new LinkedHashMap<>();
162 
163     // *****************************
164     // *** CONTINUITY PROPERTIES ***
165     // *****************************
166 
167     /** Updater for update times. */
168     private final GraphUpdater<Time> graphUpdater;
169 
170     /** Whether any command since or during the last update asks for a complete redo. */
171     private boolean redo = true;
172 
173     /** Time up to which to determine data. This is a multiple of the update interval, which is now, or recent on a redo. */
174     private Time toTime;
175 
176     /** Number of items that are ready. To return NaN values if not ready, and for operations between consecutive updates. */
177     private int readyItems = -1;
178 
179     /** Selected space granularity, to be set and taken on the next update. */
180     private Double desiredSpaceGranularity = null;
181 
182     /** Selected time granularity, to be set and taken on the next update. */
183     private Double desiredTimeGranularity = null;
184 
185     /** Whether to smooth data. */
186     private boolean smooth = false;
187 
188     // ********************
189     // *** CONSTRUCTORS ***
190     // ********************
191 
192     /**
193      * Constructor using default granularities.
194      * @param samplerData sampler data
195      * @param path path
196      */
197     public ContourDataSource(final SamplerData<?> samplerData, final GraphPath<? extends LaneData<?>> path)
198     {
199         this(samplerData, Duration.instantiateSI(1.0), path, DEFAULT_SPACE_GRANULARITIES, DEFAULT_SPACE_GRANULARITY_INDEX,
200                 DEFAULT_TIME_GRANULARITIES, DEFAULT_TIME_GRANULARITY_INDEX, DEFAULT_LOWER_TIME_BOUND,
201                 AbstractPlot.DEFAULT_INITIAL_UPPER_TIME_BOUND);
202     }
203 
204     /**
205      * Constructor for non-default input.
206      * @param samplerData sampler data
207      * @param delay delay so critical future events have occurred, e.g. GTU's next move's to extend trajectories
208      * @param path path
209      * @param spaceGranularity granularity options for space dimension
210      * @param initSpaceIndex initial selected space granularity
211      * @param timeGranularity granularity options for time dimension
212      * @param initTimeIndex initial selected time granularity
213      * @param start start time
214      * @param initialEnd initial end time of plots, will be expanded if simulation time exceeds it
215      */
216     @SuppressWarnings("parameternumber")
217     public ContourDataSource(final SamplerData<?> samplerData, final Duration delay,
218             final GraphPath<? extends LaneData<?>> path, final double[] spaceGranularity, final int initSpaceIndex,
219             final double[] timeGranularity, final int initTimeIndex, final Time start, final Time initialEnd)
220     {
221         this.samplerData = samplerData;
222         this.updateInterval = Duration.instantiateSI(timeGranularity[initTimeIndex]);
223         this.delay = delay;
224         this.path = path;
225         this.spaceAxis = new Axis(0.0, path.getTotalLength().si, spaceGranularity[initSpaceIndex], spaceGranularity);
226         this.timeAxis = new Axis(start.si, initialEnd.si, timeGranularity[initTimeIndex], timeGranularity);
227 
228         // get length-weighted mean speed limit from path to determine cFree and Vc for smoothing
229         this.cFree = Speed.min(path.getSpeedLimit(), MAX_C_FREE);
230         this.vc = Speed.min(path.getSpeedLimit().times(VC_FACRTOR), MAX_C_FREE);
231 
232         // setup updater to do the actual work in another thread
233         this.graphUpdater = new GraphUpdater<>("Contour Data Source worker", Thread.currentThread(), (t) -> update(t));
234     }
235 
236     // ************************************
237     // *** PLOT INTERFACING AND GETTERS ***
238     // ************************************
239 
240     /**
241      * Returns the sampler data for an {@code AbstractContourPlot} using this {@code ContourDataSource}.
242      * @return the sampler
243      */
244     public final SamplerData<?> getSamplerData()
245     {
246         return this.samplerData;
247     }
248 
249     /**
250      * Returns the update interval for an {@code AbstractContourPlot} using this {@code ContourDataSource}.
251      * @return update interval
252      */
253     final Duration getUpdateInterval()
254     {
255         return this.updateInterval;
256     }
257 
258     /**
259      * Returns the delay for an {@code AbstractContourPlot} using this {@code ContourDataSource}.
260      * @return delay
261      */
262     final Duration getDelay()
263     {
264         return this.delay;
265     }
266 
267     /**
268      * Returns the path for an {@code AbstractContourPlot} using this {@code ContourDataSource}.
269      * @return the path
270      */
271     final GraphPath<? extends LaneData<?>> getPath()
272     {
273         return this.path;
274     }
275 
276     /**
277      * Register a contour plot to this data pool. The contour constructor will do this.
278      * @param contourPlot contour plot
279      */
280     final void registerContourPlot(final AbstractContourPlot<?> contourPlot)
281     {
282         ContourDataType<?, ?> contourDataType = contourPlot.getContourDataType();
283         if (contourDataType != null)
284         {
285             this.additionalData.put(contourDataType, null);
286         }
287         this.plots.add(contourPlot);
288     }
289 
290     /**
291      * Returns the bin count.
292      * @param dimension space or time
293      * @return bin count
294      */
295     final int getBinCount(final Dimension dimension)
296     {
297         return dimension.getAxis(this).getBinCount();
298     }
299 
300     /**
301      * Returns the size of a bin. Usually this is equal to the granularity, except for the last which is likely smaller.
302      * @param dimension space or time
303      * @param item item number (cell number in contour plot)
304      * @return the size of a bin
305      */
306     final synchronized double getBinSize(final Dimension dimension, final int item)
307     {
308         int n = dimension.equals(Dimension.DISTANCE) ? getSpaceBin(item) : getTimeBin(item);
309         double[] ticks = dimension.getAxis(this).getTicks();
310         return ticks[n + 1] - ticks[n];
311     }
312 
313     /**
314      * Returns the value on the axis of an item.
315      * @param dimension space or time
316      * @param item item number (cell number in contour plot)
317      * @return the value on the axis of this item
318      */
319     final double getAxisValue(final Dimension dimension, final int item)
320     {
321         if (dimension.equals(Dimension.DISTANCE))
322         {
323             return this.spaceAxis.getBinValue(getSpaceBin(item));
324         }
325         return this.timeAxis.getBinValue(getTimeBin(item));
326     }
327 
328     /**
329      * Returns the axis bin number of the given value.
330      * @param dimension space or time
331      * @param value value
332      * @return axis bin number of the given value
333      */
334     final int getAxisBin(final Dimension dimension, final double value)
335     {
336         if (dimension.equals(Dimension.DISTANCE))
337         {
338             return this.spaceAxis.getValueBin(value);
339         }
340         return this.timeAxis.getValueBin(value);
341     }
342 
343     /**
344      * Returns the available granularities that a linked plot may use.
345      * @param dimension space or time
346      * @return available granularities that a linked plot may use
347      */
348     @SuppressWarnings("synthetic-access")
349     public final double[] getGranularities(final Dimension dimension)
350     {
351         return dimension.getAxis(this).granularities;
352     }
353 
354     /**
355      * Returns the selected granularity that a linked plot should use.
356      * @param dimension space or time
357      * @return granularity that a linked plot should use
358      */
359     @SuppressWarnings("synthetic-access")
360     public final double getGranularity(final Dimension dimension)
361     {
362         return dimension.getAxis(this).granularity;
363     }
364 
365     /**
366      * Called by {@code AbstractContourPlot} to update the time. This will invalidate the plot triggering a redraw.
367      * @param updateTime current time
368      */
369     @SuppressWarnings("synthetic-access")
370     final synchronized void increaseTime(final Time updateTime)
371     {
372         if (updateTime.si > this.timeAxis.maxValue)
373         {
374             this.timeAxis.setMaxValue(updateTime.si);
375             for (AbstractContourPlot<?> plot : this.plots)
376             {
377                 plot.setUpperDomainBound(updateTime.si);
378             }
379         }
380         if (this.toTime == null || updateTime.si > this.toTime.si) // null at initialization
381         {
382             invalidate(updateTime);
383         }
384     }
385 
386     /**
387      * Sets the granularity of the plot. This will invalidate the plot triggering a redraw.
388      * @param dimension space or time
389      * @param granularity granularity in space or time (SI unit)
390      */
391     public final synchronized void setGranularity(final Dimension dimension, final double granularity)
392     {
393         if (dimension.equals(Dimension.DISTANCE))
394         {
395             this.desiredSpaceGranularity = granularity;
396             for (AbstractContourPlot<?> contourPlot : ContourDataSource.this.plots)
397             {
398                 contourPlot.setSpaceGranularity(granularity);
399             }
400         }
401         else
402         {
403             this.desiredTimeGranularity = granularity;
404             for (AbstractContourPlot<?> contourPlot : ContourDataSource.this.plots)
405             {
406                 contourPlot.setUpdateInterval(Duration.instantiateSI(granularity));
407                 contourPlot.setTimeGranularity(granularity);
408             }
409         }
410         invalidate(null);
411     }
412 
413     /**
414      * Sets bi-linear interpolation enabled or disabled. This will invalidate the plot triggering a redraw.
415      * @param interpolate whether to enable interpolation
416      */
417     @SuppressWarnings("synthetic-access")
418     public final void setInterpolate(final boolean interpolate)
419     {
420         if (this.timeAxis.interpolate != interpolate)
421         {
422             synchronized (this)
423             {
424                 this.timeAxis.setInterpolate(interpolate);
425                 this.spaceAxis.setInterpolate(interpolate);
426                 for (AbstractContourPlot<?> contourPlot : ContourDataSource.this.plots)
427                 {
428                     contourPlot.setInterpolation(interpolate);
429                 }
430                 invalidate(null);
431             }
432         }
433     }
434 
435     /**
436      * Sets the adaptive smoothing enabled or disabled. This will invalidate the plot triggering a redraw.
437      * @param smooth whether to smooth the plor
438      */
439     public final void setSmooth(final boolean smooth)
440     {
441         if (this.smooth != smooth)
442         {
443             synchronized (this)
444             {
445                 this.smooth = smooth;
446                 invalidate(null);
447             }
448         }
449     }
450 
451     // ************************
452     // *** UPDATING METHODS ***
453     // ************************
454 
455     /**
456      * Each method that changes a setting such that the plot is no longer valid, should call this method after the setting was
457      * changed. If time is updated (increased), it should be given as input in to this method. The given time <i>should</i> be
458      * {@code null} if the plot is not valid for any other reason. In this case a full redo is initiated.
459      * <p>
460      * Every method calling this method should be {@code synchronized}, at least for the part where the setting is changed and
461      * this method is called. This method will in all cases add an update request to the updater, working in another thread. It
462      * will invoke method {@code update()}. That method utilizes a synchronized block to obtain all synchronization sensitive
463      * data, before starting the actual work.
464      * @param t time up to which to show data
465      */
466     private synchronized void invalidate(final Time t)
467     {
468         if (t != null)
469         {
470             this.toTime = t;
471         }
472         else
473         {
474             this.redo = true;
475         }
476         if (this.toTime != null) // null at initialization
477         {
478             // either a later time was set, or time was null and a redo is required (will be picked up through the redo field)
479             // note that we cannot set {@code null}, hence we set the current to time, which may or may not have just changed
480             this.graphUpdater.offer(this.toTime);
481         }
482     }
483 
484     /**
485      * Heart of the data pool. This method is invoked regularly by the "DataPool worker" thread, as scheduled in a queue through
486      * planned updates at an interval, or by user action changing the plot appearance. No two invocations can happen at the same
487      * time, as the "DataPool worker" thread executes this method before the next update request from the queue is considered.
488      * <p>
489      * This method regularly checks conditions that indicate the update should be interrupted as for example a setting has
490      * changed and appearance should change. Whenever a new invalidation causes {@code redo = true}, this method can stop as the
491      * full data needs to be recalculated. This can be set by any change of e.g. granularity or smoothing, during the update.
492      * <p>
493      * During the data recalculation, a later update time may also trigger this method to stop, while the next update will pick
494      * up where this update left off. During the smoothing this method doesn't stop for an increased update time, as that will
495      * leave a gap in the smoothed data. Note that smoothing either smoothes all data (when {@code redo = true}), or only the
496      * last part that falls within the kernel.
497      * @param t time up to which to show data
498      */
499     @SuppressWarnings({"synthetic-access", "methodlength"})
500     private void update(final Time t)
501     {
502         Throw.when(this.plots.isEmpty(), IllegalStateException.class, "ContourDataSource is used, but not by a contour plot!");
503 
504         if (t.si < this.toTime.si)
505         {
506             // skip this update as new updates were commanded, while this update was in the queue, and a previous was running
507             return;
508         }
509 
510         /**
511          * This method is executed once at a time by the worker Thread. Many properties, such as the data, are maintained by
512          * this method. Other properties, which other methods can change, are read first in a synchronized block, while those
513          * methods are also synchronized.
514          */
515         boolean redo0;
516         boolean smooth0;
517         boolean interpolate0;
518         double timeGranularity;
519         double spaceGranularity;
520         double[] spaceTicks;
521         double[] timeTicks;
522         int fromSpaceIndex = 0;
523         int fromTimeIndex = 0;
524         int toTimeIndex;
525         double tFromEgtf = 0;
526         int nFromEgtf = 0;
527         synchronized (this)
528         {
529             // save local copies so commands given during this execution can change it for the next execution
530             redo0 = this.redo;
531             smooth0 = this.smooth;
532             interpolate0 = this.timeAxis.interpolate;
533             // timeTicks may be longer than the simulation time, so we use the time bin for the required time of data
534             if (this.desiredTimeGranularity != null)
535             {
536                 this.timeAxis.setGranularity(this.desiredTimeGranularity);
537                 this.desiredTimeGranularity = null;
538             }
539             if (this.desiredSpaceGranularity != null)
540             {
541                 this.spaceAxis.setGranularity(this.desiredSpaceGranularity);
542                 this.desiredSpaceGranularity = null;
543             }
544             timeGranularity = this.timeAxis.granularity;
545             spaceGranularity = this.spaceAxis.granularity;
546             spaceTicks = this.spaceAxis.getTicks();
547             timeTicks = this.timeAxis.getTicks();
548             if (!redo0)
549             {
550                 // remember where we started, readyItems will be updated but we need to know where we started during the update
551                 fromSpaceIndex = getSpaceBin(this.readyItems + 1);
552                 fromTimeIndex = getTimeBin(this.readyItems + 1);
553             }
554             toTimeIndex = ((int) (t.si / timeGranularity)) - (interpolate0 ? 0 : 1);
555             if (smooth0)
556             {
557                 // time of current bin - kernel size, get bin of that time, get time (middle) of that bin
558                 tFromEgtf = this.timeAxis.getBinValue(redo0 ? 0 : this.timeAxis.getValueBin(
559                         this.timeAxis.getBinValue(fromTimeIndex) - Math.max(TAU.si, timeGranularity / 2) * KERNEL_FACTOR));
560                 nFromEgtf = this.timeAxis.getValueBin(tFromEgtf);
561             }
562             // starting execution, so reset redo trigger which any next command may set to true if needed
563             this.redo = false;
564         }
565 
566         // reset upon a redo
567         if (redo0)
568         {
569             this.readyItems = -1;
570 
571             // init all data arrays
572             int nSpace = spaceTicks.length - 1;
573             int nTime = timeTicks.length - 1;
574             this.distance = new float[nSpace][nTime];
575             this.time = new float[nSpace][nTime];
576             for (ContourDataType<?, ?> contourDataType : this.additionalData.keySet())
577             {
578                 this.additionalData.put(contourDataType, new float[nSpace][nTime]);
579             }
580 
581             // setup the smoothing filter
582             if (smooth0)
583             {
584                 // create the filter
585                 this.egtf = new Egtf(C_CONG.si, this.cFree.si, DELTA_V.si, this.vc.si);
586 
587                 // create data source and its data streams for speed, distance traveled, time traveled, and additional
588                 DataSource generic = this.egtf.getDataSource("generic");
589                 generic.addStream(TypedQuantity.SPEED, Speed.instantiateSI(1.0), Speed.instantiateSI(1.0));
590                 generic.addStreamSI(this.travelTimeQuantity, 1.0, 1.0);
591                 generic.addStreamSI(this.travelDistanceQuantity, 1.0, 1.0);
592                 this.speedStream = generic.getStream(TypedQuantity.SPEED);
593                 this.travelTimeStream = generic.getStream(this.travelTimeQuantity);
594                 this.travelDistanceStream = generic.getStream(this.travelDistanceQuantity);
595                 for (ContourDataType<?, ?> contourDataType : this.additionalData.keySet())
596                 {
597                     this.additionalStreams.put(contourDataType, generic.addStreamSI(contourDataType.getQuantity(), 1.0, 1.0));
598                 }
599 
600                 // in principle we use sigma and tau, unless the data is so rough, we need more (granularity / 2).
601                 double tau2 = Math.max(TAU.si, timeGranularity / 2);
602                 double sigma2 = Math.max(SIGMA.si, spaceGranularity / 2);
603                 // for maximum space and time range, increase sigma and tau by KERNEL_FACTOR, beyond which both kernels diminish
604                 this.egtf.setGaussKernelSI(sigma2 * KERNEL_FACTOR, tau2 * KERNEL_FACTOR, sigma2, tau2);
605 
606                 // add listener to provide a filter status update and to possibly stop the filter when the plot is invalidated
607                 this.egtf.addListener(new EgtfListener()
608                 {
609                     @Override
610                     public void notifyProgress(final EgtfEvent event)
611                     {
612                         // check stop (explicit use of property, not locally stored value)
613                         if (ContourDataSource.this.redo)
614                         {
615                             // plots need to be redone
616                             event.interrupt(); // stop the EGTF
617                         }
618                     }
619                 });
620             }
621         }
622 
623         // discard any data from smoothing if we are not smoothing
624         if (!smooth0)
625         {
626             // free for garbage collector to remove the data
627             this.egtf = null;
628             this.speedStream = null;
629             this.travelTimeStream = null;
630             this.travelDistanceStream = null;
631             this.additionalStreams.clear();
632         }
633 
634         // ensure capacity
635         for (int i = 0; i < this.distance.length; i++)
636         {
637             this.distance[i] = GraphUtil.ensureCapacity(this.distance[i], toTimeIndex + 1);
638             this.time[i] = GraphUtil.ensureCapacity(this.time[i], toTimeIndex + 1);
639             for (float[][] additional : this.additionalData.values())
640             {
641                 additional[i] = GraphUtil.ensureCapacity(additional[i], toTimeIndex + 1);
642             }
643         }
644 
645         // loop cells to update data
646         for (int j = fromTimeIndex; j <= toTimeIndex; j++)
647         {
648             Time tFrom = Time.instantiateSI(timeTicks[j]);
649             Time tTo = Time.instantiateSI(timeTicks[j + 1]);
650 
651             // we never filter time, time always spans the entire simulation, it will contain tFrom till tTo
652 
653             for (int i = fromSpaceIndex; i < spaceTicks.length - 1; i++)
654             {
655                 // when interpolating, set the first row and column to NaN so colors representing 0 do not mess up the edges
656                 if ((j == 0 || i == 0) && interpolate0)
657                 {
658                     this.distance[i][j] = Float.NaN;
659                     this.time[i][j] = Float.NaN;
660                     this.readyItems++;
661                     continue;
662                 }
663 
664                 // only first loop with offset, later in time, none of the space was done in the previous update
665                 fromSpaceIndex = 0;
666                 Length xFrom = Length.instantiateSI(spaceTicks[i]);
667                 Length xTo = Length.instantiateSI(Math.min(spaceTicks[i + 1], this.path.getTotalLength().si));
668 
669                 // init cell data
670                 double totalDistance = 0.0;
671                 double totalTime = 0.0;
672                 Map<ContourDataType<?, ?>, Object> additionalIntermediate = new LinkedHashMap<>();
673                 for (ContourDataType<?, ?> contourDataType : this.additionalData.keySet())
674                 {
675                     additionalIntermediate.put(contourDataType, contourDataType.identity());
676                 }
677 
678                 // aggregate series in cell
679                 for (int series = 0; series < this.path.getNumberOfSeries(); series++)
680                 {
681                     // obtain trajectories
682                     List<TrajectoryGroup<?>> trajectories = new ArrayList<>();
683                     for (Section<? extends LaneData<?>> section : getPath().getSections())
684                     {
685                         TrajectoryGroup<?> trajectoryGroup = this.samplerData.getTrajectoryGroup(section.getSource(series));
686                         if (null == trajectoryGroup)
687                         {
688                             CategoryLogger.always().error("trajectoryGroup {} is null", series);
689                         }
690                         trajectories.add(trajectoryGroup);
691                     }
692 
693                     // filter groups (lanes) that overlap with section i
694                     List<TrajectoryGroup<?>> included = new ArrayList<>();
695                     List<Length> xStart = new ArrayList<>();
696                     List<Length> xEnd = new ArrayList<>();
697                     for (int k = 0; k < trajectories.size(); k++)
698                     {
699                         TrajectoryGroup<?> trajectoryGroup = trajectories.get(k);
700                         LaneData<?> lane = trajectoryGroup.getLane();
701                         Length startDistance = this.path.getStartDistance(this.path.get(k));
702                         if (startDistance.si + this.path.get(k).length().si > spaceTicks[i]
703                                 && startDistance.si < spaceTicks[i + 1])
704                         {
705                             included.add(trajectoryGroup);
706                             double scale = this.path.get(k).length().si / lane.getLength().si;
707                             // divide by scale, so we go from base length to section length
708                             xStart.add(Length.max(xFrom.minus(startDistance).divide(scale), Length.ZERO));
709                             xEnd.add(Length.min(xTo.minus(startDistance).divide(scale), trajectoryGroup.getLane().getLength()));
710                         }
711                     }
712 
713                     // accumulate distance and time of trajectories
714                     for (int k = 0; k < included.size(); k++)
715                     {
716                         TrajectoryGroup<?> trajectoryGroup = included.get(k);
717                         for (Trajectory<?> trajectory : trajectoryGroup.getTrajectories())
718                         {
719                             // for optimal operations, we first do quick-reject based on time, as by far most trajectories
720                             // during the entire time span of simulation will not apply to a particular cell in space-time
721                             if (GraphUtil.considerTrajectory(trajectory, tFrom, tTo))
722                             {
723                                 // again for optimal operations, we use a space-time view only (we don't need more)
724                                 SpaceTimeView spaceTimeView;
725                                 try
726                                 {
727                                     spaceTimeView = trajectory.getSpaceTimeView(xStart.get(k), xEnd.get(k), tFrom, tTo);
728                                 }
729                                 catch (IllegalArgumentException exception)
730                                 {
731                                     CategoryLogger.always().debug(exception,
732                                             "Unable to generate space-time view from x = {} to {} and t = {} to {}.",
733                                             xStart.get(k), xEnd.get(k), tFrom, tTo);
734                                     continue;
735                                 }
736                                 totalDistance += spaceTimeView.distance().si;
737                                 totalTime += spaceTimeView.time().si;
738                             }
739                         }
740                     }
741 
742                     // loop and set any additional data
743                     for (ContourDataType<?, ?> contourDataType : this.additionalData.keySet())
744                     {
745                         addAdditional(additionalIntermediate, contourDataType, included, xStart, xEnd, tFrom, tTo);
746                     }
747 
748                 }
749 
750                 // scale values to the full size of a cell on a single lane, so the EGTF is interpolating comparable values
751                 double norm = spaceGranularity / (xTo.si - xFrom.si) / this.path.getNumberOfSeries();
752                 totalDistance *= norm;
753                 totalTime *= norm;
754                 this.distance[i][j] = (float) totalDistance;
755                 this.time[i][j] = (float) totalTime;
756                 for (ContourDataType<?, ?> contourDataType : this.additionalData.keySet())
757                 {
758                     this.additionalData.get(contourDataType)[i][j] =
759                             finalizeAdditional(additionalIntermediate, contourDataType);
760                 }
761 
762                 // add data to EGTF (yes it's a copy, but our local data will be overwritten with smoothed data later)
763                 if (smooth0)
764                 {
765                     // center of cell
766                     double xDat = (xFrom.si + xTo.si) / 2.0;
767                     double tDat = (tFrom.si + tTo.si) / 2.0;
768                     // speed data is implicit as totalDistance/totalTime, but the EGTF needs it explicitly
769                     this.egtf.addPointDataSI(this.speedStream, xDat, tDat, totalDistance / totalTime);
770                     this.egtf.addPointDataSI(this.travelDistanceStream, xDat, tDat, totalDistance);
771                     this.egtf.addPointDataSI(this.travelTimeStream, xDat, tDat, totalTime);
772                     for (ContourDataType<?, ?> contourDataType : this.additionalStreams.keySet())
773                     {
774                         ContourDataSource.this.egtf.addPointDataSI(
775                                 ContourDataSource.this.additionalStreams.get(contourDataType), xDat, tDat,
776                                 this.additionalData.get(contourDataType)[i][j]);
777                     }
778                 }
779 
780                 // check stop (explicit use of properties, not locally stored values)
781                 if (this.redo)
782                 {
783                     // plots need to be redone, or time has increased meaning that a next call may continue further just as well
784                     return;
785                 }
786 
787                 // one more item is ready for plotting
788                 this.readyItems++;
789             }
790 
791             // notify changes for every time slice
792             this.plots.forEach((plot) -> plot.notifyPlotChange());
793         }
794 
795         // smooth all data that is as old as our kernel includes (or all data on a redo)
796         if (smooth0)
797         {
798             Set<Quantity<?, ?>> quantities = new LinkedHashSet<>();
799             quantities.add(this.travelDistanceQuantity);
800             quantities.add(this.travelTimeQuantity);
801             for (ContourDataType<?, ?> contourDataType : this.additionalData.keySet())
802             {
803                 quantities.add(contourDataType.getQuantity());
804             }
805             Filter filter = this.egtf.filterFastSI(spaceTicks[0] + 0.5 * spaceGranularity, spaceGranularity,
806                     spaceTicks[0] + (-1.5 + spaceTicks.length) * spaceGranularity, tFromEgtf, timeGranularity, t.si,
807                     quantities.toArray(new Quantity<?, ?>[quantities.size()]));
808             if (filter != null) // null if interrupted
809             {
810                 overwriteSmoothed(this.distance, nFromEgtf, filter.getSI(this.travelDistanceQuantity));
811                 overwriteSmoothed(this.time, nFromEgtf, filter.getSI(this.travelTimeQuantity));
812                 for (ContourDataType<?, ?> contourDataType : this.additionalData.keySet())
813                 {
814                     overwriteSmoothed(this.additionalData.get(contourDataType), nFromEgtf,
815                             filter.getSI(contourDataType.getQuantity()));
816                 }
817                 this.plots.forEach((plot) -> plot.notifyPlotChange());
818             }
819         }
820     }
821 
822     /**
823      * Add additional data to stored intermediate result.
824      * @param additionalIntermediate intermediate storage map
825      * @param contourDataType additional data type
826      * @param included trajectories
827      * @param xStart start distance per trajectory group
828      * @param xEnd end distance per trajectory group
829      * @param tFrom start time
830      * @param tTo end time
831      * @param <I> intermediate data type
832      */
833     @SuppressWarnings("unchecked")
834     private <I> void addAdditional(final Map<ContourDataType<?, ?>, Object> additionalIntermediate,
835             final ContourDataType<?, ?> contourDataType, final List<TrajectoryGroup<?>> included, final List<Length> xStart,
836             final List<Length> xEnd, final Time tFrom, final Time tTo)
837     {
838         additionalIntermediate.put(contourDataType, ((ContourDataType<?, I>) contourDataType)
839                 .processSeries((I) additionalIntermediate.get(contourDataType), included, xStart, xEnd, tFrom, tTo));
840     }
841 
842     /**
843      * Stores a finalized result for additional data.
844      * @param additionalIntermediate intermediate storage map
845      * @param contourDataType additional data type
846      * @return finalized results for a cell
847      * @param <I> intermediate data type
848      */
849     @SuppressWarnings("unchecked")
850     private <I> float finalizeAdditional(final Map<ContourDataType<?, ?>, Object> additionalIntermediate,
851             final ContourDataType<?, ?> contourDataType)
852     {
853         return ((ContourDataType<?, I>) contourDataType).finalize((I) additionalIntermediate.get(contourDataType)).floatValue();
854     }
855 
856     /**
857      * Helper method to fill smoothed data in to raw data.
858      * @param raw the raw unsmoothed data
859      * @param rawCol column from which onward to fill smoothed data in to the raw data which is used for plotting
860      * @param smoothed smoothed data returned by {@code EGTF}
861      */
862     private void overwriteSmoothed(final float[][] raw, final int rawCol, final double[][] smoothed)
863     {
864         for (int i = 0; i < raw.length; i++)
865         {
866             // can't use System.arraycopy due to float vs double
867             for (int j = 0; j < smoothed[i].length; j++)
868             {
869                 raw[i][j + rawCol] = (float) smoothed[i][j];
870             }
871         }
872     }
873 
874     // ******************************
875     // *** DATA RETRIEVAL METHODS ***
876     // ******************************
877 
878     /**
879      * Returns the speed of the cell pertaining to plot item.
880      * @param item plot item
881      * @return speed of the cell, calculated as 'total distance' / 'total space'.
882      */
883     public double getSpeed(final int item)
884     {
885         if (item > this.readyItems)
886         {
887             return Double.NaN;
888         }
889         return getTotalDistance(item) / getTotalTime(item);
890     }
891 
892     /**
893      * Returns the total distance traveled in the cell pertaining to plot item.
894      * @param item plot item
895      * @return total distance traveled in the cell
896      */
897     public double getTotalDistance(final int item)
898     {
899         if (item > this.readyItems)
900         {
901             return Double.NaN;
902         }
903         return this.distance[getSpaceBin(item)][getTimeBin(item)];
904     }
905 
906     /**
907      * Returns the total time traveled in the cell pertaining to plot item.
908      * @param item plot item
909      * @return total time traveled in the cell
910      */
911     public double getTotalTime(final int item)
912     {
913         if (item > this.readyItems)
914         {
915             return Double.NaN;
916         }
917         return this.time[getSpaceBin(item)][getTimeBin(item)];
918     }
919 
920     /**
921      * Returns data of the given {@code ContourDataType} for a specific item.
922      * @param item plot item
923      * @param contourDataType contour data type
924      * @return data of the given {@code ContourDataType} for a specific item
925      */
926     public double get(final int item, final ContourDataType<?, ?> contourDataType)
927     {
928         if (item > this.readyItems)
929         {
930             return Double.NaN;
931         }
932         return this.additionalData.get(contourDataType)[getSpaceBin(item)][getTimeBin(item)];
933     }
934 
935     /**
936      * Returns the time bin number of the item.
937      * @param item item number
938      * @return time bin number of the item
939      */
940     private int getTimeBin(final int item)
941     {
942         Throw.when(item < 0 || item >= this.spaceAxis.getBinCount() * this.timeAxis.getBinCount(),
943                 IndexOutOfBoundsException.class, "Item out of range");
944         return item / this.spaceAxis.getBinCount();
945     }
946 
947     /**
948      * Returns the space bin number of the item.
949      * @param item item number
950      * @return space bin number of the item
951      */
952     private int getSpaceBin(final int item)
953     {
954         return item % this.spaceAxis.getBinCount();
955     }
956 
957     // **********************
958     // *** HELPER CLASSES ***
959     // **********************
960 
961     /**
962      * Enum to refer to either the distance or time axis.
963      * <p>
964      * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
965      * <br>
966      * BSD-style license. See <a href="https://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
967      * </p>
968      * @author <a href="https://github.com/averbraeck">Alexander Verbraeck</a>
969      * @author <a href="https://github.com/peter-knoppers">Peter Knoppers</a>
970      * @author <a href="https://github.com/wjschakel">Wouter Schakel</a>
971      */
972     public enum Dimension
973     {
974         /** Distance axis. */
975         DISTANCE
976         {
977             @Override
978             protected Axis getAxis(final ContourDataSource dataPool)
979             {
980                 return dataPool.spaceAxis;
981             }
982         },
983 
984         /** Time axis. */
985         TIME
986         {
987             @Override
988             protected Axis getAxis(final ContourDataSource dataPool)
989             {
990                 return dataPool.timeAxis;
991             }
992         };
993 
994         /**
995          * Returns the {@code Axis} object.
996          * @param dataPool data pool
997          * @return axis
998          */
999         protected abstract Axis getAxis(ContourDataSource dataPool);
1000     }
1001 
1002     /**
1003      * Class to store and determine axis information such as granularity, ticks, and range.
1004      * <p>
1005      * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
1006      * <br>
1007      * BSD-style license. See <a href="https://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
1008      * </p>
1009      * @author <a href="https://github.com/averbraeck">Alexander Verbraeck</a>
1010      * @author <a href="https://github.com/peter-knoppers">Peter Knoppers</a>
1011      * @author <a href="https://github.com/wjschakel">Wouter Schakel</a>
1012      */
1013     static class Axis
1014     {
1015         /** Minimum value. */
1016         private final double minValue;
1017 
1018         /** Maximum value. */
1019         private double maxValue;
1020 
1021         /** Selected granularity. */
1022         private double granularity;
1023 
1024         /** Possible granularities. */
1025         private final double[] granularities;
1026 
1027         /** Whether the data pool is set to interpolate. */
1028         private boolean interpolate = true;
1029 
1030         /** Tick values. */
1031         private double[] ticks;
1032 
1033         /**
1034          * Constructor.
1035          * @param minValue minimum value
1036          * @param maxValue maximum value
1037          * @param granularity initial granularity
1038          * @param granularities possible granularities
1039          */
1040         Axis(final double minValue, final double maxValue, final double granularity, final double[] granularities)
1041         {
1042             this.minValue = minValue;
1043             this.maxValue = maxValue;
1044             this.granularity = granularity;
1045             this.granularities = granularities;
1046         }
1047 
1048         /**
1049          * Sets the maximum value.
1050          * @param maxValue maximum value
1051          */
1052         void setMaxValue(final double maxValue)
1053         {
1054             if (this.maxValue != maxValue)
1055             {
1056                 this.maxValue = maxValue;
1057                 this.ticks = null;
1058             }
1059         }
1060 
1061         /**
1062          * Sets the granularity.
1063          * @param granularity granularity
1064          */
1065         void setGranularity(final double granularity)
1066         {
1067             if (this.granularity != granularity)
1068             {
1069                 this.granularity = granularity;
1070                 this.ticks = null;
1071             }
1072         }
1073 
1074         /**
1075          * Returns the ticks, which are calculated if needed.
1076          * @return ticks
1077          */
1078         double[] getTicks()
1079         {
1080             if (this.ticks == null)
1081             {
1082                 int n = getBinCount() + 1;
1083                 this.ticks = new double[n];
1084                 int di = this.interpolate ? 1 : 0;
1085                 for (int i = 0; i < n; i++)
1086                 {
1087                     if (i == n - 1)
1088                     {
1089                         this.ticks[i] = Math.min((i - di) * this.granularity, this.maxValue);
1090                     }
1091                     else
1092                     {
1093                         this.ticks[i] = (i - di) * this.granularity;
1094                     }
1095                 }
1096             }
1097             return this.ticks;
1098         }
1099 
1100         /**
1101          * Calculates the number of bins.
1102          * @return number of bins
1103          */
1104         int getBinCount()
1105         {
1106             return (int) Math.ceil((this.maxValue - this.minValue) / this.granularity) + (this.interpolate ? 1 : 0);
1107         }
1108 
1109         /**
1110          * Calculates the center value of a bin.
1111          * @param bin bin number
1112          * @return center value of the bin
1113          */
1114         double getBinValue(final int bin)
1115         {
1116             return this.minValue + (0.5 + bin - (this.interpolate ? 1 : 0)) * this.granularity;
1117         }
1118 
1119         /**
1120          * Looks up the bin number of the value.
1121          * @param value value
1122          * @return bin number
1123          */
1124         int getValueBin(final double value)
1125         {
1126             getTicks();
1127             if (value > this.ticks[this.ticks.length - 1])
1128             {
1129                 return this.ticks.length - 1;
1130             }
1131             int i = 0;
1132             while (i < this.ticks.length - 1 && this.ticks[i + 1] < value + 1e-9)
1133             {
1134                 i++;
1135             }
1136             return i;
1137         }
1138 
1139         /**
1140          * Sets interpolation, important is it required the data to have an additional row or column.
1141          * @param interpolate interpolation
1142          */
1143         void setInterpolate(final boolean interpolate)
1144         {
1145             if (this.interpolate != interpolate)
1146             {
1147                 this.interpolate = interpolate;
1148                 this.ticks = null;
1149             }
1150         }
1151 
1152         /**
1153          * Retrieve the interpolate flag.
1154          * @return true if interpolation is on; false if interpolation is off
1155          */
1156         public boolean isInterpolate()
1157         {
1158             return this.interpolate;
1159         }
1160 
1161         @Override
1162         public String toString()
1163         {
1164             return "Axis [minValue=" + this.minValue + ", maxValue=" + this.maxValue + ", granularity=" + this.granularity
1165                     + ", granularities=" + Arrays.toString(this.granularities) + ", interpolate=" + this.interpolate
1166                     + ", ticks=" + Arrays.toString(this.ticks) + "]";
1167         }
1168 
1169     }
1170 
1171     /**
1172      * Interface for data types of which a contour plot can be made. Using this class, the data pool can determine and store
1173      * cell values for a variable set of additional data types (besides total distance, total time and speed).
1174      * <p>
1175      * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
1176      * <br>
1177      * BSD-style license. See <a href="https://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
1178      * </p>
1179      * @author <a href="https://github.com/averbraeck">Alexander Verbraeck</a>
1180      * @author <a href="https://github.com/peter-knoppers">Peter Knoppers</a>
1181      * @author <a href="https://github.com/wjschakel">Wouter Schakel</a>
1182      * @param <Z> value type
1183      * @param <I> intermediate data type
1184      */
1185     public interface ContourDataType<Z extends Number, I>
1186     {
1187         /**
1188          * Returns the initial value for intermediate result.
1189          * @return I, initial intermediate value
1190          */
1191         I identity();
1192 
1193         /**
1194          * Calculate value from provided trajectories that apply to a single grid cell on a single series (lane).
1195          * @param intermediate intermediate value of previous series, starts as the identity
1196          * @param trajectories trajectories, all groups overlap the requested space-time
1197          * @param xFrom start location of cell on the section
1198          * @param xTo end location of cell on the section.
1199          * @param tFrom start time of cell
1200          * @param tTo end time of cell
1201          * @return intermediate value
1202          */
1203         I processSeries(I intermediate, List<TrajectoryGroup<?>> trajectories, List<Length> xFrom, List<Length> xTo, Time tFrom,
1204                 Time tTo);
1205 
1206         /**
1207          * Returns the final value of the intermediate result after all lanes.
1208          * @param intermediate intermediate result after all lanes
1209          * @return final value
1210          */
1211         Z finalize(I intermediate);
1212 
1213         /**
1214          * Returns the quantity that is being plotted on the z-axis for the EGTF filter.
1215          * @return quantity that is being plotted on the z-axis for the EGTF filter
1216          */
1217         Quantity<Z, ?> getQuantity();
1218     }
1219 
1220     @Override
1221     public String toString()
1222     {
1223         return "ContourDataSource [samplerData=" + this.samplerData + ", updateInterval=" + this.updateInterval + ", delay="
1224                 + this.delay + ", path=" + this.path + ", spaceAxis=" + this.spaceAxis + ", timeAxis=" + this.timeAxis
1225                 + ", plots=" + this.plots + ", distance=" + Arrays.toString(this.distance) + ", time="
1226                 + Arrays.toString(this.time) + ", additionalData=" + this.additionalData + ", smooth=" + this.smooth
1227                 + ", cFree=" + this.cFree + ", vc=" + this.vc + ", egtf=" + this.egtf + ", speedStream=" + this.speedStream
1228                 + ", travelTimeStream=" + this.travelTimeStream + ", travelDistanceStream=" + this.travelDistanceStream
1229                 + ", travelTimeQuantity=" + this.travelTimeQuantity + ", travelDistanceQuantity=" + this.travelDistanceQuantity
1230                 + ", additionalStreams=" + this.additionalStreams + ", graphUpdater=" + this.graphUpdater + ", redo="
1231                 + this.redo + ", toTime=" + this.toTime + ", readyItems=" + this.readyItems + ", desiredSpaceGranularity="
1232                 + this.desiredSpaceGranularity + ", desiredTimeGranularity=" + this.desiredTimeGranularity + "]";
1233     }
1234 
1235 }