semantique.processor.reducers.range_

Contents

semantique.processor.reducers.range_#

semantique.processor.reducers.range_(x, track_types=True, **kwargs)[source]#

Return the difference between the maximum and minimum values in a set.

Parameters:
  • x (xarray.DataArray) – The array to be reduced.

  • track_types (bool) – Should the reducer promote the value type of the output object, based on the value type of the input object?

  • **kwargs – Additional keyword arguments. If the reducer has to be applied to a specific dimension, the keyword argument “dim” with as value the name of the targeted dimension should be specified here.

Returns:

xarray.DataArray – The reduced array.

Note

When tracking value types, this reducer uses the following type promotion manual, with the keys being the supported value types of x, and the corresponding value being the promoted value type of the output.

{'continuous': 'continuous', 'discrete': 'discrete', 'datetime': 'continuous'}

Note

When applied to an input containing timestamps as values, the output array will contain numerical values representing the difference between the most recent and least recent timestamp in nanoseconds.