flowmachine.features.subscriber.subscriber_call_durations

Source: flowmachine/features/subscriber/subscriber_call_durations.py

Total and per-counterpart call durations for subscribers.

Class PairedPerLocationSubscriberCallDurations

PairedPerLocationSubscriberCallDurations(start, stop, *, subscriber_identifier='msisdn', statistic: flowmachine.utils.Statistic = <Statistic.SUM: 'sum'>, spatial_unit: Union[flowmachine.core.spatial_unit.CellSpatialUnit, flowmachine.core.spatial_unit.GeomSpatialUnit, NoneType] = None, hours: Union[Tuple[int, int], NoneType] = None, subscriber_subset=None)

Source: flowmachine/features/subscriber/subscriber_call_durations.py

This class returns the total amount of time a subscriber spent calling each other subscriber within the period, faceted by their respective locations at the time.

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

• 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_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.

• spatial_unit: typing.Union[flowmachine.core.spatial_unit.CellSpatialUnit, flowmachine.core.spatial_unit.GeomSpatialUnit, NoneType], default None

  Spatial unit to which subscriber locations will be mapped. See the docstring of make_spatial_unit for more information.

• statistic: flowmachine.utils.Statistic, default sum

  Defaults to 'sum', aggregation statistic over the durations.

Examples

s = PairedPerLocationSubscriberCallDurations("2016-01-01", "2016-01-07")
s.get_dataframe()

subscriber msisdn_counterpart name name_counterpart 0 038OVABN11Ak4W5P BVYqp0ryO1oj1gRo Dolpa Kailali 1 038OVABN11Ak4W5P BVYqp0ryO1oj1gRo Dolpa Rasuwa 2 038OVABN11Ak4W5P BVYqp0ryO1oj1gRo Mugu Baglung ... value 0 2756.0 1 1885.0 2 1027.0

Note

This query is currently very slow.

Methods

cache

cache

Source: flowmachine/core/query.py

Returns

• bool

  True is caching is switched on.

column_names

column_names

Source: flowmachine/features/subscriber/subscriber_call_durations.py

Returns the column names.

Returns

• typing.List[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 PairedSubscriberCallDurations

PairedSubscriberCallDurations(start, stop, *, subscriber_identifier='msisdn', statistic: flowmachine.utils.Statistic = <Statistic.SUM: 'sum'>, hours: Union[Tuple[int, int], NoneType] = None, subscriber_subset=None)

Source: flowmachine/features/subscriber/subscriber_call_durations.py

This class returns the total amount of time a subscriber spent calling each other subscriber within the period.

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

• 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_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.

• statistic: flowmachine.utils.Statistic, default sum

  Defaults to sum, aggregation statistic over the durations.

Examples

s = PairedSubscriberCallDurations("2016-01-01", "2016-01-07")
s.get_dataframe()

subscriber msisdn_counterpart value 0 038OVABN11Ak4W5P BVYqp0ryO1oj1gRo 10833.0 1 09NrjaNNvDanD8pk mJ9eZYnvvr5YGW2j 17028.0 2 0ayZGYEQrqYlKw6g Q1jMk7qjqXBnwoDR 10465.0 3 0DB8zw67E9mZAPK2 jpXleRQqrLR0aPwN 14344.0 ...

Methods

cache

cache

Source: flowmachine/core/query.py

Returns

• bool

  True is caching is switched on.

column_names

column_names

Source: flowmachine/features/subscriber/subscriber_call_durations.py

Returns the column names.

Returns

• typing.List[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 PerLocationSubscriberCallDurations

PerLocationSubscriberCallDurations(start, stop, *, subscriber_identifier='msisdn', direction: Union[str, flowmachine.features.utilities.direction_enum.Direction] = <Direction.OUT: 'out'>, statistic: flowmachine.utils.Statistic = <Statistic.SUM: 'sum'>, spatial_unit: Union[flowmachine.core.spatial_unit.CellSpatialUnit, flowmachine.core.spatial_unit.GeomSpatialUnit, NoneType] = None, hours: Union[Tuple[int, int], NoneType] = None, subscriber_subset=None)

Source: flowmachine/features/subscriber/subscriber_call_durations.py

This class returns the total amount of time a subscriber spent calling within the period, optionally limited to only calls they made, or received, faceted by their location at the time.

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

• 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_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'.

• spatial_unit: typing.Union[flowmachine.core.spatial_unit.CellSpatialUnit, flowmachine.core.spatial_unit.GeomSpatialUnit, NoneType], default None

  Spatial unit to which subscriber locations will be mapped. See the docstring of make_spatial_unit for more information.

• statistic: flowmachine.utils.Statistic, default sum

  Defaults to sum, aggregation statistic over the durations.

Examples

s = PerLocationSubscriberCallDurations("2016-01-01", "2016-01-07", direction="in")
s.get_dataframe()

subscriber name value 0 038OVABN11Ak4W5P Baglung 1979.0 1 038OVABN11Ak4W5P Banke 2204.0 2 038OVABN11Ak4W5P Dolpa 9169.0 ...

Methods

cache

cache

Source: flowmachine/core/query.py

Returns

• bool

  True is caching is switched on.

column_names

column_names

Source: flowmachine/features/subscriber/subscriber_call_durations.py

Returns the column names.

Returns

• typing.List[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 SubscriberCallDurations

SubscriberCallDurations(start, stop, *, subscriber_identifier='msisdn', direction: Union[str, flowmachine.features.utilities.direction_enum.Direction] = <Direction.OUT: 'out'>, statistic: flowmachine.utils.Statistic = <Statistic.SUM: 'sum'>, hours: Union[Tuple[int, int], NoneType] = None, subscriber_subset=None)

Source: flowmachine/features/subscriber/subscriber_call_durations.py

This class returns the total amount of time a subscriber spent calling within the period, optionally limited to only calls they made, or received.

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

• 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_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'.

• statistic: flowmachine.utils.Statistic, default sum

  Defaults to sum, aggregation statistic over the durations.

Examples

s = SubscriberCallDurations("2016-01-01", "2016-01-07", direction="in")
s.get_dataframe()

msisdn value 0 jWlyLwbGdvKV35Mm 4038.0 1 EreGoBpxJOBNl392 12210.0 2 nvKNoAmxMvBW4kJr 10847.0 3 VkzMxYjv7mYn53oK 48374.0 4 BKMy1nYEZpnoEA7G 8697.0 ...

Methods

cache

cache

Source: flowmachine/core/query.py

Returns

• bool

  True is caching is switched on.

column_names

column_names

Source: flowmachine/features/subscriber/subscriber_call_durations.py

Returns the column names.

Returns

• typing.List[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