foundryts.functions.scale

foundryts.functions.scale(factor)

Returns a function that multiplies each value in a single time series by the specified factor.

For a source time series with points (timestamp, value), upon scaling by factor, the resulting scaled time series will have points (timestamp, value * factor).

• Parameters: factor (float) – The scaling factor that is multiplied with the value of each point.
• Returns: A function that accepts a single time series as input and returns the scaled time series.
• Return type: (FunctionNode) -> FunctionNode

Dataframe schema

Examples

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
>>> series = F.points(
...     (100, 0.0),
...     (200, float("inf")),
...     (300, 3.14159),
...     (2147483647, 1.0),
...     name="series"
... )
>>> series.to_pandas()
                      timestamp    value
0 1970-01-01 00:00:00.000000100  0.00000
1 1970-01-01 00:00:00.000000200      inf
2 1970-01-01 00:00:00.000000300  3.14159
3 1970-01-01 00:00:02.147483647  1.00000

Copied!
1
2
3
4
5
6
7
>>> scaled = F.scale(1.5)(series)
>>> scaled.to_pandas()
                      timestamp     value
0 1970-01-01 00:00:00.000000100  0.000000
1 1970-01-01 00:00:00.000000200       inf
2 1970-01-01 00:00:00.000000300  4.712385
3 1970-01-01 00:00:02.147483647  1.500000