Skip to content

flowmachine.features.subscriber.contact_reciprocal

Source: flowmachine/features/subscriber/contact_reciprocal.py

Classes for searching and dealing with reciprocal contacts.

Class ContactReciprocal

ContactReciprocal(start, stop, *, hours: Union[Tuple[int, int], NoneType] = None, tables='all', exclude_self_calls=True, subscriber_subset=None)
Source: flowmachine/features/subscriber/contact_reciprocal.py

This class classifies a subscribers contact as reciprocal or not. In addition to that, it calculates the number of incoming and outgoing events between the subscriber and her/his counterpart as well as the proportion that those events represent in total incoming and outgoing events. A reciprocal contact is a contact who has initiated contact with the subscriber and who also has been the counterpart of an initatiated contact by the subscriber.

Attributes

Parameters

  • start, stop: str

    iso-format start and stop datetimes

  • hours: typing.Union[typing.Tuple[int, int], NoneType], default None

    Restrict the analysis to only a certain set of hours within each day.

  • subscriber_subset: flowmachine.core.Table, flowmachine.core.Query, list, str, default None

    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.

  • exclude_self_calls: bool, default True

    Set to false to include calls a subscriber made to themself

  • tables: list of strings, str, default 'all'

    Can be a string of a single table (with the schema) or a list of these. The keyword all is to select all subscriber tables

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_reciprocal.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

Class ProportionContactReciprocal

ProportionContactReciprocal(contact_reciprocal)
Source: flowmachine/features/subscriber/contact_reciprocal.py

This class calculates the proportion of reciprocal contacts a subscriber has. A reciprocal contact is a contact who has initiated contact with the subscriber and who also has been the counterpart of an initatiated contact by the subscriber.

Attributes

Parameters

  • contact_reciprocal: flowmachine.features.ContactReciprocal

    An instance of ContactReciprocal listing which contacts are reciprocal and which are not.

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_reciprocal.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

Class ProportionEventReciprocal

ProportionEventReciprocal(start, stop, contact_reciprocal, *, direction: Union[str, flowmachine.features.utilities.direction_enum.Direction] = <Direction.OUT: 'out'>, subscriber_identifier='msisdn', hours: Union[Tuple[int, int], NoneType] = None, subscriber_subset=None, tables='all', exclude_self_calls=True)
Source: flowmachine/features/subscriber/contact_reciprocal.py

This class calculates the proportion of events with a reciprocal contact per subscriber. It is possible to fine-tune the period for which a reciprocal contact must have happened. A reciprocal contact is a contact who has initiated contact with the subscriber and who also has been the counterpart of an initatiated contact by the subscriber.

Attributes

Parameters

  • start, stop: str

    iso-format start and stop datetimes

  • hours: typing.Union[typing.Tuple[int, int], NoneType], default None

    Restrict the analysis to only a certain set of hours within each day.

  • contact_reciprocal: flowmachine.features.ContactReciprocal

    An instance of ContactReciprocal listing which contacts are reciprocal and which are not.

  • subscriber_identifier: {'msisdn', 'imei'}, default 'msisdn'

    Either msisdn, or imei, the column that identifies the subscriber.

  • subscriber_subset: flowmachine.core.Table, flowmachine.core.Query, list, str, default None

    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.

  • direction: typing.Union[str, flowmachine.features.utilities.direction_enum.Direction], default out

    Whether to consider calls made, received, or both. Defaults to 'out'.

  • exclude_self_calls: bool, default True

    Set to false to include calls a subscriber made to themself

  • tables: list of strings, str, default 'all'

    Can be a string of a single table (with the schema) or a list of these. The keyword all is to select all subscriber tables

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_reciprocal.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