Backend

The backend module provides an abstraction layer for array operations, allowing XRayLabTool to run on either NumPy or JAX backends.

class xraylabtool.backend.InterpolationFactory

Bases: object

static create_pchip(x, y, extrapolate=False)

Return type:

Any

Parameters:

• x (Any)

• y (Any)

• extrapolate (bool)

xraylabtool.backend.get_backend()

Return type:

ArrayBackend

xraylabtool.backend.set_backend(name)

Return type:

None

Parameters:

name (str)

Array Operations

class xraylabtool.backend.array_ops.ArrayBackend(*args, **kwargs)

Bases: Protocol

property float64: Any

zeros(shape, dtype=np.float64)

Return type:

Any

Parameters:

• shape (Any)

• dtype (Any)

ones(shape, dtype=np.float64)

Return type:

Any

Parameters:

• shape (Any)

• dtype (Any)

asarray(x, dtype=None)

Return type:

Any

Parameters:

• x (Any)

• dtype (Any)

square(x)

Return type:

Any

Parameters:

x (Any)

sqrt(x)

Return type:

Any

Parameters:

x (Any)

exp(x)

Return type:

Any

Parameters:

x (Any)

sum(x, axis=None)

Return type:

Any

Parameters:

• x (Any)

• axis (Any)

where(condition, x, y)

Return type:

Any

Parameters:

• condition (Any)

• x (Any)

• y (Any)

maximum(x, y)

Return type:

Any

Parameters:

• x (Any)

• y (Any)

einsum(subscripts, *operands)

Return type:

Any

Parameters:

• subscripts (str)

• operands (Any)

isnan(x)

Return type:

Any

Parameters:

x (Any)

isinf(x)

Return type:

Any

Parameters:

x (Any)

isfinite(x)

Return type:

Any

Parameters:

x (Any)

any(x)

Return type:

bool

Parameters:

x (Any)

all(x)

Return type:

bool

Parameters:

x (Any)

linspace(start, stop, num)

Return type:

Any

Parameters:

• start (Any)

• stop (Any)

• num (int)

logspace(start, stop, num)

Return type:

Any

Parameters:

• start (Any)

• stop (Any)

• num (int)

argsort(x)

Return type:

Any

Parameters:

x (Any)

ascontiguousarray(x)

Return type:

Any

Parameters:

x (Any)

__init__(*args, **kwargs)

class xraylabtool.backend.array_ops.NumpyBackend

Bases: object

property float64: Any

zeros(shape, dtype=np.float64)

Return type:

Any

Parameters:

• shape (Any)

• dtype (Any)

ones(shape, dtype=np.float64)

Return type:

Any

Parameters:

• shape (Any)

• dtype (Any)

asarray(x, dtype=None)

Return type:

Any

Parameters:

• x (Any)

• dtype (Any)

square(x)

Return type:

Any

Parameters:

x (Any)

sqrt(x)

Return type:

Any

Parameters:

x (Any)

exp(x)

Return type:

Any

Parameters:

x (Any)

sum(x, axis=None)

Return type:

Any

Parameters:

• x (Any)

• axis (Any)

where(condition, x, y)

Return type:

Any

Parameters:

• condition (Any)

• x (Any)

• y (Any)

maximum(x, y)

Return type:

Any

Parameters:

• x (Any)

• y (Any)

einsum(subscripts, *operands)

Return type:

Any

Parameters:

• subscripts (str)

• operands (Any)

isnan(x)

Return type:

Any

Parameters:

x (Any)

isinf(x)

Return type:

Any

Parameters:

x (Any)

isfinite(x)

Return type:

Any

Parameters:

x (Any)

any(x)

Return type:

bool

Parameters:

x (Any)

all(x)

Return type:

bool

Parameters:

x (Any)

linspace(start, stop, num)

Return type:

Any

Parameters:

• start (Any)

• stop (Any)

• num (int)

logspace(start, stop, num)

Return type:

Any

Parameters:

• start (Any)

• stop (Any)

• num (int)

argsort(x)

Return type:

Any

Parameters:

x (Any)

ascontiguousarray(x)

Return type:

Any

Parameters:

x (Any)

class xraylabtool.backend.array_ops.JaxBackend

Bases: object

__init__()

Return type:

None

property float64: Any

zeros(shape, dtype=None)

Return type:

Any

Parameters:

• shape (Any)

• dtype (Any)

ones(shape, dtype=None)

Return type:

Any

Parameters:

• shape (Any)

• dtype (Any)

asarray(x, dtype=None)

Return type:

Any

Parameters:

• x (Any)

• dtype (Any)

square(x)

Return type:

Any

Parameters:

x (Any)

sqrt(x)

Return type:

Any

Parameters:

x (Any)

exp(x)

Return type:

Any

Parameters:

x (Any)

sum(x, axis=None)

Return type:

Any

Parameters:

• x (Any)

• axis (Any)

where(condition, x, y)

Return type:

Any

Parameters:

• condition (Any)

• x (Any)

• y (Any)

maximum(x, y)

Return type:

Any

Parameters:

• x (Any)

• y (Any)

einsum(subscripts, *operands)

Return type:

Any

Parameters:

• subscripts (str)

• operands (Any)

isnan(x)

Return type:

Any

Parameters:

x (Any)

isinf(x)

Return type:

Any

Parameters:

x (Any)

isfinite(x)

Return type:

Any

Parameters:

x (Any)

any(x)

Return type:

bool

Parameters:

x (Any)

all(x)

Return type:

bool

Parameters:

x (Any)

linspace(start, stop, num)

Return type:

Any

Parameters:

• start (Any)

• stop (Any)

• num (int)

logspace(start, stop, num)

Return type:

Any

Parameters:

• start (Any)

• stop (Any)

• num (int)

argsort(x)

Return type:

Any

Parameters:

x (Any)

ascontiguousarray(x)

Return type:

Any

Parameters:

x (Any)

xraylabtool.backend.array_ops.get_backend()

Return type:

ArrayBackend

xraylabtool.backend.array_ops.set_backend(name)

Return type:

None

Parameters:

name (str)

Interpolation

class xraylabtool.backend.interpolation.InterpolationFactory

Bases: object

static create_pchip(x, y, extrapolate=False)

Return type:

Any

Parameters:

• x (Any)

• y (Any)

• extrapolate (bool)