Skip to content

flowmachine.features.location.labelled_spatial_aggregate

Class LabelledSpatialAggregate

LabelledSpatialAggregate(locations: flowmachine.core.query.Query, labels: flowmachine.core.query.Query, label_columns: List[str] = ('value',))
Source: flowmachine/features/location/labelled_spatial_aggregate.py

Class representing a disaggregation of a SpatialAggregate by some label or set of labels

Attributes

Parameters

  • locations: flowmachine.core.query.Query

    Any query with a subscriber and location columns

  • labels: flowmachine.core.query.Query

    Any query with a subscriber column

  • label_columns: typing.List, default ('value',)

    A list of columns in labels to aggregate on

Examples

locations = locate_subscribers(
...     "2016-01-01",
...     "2016-01-02",
...     spatial_unit=make_spatial_unit("admin", level=3),
...     method="most-common",
... )
metric = SubscriberHandsetCharacteristic(
...     "2016-01-01", "2016-01-02", characteristic="hnd_type"
... )
labelled = LabelledSpatialAggregate(locations=locations,labels=metric)
labelled.get_dataframe()
           pcod label_value  value
 0  524 3 08 44     Feature     36
 1  524 3 08 44       Smart     28
 2  524 4 12 62     Feature     44
 3  524 4 12 62       Smart     19'

Methods

cache

cache
Source: flowmachine/core/query.py

Returns

  • bool

    True is caching is switched on.

column_names

column_names
Source: flowmachine/features/location/labelled_spatial_aggregate.py

Returns the column names.

Returns

  • typing.List

    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.

out_label_columns

out_label_columns
Source: flowmachine/features/location/labelled_spatial_aggregate.py

Returns all label columns

Returns
  • typing.List

out_label_columns_as_string_list

out_label_columns_as_string_list
Source: flowmachine/features/location/labelled_spatial_aggregate.py

Returns the label column heading as a single string

out_spatial_columns

out_spatial_columns
Source: flowmachine/features/location/labelled_spatial_aggregate.py

Returns all spatial-related columns

Returns
  • typing.List

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