Skip to content

flowmachine.features.location.total_events

Source: flowmachine/features/location/total_events.py

Calculates the number of events at a location during a specified time period.

Class TotalLocationEvents

TotalLocationEvents(start: str, stop: str, *, table: Union[NoneType, List[str]] = None, spatial_unit: Union[flowmachine.core.spatial_unit.CellSpatialUnit, flowmachine.core.spatial_unit.GeomSpatialUnit] = CellSpatialUnit(), interval: str = 'hour', direction: Union[str, flowmachine.features.utilities.direction_enum.Direction] = <Direction.BOTH: 'both'>, hours='all', subscriber_subset=None, subscriber_identifier='msisdn')
Source: flowmachine/features/location/total_events.py

Calculates the total number of events on an hourly basis per location (such as a tower or admin region), and per interaction type.

Attributes

Parameters

  • start: str

    ISO format date string to at which to start the analysis

  • stop: str

    As above for the end of the analysis

  • table: typing.Union[NoneType, typing.List[str]], default None

    Specifies a table of cdr data on which to base the analysis. Table must exist in events schema. If 'all' then we use all tables specified in flowmachine.yml.

  • spatial_unit: typing.Union[flowmachine.core.spatial_unit.CellSpatialUnit, flowmachine.core.spatial_unit.GeomSpatialUnit], default CellSpatialUnit()

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

  • interval: str, default hour

    Records activity on an hourly, daily, or by minute level.

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

    Look only at incoming or outgoing events. Can be either 'out', 'in' or 'both'.

Methods

cache

cache
Source: flowmachine/core/query.py

Returns
  • bool

    True is caching is switched on.

column_names

column_names
Source: flowmachine/features/location/total_events.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