flowmachine.features.subscriber.most_frequent_location

Source: flowmachine/features/subscriber/most_frequent_location.py

Computes the location in which an subscriber has been the most frequently.

Class MostFrequentLocation

MostFrequentLocation(start, stop, spatial_unit: Union[flowmachine.core.spatial_unit.CellSpatialUnit, flowmachine.core.spatial_unit.GeomSpatialUnit, NoneType] = None, hours: Union[Tuple[int, int], NoneType] = None, table='all', subscriber_identifier='msisdn', *, ignore_nulls=True, subscriber_subset=None)

Source: flowmachine/features/subscriber/most_frequent_location.py

Class representing the subscribers most frequent location within a certain time frame

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: str

  iso format date range for the beginning of the time frame, e.g. 2016-01-01 or 2016-01-01 14:03:01

• stop: str

  As above

• spatial_unit: typing.Union[flowmachine.core.spatial_unit.CellSpatialUnit, flowmachine.core.spatial_unit.GeomSpatialUnit, NoneType], default None

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

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

  Subset the result within certain hours, e.g. (4,17) This will subset the query only with these hours, but across all specified days. Or set to 'all' to include all hours.

• table: str, default 'all'

  schema qualified name of the table which the analysis is based upon. If 'all' it will use all tables that contain location data.

• 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.

Note

• A date without a hours and mins will be interpreted as midnight of that day, so to get data within a single day pass (e.g.) '2016-01-01', '2016-01-02'. * Use 24 hr format!

Methods

cache

cache

Source: flowmachine/core/query.py

Returns

• bool

  True is caching is switched on.

column_names

column_names

Source: flowmachine/features/subscriber/most_frequent_location.py

Returns the column names.

Returns

• typing.List[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