@@ -131,11 +131,10 @@ def average(
131
131
than the upper bound (e.g., across the prime meridian, dateline), by
132
132
default None.
133
133
min_weight : optional, float
134
- Fraction of data coverage (i.e, weight) needed to return a
135
- spatial average value. Value must range from 0 to 1, by default None
136
- (equivalent to ``min_weight=0.0``). This parameter is useful for
137
- cases where the weighting of data might be skewed based on the
138
- availability of data.
134
+ Minimum fraction of data coverage (weight) required to compute a
135
+ spatial average. Must be between 0 and 1. Useful for ensuring
136
+ accurate averages in regions with missing data, by default None
137
+ (equivalent to 0.0).
139
138
140
139
Returns
141
140
-------
@@ -738,8 +737,10 @@ def _averager(
738
737
axis : List[SpatialAxis] | Tuple[SpatialAxis, ...]
739
738
List of axis dimensions to average over.
740
739
min_weight : float
741
- Fraction of data coverage (i.e, weight) needed to return a
742
- spatial average value. Value must range from 0 to 1.
740
+ Minimum fraction of data coverage (weight) required to compute a
741
+ spatial average. Must be between 0 and 1. Useful for ensuring
742
+ accurate averages in regions with missing data, by default None
743
+ (equivalent to 0.0).
743
744
744
745
Returns
745
746
-------
@@ -798,8 +799,10 @@ def _mask_var_with_weight_threshold(
798
799
averaging. ``weights`` must include the same axis dimensions and
799
800
dimensional sizes as the data variable.
800
801
min_weight : float
801
- Fraction of data coverage (i.e, weight) needed to return a
802
- spatial average value. Value must range from 0 to 1.
802
+ Minimum fraction of data coverage (weight) required to compute a
803
+ spatial average. Must be between 0 and 1. Useful for ensuring
804
+ accurate averages in regions with missing data, by default None
805
+ (equivalent to 0.0).
803
806
804
807
Returns
805
808
-------
0 commit comments