TypedEgtf.java

  1. package org.opentrafficsim.draw.egtf.typed;

  3. import org.djunits.unit.SpeedUnit;
  4. import org.djunits.unit.Unit;
  5. import org.djunits.value.base.Scalar;
  6. import org.djunits.value.vdouble.matrix.base.DoubleMatrix;
  7. import org.djunits.value.vdouble.scalar.Duration;
  8. import org.djunits.value.vdouble.scalar.Length;
  9. import org.djunits.value.vdouble.scalar.Speed;
  10. import org.djunits.value.vdouble.vector.DurationVector;
  11. import org.djunits.value.vdouble.vector.LengthVector;
  12. import org.djunits.value.vdouble.vector.base.DoubleVector;
  13. import org.opentrafficsim.draw.egtf.DataStream;
  14. import org.opentrafficsim.draw.egtf.Egtf;
  15. import org.opentrafficsim.draw.egtf.KernelShape;
  16. import org.opentrafficsim.draw.egtf.Quantity;

  18. /**
  19.  * Typed version of the EGTF.
  20.  * <p>
  21.  * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
  22.  * BSD-style license. See <a href="https://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
  23.  * </p>
  24.  * @author <a href="https://github.com/averbraeck">Alexander Verbraeck</a>
  25.  * @author <a href="https://tudelft.nl/staff/p.knoppers-1">Peter Knoppers</a>
  26.  * @author <a href="https://github.com/wjschakel">Wouter Schakel</a>
  27.  */
  28. public class TypedEgtf extends Egtf
  29. {

  31.     /**
  32.      * Constructor using cCong = -18km/h, cFree = 80km/h, deltaV = 10km/h and vc = 80km/h. A default kernel is set.
  33.      */
  34.     public TypedEgtf()
  35.     {
  36.     }

  38.     /**
  39.      * Constructor defining global settings. A default kernel is set.
  40.      * @param cCong Speed; shock wave speed in congestion
  41.      * @param cFree Speed; shock wave speed in free flow
  42.      * @param deltaV Speed; speed range between congestion and free flow
  43.      * @param vc Speed; flip-over speed below which we have congestion
  44.      */
  45.     public TypedEgtf(final Speed cCong, final Speed cFree, final Speed deltaV, final Speed vc)
  46.     {
  47.         super(cCong.getInUnit(SpeedUnit.KM_PER_HOUR), cFree.getInUnit(SpeedUnit.KM_PER_HOUR),
  48.                 deltaV.getInUnit(SpeedUnit.KM_PER_HOUR), vc.getInUnit(SpeedUnit.KM_PER_HOUR));
  49.     }

  51.     /**
  52.      * Convenience constructor that also sets a specified kernel.
  53.      * @param cCong Speed; shock wave speed in congestion
  54.      * @param cFree Speed; shock wave speed in free flow
  55.      * @param deltaV Speed; speed range between congestion and free flow
  56.      * @param vc Speed; flip-over speed below which we have congestion
  57.      * @param sigma Length; spatial kernel size
  58.      * @param tau Duration; temporal kernel size
  59.      * @param xMax Length; maximum spatial range
  60.      * @param tMax Duration; maximum temporal range
  61.      */
  62.     @SuppressWarnings("parameternumber")
  63.     public TypedEgtf(final Speed cCong, final Speed cFree, final Speed deltaV, final Speed vc, final Length sigma,
  64.             final Duration tau, final Length xMax, final Duration tMax)
  65.     {
  66.         super(cCong.getInUnit(SpeedUnit.KM_PER_HOUR), cFree.getInUnit(SpeedUnit.KM_PER_HOUR),
  67.                 deltaV.getInUnit(SpeedUnit.KM_PER_HOUR), vc.getInUnit(SpeedUnit.KM_PER_HOUR), sigma.si, tau.si, xMax.si,
  68.                 tMax.si);
  69.     }

  71.     /**
  72.      * Adds point data.
  73.      * @param quantity Quantity&lt;Z, ?&gt;; quantity of the data
  74.      * @param location Length; location
  75.      * @param time Duration; time
  76.      * @param value Z; data value
  77.      * @param <U> unit of type
  78.      * @param <Z> value type
  79.      * @throws IllegalStateException if data was added with a data stream previously
  80.      */
  81.     public synchronized <U extends Unit<U>, Z extends Scalar<U, Z>> void addPointData(final Quantity<Z, ?> quantity,
  82.             final Length location, final Duration time, final Z value)
  83.     {
  84.         addPointDataSI(quantity, location.si, time.si, value.doubleValue());
  85.     }

  87.     /**
  88.      * Adds point data.
  89.      * @param dataStream DataStream&lt;Z&gt;; data stream of the data
  90.      * @param location Length; location
  91.      * @param time Duration; time
  92.      * @param value Z; data value
  93.      * @param <U> unit of type
  94.      * @param <Z> value type
  95.      * @throws IllegalStateException if data was added with a quantity previously
  96.      */
  97.     public synchronized <U extends Unit<U>, Z extends Scalar<U, Z>> void addPointData(final DataStream<Z> dataStream,
  98.             final Length location, final Duration time, final Z value)
  99.     {
  100.         addPointDataSI(dataStream, location.si, time.si, value.doubleValue());
  101.     }

  103.     /**
  104.      * Adds vector data.
  105.      * @param quantity Quantity&lt;Z, ?&gt;; quantity of the data
  106.      * @param location LengthVector; locations
  107.      * @param time DurationVector; times
  108.      * @param values DoubleVectorInterface&lt;U&gt;; data values
  109.      * @param <U> unit of type
  110.      * @param <Z> value type
  111.      * @throws IllegalStateException if data was added with a data stream previously
  112.      */
  113.     public synchronized <U extends Unit<U>, Z extends Scalar<U, Z>> void addVectorData(final Quantity<Z, ?> quantity,
  114.             final LengthVector location, final DurationVector time, final DoubleVector<U, ?, ?> values)
  115.     {
  116.         addVectorDataSI(quantity, location.getValuesSI(), time.getValuesSI(), values.getValuesSI());
  117.     }

  119.     /**
  120.      * Adds vector data.
  121.      * @param dataStream DataStream&lt;Z&gt;; data stream of the data
  122.      * @param location LengthVector; locations
  123.      * @param time DurationVector; times
  124.      * @param values DoubleVectorInterface&lt;U&gt;; data values
  125.      * @param <U> unit of type
  126.      * @param <Z> value type
  127.      * @throws IllegalStateException if data was added with a quantity previously
  128.      */
  129.     public synchronized <U extends Unit<U>, Z extends Scalar<U, Z>> void addVectorData(final DataStream<Z> dataStream,
  130.             final LengthVector location, final DurationVector time, final DoubleVector<U, ?, ?> values)
  131.     {
  132.         addVectorDataSI(dataStream, location.getValuesSI(), time.getValuesSI(), values.getValuesSI());
  133.     }

  135.     /**
  136.      * Adds grid data.
  137.      * @param quantity Quantity&lt;Z, ?&gt;; quantity of the data
  138.      * @param location LengthVector; locations
  139.      * @param time DurationVector; times
  140.      * @param values DoubleMatrixInterface&lt;U&gt;; data values
  141.      * @param <U> unit of type
  142.      * @param <Z> value type
  143.      * @throws IllegalStateException if data was added with a data stream previously
  144.      */
  145.     public synchronized <U extends Unit<U>, Z extends Scalar<U, Z>> void addGridData(final Quantity<Z, ?> quantity,
  146.             final LengthVector location, final DurationVector time, final DoubleMatrix<U, ?, ?, ?> values)
  147.     {
  148.         addGridDataSI(quantity, location.getValuesSI(), time.getValuesSI(), values.getValuesSI());
  149.     }

  151.     /**
  152.      * Adds grid data.
  153.      * @param dataStream DataStream&lt;Z&gt;; data stream of the data
  154.      * @param location LengthVector; locations
  155.      * @param time DurationVector; times
  156.      * @param values DoubleMatrixInterface&lt;U&gt;; data values
  157.      * @param <U> unit of type
  158.      * @param <Z> value type
  159.      * @throws IllegalStateException if data was added with a quantity previously
  160.      */
  161.     public synchronized <U extends Unit<U>, Z extends Scalar<U, Z>> void addGridData(final DataStream<Z> dataStream,
  162.             final LengthVector location, final DurationVector time, final DoubleMatrix<U, ?, ?, ?> values)
  163.     {
  164.         addGridDataSI(dataStream, location.getValuesSI(), time.getValuesSI(), values.getValuesSI());
  165.     }

  167.     /**
  168.      * Removes all data from before the given time. This is useful in live usages of this class, where older data is no longer
  169.      * required.
  170.      * @param time Duration; time before which all data can be removed
  171.      */
  172.     public void clearDataBefore(final Duration time)
  173.     {
  174.         clearDataBefore(time.si);
  175.     }

  177.     /**
  178.      * Sets an exponential kernel with infinite range.
  179.      * @param sigma Length; spatial kernel size
  180.      * @param tau Duration; temporal kernel size
  181.      */
  182.     public void setKernel(final Length sigma, final Duration tau)
  183.     {
  184.         setKernelSI(sigma.si, tau.si);
  185.     }

  187.     /**
  188.      * Returns an exponential kernel with limited range.
  189.      * @param sigma Length; spatial kernel size in [m]
  190.      * @param tau Duration; temporal kernel size in [s]
  191.      * @param xMax Length; maximum spatial range in [m]
  192.      * @param tMax Duration; maximum temporal range in [s]
  193.      */
  194.     public void setKernel(final Length sigma, final Duration tau, final Length xMax, final Duration tMax)
  195.     {
  196.         setKernelSI(sigma.si, tau.si, xMax.si, tMax.si);
  197.     }

  199.     /**
  200.      * Sets a Gaussian kernel with infinite range.
  201.      * @param sigma Length; spatial kernel size
  202.      * @param tau Duration; temporal kernel size
  203.      */
  204.     public void setGaussKernel(final Length sigma, final Duration tau)
  205.     {
  206.         setGaussKernelSI(sigma.si, tau.si);
  207.     }

  209.     /**
  210.      * Returns a Gaussian kernel with limited range.
  211.      * @param sigma Length; spatial kernel size in [m]
  212.      * @param tau Duration; temporal kernel size in [s]
  213.      * @param xMax Length; maximum spatial range in [m]
  214.      * @param tMax Duration; maximum temporal range in [s]
  215.      */
  216.     public void setGaussKernel(final Length sigma, final Duration tau, final Length xMax, final Duration tMax)
  217.     {
  218.         setGaussKernelSI(sigma.si, tau.si, xMax.si, tMax.si);
  219.     }

  221.     /**
  222.      * Sets a kernel with limited range and provided shape. The shape allows using non-exponential kernels.
  223.      * @param xMax Length; maximum spatial range
  224.      * @param tMax Duration; maximum temporal range
  225.      * @param shape KernelShape; shape of the kernel
  226.      */
  227.     public void setKernel(final Length xMax, final Duration tMax, final KernelShape shape)
  228.     {
  229.         setKernelSI(xMax.si, tMax.si, shape);
  230.     }

  232.     /**
  233.      * Returns filtered data.
  234.      * @param location LengthVector; location of output grid
  235.      * @param time DurationVector; time of output grid
  236.      * @param quantities Quantity&lt;?, ?&gt;...; quantities to calculate filtered data of
  237.      * @return Filter; filtered data, {@code null} when interrupted
  238.      */
  239.     public TypedFilter filter(final LengthVector location, final DurationVector time, final Quantity<?, ?>... quantities)
  240.     {
  241.         return new TypedFilter(filterSI(location.getValuesSI(), time.getValuesSI(), quantities));
  242.     }

  244.     /** {@inheritDoc} */
  245.     @Override
  246.     public String toString()
  247.     {
  248.         return "TypedEGTF []";
  249.     }

  251. }
Created with JaCoCo 0.8.12.202403310830