flowmachine.features.location.joined_spatial_aggregate¶

Class JoinedSpatialAggregate¶

JoinedSpatialAggregate(*, metric, locations, method: Union[flowmachine.core.statistic_types.Statistic, str] = <Statistic.AVG: 'avg'>)

Source: flowmachine/features/location/joined_spatial_aggregate.py

Creates spatially aggregated data from two objects, one of which is a metric of subscribers, and the other of which represents the subscribers' locations. A general class that join metric information about a subscriber with location information about a subscriber and aggregates to the geometric level.

Parameters¶

metric: Query

A query object that represents a subscriber level metric such as radius of gyration. The underlying data must have a 'subscriber' column. All other columns must be numeric and will be aggregated.
locations: Query

A query object that represents the locations of subscribers. Must have a 'subscriber' column, and a 'spatial_unit' attribute.
method: typing.Union, default avg

Method of aggregation.

Examples¶

>>>  mfl = subscribers.MostFrequentLocation('2016-01-01',                                           '2016-01-04',                                           spatial_unit=AdminSpatialUnit(level=3))     >>> rog = subscribers.RadiusOfGyration('2016-01-01',                                      '2016-01-04')     >>> sm = JoinedSpatialAggregate(metric=rog, locations=mfl)     >>> sm.head()             name     rog         0   Rasuwa   157.200039         1   Sindhuli 192.194037         2   Humla    123.676914         3   Gulmi    163.980299         4   Jumla    144.432886         ...

Methods¶

cache¶

cache

Source: flowmachine/core/query.py

Returns¶

bool

True is caching is switched on.

column_names¶

column_names

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

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