spameanweighted#
- ens_calculator.spameanweighted(source_parts: List[ENS_PART] | List[int] | List[str] | ENS_PART | int | str, variable: ENS_VAR | str | int, component: str = '[X]', weight: str | int | ENS_VAR | None = None, result_type: str = 'Compute_Per_case', output_varname: str | None = None) ENS_VAR #
Computes a constant variable defined as the volume (or area) weighted mean of the variable specified. Volume or area is weighted by a second variable.
- Args:
- source_parts:
Any part(s) or a part number.
- variable:
A scalar or vector variable.
- component:
A vector component [X], [Y], [Z] or [] for magnitude.
- weight:
A scalar or vector variable.
- result_type:
Per/Case or Per/Part Results
- output_varname:
The name of the newly created variable
- Returns:
New ENS_VAR instance or None
- Note:
See SpaMeanWeighted() for function details.