stateCount() function

Warning! This page documents an earlier version of Flux, which is no longer actively developed. Flux v0.24 is the most recent stable version of Flux.

The stateCount() function computes the number of consecutive records in a given state.
The state is defined via the function fn.
For each consecutive point that evaluates as true, the state count will be incremented.
When a point evaluates as false, the state count is reset.
The state count is added as an additional column to each record.

Function type: TransformationOutput data type: Integer

stateCount(fn:(r)=>r._field=="state",column:"stateCount")

If the expression generates an error during evaluation, the point is discarded
and does not affect the state count.

Parameters

fn

A single argument function that evaluates true or false to identify the state of the record.
Records are passed to the function.
Those that evaluate to true increment the state count.
Those that evaluate to false reset the state count.

Data type: Function

column

The name of the column added to each record that contains the incremented state count.