flowmachine.features.subscriber.unmoving_at_reference_location¶
Class UnmovingAtReferenceLocation¶
UnmovingAtReferenceLocation(locations: flowmachine.features.subscriber.unique_locations.UniqueLocations, reference_locations: Union[flowmachine.features.subscriber.modal_location.ModalLocation, flowmachine.features.subscriber.last_location.LastLocation, flowmachine.features.subscriber.most_frequent_location.MostFrequentLocation])
Determine whether a subscriber moved from their reference location within a time period. Value will be True if the subscriber did not move.
Attributes¶
Parameters¶
-
locations
:flowmachine.features.subscriber.unique_locations.UniqueLocations
A unique locations object
-
reference_locations
:typing.Union
Per subscriber reference location check for movement from.
Examples¶
UnmovingAtReferenceLocation(locations=UniqueLocations(SubscriberLocations("2016-01-01", "2016-01-01 10:00", spatial_unit=make_spatial_unit("admin", level=3))), reference_locations=LastLocation("2016-01-01", "2016-01-02")).head()
subscriber value
0 038OVABN11Ak4W5P False
1 09NrjaNNvDanD8pk False
2 0ayZGYEQrqYlKw6g False
3 0DB8zw67E9mZAPK2 False
4 0Gl95NRLjW2aw8pW False
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