Package org.sensorhub.api.datastore.obs

Class ObsStats

java.lang.Object
org.sensorhub.api.datastore.obs.ObsStats
public class ObsStats extends Object

Immutable object representing statistics for observations associated to a pair of single data stream and FOI.

Since:
Sep 13, 2019

  • Field Details

    • dataStreamID

      protected BigId dataStreamID

    • foiID

      protected FeatureId foiID

    • phenomenonTimeRange

      protected TimeExtent phenomenonTimeRange

    • resultTimeRange

      protected TimeExtent resultTimeRange

    • phenomenonBbox

      protected Bbox phenomenonBbox

    • totalObsCount

      protected long totalObsCount

    • obsCountsByTime

      protected int[] obsCountsByTime

  • Method Details

    • getDataStreamID

      public BigId getDataStreamID()
      Returns:
      The ID of the datastream that these statistics apply to

    • getFoiID

      public FeatureId getFoiID()
      Returns:
      The unique ID of the feature of interest targeted by observations in this bucket.

    • getPhenomenonTimeRange

      public TimeExtent getPhenomenonTimeRange()
      Returns:
      The time range spanned by phenomenon times of all selected observations

    • getResultTimeRange

      public TimeExtent getResultTimeRange()
      Returns:
      The time range spanned by result times of all selected observations. There are 3 main cases:
    • The returned range is equal to the phenomenon time range for many sensors for which sampling and measurement operations are considered to be simultaneous (most electronic sensors fit into this category).
    • The returned range is different from the phenomenon time range when the measured phenomenon happened in the past or is forecasted to happen in the future.
    • A time instant is returned if all observation in the series share the same result time (e.g. model run).

    • getPhenomenonBbox

      public Bbox getPhenomenonBbox()
      Returns:
      Bounding rectangle enclosing phenomenon locations of all selected observations

    • getTotalObsCount

      public long getTotalObsCount()
      Returns:
      The total number of selected observations

    • getObsCountsByTime

      public int[] getObsCountsByTime()
      Returns:
      The histogram of observation counts vs. time

    • toString

      public String toString()
      Overrides:
      toString in class Object