mrpro.operators.ScaledFunctional

class mrpro.operators.ScaledFunctional(functional: Functional, scale: Tensor | float)

Bases: Functional

Functional scaled by a scalar.

__init__(functional: Functional, scale: Tensor | float) → None

Initialize a scaled functional.

A scaled functional is a functional that is scaled by a scalar factor \(\alpha\), i.e. \(f(x) = \alpha g(x)\).

Parameters:

• functional – functional to be scaled

• scale – scaling factor, must be real and positive

forward(x: Tensor) → tuple[Tensor]

Forward method.

Parameters:

x – input tensor

Return type:

scaled output of the functional