Documentation

experimental.integral() function

experimental.integral() is subject to change at any time.

experimental.integral() computes the area under the curve per unit of time of subsequent non-null records.

The curve is defined using _time as the domain and record values as the range.

Input tables must have _start, _stop, _time, and _valuecolumns._startand_stop` must be part of the group key.

Function type signature
(<-tables: stream[{A with _value: B, _time: time}], ?interpolate: string, ?unit: duration) => stream[{A with _value: B}]
For more information, see Function type signatures.

Parameters

unit

Time duration used to compute the integral.

interpolate

Type of interpolation to use. Default is "" (no interpolation).

Use one of the following interpolation options:

  • empty string ("") for no interpolation
  • linear

tables

Input data. Default is piped-forward data (<-).

Examples

Calculate the integral

import "experimental"
import "sampledata"

data =
    sampledata.int()
        |> range(start: sampledata.start, stop: sampledata.stop)

data
    |> experimental.integral(unit: 20s)

View example input and ouput

Calculate the integral with linear interpolation

import "experimental"
import "sampledata"

data =
    sampledata.int()
        |> range(start: sampledata.start, stop: sampledata.stop)

data
    |> experimental.integral(unit: 20s, interpolate: "linear")

View example input and ouput


Was this page helpful?

Thank you for your feedback!


Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.