Aggregations
Aggregations
¶
Standard aggregations for batch KPI computation.
All aggregations operate column-wise on DataFrames and return a Series with one value per column.
Examples:
>>> Aggregations.Mean(pd.DataFrame({'N1': [10, 20, 30], 'N2': [15, 25, 35]}))
N1 20.0
N2 25.0
dtype: float64
Source code in src/mesqual/kpis/aggregations.py
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 | |
Sum
class-attribute
instance-attribute
¶
Sum = Aggregation('Sum', lambda df: _column_wise_sum(_ensure_frame_format(df)))
Total
class-attribute
instance-attribute
¶
Total = Aggregation('Total', lambda df: _column_wise_sum(_ensure_frame_format(df)))
Mean
class-attribute
instance-attribute
¶
Mean = Aggregation('Mean', lambda df: _ensure_frame_format(df).mean(axis=0))
Max
class-attribute
instance-attribute
¶
Max = Aggregation('Max', lambda df: _ensure_frame_format(df).max(axis=0))
Min
class-attribute
instance-attribute
¶
Min = Aggregation('Min', lambda df: _ensure_frame_format(df).min(axis=0))
AnnualizedSum
class-attribute
instance-attribute
¶
AnnualizedSum = Aggregation('AnnualizedSum', _annualized_sum_batch)
AbsSum
class-attribute
instance-attribute
¶
AbsSum = Aggregation('AbsSum', lambda df: _ensure_frame_format(df).abs().sum(axis=0))
AbsMax
class-attribute
instance-attribute
¶
AbsMax = Aggregation('AbsMax', lambda df: _ensure_frame_format(df).abs().max(axis=0))
AbsMean
class-attribute
instance-attribute
¶
AbsMean = Aggregation('AbsMean', lambda df: _ensure_frame_format(df).abs().mean(axis=0))
AbsMin
class-attribute
instance-attribute
¶
AbsMin = Aggregation('AbsMin', lambda df: _ensure_frame_format(df).abs().min(axis=0))
SumGeqZero
class-attribute
instance-attribute
¶
SumGeqZero = Aggregation('SumGeqZero', lambda df: _ensure_frame_format(df).clip(0, None).sum(axis=0))
SumLeqZero
class-attribute
instance-attribute
¶
SumLeqZero = Aggregation('SumLeqZero', lambda df: _ensure_frame_format(df).clip(None, 0).sum(axis=0))
MeanGeqZero
class-attribute
instance-attribute
¶
MeanGeqZero = Aggregation('MeanGeqZero', lambda df: _ensure_frame_format(df).clip(0, None).mean(axis=0))
MeanLeqZero
class-attribute
instance-attribute
¶
MeanLeqZero = Aggregation('MeanLeqZero', lambda df: _ensure_frame_format(df).clip(None, 0).mean(axis=0))
MTUsWithNaN
class-attribute
instance-attribute
¶
MTUsWithNaN = Aggregation('MTUsWithNaN', lambda df: _ensure_frame_format(df).isna().sum(axis=0), Units.MTU)
MTUsNonZero
class-attribute
instance-attribute
¶
MTUsNonZero = Aggregation('MTUsNonZero', lambda df: ((_ensure_frame_format(df) != 0) & ~_ensure_frame_format(df).isna()).sum(axis=0), Units.MTU)
MTUsEqZero
class-attribute
instance-attribute
¶
MTUsEqZero = Aggregation('MTUsEqZero', lambda df: (_ensure_frame_format(df) == 0).sum(axis=0), Units.MTU)
MTUsAboveZero
class-attribute
instance-attribute
¶
MTUsAboveZero = Aggregation('MTUsAboveZero', lambda df: (_ensure_frame_format(df) > 0).sum(axis=0), Units.MTU)
MTUsBelowZero
class-attribute
instance-attribute
¶
MTUsBelowZero = Aggregation('MTUsBelowZero', lambda df: (_ensure_frame_format(df) < 0).sum(axis=0), Units.MTU)
MTUsAboveX
staticmethod
¶
MTUsAboveX(x: float) -> Aggregation
Count timesteps where value is above threshold.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x
|
float
|
Threshold value |
required |
Returns:
| Type | Description |
|---|---|
Aggregation
|
Aggregation that counts timesteps > x per column |
Source code in src/mesqual/kpis/aggregations.py
159 160 161 162 163 164 165 166 167 168 169 170 | |
MTUsBelowX
staticmethod
¶
MTUsBelowX(x: float) -> Aggregation
Count timesteps where value is below threshold.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x
|
float
|
Threshold value |
required |
Returns:
| Type | Description |
|---|---|
Aggregation
|
Aggregation that counts timesteps < x per column |
Source code in src/mesqual/kpis/aggregations.py
172 173 174 175 176 177 178 179 180 181 182 183 | |
ValueComparisons
¶
Standard comparison operations for KPIs.
Used to compare variation vs reference scenarios.
Examples:
>>> ValueComparisons.Increase(120, 100)
20
>>> ValueComparisons.PercentageIncrease(120, 100)
20.0
Source code in src/mesqual/kpis/aggregations.py
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 | |
Increase
class-attribute
instance-attribute
¶
Increase = ValueComparison('Increase', lambda var, ref: var - ref)
Decrease
class-attribute
instance-attribute
¶
Decrease = ValueComparison('Decrease', lambda var, ref: ref - var)
PercentageIncrease
class-attribute
instance-attribute
¶
PercentageIncrease = ValueComparison('PercentageIncrease', lambda var, ref: np.inf * np.sign(var) if ref == 0 else (var - ref) / ref * 100, Units.percent)
PercentageDecrease
class-attribute
instance-attribute
¶
PercentageDecrease = ValueComparison('PercentageDecrease', lambda var, ref: -1 * np.inf * np.sign(var) if ref == 0 else (ref - var) / ref * 100, Units.percent)
Share
class-attribute
instance-attribute
¶
Share = ValueComparison('Share', lambda var, ref: np.inf * np.sign(var) if ref == 0 else var / ref * 100, Units.percent)
Ratio
class-attribute
instance-attribute
¶
Ratio = ValueComparison('Ratio', lambda var, ref: np.inf * np.sign(var) if ref == 0 else var / ref * 100, Units.ratio)
Delta
class-attribute
instance-attribute
¶
Delta = ValueComparison('Delta', lambda var, ref: var - ref)
Diff
class-attribute
instance-attribute
¶
Diff = ValueComparison('Diff', lambda var, ref: var - ref)
ArithmeticValueOperations
¶
Standard arithmetic operations for KPIs.
Used to derive new KPI values from existing ones.
Examples:
>>> ArithmeticValueOperations.Sum(100, 50)
150
>>> ArithmeticValueOperations.Division(100, 50)
2.0
Source code in src/mesqual/kpis/aggregations.py
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 | |
Product
class-attribute
instance-attribute
¶
Product = ArithmeticValueOperation('Product', lambda var, ref: var * ref)
Division
class-attribute
instance-attribute
¶
Division = ArithmeticValueOperation('Division', lambda var, ref: np.inf * np.sign(var) if ref == 0 else var / ref)
Share
class-attribute
instance-attribute
¶
Share = ArithmeticValueOperation('Share', lambda var, ref: np.inf * np.sign(var) if ref == 0 else var / ref * 100, Units.percent)
Sum
class-attribute
instance-attribute
¶
Sum = ArithmeticValueOperation('Sum', lambda var, ref: var + ref)
Diff
class-attribute
instance-attribute
¶
Diff = ArithmeticValueOperation('Diff', lambda var, ref: var - ref)
Delta
class-attribute
instance-attribute
¶
Delta = ArithmeticValueOperation('Delta', lambda var, ref: var - ref)
Aggregation
dataclass
¶
Aggregation function for batch KPI computation.
An aggregation takes a whole DataFrame and returns a Series with one value per column, that is one value per object.
Attributes:
| Name | Type | Description |
|---|---|---|
name |
str
|
Human-readable name of the aggregation |
agg |
Callable[[DataFrame], Series]
|
Function that takes DataFrame and returns Series |
unit |
Unit
|
Optional unit override (e.g., MTU for time-based counts) |
Source code in src/mesqual/kpis/aggregations.py
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 | |
__call__
¶
__call__(df: DataFrame) -> Series
Apply aggregation to DataFrame, return Series with one value per column.
Source code in src/mesqual/kpis/aggregations.py
31 32 33 | |
__str__
¶
__str__()
Source code in src/mesqual/kpis/aggregations.py
35 36 | |
__hash__
¶
__hash__()
Source code in src/mesqual/kpis/aggregations.py
38 39 | |
__eq__
¶
__eq__(other) -> bool
Source code in src/mesqual/kpis/aggregations.py
41 42 | |
OperationOfTwoValues
dataclass
¶
Operation that combines two scalar values.
Used for comparison KPIs (e.g., difference between scenarios) and arithmetic operations between KPI values.
Attributes:
| Name | Type | Description |
|---|---|---|
name |
str
|
Human-readable name of the operation |
agg |
Callable[[float | int, float | int], float | int]
|
Function that takes two scalars and returns a scalar |
unit |
Unit
|
Optional unit override |
Source code in src/mesqual/kpis/aggregations.py
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 | |
__init__
¶
__init__(name: str, agg: Callable[[float | int, float | int], float | int], unit: Unit = None) -> None
__call__
¶
__call__(variation_value: float | int, reference_value: float | int) -> float | int
Apply operation to two values.
Source code in src/mesqual/kpis/aggregations.py
204 205 206 | |
__str__
¶
__str__()
Source code in src/mesqual/kpis/aggregations.py
208 209 | |
__hash__
¶
__hash__()
Source code in src/mesqual/kpis/aggregations.py
211 212 | |
__eq__
¶
__eq__(other) -> bool
Source code in src/mesqual/kpis/aggregations.py
214 215 | |
ValueComparison
dataclass
¶
Bases: OperationOfTwoValues
Comparison operation between two KPI values (e.g., difference, percentage change).
Source code in src/mesqual/kpis/aggregations.py
218 219 220 221 | |
ArithmeticValueOperation
dataclass
¶
Bases: OperationOfTwoValues
Arithmetic operation between two KPI values (e.g., sum, product).
Source code in src/mesqual/kpis/aggregations.py
259 260 261 262 | |