Table of Contents

Indicators

This page explains how to manage indicators on the Hotmaps toolbox. An indicator is a value that is displayed on the Hotmaps toolbox in the client-side. The indicator is part of a layer. An indicator is a value, for a specific spatial region, with a unit. An indicator is part of a layer dictionary. A layer object contains an array named "indicators". This table will be used to list all the indicators that you want to see for the layer.

layers = {
    'heat_tot_curr_density_tif':{
        'tablename':'heat_tot_curr_density_tif',
        'from_indicator_name':'stat_heat_tot_curr_density_tif',
        'schema_scalelvl': 'stat',
        'schema_hectare': 'geo',
        'crs': '3035',
        'geo_column': 'geometry',
        'table_type':'raster',
        'data_lvl':['NUTS 0','NUTS 1','NUTS 2','NUTS 3','LAU 2','Hectare'],
        'data_aggregated':True,
        'scalelvl_column':'',
        'indicators':[
            {'table_column': 'sum', 'unit': 'MWh','indicator_id':'consumption'},
            {'table_column': 'count', 'unit': 'cells','indicator_id':'count_cell'},
            {
                'reference_indicator_id_1': 'consumption',
                'reference_tablename_indicator_id_1': 'heat_tot_curr_density_tif', 
                'operator': '/',
                'reference_indicator_id_2': 'count_cell',
                'reference_tablename_indicator_id_2': 'pop_tot_curr_density_tif', 
                'unit':'MWh/person', 'indicator_id': 'heat_tot_curr_density_tif_per_pop_tot_curr_density_tif'
            }
        ]
    }
}
  • 'tablename'

Name of the DB table. (Exemple: 'heat_tot_curr_density_tif')

  • 'from_indicator_name'

Subtablename for the selection of indicators. Must be unique. (Exemple: 'stat_heat_tot_curr_density_tif')

  • 'data_aggregated'

Is the data aggregated or not (Values: True or False)

  • 'scalelvl_column'

Scale level column name if different to default one (Exemple: 'code')

  • 'data_lvl'

Levels available for the data in the database

  • 'schema_scalelvl'

Table schema location for the nuts level. (Exemple: 'geo', 'stat', 'public')

  • 'schema_hectare'

Table schema location for the hectare level. (Exemple: 'geo', 'stat', 'public')

  • 'crs'

Projection of the geometry (Exemple: '3035', '4326', '4258')

  • 'geo_column'

Name of the geometry column in the database (Exemple: 'geom', 'geometry')

  • 'table_type'

Type of the layer in the database (Values: 'vector' or 'raster').

Important: If it is a raster, the column available are count, sum, mean, stddev, min and max

  • 'Indicators'

There are 2 types of indicators (Simple indicators & Cross indicators).

To Top

Simple indicator

A simple indicator is an object with 3 parameters.

{
    'table_column': 'count', 
    'unit': 'cells',
    'indicator_id':'count_cell'
}
  • 'table_column'

This is the table column that is selected in the table. (Example: 'count')

tablecolumnselection

  • 'unit'

This is the unit of the indicator. (Example: 'cells', 'MWh')

  • 'indicator_id'

This is the indicator identifier of the indicator (Like an ID). This name must be unique in the array of indicators.

To Top

Cross indicator

A cross indicator is an object with 7 parameters. The goal of this indicator is to make a calculation among simple indicators.

{
    'reference_indicator_id_1': 'consumption',
    'reference_tablename_indicator_id_1':'heat_tot_curr_density_tif', 
    'operator': '/',
    'reference_indicator_id_2':'count_cell',
    'reference_tablename_indicator_id_2':'pop_tot_curr_density_tif', 
    'unit':'MWh/person', 
    'indicator_id':'heat_tot_curr_density_tif_per_pop_tot_curr_density_tif'
}
  • 'reference_indicator_id_1'

Corresponds to the identifier of a simple indicator. This name must be defined in the indicator array. It is value number 1.

  • 'reference_tablename_indicator_id_1'

Reference of the layer tablename that reference the value number 1. (Exemple: 'heat_tot_curr_density_tif')

  • 'operator'

Calcul rule to apply to the 2 values (Values: '/' or '*' or '+' or '-')

  • 'reference_indicator_id_1'

Corresponds to the identifier of a simple indicator. This name must be defined in the indicator array. It is value number 2.

  • 'reference_tablename_indicator_id_2'

Reference of the layer tablename that reference the value number 2. (Exemple: 'pop_tot_curr_density_tif')

  • 'unit'

This is the unit of the indicator. (Example: 'cells', 'MWh')

  • 'name'

This is the name of the indicator (Like an ID). This name must be unique in the array of indicators.

Note: For this example, the calculation below is done.
reference_indicator_id_1.reference_indicator_id_1 / reference_indicator_id_1.reference_indicator_id_1 = heat_tot_curr_density_tif.consumption / pop_tot_curr_density_tif.count_cell

To Top

Indicator result

The result of the indicators are as follows:

{
  "values": [
    {
      "unit": "MWh",
      "name": "heat_tot_curr_density_tif_consumption",
      "value": "4112030.46"
    },
    {
      "unit": "cells",
      "name": "heat_tot_curr_density_tif_count_cell",
      "value": "46764"
    },
    {
      "unit": "MWh/person",
      "name": "heat_tot_curr_density_tif_per_pop_tot_curr_density_tif",
      "value": "38.0092476775893146"
    }
  ],
  "name": "heat_tot_curr_density_tif"
}

To Top

How to cite

Mostafa Fallahnejad, in Hotmaps-Wiki, Guidelines-for-defining-indicators (April 2019)

To Top

Authors and reviewers

This page is written by Mostafa Fallahnejad*.

  • [ ] This page was reviewed by Lukas Kranzl*.

* Energy Economics Group - TU Wien

Institute of Energy Systems and Electrical Drives

Gusshausstrasse 27-29/370

1040 Wien

To Top

License

Copyright © 2016-2019: Mostafa Fallahnejad

Creative Commons Attribution 4.0 International License

This work is licensed under a Creative Commons CC BY 4.0 International License.

SPDX-License-Identifier: CC-BY-4.0

License-Text: https://spdx.org/licenses/CC-BY-4.0.html

To Top

Acknowledgement

We would like to convey our deepest appreciation to the Horizon 2020 Hotmaps Project (Grant Agreement number 723677), which provided the funding to carry out the present investigation.

To Top

View in another language:

German*

* machine translated