flowmachine.features.subscriber.first_location¶
Source: flowmachine/features/subscriber/first_location.py
Identifies the first location in which a subscriber is seen within a specified time period.
Class FirstLocation¶
FirstLocation(start, stop, *, location, 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)
Class that defines the time at which the subscriber was first spotted at the location in question. Note this does not imply that the subscriber was never here before, but this is the first time within the specified time range.
Attributes¶
Parameters¶
-
start
:str
String representing the beginning of the focal time period
-
stop
:str
String representing the end of the focal period
-
location
:or list/tuple thereof
,tuple
,dict
,str
str representing the location of interest. Could be a cell or an admin region for instance. You must specify spatial_unit to match this. i.e. location='ER0980', spatial_unit=make_spatial_unit('cell'). Can also pass a list of strings e.g. ['ER0980', 'CW2020'] will return the time at which the subscriber was first at any of these locations. Pass the argument 'any', to find the first time a subscriber pops up at any location. For spatial units with multiple location_id_columns, see
SpatialUnitMixin.location_subset_clause
orLonLatSpatialUnit.location_subset_clause
for a description of the allowed formats for the location argument. -
spatial_unit
:typing.Union
, defaultCellSpatialUnit()
Spatial unit to which subscriber locations will be mapped. See the docstring of make_spatial_unit for more information.
-
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
, 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.
Methods¶
cache¶
cache
Returns¶
-
bool
True is caching is switched on.
column_names¶
column_names
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
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