glass.arraytools — Array tools utilities

This module contains utilities for working with arrays which are used by GLASS.

This module should be imported manually if used outside of GLASS:

import glass.arraytools

General

glass.arraytools.broadcast_first(*arrays)

Broadcast arrays, treating the first axis as common.

Parameters:

arrays (Any) – The arrays to broadcast.

Returns:

The broadcasted arrays.

Return type:

tuple[Any, ...]

glass.arraytools.broadcast_leading_axes(*args, xp=None)

Broadcast all but the last N axes.

Parameters:

• args (tuple[Union[float, Any], int]) – The arrays and the number of axes to keep.

• xp (Optional[ModuleType]) – The array library backend to use for array operations.

Returns:

The shape of the broadcast dimensions, and all input arrays with leading axes matching that shape.

Return type:

tuple[tuple[int, ...], Unpack[tuple[Any, ...]]]

Examples

Broadcast all dimensions of a, all except the last dimension of b, and all except the last two dimensions of c.

>>> import numpy as np
>>> a = 0
>>> b = np.zeros((4, 10))
>>> c = np.zeros((3, 1, 5, 6))
>>> dims, a, b, c = broadcast_leading_axes((a, 0), (b, 1), (c, 2))
>>> dims
(3, 4)
>>> a.shape
(3, 4)
>>> b.shape
(3, 4, 10)
>>> c.shape
(3, 4, 5, 6)

glass.arraytools.cumulative_trapezoid(f, x)

Cumulative trapezoidal rule along last axis.

Parameters:

• f (Any) – The function values.

• x (Any) – The x-coordinates.

Returns:

The cumulative integral of the function.

Return type:

Any

glass.arraytools.ndinterp(x, xq, fq, axis=-1, left=None, right=None, period=None)

Interpolate multi-dimensional array over axis.

Parameters:

• x (Union[float, Any]) – The x-coordinates.

• xq (Any) – The x-coordinates of the data points.

• fq (Any) – The function values corresponding to the x-coordinates in xq.

• axis (int) – The axis to interpolate over.

• left (Optional[float]) – The value to return for x < xq[0].

• right (Optional[float]) – The value to return for x > xq[-1].

• period (Optional[float]) – The period of the function, used for interpolating periodic data.

Returns:

The interpolated array.

Return type:

Any

glass.arraytools.trapezoid_product(f, *ff, axis=-1)

Trapezoidal rule for a product of functions.

Parameters:

• f (tuple[Any, Any]) – The first function.

• ff (tuple[Any, Any]) – The other functions.

• axis (int) – The axis along which to integrate.

Returns:

The integral of the product of the functions.

Return type:

Union[float, Any]