Skip to content

flowmachine.features.spatial.circles

Source: flowmachine/features/spatial/circles.py

Classes for creating raster sums over circles in space. Will be used to implement Radiation model of mobility.

Class Circle

Circle(lon, lat, radius, name)
Source: flowmachine/features/spatial/circles.py

This is a simple class for storing information about the location and extent of a circle - this could represent the extent of a city. It is to be used in conjuction with the Circle class in order to for a set of geometries that represent the circles in question.

Parameters

  • lon, lat: int

    The longitude and latitude of the circle centre

  • radius: float

    The radius in meters to use as the extent of the circle

  • names: str

    An ID string for the circle

Examples

c = Circle(2, 3, 4, 'bob')
c
Circle(2, 3, 4,'bob')

Class CircleGeometries

CircleGeometries(circles)
Source: flowmachine/features/spatial/circles.py

This class will form the required geometries for a set of circles defined by an iterable of Circle objects. This class is used by CircleRasterPops which calculates population based on a raster.

Attributes

Parameters

  • circles: iterable of Circle

    The circular regions for which geometries are required

Examples

cl = Circle(2, 3, 4, 'bob')
c = CircleGeometries([cl])
c.head()
geom     name
01030000... bob
c.raster_sum()

Methods

raster_sum

raster_sum(self, raster)
Source: flowmachine/features/spatial/circles.py

Returns the raster sum over the circle geometries

Examples
lons = [85.3240,83.9956]
lats = [27.7172,28.2380]
names = ['Kathmandu','Pokhara']
radii = [4000,11000]

circles = [Circle(*vals) for vals in zip(lons,lats,radii,names)]
cp = CircleGeometries(circles)
rs = cp.raster_sum('population.small_nepal_raster')
rs.get_dataframe()
name statistic Kathmandu 1.135396e+06 Pokhara 4.052404e+05

cache

cache
Source: flowmachine/core/query.py

Returns
  • bool

    True is caching is switched on.

column_names

column_names
Source: flowmachine/features/spatial/circles.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