flowmachine.features.location.consecutive_trips_od_matrix¶
Class ConsecutiveTripsODMatrix¶
ConsecutiveTripsODMatrix(subscriber_locations: flowmachine.features.utilities.subscriber_locations.SubscriberLocations)
An object which represents a count of subscriber who made consecutive visits between locations. Originally added as the FlowKit implementation of COVID-19 aggregate12.
Attributes¶
Parameters¶
subscriber_locations
:flowmachine.features.utilities.subscriber_locations.SubscriberLocations
Examples¶
ConsecutiveTripsODMatrix(subscriber_locations=SubscriberLocations('2016-01-01 13:30:30','2016-01-02 16:25:00')).head()
location_id_from location_id_to value
0 0RIMKYtf ZOsVSeQS 3
1 0RIMKYtf ypbTrAkZ 1
2 0RIMKYtf yPANTB8f 1
3 0RIMKYtf wQ7i3Z8n 1
4 0RIMKYtf WET2L101 2
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