Discriminants API reference

scared.discriminants.discriminant(function)

Decorator that build a discriminant from the function.

A discriminant is a function that takes a numeric array as input and returns array reduced over its last dimension, applying some kind of operation on it.

Parameters:

function (callable) – a function which takes a data Numpy ndarray as argument and returns data reduced over the last dimension.

Returns:

resulting discriminant function.

Return type:

(callable)

scared.discriminants.nanmax(data, axis)

Nan Max discriminant.

Returns:

(numpy.ndarray) nanmax value over the last dimension.

Nan Max discriminant.

Returns:

(numpy.ndarray) nanmax value over the last dimension.

scared.discriminants.maxabs(data, axis)

Nan absolute max discriminant.

Returns:

(numpy.ndarray) nanmax over absolute values of the last dimension.

Nan absolute max discriminant.

Returns:

(numpy.ndarray) nanmax over absolute values of the last dimension.

scared.discriminants.opposite_min(data, axis)

Opposite of min value.

Returns:

(numpy.ndarray) opposite of min value over the last dimension.

Opposite of min value.

Returns:

(numpy.ndarray) opposite of min value over the last dimension.

scared.discriminants.nansum(data, axis)

Sum discriminant function.

Returns:

(numpy.ndarray) sum over the last dimension.

Sum discriminant function.

Returns:

(numpy.ndarray) sum over the last dimension.

scared.discriminants.abssum(data, axis)

Sum on absolute discriminant function.

Returns:

(numpy.ndarray) sum over absolute values over the last dimension.

Sum on absolute discriminant function.

Returns:

(numpy.ndarray) sum over absolute values over the last dimension.