Class: QgsDateTimeStatisticalSummary¶
- class qgis.core.QgsDateTimeStatisticalSummary¶
Bases:
sip.wrapper
Calculator for summary statistics and aggregates for a list of datetimes.
Statistics are calculated by calling
calculate()
and passing a list of datetimes. The individual statistics can then be retrieved using the associated methods. Note that not all statistics are calculated by default. Statistics which require slower computations are only calculated by specifying the statistic in the constructor or viasetStatistics()
.QgsDateTimeStatisticalSummary(stats: Union[Qgis.DateTimeStatistics, Qgis.DateTimeStatistic] = Qgis.DateTimeStatistic.All) Constructor for QgsDateTimeStatisticalSummary
- Parameters:
stats – flags for statistics to calculate
QgsDateTimeStatisticalSummary(
QgsDateTimeStatisticalSummary
)Enums
alias of
DateTimeStatistic
Methods
Adds a single datetime to the statistics calculation.
Calculates summary statistics for a list of variants.
Returns the calculated count of values.
Returns the number of distinct datetime values.
Returns the number of missing (null) datetime values.
Returns the friendly display name for a statistic
Returns the set of distinct datetime values.
Must be called after adding all datetimes with
addValue()
and before retrieving any calculated datetime statistics.Returns the maximum (latest) non-null datetime value.
Returns the minimum (earliest) non-null datetime value.
Returns the range (interval between earliest and latest non-null datetime values).
Resets the calculated values
Sets flags which specify which statistics will be calculated.
Returns the value of a specified statistic
Returns flags which specify which statistics will be calculated.
- Statistic¶
alias of
DateTimeStatistic
- Statistics¶
alias of
DateTimeStatistics
- addValue(self, value: Any)¶
Adds a single datetime to the statistics calculation. Calling this method allows datetimes to be added to the calculation one at a time. For large quantities of dates this may be more efficient then first adding all the variants to a list and calling
calculate()
.- Parameters:
value (Any) – datetime to add. Any non-datetime variants will be ignored.
Note
call
reset()
before adding the first datetime using this method to clear the results from any previous calculationsNote
finalize()
must be called after adding the final value and before retrieving calculated statistics.See also
See also
- calculate(self, values: Iterable[Any])¶
Calculates summary statistics for a list of variants. Any non-datetime variants will be ignored.
- Parameters:
values (Iterable[Any]) – list of variants
See also
- count(self) int ¶
Returns the calculated count of values.
- Return type:
int
- countDistinct(self) int ¶
Returns the number of distinct datetime values.
- Return type:
int
- countMissing(self) int ¶
Returns the number of missing (null) datetime values.
- Return type:
int
- displayName(statistic: Qgis.DateTimeStatistic) str ¶
Returns the friendly display name for a statistic
- Parameters:
statistic (Qgis.DateTimeStatistic) – statistic to return name for
- Return type:
str
- distinctValues(self) Set[QDateTime] ¶
Returns the set of distinct datetime values.
- Return type:
Set[QDateTime]
- finalize(self)¶
Must be called after adding all datetimes with
addValue()
and before retrieving any calculated datetime statistics.See also
- max(self) QDateTime ¶
Returns the maximum (latest) non-null datetime value.
- Return type:
QDateTime
- min(self) QDateTime ¶
Returns the minimum (earliest) non-null datetime value.
- Return type:
QDateTime
- range(self) QgsInterval ¶
Returns the range (interval between earliest and latest non-null datetime values).
- Return type:
- reset(self)¶
Resets the calculated values
- setStatistics(self, stats: Qgis.DateTimeStatistics | Qgis.DateTimeStatistic)¶
Sets flags which specify which statistics will be calculated. Some statistics are always calculated (e.g., count).
- Parameters:
stats (Union[Qgis.DateTimeStatistics) – flags for statistics to calculate
See also
- statistic(self, stat: Qgis.DateTimeStatistic) Any ¶
Returns the value of a specified statistic
- Parameters:
stat (Qgis.DateTimeStatistic) – statistic to return
- Return type:
Any
- Returns:
calculated value of statistic
- statistics(self) Qgis.DateTimeStatistics ¶
Returns flags which specify which statistics will be calculated. Some statistics are always calculated (e.g., count).
See also
- Return type: