feat: add location_type to isochrone parameters (#191)

fixes #171 --------- Co-authored-by: Jakob Schnell <Jakob.Schnell@heigit.org>
GIScience · Dec 8, 2023 · f7e4c6a · f7e4c6a
1 parent bdb7974
commit f7e4c6a
Show file tree

Hide file tree

Showing 10 changed files with 54 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -44,6 +44,7 @@ RELEASING:
 ### Added
 - Additional parameter for the "smoothing factor" to isochrones processing algorithms ([#172](https://github.com/GIScience/orstools-qgis-plugin/issues/172))
 - Mention omission of configuration options when using traveling salesman
+- option to set location type for isochrones ([#191](https://github.com/GIScience/orstools-qgis-plugin/pull/191))
 
 ## [1.6.0] - 2023-07-25
 

diff --git a/ORStools/common/__init__.py b/ORStools/common/__init__.py
@@ -56,3 +56,5 @@
     "INPUT_AVOID_POLYGONS",
     "INPUT_SMOOTHING",
 ]
+
+LOCATION_TYPES = ["start", "destination"]
diff --git a/ORStools/help/isochrones_from_layer.help b/ORStools/help/isochrones_from_layer.help
@@ -9,6 +9,8 @@ Current <a href="https://openrouteservice.org/restrictions/">restriction limits<
 
 <i>Ranges</i>: parameter needs to be a comma-separated list of integer values, no decimal points.
 
+<i>Location Type</i>: start treats the location(s) as starting point, destination as goal.
+
 <i>Advanced Parameters</i>: see <a href="https://giscience.github.io/openrouteservice/documentation/routing-options/Routing-Options.html">the documentation</a> for descriptions.
 
 <i>Output layer</i>: a Polygon layer with ID, isochrone center latitude and longitude, range value, travel mode and total population (from <a href="https://ghsl.jrc.ec.europa.eu/about.php">GHSL</a>).

diff --git a/ORStools/help/isochrones_from_layer_de.help b/ORStools/help/isochrones_from_layer_de.help
@@ -10,6 +10,8 @@ Ein gültiger API-Key ('Web'-Menü > 'Dienst-Einstellungen') oder Registrierung
 
 <i>Zusätzliche Parameter</i>: Beschreibung in der <a href="https://giscience.github.io/openrouteservice/documentation/routing-options/Routing-Options.html">Dokumentation</a>.
 
+<i>Ortstyp</i>: start behandelt den/die Ort(e) als Startpunkt, destination als Ziel.
+
 <i>Ausgabelayer</i>: Polygonlayer mit ID, Längen- und Breitengrad des Isochronen-Mittelpunkts, Reichweiten-Wert, Verkehrsmittel und Bevölkerung (aus <a href="https://ghsl.jrc.ec.europa.eu/about.php">GHSL</a>). KBS ist EPSG:4326.
 
 Der Mittelpunkt kann über das <code>Punktlayer aus Tabelle erzeugen</code>-Werkzeug ('Verarbeitungswerkzeuge' ► 'Vektorerzeugung') extrahiert werden.

diff --git a/ORStools/help/isochrones_from_point.help b/ORStools/help/isochrones_from_point.help
@@ -7,6 +7,8 @@ Current <a href="https://openrouteservice.org/restrictions/">restriction limits<
 
 <i>Ranges</i>: parameter needs to be a comma-separated list of integer values, no decimal points.
 
+<i>Location Type</i>: start treats the location(s) as starting point, destination as goal.
+
 <i>Advanced Parameters</i>: see <a href="https://giscience.github.io/openrouteservice/documentation/routing-options/Routing-Options.html">the documentation</a> for descriptions.
 
 <i>Output layer</i>: a Polygon layer with ID, isochrone center latitude and longitude, range value, travel mode and total population (from <a href="https://ghsl.jrc.ec.europa.eu/about.php">GHSL</a>).

diff --git a/ORStools/help/isochrones_from_point_de.help b/ORStools/help/isochrones_from_point_de.help
@@ -8,6 +8,8 @@ Ein gültiger API-Key ('Web'-Menü > 'Dienst-Einstellungen') oder Registrierung
 
 <i>Zusätzliche Parameter</i>: Beschreibung in der <a href="https://giscience.github.io/openrouteservice/documentation/routing-options/Routing-Options.html">Dokumentation</a>.
 
+<i>Ortstyp</i>: start behandelt den/die Ort(e) als Startpunkt, destination als Ziel.
+
 <i>Ausgabelayer</i>: Polygonlayer mit ID, Längen- und Breitengrad des Isochronen-Mittelpunkts, Reichweiten-Wert, Verkehrsmittel und Bevölkerung (aus <a href="https://ghsl.jrc.ec.europa.eu/about.php">GHSL</a>). KBS ist EPSG:4326.
 
 Der Mittelpunkt kann über das <code>Punktlayer aus Tabelle erzeugen</code>-Werkzeug ('Verarbeitungswerkzeuge' ► 'Vektorerzeugung') extrahiert werden.

diff --git a/ORStools/i18n/orstools_de.qm b/ORStools/i18n/orstools_de.qm
diff --git a/ORStools/i18n/orstools_de.ts b/ORStools/i18n/orstools_de.ts
@@ -165,63 +165,73 @@
 <context>
     <name>ORSIsochronesLayerAlgo</name>
     <message>
-        <location filename="../proc/isochrones_layer_proc.py" line="64"/>
+        <location filename="../proc/isochrones_layer_proc.py" line="67"/>
         <source>Input Point layer</source>
         <translation>Eingabelayer (Punkte)</translation>
     </message>
     <message>
-        <location filename="../proc/isochrones_layer_proc.py" line="73"/>
+        <location filename="../proc/isochrones_layer_proc.py" line="76"/>
         <source>Input layer ID Field (mutually exclusive with Point option)</source>
         <translation>ID-Attribut (schließt Punkt-Option aus)</translation>
     </message>
     <message>
-        <location filename="../proc/isochrones_layer_proc.py" line="79"/>
+        <location filename="../proc/isochrones_layer_proc.py" line="82"/>
         <source>Dimension</source>
         <translation>Dimension</translation>
     </message>
     <message>
-        <location filename="../proc/isochrones_layer_proc.py" line="85"/>
+        <location filename="../proc/isochrones_layer_proc.py" line="88"/>
         <source>Comma-separated ranges [min or m]</source>
         <translation>Komma-getrennte Reichweiten [min oder m]</translation>
     </message>
     <message>
-        <location filename="../proc/isochrones_layer_proc.py" line="225"/>
+        <location filename="../proc/isochrones_layer_proc.py" line="236"/>
         <source>Isochrones from Point-Layer</source>
         <translation>Isochronen aus Punkt-Layer</translation>
     </message>
     <message>
-        <location filename="../proc/isochrones_layer_proc.py" line="90"/>
+        <location filename="../proc/isochrones_layer_proc.py" line="93"/>
         <source>Smoothing factor between 0 [detailed] and 100 [generalized]</source>
         <translation>Glättungsfaktor zwischen 0 [detailliert] und 100 [verallgemeinert]</translation>
     </message>
+    <message>
+        <location filename="../proc/isochrones_layer_proc.py" line="100"/>
+        <source>Location Type</source>
+        <translation>Ortstyp</translation>
+    </message>
 </context>
 <context>
     <name>ORSIsochronesPointAlgo</name>
     <message>
-        <location filename="../proc/isochrones_point_proc.py" line="58"/>
+        <location filename="../proc/isochrones_point_proc.py" line="62"/>
         <source>Input Point from map canvas (mutually exclusive with layer option)</source>
         <translation>Eingabepunkt aus Kartenansicht (schließt Ebenen-Option aus)</translation>
     </message>
     <message>
-        <location filename="../proc/isochrones_point_proc.py" line="63"/>
+        <location filename="../proc/isochrones_point_proc.py" line="68"/>
         <source>Dimension</source>
         <translation>Dimension</translation>
     </message>
     <message>
-        <location filename="../proc/isochrones_point_proc.py" line="69"/>
+        <location filename="../proc/isochrones_point_proc.py" line="74"/>
         <source>Comma-separated ranges [min or m]</source>
         <translation>Komma-getrennte Reichweiten [min oder m]</translation>
     </message>
     <message>
-        <location filename="../proc/isochrones_point_proc.py" line="163"/>
+        <location filename="../proc/isochrones_point_proc.py" line="172"/>
         <source>Isochrones from Point</source>
         <translation>Isochronen von einzelnem Punkt</translation>
     </message>
     <message>
-        <location filename="../proc/isochrones_point_proc.py" line="74"/>
+        <location filename="../proc/isochrones_point_proc.py" line="79"/>
         <source>Smoothing factor between 0 [detailed] and 100 [generalized]</source>
         <translation>Glättungsfaktor zwischen 0 [detailliert] und 100 [verallgemeinert]</translation>
     </message>
+    <message>
+        <location filename="../proc/isochrones_point_proc.py" line="86"/>
+        <source>Location Type</source>
+        <translation>Ortstyp</translation>
+    </message>
 </context>
 <context>
     <name>ORSMatrixAlgo</name>
@@ -254,12 +264,12 @@
 <context>
     <name>ORStoolsDialog</name>
     <message>
-        <location filename="../gui/ORStoolsDialog.py" line="392"/>
+        <location filename="../gui/ORStoolsDialog.py" line="390"/>
         <source>Apply</source>
         <translation>Anwenden</translation>
     </message>
     <message>
-        <location filename="../gui/ORStoolsDialog.py" line="393"/>
+        <location filename="../gui/ORStoolsDialog.py" line="391"/>
         <source>Close</source>
         <translation>Schließen</translation>
     </message>

diff --git a/ORStools/proc/isochrones_layer_proc.py b/ORStools/proc/isochrones_layer_proc.py
@@ -40,7 +40,7 @@
     QgsProcessingParameterNumber,
 )
 
-from ORStools.common import isochrones_core, PROFILES, DIMENSIONS
+from ORStools.common import isochrones_core, PROFILES, DIMENSIONS, LOCATION_TYPES
 from ORStools.proc.base_processing_algorithm import ORSBaseProcessingAlgorithm
 from ORStools.utils import transform, exceptions, logger
 
@@ -60,6 +60,7 @@ def __init__(self):
         self.IN_DIFFERENCE = "INPUT_DIFFERENCE"
         self.USE_SMOOTHING = "USE_SMOOTHING"
         self.IN_SMOOTHING = "INPUT_SMOOTHING"
+        self.LOCATION_TYPE = "LOCATION_TYPE"
         self.PARAMETERS = [
             QgsProcessingParameterFeatureSource(
                 name=self.IN_POINTS,
@@ -95,6 +96,12 @@ def __init__(self):
                 maxValue=100,
                 optional=True,
             ),
+            QgsProcessingParameterEnum(
+                name=self.LOCATION_TYPE,
+                description=self.tr("Location Type"),
+                options=LOCATION_TYPES,
+                defaultValue=LOCATION_TYPES[0],
+            ),
         ]
 
     # Save some important references
@@ -111,6 +118,7 @@ def processAlgorithm(self, parameters, context, feedback):
 
         profile = dict(enumerate(PROFILES))[parameters[self.IN_PROFILE]]
         dimension = dict(enumerate(DIMENSIONS))[parameters[self.IN_METRIC]]
+        location_type = dict(enumerate(LOCATION_TYPES))[parameters[self.LOCATION_TYPE]]
 
         factor = 60 if dimension == "time" else 1
         ranges_raw = parameters[self.IN_RANGES]
@@ -151,6 +159,7 @@ def processAlgorithm(self, parameters, context, feedback):
                 "attributes": ["total_pop"],
                 "id": id_value,
                 "options": options,
+                "location_type": location_type,
             }
 
             # only include smoothing if set

diff --git a/ORStools/proc/isochrones_point_proc.py b/ORStools/proc/isochrones_point_proc.py
@@ -37,7 +37,7 @@
     QgsProcessingParameterNumber,
 )
 
-from ORStools.common import isochrones_core, PROFILES, DIMENSIONS
+from ORStools.common import isochrones_core, PROFILES, DIMENSIONS, LOCATION_TYPES
 from ORStools.utils import exceptions, logger
 from .base_processing_algorithm import ORSBaseProcessingAlgorithm
 
@@ -54,6 +54,7 @@ def __init__(self):
         self.IN_KEY = "INPUT_APIKEY"
         self.IN_DIFFERENCE = "INPUT_DIFFERENCE"
         self.IN_SMOOTHING = "INPUT_SMOOTHING"
+        self.LOCATION_TYPE = "LOCATION_TYPE"
         self.PARAMETERS = [
             QgsProcessingParameterPoint(
                 name=self.IN_POINT,
@@ -81,6 +82,12 @@ def __init__(self):
                 maxValue=100,
                 optional=True,
             ),
+            QgsProcessingParameterEnum(
+                name=self.LOCATION_TYPE,
+                description=self.tr("Location Type"),
+                options=LOCATION_TYPES,
+                defaultValue=LOCATION_TYPES[0],
+            ),
         ]
 
     # Save some important references
@@ -97,6 +104,7 @@ def processAlgorithm(self, parameters, context, feedback):
 
         profile = dict(enumerate(PROFILES))[parameters[self.IN_PROFILE]]
         dimension = dict(enumerate(DIMENSIONS))[parameters[self.IN_METRIC]]
+        location_type = dict(enumerate(LOCATION_TYPES))[parameters[self.LOCATION_TYPE]]
 
         factor = 60 if dimension == "time" else 1
         ranges_raw = parameters[self.IN_RANGES]
@@ -117,6 +125,7 @@ def processAlgorithm(self, parameters, context, feedback):
             "attributes": ["total_pop"],
             "id": None,
             "options": options,
+            "location_type": location_type,
         }
 
         if smoothing or smoothing == 0: