Skip to content

flowmachine.features.subscriber.nocturnal_events

Source: flowmachine/features/subscriber/nocturnal_events.py

Calculates the proportion of calls that a subscriber makes during night time. Nocturnal hour definitions can be specified.

Class NocturnalEvents

NocturnalEvents(start, stop, hours: Tuple[int, int] = (20, 4), *, subscriber_identifier='msisdn', direction: Union[str, flowmachine.features.utilities.direction_enum.Direction] = <Direction.BOTH: 'both'>, subscriber_subset=None, tables='all')
Source: flowmachine/features/subscriber/nocturnal_events.py

Represents the percentage of events that a subscriber make/receives which began at night. The definition of night is configurable.

Attributes

Parameters

  • start, stop: str

    iso-format start and stop datetimes

  • hours: typing.Tuple[int, int], default (20, 4)

    Hours that count as being nocturnal. e.g. (20,4) will be the times after 8pm and before 4 am.

  • 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 both

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

  • 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

Examples

s = NocturnalEvents("2016-01-01", "2016-01-02")
s.get_dataframe()
subscriber value 2ZdMowMXoyMByY07 0.000000 MobnrVMDK24wPRzB 40.000000 0Ze1l70j0LNgyY4w 16.666667 Nnlqka1oevEMvVrm 33.333333 4dqenN2oQZExwEK2 83.333333 ... ...

Methods

cache

cache
Source: flowmachine/core/query.py

Returns

  • bool

    True is caching is switched on.

column_names

column_names
Source: flowmachine/features/subscriber/nocturnal_events.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