flowmachine.features.subscriber.interevent_interval¶
Source: flowmachine/features/subscriber/interevent_interval.py
Intervent period statistics, such as the average and standard deviation of the duration between calls.
Class IntereventInterval¶
IntereventInterval(start: str, stop: str, statistic: flowmachine.core.statistic_types.Statistic = <Statistic.AVG: 'avg'>, *, hours: Union[str, Tuple[int, int]] = 'all', tables: Union[str, List[str]] = 'all', subscriber_identifier: str = 'msisdn', subscriber_subset: Optional[flowmachine.core.query.Query] = None, direction: Union[str, flowmachine.features.utilities.direction_enum.Direction] = <Direction.OUT: 'out'>)
This class calculates intervent period statistics such as the average and standard deviation of the duration between calls and returns them as time intervals.
Attributes¶
Parameters¶
-
start
:str
-
stop
:str
iso-format start and stop datetimes
-
hours
:typing.Union
, defaultall
Restrict the analysis to only a certain set of hours within each day.
-
time_resolution
:str
Temporal resolution to return results at, e.g. 'hour' for fractional hours.
-
subscriber_identifier
:str
, defaultmsisdn
Either msisdn, or imei, the column that identifies the subscriber.
-
subscriber_subset
:typing.Optional
, defaultNone
If provided, string or list of string which are msisdn or imeis to limit results to; or, a query or table which has a column with a name matching subscriber_identifier (typically, msisdn), to limit results to.
-
direction
:typing.Union
, defaultout
Whether to consider calls made, received, or both. Defaults to 'out'.
-
tables
:typing.Union
, defaultall
Can be a string of a single table (with the schema) or a list of these. The keyword all is to select all subscriber tables
-
statistic
:flowmachine.core.statistic_types.Statistic
, defaultavg
Defaults to avg, aggregation statistic over the durations.
Examples¶
s = IntereventInterval("2016-01-01", "2016-01-07")
s.get_dataframe()
subscriber value
0 038OVABN11Ak4W5P 04:57:22.428571
1 09NrjaNNvDanD8pk 03:52:38.454545
2 0ayZGYEQrqYlKw6g 04:02:05.666667
3 0DB8zw67E9mZAPK2 06:32:30.714285
4 0Gl95NRLjW2aw8pW 05:44:20.625000
.. ... ...
495 ZQG8glazmxYa1K62 04:12:27.705882
496 Zv4W9eak2QN1M5A7 03:41:10.323529
497 zvaOknzKbEVD2eME 04:21:27.218750
498 Zy3DkbY7MDd6Er7l 04:33:00.870968
499 ZYPxqVGLzlQy6l7n 04:01:28.212121
Methods¶
cache¶
cache
Returns¶
-
bool
True is caching is switched on.
column_names¶
column_names
Returns the column names.
Returns¶
-
list
ofstr
List of the column names of this query.
column_names_as_string_list¶
column_names_as_string_list
Get the column names as a comma separated list
Returns¶
-
str
Comma separated list of column names
dependencies¶
dependencies
Returns¶
-
set
The set of queries which this one is directly dependent on.
fully_qualified_table_name¶
fully_qualified_table_name
Returns a unique fully qualified name for the query to be stored as under the cache schema, based on a hash of the parameters, class, and subqueries.
Returns¶
-
str
String form of the table's fqn
index_cols¶
index_cols
A list of columns to use as indexes when storing this query.
Returns¶
-
ixen
:list
By default, returns the location columns if they are present and self.spatial_unit is defined, and the subscriber column.
Examples¶
daily_location("2016-01-01").index_cols
[['name'], '"subscriber"']
is_stored¶
is_stored
Returns¶
-
bool
True if the table is stored, and False otherwise.
query_id¶
query_id
Generate a uniquely identifying hash of this query, based on the parameters of it and the subqueries it is composed of.
Returns¶
-
str
query_id hash string
query_state¶
query_state
Return the current query state.
Returns¶
-
QueryState
The current query state
query_state_str¶
query_state_str
Return the current query state as a string
Returns¶
-
str
The current query state. The possible values are the ones defined in
flowmachine.core.query_state.QueryState
.
table_name¶
table_name
Returns a uniquename for the query to be stored as, based on a hash of the parameters, class, and subqueries.
Returns¶
-
str
String form of the table's fqn