Package org.djutils.stats.summarizers.event

Class StatisticsEvents

java.lang.Object
org.djutils.stats.summarizers.event.StatisticsEvents
public final class StatisticsEvents extends Object
StatisticsEvents defines the standard events for statistics.

Copyright (c) 2020-2024 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://djutils.org. The DJUTILS project is distributed under a three-clause BSD-style license, which can be found at https://djutils.org/docs/license.html.
Author:
Alexander Verbraeck, Peter Knoppers

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.djutils.event.EventType
    COUNT_EVENT
    COUNT_EVENT is fired whenever there is an observation that potentially updates the count of the Counter.
    static final org.djutils.event.EventType
    INITIALIZED_EVENT
    INITIALIZED_EVENT is fired whenever a statistic is (re-)initialized.
    static final org.djutils.event.EventType
    MAX_EVENT
    MAX_EVENT is fired whenever there is an observation that potentially updates the highest observed value of the statistic.
    static final org.djutils.event.EventType
    MIN_EVENT
    MIN_EVENT is fired whenever there is an observation that potentially updates the lowest observed value of the statistic.
    static final org.djutils.event.EventType
    N_EVENT
    N_EVENT is fired whenever n is updated.
    static final org.djutils.event.EventType
    OBSERVATION_ADDED_EVENT
    OBSERVATION_ADDED_EVENT is fired whenever an observation is processed.
    static final org.djutils.event.EventType
    POPULATION_EXCESS_KURTOSIS_EVENT
    EXCESS_KURTOSIS_EVENT is fired whenever there is an observation that potentially updates the population excess kurtosis of the statistic.
    static final org.djutils.event.EventType
    POPULATION_KURTOSIS_EVENT
    KURTOSIS_EVENT is fired whenever there is an observation that potentially updates the population kurtosis of the statistic.
    static final org.djutils.event.EventType
    POPULATION_MEAN_EVENT
    MEAN_EVENT is fired whenever there is an observation that potentially updates the population mean value of the statistic.
    static final org.djutils.event.EventType
    POPULATION_SKEWNESS_EVENT
    SKEWNESS_EVENT is fired whenever there is an observation that potentially updates the population skewness of the statistic.
    static final org.djutils.event.EventType
    POPULATION_STDEV_EVENT
    STDEV_EVENT is fired whenever there is an observation that potentially updates the population standard deviation of the statistic.
    static final org.djutils.event.EventType
    POPULATION_VARIANCE_EVENT
    VARIANCE_EVENT is fired whenever there is an observation that potentially updates the population variance of the statistic.
    static final org.djutils.event.EventType
    SAMPLE_EXCESS_KURTOSIS_EVENT
    SAMPLE_KURTOSIS_EVENT is fired whenever there is an observation that potentially updates the sample excess kurtosis of the statistic.
    static final org.djutils.event.EventType
    SAMPLE_KURTOSIS_EVENT
    SAMPLE_KURTOSIS_EVENT is fired whenever there is an observation that potentially updates the sample kurtosis of the statistic.
    static final org.djutils.event.EventType
    SAMPLE_MEAN_EVENT
    SAMPLE_MEAN_EVENT is fired whenever there is an observation that potentially updates the sample mean value of the statistic.
    static final org.djutils.event.EventType
    SAMPLE_SKEWNESS_EVENT
    SAMPLE_SKEWNESS_EVENT is fired whenever there is an observation that potentially updates the sample skewness of the statistic.
    static final org.djutils.event.EventType
    SAMPLE_STDEV_EVENT
    SAMPLE_STDEV_EVENT is fired whenever there is an observation that potentially updates the sample standard deviation of the statistic.
    static final org.djutils.event.EventType
    SAMPLE_VARIANCE_EVENT
    SAMPLE_VARIANCE_EVENT is fired whenever there is an observation that potentially updates the sample variance of the statistic.
    static final org.djutils.event.EventType
    SUM_EVENT
    SUM_EVENT is fired whenever there is an observation that potentially updates the sum value of the statistic.
    static final org.djutils.event.EventType
    TIMED_MAX_EVENT
    TIMED_MAX_EVENT is fired whenever there is an observation that potentially updates the highest observed value of the statistic.
    static final org.djutils.event.EventType
    TIMED_MIN_EVENT
    TIMED_MIN_EVENT is fired whenever there is an observation that potentially updates the lowest observed value of the statistic.
    static final org.djutils.event.EventType
    TIMED_N_EVENT
    TIMED_N_EVENT is fired whenever n is updated.
    static final org.djutils.event.EventType
    TIMED_WEIGHTED_POPULATION_MEAN_EVENT
    TIMED_WEIGHTED_MEAN_EVENT is fired whenever there is an observation that potentially updates the weighted population mean value of the statistic.
    static final org.djutils.event.EventType
    TIMED_WEIGHTED_POPULATION_STDEV_EVENT
    TIMED_WEIGHTED_STDEV_EVENT is fired whenever there is an observation that potentially updates the weighted population standard deviation of the statistic.
    static final org.djutils.event.EventType
    TIMED_WEIGHTED_POPULATION_VARIANCE_EVENT
    TIMED_WEIGHTED_VARIANCE_EVENT is fired whenever there is an observation that potentially updates the weighted population variance of the statistic.
    static final org.djutils.event.EventType
    TIMED_WEIGHTED_SAMPLE_MEAN_EVENT
    TIMED_WEIGHTED_SAMPLE_MEAN_EVENT is fired whenever there is an observation that potentially updates the weighted sample mean value of the statistic.
    static final org.djutils.event.EventType
    TIMED_WEIGHTED_SAMPLE_STDEV_EVENT
    TIMED_WEIGHTED_SAMPLE_STDEV_EVENT is fired whenever there is an observation that potentially updates the weighted sample standard deviation of the statistic.
    static final org.djutils.event.EventType
    TIMED_WEIGHTED_SAMPLE_VARIANCE_EVENT
    TIMED_WEIGHTED_SAMPLE_VARIANCE_EVENT is fired whenever there is an observation that potentially updates the weighted sample variance of the statistic.
    static final org.djutils.event.EventType
    TIMED_WEIGHTED_SUM_EVENT
    TIMED_WEIGHTED_SUM_EVENT is fired whenever there is an observation that potentially updates the weighted sum value of the statistic.
    static final org.djutils.event.EventType
    TIMESTAMPED_OBSERVATION_ADDED_EVENT
    OBSERVATION_ADDED_EVENT is fired whenever an observation is processed.
    static final org.djutils.event.EventType
    WEIGHTED_OBSERVATION_ADDED_EVENT
    WEIGTHED_OBSERVATION_ADDED_EVENT is fired whenever a weighted observation is processed.
    static final org.djutils.event.EventType
    WEIGHTED_POPULATION_MEAN_EVENT
    WEIGHTED_MEAN_EVENT is fired whenever there is an observation that potentially updates the weighted population mean value of the statistic.
    static final org.djutils.event.EventType
    WEIGHTED_POPULATION_STDEV_EVENT
    WEIGHTED_STDEV_EVENT is fired whenever there is an observation that potentially updates the weighted population standard deviation of the statistic.
    static final org.djutils.event.EventType
    WEIGHTED_POPULATION_VARIANCE_EVENT
    WEIGHTED_VARIANCE_EVENT is fired whenever there is an observation that potentially updates the weighted population variance of the statistic.
    static final org.djutils.event.EventType
    WEIGHTED_SAMPLE_MEAN_EVENT
    WEIGHTED_SAMPLE_MEAN_EVENT is fired whenever there is an observation that potentially updates the weighted sample mean value of the statistic.
    static final org.djutils.event.EventType
    WEIGHTED_SAMPLE_STDEV_EVENT
    WEIGHTED_SAMPLE_STDEV_EVENT is fired whenever there is an observation that potentially updates the weighted sample standard deviation of the statistic.
    static final org.djutils.event.EventType
    WEIGHTED_SAMPLE_VARIANCE_EVENT
    WEIGHTED_SAMPLE_VARIANCE_EVENT is fired whenever there is an observation that potentially updates the weighted sample variance of the statistic.
    static final org.djutils.event.EventType
    WEIGHTED_SUM_EVENT
    WEIGHTED_SUM_EVENT is fired whenever there is an observation that potentially updates the weighted sum value of the statistic.

  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • INITIALIZED_EVENT

      public static final org.djutils.event.EventType INITIALIZED_EVENT
      INITIALIZED_EVENT is fired whenever a statistic is (re-)initialized. The event should define the Statistic as the source and null as the content.

    • OBSERVATION_ADDED_EVENT

      public static final org.djutils.event.EventType OBSERVATION_ADDED_EVENT
      OBSERVATION_ADDED_EVENT is fired whenever an observation is processed. The event should define the Statistic as the source and the observation value as the content.

    • WEIGHTED_OBSERVATION_ADDED_EVENT

      public static final org.djutils.event.EventType WEIGHTED_OBSERVATION_ADDED_EVENT
      WEIGTHED_OBSERVATION_ADDED_EVENT is fired whenever a weighted observation is processed. The event should define the Statistic as the source and an Object[] with { weight, observation_value } as the content.

    • TIMESTAMPED_OBSERVATION_ADDED_EVENT

      public static final org.djutils.event.EventType TIMESTAMPED_OBSERVATION_ADDED_EVENT
      OBSERVATION_ADDED_EVENT is fired whenever an observation is processed. The event should define the Statistic as the source and an Object[] with { timestamp, observation_value } as the content. This event is also fired at the end of the observations to signal the final values.

    • N_EVENT

      public static final org.djutils.event.EventType N_EVENT
      N_EVENT is fired whenever n is updated. The event should define the Statistic as the source and the current (Long) value of n as the content.

    • COUNT_EVENT

      public static final org.djutils.event.EventType COUNT_EVENT
      COUNT_EVENT is fired whenever there is an observation that potentially updates the count of the Counter. The event should define the Statistic as the source and the current (Long) count value as the content.

    • MIN_EVENT

      public static final org.djutils.event.EventType MIN_EVENT
      MIN_EVENT is fired whenever there is an observation that potentially updates the lowest observed value of the statistic. The event should define the Statistic as the source and the current minimum observed value as the content.

    • MAX_EVENT

      public static final org.djutils.event.EventType MAX_EVENT
      MAX_EVENT is fired whenever there is an observation that potentially updates the highest observed value of the statistic. The event should define the Statistic as the source and the current maximum observed value as the content.

    • POPULATION_MEAN_EVENT

      public static final org.djutils.event.EventType POPULATION_MEAN_EVENT
      MEAN_EVENT is fired whenever there is an observation that potentially updates the population mean value of the statistic. The event should define the Statistic as the source and the current population mean as the content.

    • POPULATION_VARIANCE_EVENT

      public static final org.djutils.event.EventType POPULATION_VARIANCE_EVENT
      VARIANCE_EVENT is fired whenever there is an observation that potentially updates the population variance of the statistic. The event should define the Statistic as the source and the current population variance as the content.

    • POPULATION_SKEWNESS_EVENT

      public static final org.djutils.event.EventType POPULATION_SKEWNESS_EVENT
      SKEWNESS_EVENT is fired whenever there is an observation that potentially updates the population skewness of the statistic. The event should define the Statistic as the source and the current population skewness as the content.

    • POPULATION_KURTOSIS_EVENT

      public static final org.djutils.event.EventType POPULATION_KURTOSIS_EVENT
      KURTOSIS_EVENT is fired whenever there is an observation that potentially updates the population kurtosis of the statistic. The event should define the Statistic as the source and the current population kurtosis as the content.

    • POPULATION_EXCESS_KURTOSIS_EVENT

      public static final org.djutils.event.EventType POPULATION_EXCESS_KURTOSIS_EVENT
      EXCESS_KURTOSIS_EVENT is fired whenever there is an observation that potentially updates the population excess kurtosis of the statistic. The event should define the Statistic as the source and the current population excess kurtosis as the content.

    • POPULATION_STDEV_EVENT

      public static final org.djutils.event.EventType POPULATION_STDEV_EVENT
      STDEV_EVENT is fired whenever there is an observation that potentially updates the population standard deviation of the statistic. The event should define the Statistic as the source and the current population standard deviation as the content.

    • SUM_EVENT

      public static final org.djutils.event.EventType SUM_EVENT
      SUM_EVENT is fired whenever there is an observation that potentially updates the sum value of the statistic. The event should define the Statistic as the source and the current sum as the content.

    • SAMPLE_MEAN_EVENT

      public static final org.djutils.event.EventType SAMPLE_MEAN_EVENT
      SAMPLE_MEAN_EVENT is fired whenever there is an observation that potentially updates the sample mean value of the statistic. The event should define the Statistic as the source and the current sample mean as the content.

    • SAMPLE_VARIANCE_EVENT

      public static final org.djutils.event.EventType SAMPLE_VARIANCE_EVENT
      SAMPLE_VARIANCE_EVENT is fired whenever there is an observation that potentially updates the sample variance of the statistic. The event should define the Statistic as the source and the current sample variance as the content.

    • SAMPLE_SKEWNESS_EVENT

      public static final org.djutils.event.EventType SAMPLE_SKEWNESS_EVENT
      SAMPLE_SKEWNESS_EVENT is fired whenever there is an observation that potentially updates the sample skewness of the statistic. The event should define the Statistic as the source and the current sample skewness as the content.

    • SAMPLE_KURTOSIS_EVENT

      public static final org.djutils.event.EventType SAMPLE_KURTOSIS_EVENT
      SAMPLE_KURTOSIS_EVENT is fired whenever there is an observation that potentially updates the sample kurtosis of the statistic. The event should define the Statistic as the source and the current sample kurtosis as the content.

    • SAMPLE_EXCESS_KURTOSIS_EVENT

      public static final org.djutils.event.EventType SAMPLE_EXCESS_KURTOSIS_EVENT
      SAMPLE_KURTOSIS_EVENT is fired whenever there is an observation that potentially updates the sample excess kurtosis of the statistic. The event should define the Statistic as the source and the current sample excess kurtosis as the content.

    • SAMPLE_STDEV_EVENT

      public static final org.djutils.event.EventType SAMPLE_STDEV_EVENT
      SAMPLE_STDEV_EVENT is fired whenever there is an observation that potentially updates the sample standard deviation of the statistic. The event should define the Statistic as the source and the current sample standard deviation as the content.

    • WEIGHTED_POPULATION_MEAN_EVENT

      public static final org.djutils.event.EventType WEIGHTED_POPULATION_MEAN_EVENT
      WEIGHTED_MEAN_EVENT is fired whenever there is an observation that potentially updates the weighted population mean value of the statistic. The event should define the Statistic as the source and the current weighted population mean as the content.

    • WEIGHTED_POPULATION_VARIANCE_EVENT

      public static final org.djutils.event.EventType WEIGHTED_POPULATION_VARIANCE_EVENT
      WEIGHTED_VARIANCE_EVENT is fired whenever there is an observation that potentially updates the weighted population variance of the statistic. The event should define the Statistic as the source and the current weighted population variance as the content.

    • WEIGHTED_POPULATION_STDEV_EVENT

      public static final org.djutils.event.EventType WEIGHTED_POPULATION_STDEV_EVENT
      WEIGHTED_STDEV_EVENT is fired whenever there is an observation that potentially updates the weighted population standard deviation of the statistic. The event should define the Statistic as the source and the current weighted population standard deviation as the content.

    • WEIGHTED_SUM_EVENT

      public static final org.djutils.event.EventType WEIGHTED_SUM_EVENT
      WEIGHTED_SUM_EVENT is fired whenever there is an observation that potentially updates the weighted sum value of the statistic. The event should define the Statistic as the source and the current weighted sum as the content.

    • WEIGHTED_SAMPLE_MEAN_EVENT

      public static final org.djutils.event.EventType WEIGHTED_SAMPLE_MEAN_EVENT
      WEIGHTED_SAMPLE_MEAN_EVENT is fired whenever there is an observation that potentially updates the weighted sample mean value of the statistic. The event should define the Statistic as the source and the current weighted sample mean as the content.

    • WEIGHTED_SAMPLE_VARIANCE_EVENT

      public static final org.djutils.event.EventType WEIGHTED_SAMPLE_VARIANCE_EVENT
      WEIGHTED_SAMPLE_VARIANCE_EVENT is fired whenever there is an observation that potentially updates the weighted sample variance of the statistic. The event should define the Statistic as the source and the current weighted sample variance as the content.

    • WEIGHTED_SAMPLE_STDEV_EVENT

      public static final org.djutils.event.EventType WEIGHTED_SAMPLE_STDEV_EVENT
      WEIGHTED_SAMPLE_STDEV_EVENT is fired whenever there is an observation that potentially updates the weighted sample standard deviation of the statistic. The event should define the Statistic as the source and the current weighted sample standard deviation as the content.

    • TIMED_N_EVENT

      public static final org.djutils.event.EventType TIMED_N_EVENT
      TIMED_N_EVENT is fired whenever n is updated. The event should define the Statistic as the source and the current (Long) value of n as the content.

    • TIMED_MIN_EVENT

      public static final org.djutils.event.EventType TIMED_MIN_EVENT
      TIMED_MIN_EVENT is fired whenever there is an observation that potentially updates the lowest observed value of the statistic. The event should define the Statistic as the source and the current minimum observed value as the content.

    • TIMED_MAX_EVENT

      public static final org.djutils.event.EventType TIMED_MAX_EVENT
      TIMED_MAX_EVENT is fired whenever there is an observation that potentially updates the highest observed value of the statistic. The event should define the Statistic as the source and the current maximum observed value as the content.

    • TIMED_WEIGHTED_POPULATION_MEAN_EVENT

      public static final org.djutils.event.EventType TIMED_WEIGHTED_POPULATION_MEAN_EVENT
      TIMED_WEIGHTED_MEAN_EVENT is fired whenever there is an observation that potentially updates the weighted population mean value of the statistic. The event should define the Statistic as the source and the current weighted population mean as the content.

    • TIMED_WEIGHTED_POPULATION_VARIANCE_EVENT

      public static final org.djutils.event.EventType TIMED_WEIGHTED_POPULATION_VARIANCE_EVENT
      TIMED_WEIGHTED_VARIANCE_EVENT is fired whenever there is an observation that potentially updates the weighted population variance of the statistic. The event should define the Statistic as the source and the current weighted population variance as the content.

    • TIMED_WEIGHTED_POPULATION_STDEV_EVENT

      public static final org.djutils.event.EventType TIMED_WEIGHTED_POPULATION_STDEV_EVENT
      TIMED_WEIGHTED_STDEV_EVENT is fired whenever there is an observation that potentially updates the weighted population standard deviation of the statistic. The event should define the Statistic as the source and the current weighted population standard deviation as the content.

    • TIMED_WEIGHTED_SUM_EVENT

      public static final org.djutils.event.EventType TIMED_WEIGHTED_SUM_EVENT
      TIMED_WEIGHTED_SUM_EVENT is fired whenever there is an observation that potentially updates the weighted sum value of the statistic. The event should define the Statistic as the source and the current weighted sum as the content.

    • TIMED_WEIGHTED_SAMPLE_MEAN_EVENT

      public static final org.djutils.event.EventType TIMED_WEIGHTED_SAMPLE_MEAN_EVENT
      TIMED_WEIGHTED_SAMPLE_MEAN_EVENT is fired whenever there is an observation that potentially updates the weighted sample mean value of the statistic. The event should define the Statistic as the source and the current weighted sample mean as the content.

    • TIMED_WEIGHTED_SAMPLE_VARIANCE_EVENT

      public static final org.djutils.event.EventType TIMED_WEIGHTED_SAMPLE_VARIANCE_EVENT
      TIMED_WEIGHTED_SAMPLE_VARIANCE_EVENT is fired whenever there is an observation that potentially updates the weighted sample variance of the statistic. The event should define the Statistic as the source and the current weighted sample variance as the content.

    • TIMED_WEIGHTED_SAMPLE_STDEV_EVENT

      public static final org.djutils.event.EventType TIMED_WEIGHTED_SAMPLE_STDEV_EVENT
      TIMED_WEIGHTED_SAMPLE_STDEV_EVENT is fired whenever there is an observation that potentially updates the weighted sample standard deviation of the statistic. The event should define the Statistic as the source and the current weighted sample standard deviation as the content.