scipp.islinspace

scipp.islinspace(x, dim=None)

Check if the values of a variable are evenly spaced.

Parameters:

• x (TypeVar(_T, Variable, DataGroup[object])) – Variable to check.

• dim (str | None, default: None) – Optional variable for the dim to check from the Variable.

Returns:

TypeVar(_T, Variable, DataGroup[object]) – Variable of value True if the variable contains regularly spaced values, variable of value False otherwise.

Examples

Check if values are evenly spaced:

>>> import scipp as sc
>>> x = sc.linspace('x', 0.0, 1.0, num=5, unit='m')
>>> x
<scipp.Variable> (x: 5)    float64              [m]  [0, 0.25, ..., 0.75, 1]
>>> sc.islinspace(x)
<scipp.Variable> ()       bool        <no unit>  True

Non-evenly spaced values return False:

>>> x_nonlin = sc.array(dims=['x'], values=[0.0, 1.0, 3.0, 4.0], unit='m')
>>> sc.islinspace(x_nonlin)
<scipp.Variable> ()       bool        <no unit>  False