flowmachine.features.subscriber.contact_reference_locations_stats

Source: flowmachine/features/subscriber/contact_reference_locations_stats.py

Statistics for the distance between subscriber's own modal location and its contacts' modal location.

Class ContactReferenceLocationStats

ContactReferenceLocationStats(
    contact_balance, contact_locations, statistic="avg", geom_column=None
)

Source: flowmachine/features/subscriber/contact_reference_locations_stats.py

This class calculates statistics of the distance between a subscriber's reference point and its contacts' reference point.

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

• contact_balance: flowmachine.features.ContactBalance

  An instance of ContactBalance which lists the contacts of the targeted subscribers along with the number of events between them.

• contact_locations: flowmachine.core.Query

  A flowmachine Query instance that contains a subscriber column. In addition to that the query must have a spatial unit or the target geometry column that contains the subscribers' reference locations.

• statistic: {'count', 'sum', 'avg', 'max', 'min', 'median', 'mode', 'stddev', 'variance'}, default 'sum'

  Defaults to sum, aggregation statistic over the durations.

• geom_column

  The column containing the subscribers' reference locations. This is required if the Query does not contain a spatial unit with 'lon' and 'lat' columns.

Methods

cache

cache

Source: flowmachine/core/query.py

Returns

• bool

  True is caching is switched on.

column_names

column_names

Source: flowmachine/features/subscriber/contact_reference_locations_stats.py

Returns the column names.

Returns

• list of str

  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/core/query.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