Constructor Detail

• WorkflowOSM()

• WorkflowOSM(groovy.lang.Binding context)

Method Detail

• java.lang.Object abstractModelTableBatchExportTable(JdbcDataSource output_datasource, java.lang.Object output_table, java.lang.Object id_zone, java.lang.Object h2gis_datasource, java.lang.Object h2gis_table_to_save, java.lang.Object filter, java.lang.Object inputSRID, java.lang.Object outputSRID, java.lang.Object reproject)

  Generic method to save the abstract model tables prepared in H2GIS to another database @return

  Parameters:

  output_datasource - connexion to a database

  output_table - name of the output table

  srid - srid to reproject

  h2gis_datasource - local H2GIS database

  h2gis_table_to_save - name of the H2GIS table to save

  batchSize - size of the batch

  filter - to limit the data from H2GIS *

  outputSRID - srid code used to reproject the output table

• java.util.Map buildGeoclimateLayers(JdbcDataSource datasource, java.lang.Object zoneToExtract, float distance, int hLevMin)

  This process chains a set of subprocesses to extract and transform the OSM data into the geoclimate model @return

  Parameters:

  datasource - a connection to the database where the result files should be stored

  osmTablesPrefix - The prefix used for naming the 11 OSM tables build from the OSM file

  zoneToExtract - A zone to extract. Can be, a name of the place (neighborhood, city, etc. - cf https://wiki.openstreetmap.org/wiki/Key:level) or a bounding box specified as a JTS envelope

  distance - The integer value to expand the envelope of zone

• java.lang.Object extractOSMZone(java.lang.Object datasource, java.lang.Object zoneToExtract, java.lang.Object distance, java.lang.Object bbox_size)

  Extract the OSM zone and its envelope area from Nominatim API @return

  Parameters:

  datasource - a connexion to the local H2GIS database

  zoneToExtract - the osm filter : place or bbox

  distance - to expand the OSM bbox

• java.lang.Object extractProcessingParameters(java.lang.Object processing_parameters)

  Read the file parameters and create a new map of parameters The map of parameters is initialized with default values

  Parameters:

  processing_parameters - the file parameters

  Returns:

  a filled map of parameters

• java.lang.Object indicatorTableBatchExportTable(java.lang.Object output_datasource, java.lang.Object output_table, java.lang.Object id_zone, java.lang.Object h2gis_datasource, java.lang.Object h2gis_table_to_save, java.lang.Object filter, java.lang.Object inputSRID, java.lang.Object outputSRID, java.lang.Object reproject)

  Generic method to save the indicator tables prepared in H2GIS to another database @return

  Parameters:

  output_datasource - connexion to a database

  output_table - name of the output table

  id_zone - id of the zone

  h2gis_datasource - local H2GIS database

  h2gis_table_to_save - name of the H2GIS table to save

  filter - to limit the data from H2GIS *

  inputSRID - srid code of the inputable

  outputSRID - srid code used to reproject the output table

• static void main(java.lang.String[] args)

• java.util.Map osm_processing(JdbcDataSource h2gis_datasource, java.lang.Object processing_parameters, java.lang.Object id_zones, java.io.File outputFolder, java.lang.Object ouputTableFiles, java.lang.Object output_datasource, java.lang.Object outputTableNames, java.lang.Object outputSRID, java.lang.Object downloadAllOSMData, java.lang.Object deleteOutputData, java.lang.Object deleteOSMFile, java.lang.Object logTableZones, java.lang.Object bbox_size, java.lang.Object overpass_timeout, java.lang.Object overpass_maxsize)

  Process to extract the OSM data, build the GIS layers and run the Geoclimate algorithms

  Parameters:

  h2gis_datasource - the local H2GIS database

  processing_parameters - the geoclimate chain parameters

  id_zones - a list of id zones to process

  outputFolder - folder to store the files, null otherwise

  ouputTableFiles - the name of the tables that will be saved

  output_datasource - a connexion to a database to save the results

  outputTableNames - the name of the tables in the output_datasource to save the results

  bbox_size - the size of OSM BBox in km²

  Returns:

  the identifier of the zone and the list of the output tables computed and stored in the local database for this zone

• java.lang.Object prepareTableOutput(java.lang.Object h2gis_table_to_save, java.lang.Object filter, java.lang.Object inputSRID, H2GIS h2gis_datasource, java.lang.Object output_table, java.lang.Object outputSRID, java.lang.Object output_datasource)

  Method to prepare a ITable aka resulset to export table in a database @return

  Parameters:

  h2gis_table_to_save

  inputSRID

  h2gis_datasource

  output_table

  outputSRID

  output_datasource

• java.lang.Object run()

• java.lang.Object saveOutputFiles(java.lang.Object h2gis_datasource, java.lang.Object id_zone, java.lang.Object results, java.lang.Object outputFiles, java.lang.Object ouputFolder, java.lang.Object subFolderName, java.lang.Object outputSRID, java.lang.Object reproject, java.lang.Object deleteOutputData, java.lang.Object outputGrid)

  Save the geoclimate tables into geojson files @return

  Parameters:

  id_zone - the id of the zone

  results - a list of tables computed by geoclimate

  ouputFolder - the ouput folder

  outputSRID - srid code to reproject the result

  reproject - true if the file must reprojected

  deleteOutputData - delete the files if exist

  outputGrid - file format of the grid

• java.lang.Object saveTablesInDatabase(JdbcDataSource output_datasource, JdbcDataSource h2gis_datasource, java.lang.Object outputTableNames, java.lang.Object h2gis_tables, java.lang.Object id_zone, java.lang.Object inputSRID, java.lang.Object outputSRID, java.lang.Object reproject)

  Save the output tables in a database @return

  Parameters:

  output_datasource - a connexion a database

  h2gis_datasource - local H2GIS database

  outputTableNames - name of the output tables

  h2gis_tables - name of H2GIS to save

  id_zone - id of the zone

  outputSRID - srid code to reproject the data *

  reproject - the output table

• java.util.Map workflow(java.lang.Object input)

  Extract OSM data and compute geoindicators. The parameters of the processing chain is defined from a configuration file or a Map. The configuration file is stored in a json format

  Parameters:

  input - The path of the configuration file or a Map The input file or the Map supports the following entries * { * [OPTIONAL ENTRY] "description" :"A description for the configuration file" * * [OPTIONAL ENTRY] "geoclimatedb" : { // Local H2GIS database used to run the processes * // A default db is build when this entry is not specified * "folder" : "/tmp/", //The folder to store the database * "name" : "geoclimate_db;AUTO_SERVER=TRUE" // A name for the database * "delete" :false * }, * [REQUIRED] "input" : { * "locations" : ["filter"] // OSM filter to extract the data. Can be a place name supported by nominatim // e.g "osm" : ["oran", "plourivo"] // or bbox expressed as "osm" : [[38.89557963573336,-77.03930318355559,38.89944983078282,-77.03364372253417]] * "all":true //optional value if the user wants to download a limited set of data. Default is true to download all OSM elements * "area" : 2000 //optional value to control the area ov the OSM BBox, default is 1000 km² } * , * [OPTIONAL ENTRY] "output" :{ //If not ouput is set the results are keep in the local database * "srid" : //optional value to reproject the data * "folder" : "/tmp/myResultFolder" //tmp folder to store the computed layers in a geojson format, * "database": { //database parameters to store the computed layers. * "user": "-", * "password": "-", * "url": "jdbc:postgresql://", //JDBC url to connect with the database * "tables": { //table names to store the result layers. Create the table if it doesn't exist * "building_indicators":"building_indicators", * "block_indicators":"block_indicators", * "rsu_indicators":"rsu_indicators", * "rsu_lcz":"rsu_lcz", * "zones":"zones"} } * }, * , * [OPTIONAL ENTRY] "parameters": * {"distance" : 1000, * "prefixName": "", * rsu_indicators:{ * "indicatorUse": ["LCZ", "UTRF", "TEB"], * "svfSimplified": false, * "mapOfWeights": * {"sky_view_factor": 1, * "aspect_ratio": 1, * "building_surface_fraction": 1, * "impervious_surface_fraction" : 1, * "pervious_surface_fraction": 1, * "height_of_roughness_elements": 1, * "terrain_roughness_length": 1}, * "hLevMin": 3, * "hLevMax": 15, * "hThresho2": 10 } * } * } The parameters entry tag contains all geoclimate chain parameters. When a parameter is not specificied a default value is set. - distance The integer value to expand the envelope of zone when recovering the data - distance The integer value to expand the envelope of zone when recovering the data (some objects may be badly truncated if they are not within the envelope) - indicatorUse List of geoindicator types to compute (default ["LCZ", "UTRF", "TEB"] --> "LCZ" : compute the indicators needed for the LCZ classification (Stewart et Oke, 2012) --> "UTRF" : compute the indicators needed for the urban typology classification (Bocher et al., 2017) --> "TEB" : compute the indicators needed for the Town Energy Balance model - svfSimplified A boolean indicating whether or not the simplified version of the SVF should be used. This version is faster since it is based on a simple relationship between ground SVF calculated at RSU scale and facade density (Bernard et al. 2018). - prefixName A prefix used to name the output table (default ""). Could be useful in case the user wants to investigate the sensibility of the chain to some input parameters - mapOfWeights Values that will be used to increase or decrease the weight of an indicator (which are the key of the map) for the LCZ classification step (default : all values to 1) - hLevMin Minimum building level height

  Returns:

  a map with the name of zone and a list of the output tables computed and stored in the local database, otherwise throw an error. References: --> Bocher, E., Petit, G., Bernard, J., & Palominos, S. (2018). A geoprocessing framework to compute urban indicators: The MApUCE tools chain. Urban climate, 24, 153-174. --> Jérémy Bernard, Erwan Bocher, Gwendall Petit, Sylvain Palominos. Sky View Factor Calculation in Urban Context: Computational Performance and Accuracy Analysis of Two Open and Free GIS Tools. Climate , MDPI, 2018, Urban Overheating - Progress on Mitigation Science and Engineering Applications, 6 (3), pp.60. --> Stewart, Ian D., and Tim R. Oke. "Local climate zones for urban temperature studies." Bulletin of the American Meteorological Society 93, no. 12 (2012): 1879-1900.