Skip to content

qttools.utils.stack_utils#

[docs] module qttools.utils.stack_utils 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# Copyright (c) 2024 ETH Zurich and the authors of the qttools package.

from qttools import NDArray
from qttools.profiling import Profiler

profiler = Profiler()


@profiler.profile(level="debug")
def scale_stack(stacked: NDArray, factor: NDArray, axis: int = 0) -> NDArray:
    """Scales the given stack by the given factor.

    Parameters
    ----------
    stacked : NDArray
        The stack to scale.
    factor : NDArray
        The factor to scale the stack by.
    axis : int, optional
        The axis along which to scale the stack.

    Returns
    -------
    NDArray
        The scaled stack of arrays

    """
    if not stacked.shape[axis] == factor.shape[0]:
        raise ValueError("The shape of the stack and the factor do not match.")

    for i in range(stacked.shape[axis]):
        stacked.swapaxes(axis, 0)[i] *= factor[i]

    return stacked