Skip to content

flowmachine.features.utilities.subscriber_locations

Class BaseLocation

BaseLocation()
Source: flowmachine/features/utilities/subscriber_locations.py

Mixin for all daily and home location methods. Provides the method to aggregate spatially.

Methods

aggregate

aggregate(self)
Source: flowmachine/features/utilities/subscriber_locations.py

Aggregate to the spatial level returning a query object that represents the location, and the total counts of subscribers.

join_aggregate

join_aggregate(self, metric, method="avg")
Source: flowmachine/features/utilities/subscriber_locations.py

Join with a metric representing object and aggregate spatially.

Parameters

  • metric: Query

  • method: {"avg", "max", "min", "median", "mode", "stddev", "variance"}

Returns
  • JoinedSpatialAggregate

Class SubscriberLocations

SubscriberLocations(start, stop, *, spatial_unit: Union[flowmachine.core.spatial_unit.CellSpatialUnit, flowmachine.core.spatial_unit.GeomSpatialUnit] = CellSpatialUnit(), hours: Optional[Tuple[int, int]] = None, table='all', subscriber_identifier='msisdn', ignore_nulls=True, subscriber_subset=None)
Source: flowmachine/features/utilities/subscriber_locations.py

Class representing all the locations for which a subscriber has been found. Can be at the level of a tower, lon-lat, or an admin unit.

Attributes

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, default CellSpatialUnit()

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

  • hours: typing.Optional, 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 pull together all of the tables specified as flowmachine.yml under 'location_tables'

  • subscriber_identifier: str, default 'msisdn'

    whether to identify a subscriber by either msisdn, imei or imsi.

  • ignore_nulls: bool, default True

    ignores those values that are null. Sometime data appears for which the cell is null. If set to true this will ignore those lines. If false these lines with null cells should still be present, although they contain no information on the subscribers location, they still tell us that the subscriber made a call at that time.

Examples

subscriber_locs = SubscriberLocations('2016-01-01 13:30:30',
                           '2016-01-02 16:25:00')
subscriber_locs.head()
 subscriber                 time    cell
subscriberA  2016-01-01 12:42:11  233241
subscriberA  2016-01-01 12:52:11  234111
subscriberB  2016-01-01 12:52:16  234111
...

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/utilities/subscriber_locations.py

Returns the column names.

Returns

  • typing.List

    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/features/utilities/subscriber_locations.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