Skip to content

flowmachine.features.network.total_network_objects

Source: flowmachine/features/network/total_network_objects.py

Calculates the total number of unique sites or cells at the network level.

Class AggregateNetworkObjects

AggregateNetworkObjects(*, total_network_objects, statistic='avg', aggregate_by=None)
Source: flowmachine/features/network/total_network_objects.py

Class for calculating statistics about unique cells/sites and aggregate it by period.

Attributes

Parameters

  • total_network_objects: TotalNetworkObjects

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

    Statistic to calculate, defaults to 'avg'.

  • aggregate_by: {'second', 'minute', 'hour', 'day', 'month', 'year', 'century'}

    A period definition to calculate statistics over, defaults to the one greater than total_network_objects.total_by.

Examples

t = AggregateNetworkObjects(total_network_objects=TotalNetworkObjects())
t.get_dataframe()
      name  total                  datetime
0  Nepal     55 2016-01-01 00:00:00+00:00
1  Nepal     55 2016-01-02 00:00:00+00:00
2  Nepal     55 2016-01-03 00:00:00+00:00
3  Nepal     55 2016-01-04 00:00:00+00:00
4  Nepal     55 2016-01-05 00:00:00+00:00
...

Methods

cache

cache
Source: flowmachine/core/query.py

Returns
  • bool

    True is caching is switched on.

column_names

column_names
Source: flowmachine/features/network/total_network_objects.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 TotalNetworkObjects

TotalNetworkObjects(start=None, stop=None, *, table='all', total_by='day', network_object: Union[flowmachine.core.spatial_unit.CellSpatialUnit, flowmachine.core.spatial_unit.GeomSpatialUnit] = CellSpatialUnit(), spatial_unit: Union[flowmachine.core.spatial_unit.CellSpatialUnit, flowmachine.core.spatial_unit.GeomSpatialUnit, NoneType] = None, hours='all', subscriber_subset=None, subscriber_identifier='msisdn')
Source: flowmachine/features/network/total_network_objects.py

Class for calculating unique cells/sites per location and aggregate it by period.

Attributes

Parameters

  • start: datetime

    Start time to filter query.

  • stop: datetime

    Stop time to filter query.

  • total_by: {'second', 'minute', 'hour', 'day', 'month', 'year'}

    A period definition to group data by.

  • table: str

    Either 'calls', 'sms', or other table under events.*. If no specific table is provided this will collect statistics from all tables.

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

    Objects to track, defaults to CellSpatialUnit(), the unversioned lowest level of infrastructure available. Must have network_object.is_network_object == True.

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

    Spatial unit to facet on. Must have spatial_unit.is_network_object == False.

Examples

t = TotalNetworkObjects()
t.get_dataframe()
   total                  datetime
0     55 2016-01-01 00:00:00+00:00
1     55 2016-01-02 00:00:00+00:00
...

Methods

cache

cache
Source: flowmachine/core/query.py

Returns
  • bool

    True is caching is switched on.

column_names

column_names
Source: flowmachine/features/network/total_network_objects.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