flowmachine.features.subscriber.per_location_event_stats

Class PerLocationEventStats

PerLocationEventStats(start, stop, statistic='avg', *, spatial_unit: Union[flowmachine.core.spatial_unit.CellSpatialUnit, flowmachine.core.spatial_unit.GeomSpatialUnit] = CellSpatialUnit(), hours: Union[Tuple[int, int], NoneType] = None, tables='all', subscriber_identifier='msisdn', direction: Union[str, flowmachine.features.utilities.direction_enum.Direction] = <Direction.BOTH: 'both'>, subscriber_subset=None)

Source: flowmachine/features/subscriber/per_location_event_stats.py

This class returns the statistics of event count per location per subscriber within the period, optionally limited to only incoming or outgoing events. For instance, it calculates the average number of events per cell per subscriber.

Attributes

• cache

• column_names

• column_names_as_string_list

• dependencies

• fully_qualified_table_name

• index_cols

• is_stored

• query_id

• query_state

• query_state_str

• table_name

Parameters

• start, stop: str

  iso-format start and stop datetimes

• statistic: {'count', 'sum', 'avg', 'max', 'min', 'median', 'mode', 'stddev', 'variance'}, default 'avg'

  Defaults to avg, aggregation statistic over the durations.

• hours: typing.Union[typing.Tuple[int, int], NoneType], default None

  Restrict the analysis to only a certain set of hours within each day.

• subscriber_identifier: {'msisdn', 'imei'}, default 'msisdn'

  Either msisdn, or imei, the column that identifies the subscriber.

• subscriber_subset: flowmachine.core.Table, flowmachine.core.Query, list, str, default None

  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[str, flowmachine.features.utilities.direction_enum.Direction], default both

  Whether to consider calls made, received, or both. Defaults to 'both'.

• tables: list of strings, str, default 'all'

  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

• spatial_unit: typing.Union[flowmachine.core.spatial_unit.CellSpatialUnit, flowmachine.core.spatial_unit.GeomSpatialUnit], default CellSpatialUnit()

  Spatial unit to which subscriber locations will be mapped. See the docstring of make_spatial_unit for more information.

Examples

s = PerLocationEventStats("2016-01-01", "2016-01-07")
s.get_dataframe()

subscriber value OemQ7q2DLZMWnwzB 1.388889 By4j6PKdB4NGMpxr 1.421053 L4V537alj321eWz6 1.130435 4pQo67v0PWyLdYKO 1.400000 8br1gO32xWXxjY0R 1.100000 ... ...

Methods

cache

cache

Source: flowmachine/core/query.py

Returns

• bool

  True is caching is switched on.

column_names

column_names

Source: flowmachine/features/subscriber/per_location_event_stats.py

Returns the column names.

Returns

• list of str

  List of the column names of this query.

column_names_as_string_list

column_names_as_string_list

Source: flowmachine/core/query.py

Get the column names as a comma separated list

Returns

• str

  Comma separated list of column names

dependencies

dependencies

Source: flowmachine/core/query.py

Returns

• set

  The set of queries which this one is directly dependent on.

fully_qualified_table_name

fully_qualified_table_name

Source: flowmachine/core/query.py

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

Source: flowmachine/core/query.py

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

Source: flowmachine/core/query.py

Returns

• bool

  True if the table is stored, and False otherwise.

query_id

query_id

Source: flowmachine/core/query.py

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

Source: flowmachine/core/query.py

Return the current query state.

Returns

• QueryState

  The current query state

query_state_str

query_state_str

Source: flowmachine/core/query.py

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

Source: flowmachine/core/query.py

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