[FEAT] Add download method for custom Overpass API query

Author: RebZJ

Project.toml

@@ -8,6 +8,7 @@ DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
 Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
 HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"
 JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
+JSON3 = "0f8b85d8-7281-11e9-16c2-39a750bddbf1"
 LightXML = "9c8b4983-aa76-5018-a973-4c85ecc9e179"
 MetaGraphs = "626554b9-1ddb-594c-aa3c-2596fe9399a5"
 NearestNeighbors = "b8a86587-4115-5ab1-83bc-aa920d37bbce"

src/download.jl

@@ -102,6 +102,36 @@ function overpass_query(filters::String,
     return query
 end
 
+"""
+osm_network_from_custom_filters(custom_filters::String,
+                   metadata::Bool=false,
+                   download_format::Symbol=:json,
+                   bbox::Union{Vector{AbstractFloat},Nothing}=nothing
+                   )::String
+
+To pass in a custom query string, filters and bbox
+
+# Arguments
+- `custom_filters::String`: Custom filters for the query, e.g. polygon filter, highways only, traffic lights only, etc.
+- `metadata::Bool=false`: Set true to return metadata.
+- `download_format::Symbol=:json`: Download format, either `:osm`, `:xml` or `json`.
+- `bbox::Union{Vector{AbstractFloat},Nothing}=nothing`: Optional bounding box filter.
+- `network_type::Symbol=:drive`: 
+
+# Return
+- `String`: Overpass query string.
+"""
+function osm_network_from_custom_filters(;custom_filters::String,
+    network_type::Symbol=:drive,
+    metadata::Bool=false,
+    download_format::Symbol=:json,
+    bbox::Union{Vector{<:AbstractFloat},Nothing}=nothing)::String
+    # return overpass_request(query)
+    query = overpass_query(custom_filters, metadata, download_format, bbox)
+    response = overpass_request(query)
+    return response
+end
+
 """
     overpass_polygon_network_query(geojson_polygons::Vector{Vector{Any}},
                                    network_type::Symbol=:drive,
@@ -334,6 +364,8 @@ function osm_network_downloader(download_method::Symbol)::Function
         return osm_network_from_point
     elseif download_method == :polygon
         return osm_network_from_polygon
+    elseif download_method == :custom_filters
+        return osm_network_from_custom_filters
     else
         throw(ArgumentError("OSM network downloader $download_method does not exist"))
     end
@@ -375,6 +407,12 @@ Downloads an OpenStreetMap network by querying with a place name, bounding box,
 *`download_method=:polygon`*
 - `polygon::AbstractVector`: Vector of longitude-latitude pairs.
 
+*`download_method=:custom_filters`*
+- `custom_filters::String`: Filters for the query, e.g. polygon filter, highways only, traffic lights only, etc.
+- `metadata::Bool=false`: Set true to return metadata.
+- `download_format::Symbol=:json`: Download format, either `:osm`, `:xml` or `json`.
+- `bbox::Union{Vector{AbstractFloat},Nothing}=nothing`: Optional bounding box filter.
+
 # Network Types
 - `:drive`: Motorways excluding private and service ways.
 - `:drive_service`: Motorways including private and service ways.

test/download.jl

@@ -3,6 +3,7 @@
     @test LightOSM.osm_network_downloader(:bbox) == LightOSM.osm_network_from_bbox
     @test LightOSM.osm_network_downloader(:point) == LightOSM.osm_network_from_point
     @test LightOSM.osm_network_downloader(:polygon) == LightOSM.osm_network_from_polygon
+    @test LightOSM.osm_network_downloader(:custom_filters) == LightOSM.osm_network_from_custom_filters
     @test_throws ArgumentError LightOSM.osm_network_downloader(:doesnt_exist)
 end
 
@@ -23,22 +24,54 @@ end
         try
             wait_for_overpass()
             data = download_osm_network(:point,
-                                        radius=0.5,
-                                        point=GeoLocation(-37.8136, 144.9631),
-                                        network_type=:drive,
-                                        download_format=format,
-                                        save_to_file_location=filename);
+                radius=0.5,
+                point=GeoLocation(-37.8136, 144.9631),
+                network_type=:drive,
+                download_format=format,
+                save_to_file_location=filename)
             @test isfile(filename)
             g = graph_from_file(filename) # Check it doesn't error
         catch err
             # Sometimes gets HTTP.ExceptionRequest.StatusError in tests due to connection to overpass
             !isa(err, HTTP.ExceptionRequest.StatusError) && rethrow()
-            @error "Test failed due to connection issue" exception=(err, catch_backtrace())
+            @error "Test failed due to connection issue" exception = (err, catch_backtrace())
         end
 
         try
             rm(filename)
         catch
         end
     end
+
+    #run test for custom filters
+    try
+        wait_for_overpass()
+        filename = "map.json"
+        format = :json
+        custom_filters = """way
+        ["highway"]
+        ["motorcar"!~"no"]
+        ["area"!~"yes"]   
+          ["highway"!~"elevator|steps|tertiary|construction|bridleway|proposed|track|pedestrian|secondary|path|living_street|cycleway|primary|footway|platform|abandoned|service|escalator|corridor|raceway"]
+        ["motor_vehicle"!~"no"]["access"!~"private"]
+        ["service"!~"parking|parking_aisle|driveway|private|emergency_access"]
+        ;
+            >
+            ;
+
+        """
+
+        bbox = [-37.816779513558274, 144.9590750877158, -37.81042034950731, 144.967124565619]
+        
+        test_custom_query = download_osm_network(:custom_filters, download_format=format,
+                    save_to_file_location=filename,
+                     custom_filters = custom_filters, bbox = bbox)
+
+
+        g = graph_from_file(filename)
+    catch err
+        
+        @warn "Could not build graph" 
+        rethrow()
+    end
 end

test/runtests.jl

@@ -11,7 +11,7 @@ include("stub.jl")
 
 const TEST_OSM_URL = "https://raw.githubusercontent.com/DeloitteOptimalReality/LightOSMFiles.jl/main/maps/south-yarra.json"
 
-@testset "LightOSM Tests" begin
+@testset "LightOSM Tests" begin 
     @testset "Constants" begin include("constants.jl") end
     @testset "Utilities" begin include("utilities.jl") end
     @testset "Geometry" begin include("geometry.jl") end