agepy.mag.hysteresis.shift_branch

shift_branch(*magnetization, shift_value)

Shifts hysteresis branches relative to each other.

The shift is applied to the second branch.

Parameters:

*magnetization: Sequence

One or two sequences containing the hysteresis branches of the magnetization.

shift_value: float

Value added to the second hysteresis branch.

Returns:

NDArray

The shifted magnetization values. If magnetization is one continous array, then a 1-D array with the same length is returned. If magnetization is two arrays, a 2-D array is returned containing the two branches in the first axis.

Return type:

ndarray[Any, dtype[TypeVar(_ScalarType_co, bound= generic, covariant=True)]]