Data overlay sandbox feature

[Daniilmass]

PR Instructions

otp-config.json file must have a feature enabled as follows:

{
    "otpFeatures" : {
        "DataOverlay" : true
    }
}

Then provide a data-overlay-config.json and a data file itself in a NetCDF (.nc, .nc3, .nc4) format.

Start the graph building process as usually. Your custom overlay data will populate the graph edges with values. You will also get custom /otp/routers/default/plan endpoint request parameters available (defined in the data-overlay-config.json).

Please scroll to the bottom for the data-overlay-config.json example.

Summary

PR adds a feature of a map grid data "overlay" or population. You could take i.e weather, air quality, traffic and e.t.c data in a NetCDF format and get the map populated by this data. Routing can be affected by this data if you use the custom request parameters defined in the data-overlay-config.json

Issue

---

Code style

Documentation

Changelog

The changelog file
is generated from the pull-request title, make sure the title describe the feature or issue fixed.
To exclude the PR from the changelog add [changelog skip] in the title.

Required data-overlay-config.json file example

{
  "fileName": "graphs/data-file.nc4",
  "latitudeVariable": "lat",
  "longitudeVariable": "lon",
  "timeVariable": "time",
  "timeFormat": "HOURS",
  "indexVariables": [
    {
      "name": "harmfulMicroparticlesPM2_5",
      "displayName": "Harmful micro particles pm 2.5",
      "variable": "cnc_PM2_5"
    },
    {
      "name": "carbonMonoxide",
      "displayName": "Carbon monoxide",
      "variable": "cnc_CO_gas"
    }
  ],
  "requestParameters": [
    {
      "name": "harmful_micro_particles_PM2_5_threshold",
      "parameterType": "THRESHOLD",
      "variable": "harmfulMicroparticlesPM2_5"
    },
    {
      "name": "harmful_micro_particles_PM2_5_penalty",
      "parameterType": "PENALTY",
      "variable": "harmfulMicroparticlesPM2_5",
      "formula": "(VALUE + 1 - THRESHOLD) * PENALTY"
    },
    {
      "name": "carbon_monoxide_threshold",
      "parameterType": "THRESHOLD",
      "variable": "carbonMonoxide"
    },
    {
      "name": "carbon_monoxide_penalty",
      "parameterType": "PENALTY",
      "variable": "carbonMonoxide",
      "formula": "(VALUE + 1 - THRESHOLD) * PENALTY"
    }
  ]
}

[leonardehrenfried]

@kaeline Is this done? Can this TODO be removed?

[kaeline]

@leonardehrenfried Not done yet, I will add more detailed description of how to set the configuration for the data file

[t2gran]

Suggested change

import org.opentripplanner.ext.dataoverlay.routing.DataOverlayContext;

[Daniilmass]

@t2gran @leonardehrenfried unfortunately we can not merge without write access to this repo. Could you do it?

[leonardehrenfried]

🍾