locan.visualize.transform.Transform#

class locan.visualize.transform.Transform[source]#

Bases: ABC

Abstract base class for transformation classes.

Methods

__init__()

inverse(values)

A transformation that performs the inverse operation.
abstract __call__(values, clip=True)[source]#

Transform values.

Parameters:

  • values (Union[_SupportsArray[dtype[Any]], _NestedSequence[_SupportsArray[dtype[Any]]], bool, int, float, complex, str, bytes, _NestedSequence[Union[bool, int, float, complex, str, bytes]]]) – The input values

  • clip (bool) – If True values outside the [0:1] range are clipped to the [0:1] range.

Returns:

The transformed values.

Return type:

npt.NDArray[Any]

abstract inverse(values)[source]#

A transformation that performs the inverse operation.

Return type:

ndarray[Any, dtype[Any]]