flowmachine.features.location.flows

Source: flowmachine/features/location/flows.py

Definition of the flows class, which is the difference in locations between two daily or home location classes, aggregated to a spatial unit.

Enum Direction

Direction

Source: flowmachine/features/location/flows.py

Enum where members are also (and must be) strings

Members

• from: from

• to: to

Class FlowLike

FlowLike()

Source: flowmachine/features/location/flows.py

Mixin providing utility methods specific to geographic type queries.

Methods

inflow

inflow(self)

Source: flowmachine/features/location/flows.py

Returns

• InFlow

  An inflows object. This is the total number of flows that go to one locations, regardless of their origin.

outflow

outflow(self)

Source: flowmachine/features/location/flows.py

Returns

• OutFlow

  An outflows object. This is the total number of flows that originate from one locations, regardless of their destination.

Class Flows

Flows(loc1, loc2, join_type="inner")

Source: flowmachine/features/location/flows.py

An object representing the difference in locations between two location type objects.

Attributes

• cache

• column_names

• column_names_as_string_list

• dependencies

• fully_qualified_table_name

• index_cols

• is_stored

• query_id

• query_state

• query_state_str

• table_name

Parameters

• loc1: or ModalLocation object, daily_location

  Object representing the locations of people within the first time frame of interest

• loc2: or ModalLocation object, daily_location

  As above for the second period

• join_type: {"inner", "full outer", "left", "right", "left outer", "right outer"}, default "inner"

  Join type of the join between loc_1 and loc_2

Methods

inflow

inflow(self)

Source: flowmachine/features/location/flows.py

Returns

• InFlow

  An inflows object. This is the total number of flows that go to one locations, regardless of their origin.

outflow

outflow(self)

Source: flowmachine/features/location/flows.py

Returns

• OutFlow

  An outflows object. This is the total number of flows that originate from one locations, regardless of their destination.

cache

cache

Source: flowmachine/core/query.py

Returns

• bool

  True is caching is switched on.

column_names

column_names

Source: flowmachine/features/location/flows.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/core/query.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/features/location/flows.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

Class InOutFlow

InOutFlow(flow: flowmachine.features.location.flows.Flows, direction: str)

Source: flowmachine/features/location/flows.py

An inflow or outflow from a Flows - sums by the to or from columns.

Attributes

• cache

• column_names

• column_names_as_string_list

• dependencies

• fully_qualified_table_name

• index_cols

• is_stored

• query_id

• query_state

• query_state_str

• table_name

Parameters

• flow: flowmachine.features.location.flows.Flows

  Flows object to derive an in/out flow from

• direction: str

  One of to (for inflows) or out (for outflows)

Methods

cache

cache

Source: flowmachine/core/query.py

Returns

• bool

  True is caching is switched on.

column_names

column_names

Source: flowmachine/features/location/flows.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/core/query.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/features/location/flows.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