semantique.processor.reducers.percentage_

semantique.processor.reducers.percentage_(x, track_types=True, **kwargs)

Calculate the percentage of true 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

Missing values in x are ignored. That means that this reducer will return how much percent of the non-null values are true. If all values in the set are null, it returns null.

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.

{'binary': 'continuous'}