flowmachine.features.subscriber.displacement¶
Source: flowmachine/features/subscriber/displacement.py
The maximum displacement of a user from its home location
Class Displacement¶
Displacement(start: str, stop: str, reference_location: flowmachine.features.utilities.subscriber_locations.BaseLocation, statistic: flowmachine.core.statistic_types.Statistic = <Statistic.AVG: 'avg'>, unit: str = 'km', hours: Union[str, Tuple[int, int]] = 'all', table: Union[str, List[str]] = 'all', subscriber_identifier: str = 'msisdn', ignore_nulls: bool = True, return_subscribers_not_seen: bool = False, subscriber_subset: Optional[flowmachine.core.query.Query] = None)
Calculates statistics of a subscribers displacement from their home location. Class representing the displacement from their home location for all subscribers within a certain time frame. This will return displacement from home for all subscribers in ModalLocation. If a user with a home location makes no calls between start and stop then a NaN value will be returned.
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
-
reference_location
:flowmachine.features.utilities.subscriber_locations.BaseLocation
The set of home locations from which to calculate displacement. If not given then ModalLocation Query wil be created over period start -> stop.
-
statistic
:flowmachine.core.statistic_types.Statistic
, defaultavg
The statistic to calculate.
-
unit
:str
, defaultkm
Unit with which to express the answers, currently the choices are kilometres ('km') or metres ('m')
-
hours
:typing.Union
, defaultall
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
:typing.Union
, defaultall
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
: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.
-
return_subscribers_not_seen
:bool
, defaultFalse
By default, subscribers who are not seen in the time period are dropped. Set to True to return them as NULL.
-
ignore_nulls
:bool
, defaultTrue
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¶
d = Displacement('2016-01-01 13:30:30', '2016-01-02 16:25:00')
d.head()
subscriber avg_displacement
subscriberA 13.0
subscriberB 12.3
subscriberC 6.5
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