From d1555c332c009b84c18c4a8670786e5101f4c3f1 Mon Sep 17 00:00:00 2001 From: "Documenter.jl" Date: Thu, 27 Jul 2023 03:56:53 +0000 Subject: [PATCH] build based on 9aca6ce --- dev/index.html | 2 +- dev/reference/index.html | 6 +++--- dev/search/index.html | 2 +- dev/search_index.js | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/dev/index.html b/dev/index.html index eb673a1..01a11a0 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,2 +1,2 @@ -Home · OSMToolset.jl
Edit on GitHub
+Home · OSMToolset.jl
Edit on GitHub
diff --git a/dev/reference/index.html b/dev/reference/index.html index cc88705..dbb8629 100644 --- a/dev/reference/index.html +++ b/dev/reference/index.html @@ -1,6 +1,6 @@ -Reference · OSMToolset.jl
Edit on GitHub

Reference

Measuring Attractiveness Spatial Index

OSMToolset.find_poi — Method
find_poi(filename::AbstractString; attract_config::AttractivenessConfig=__builtin_attract)

Generates a DataFrame with points of interests and their attractivenss from a given XML filename.

This DataFrame can be later used with AttractivenessSpatIndex to build an attractivenss spatial index.

The attractiveness values for the index will be used ones from the attract_config file. By default builtin_attract_path will be used but you can define your own index.

source
OSMToolset.AttractivenessSpatIndex — Type
AttractivenessSpatIndex(filename::AbstractString)
-AttractivenessSpatIndex(df::AbstractDataFrame)

Builds an attractivness spatial index basing on data in some CSV file o a DataFrame

The CSV file or DataFrame should have the following columns: - class - data class in attractiveness index, each class name creates attractiveness dimension - key - key in the XML file <tag> - values - values in the <tag> (a star "*" catches all values) - points - number of influance points - range - maximum influence range in meters

When a DataFrame is provided the additional parameter refLLA can be provided for the reference LLA coordinates in the spatial index. The spatial index works in the ENU coordinate system.

source
OSMToolset.attractiveness — Method
attractiveness(sindex::AttractivenessSpatIndex, enu::ENU; explain::Bool=false)

Returns the multidimensional attractiveness measure for the given spatial index sindex and enu cooridanates. Note that the enu coordinates must use sindex.refLLA as the reference point. If explain is set to true the result will additionally contain details about objects used to calculate the attractiveness

source
Missing docstring.

Missing docstring for attractiveness(::AttractivenessSpatIndex, ::Float64; ::Float64). Check Documenter's build log for details.

Tiling OSM file

OSMToolset.calc_tiling — Method
calc_tiling(filename::AbstractString, latTileSize::Float64, lonTileSize::Float64)

Calculates recommended bounds, number of rows and columns for a given filename and size of tile latTileSize x lonTileSize.

source
OSMToolset.calc_tiling — Method
calc_tiling(bounds::Bounds, latTileSize::Float64, lonTileSize::Float64)

Calculates recommended bounds, number of rows and columns for a given bounds and size of tile latTileSize x lonTileSize.

source
OSMToolset.tile_osm_file — Method
tile_osm_file(filename::AbstractString, [bounds::Bounds]; nrow::Integer, ncol::Integer, [out_dir::AbstractString]

Provide the tiling functionality for maps. A filename will be open for processing and the tiling will be done around given bounds. If bounds are not given they will be calculated using getbounds function. The tiling will be performed with a matrix having nrow rows and ncol columns. The output will be written to the folder name out_dir. If none out_dir is given than as the output is written to where filename is located.

source

Helper functions

OSMToolset.FloatLon — Type
This is an AbstractFloat type representing geographic longitude as the values may wrap around
source
OSMToolset.Node — Type
Node
+Reference · OSMToolset.jl
Edit on GitHub
Reference
Measuring Attractiveness Spatial Index
OSMToolset.find_poi — Method
find_poi(filename::AbstractString; attract_config::AttractivenessConfig=__builtin_attract)
Generates a DataFrame with points of interests and their attractivenss from a given XML filename.
This DataFrame can be later used with AttractivenessSpatIndex to build an attractivenss spatial index.
The attractiveness values for the index will be used ones from the attract_config file. By default builtin_attract_path will be used but you can define your own index.
source
OSMToolset.AttractivenessSpatIndex — Type
AttractivenessSpatIndex(filename::AbstractString)
+AttractivenessSpatIndex(df::AbstractDataFrame)
Builds an attractivness spatial index basing on data in some CSV file o a DataFrame
The CSV file or DataFrame should have the following columns:     - class - data class in attractiveness index, each class name creates attractiveness dimension     - key - key in the XML file <tag>     - values - values in the <tag> (a star "*" catches all values)     - points - number of influance points      - range - maximum influence range in meters 
When a DataFrame is provided the additional parameter refLLA can be provided for the reference  LLA coordinates in the spatial index. The spatial index works in the ENU coordinate system.
source
OSMToolset.attractiveness — Method
attractiveness(sindex::AttractivenessSpatIndex, enu::ENU, aggregator::Function=+; explain::Bool=false)
Returns the multidimensional attractiveness measure for the given spatial index sindex and enu cooridanates. Note that the enu coordinates must use sindex.refLLA as the reference point. If explain is set to true the result will additionally contain details  about objects used to calculate the attractiveness.
Attractiveness will be aggregagated in a way defined by the aggregator paramterr
source
Missing docstring.
Missing docstring for attractiveness(::AttractivenessSpatIndex, ::Float64; ::Float64). Check Documenter's build log for details.
Tiling OSM file
OSMToolset.calc_tiling — Method
calc_tiling(filename::AbstractString, latTileSize::Float64, lonTileSize::Float64)
Calculates recommended bounds, number of rows and columns for a given filename and size of tile latTileSize x lonTileSize.
source
OSMToolset.calc_tiling — Method
calc_tiling(bounds::Bounds, latTileSize::Float64, lonTileSize::Float64)
Calculates recommended bounds, number of rows and columns for a given bounds and size of tile latTileSize x lonTileSize.
source
OSMToolset.tile_osm_file — Method
tile_osm_file(filename::AbstractString, [bounds::Bounds]; nrow::Integer, ncol::Integer, [out_dir::AbstractString]
Provide the tiling functionality for maps. A filename will be open for processing and the tiling will be done around given bounds. If bounds are not given they will be calculated using getbounds function. The tiling will be performed with a matrix having nrow rows and ncol columns. The output will be written to the folder name out_dir.   If none out_dir is given than as the output is written to where filename is located.
source
Helper functions
OSMToolset.FloatLon — Type
This is an AbstractFloat type representing geographic longitude as the values may wrap around
source
OSMToolset.Node — Type
Node
 
 A node is a point in the map. It has an id, a latitude and a longitude.
-All nodes need to be stored in memory in this format.
source

+All nodes need to be stored in memory in this format.
source
diff --git a/dev/search/index.html b/dev/search/index.html index 428ec44..cb4eb84 100644 --- a/dev/search/index.html +++ b/dev/search/index.html @@ -1,2 +1,2 @@ -Search · OSMToolset.jl

Loading search...

    +Search · OSMToolset.jl

    Loading search...

      diff --git a/dev/search_index.js b/dev/search_index.js index bf5691e..afba6e6 100644 --- a/dev/search_index.js +++ b/dev/search_index.js @@ -1,3 +1,3 @@ var documenterSearchIndex = {"docs": -[{"location":"reference/#Reference","page":"Reference","title":"Reference","text":"","category":"section"},{"location":"reference/","page":"Reference","title":"Reference","text":"CurrentModule = OSMToolset\nDocTestSetup = quote\n using OSMToolset\nend","category":"page"},{"location":"reference/#Measuring-Attractiveness-Spatial-Index","page":"Reference","title":"Measuring Attractiveness Spatial Index","text":"","category":"section"},{"location":"reference/","page":"Reference","title":"Reference","text":"find_poi(::AbstractString; ::AbstractString)\nAttractivenessSpatIndex\nattractiveness(::AttractivenessSpatIndex, ::ENU; ::Bool)\nattractiveness(::AttractivenessSpatIndex, ::Float64; ::Float64)","category":"page"},{"location":"reference/#OSMToolset.find_poi-Tuple{AbstractString}","page":"Reference","title":"OSMToolset.find_poi","text":"find_poi(filename::AbstractString; attract_config::AttractivenessConfig=__builtin_attract)\n\nGenerates a DataFrame with points of interests and their attractivenss from a given XML filename.\n\nThis DataFrame can be later used with AttractivenessSpatIndex to build an attractivenss spatial index.\n\nThe attractiveness values for the index will be used ones from the attract_config file. By default builtin_attract_path will be used but you can define your own index.\n\n\n\n\n\n","category":"method"},{"location":"reference/#OSMToolset.AttractivenessSpatIndex","page":"Reference","title":"OSMToolset.AttractivenessSpatIndex","text":"AttractivenessSpatIndex(filename::AbstractString)\nAttractivenessSpatIndex(df::AbstractDataFrame)\n\nBuilds an attractivness spatial index basing on data in some CSV file o a DataFrame\n\nThe CSV file or DataFrame should have the following columns: - class - data class in attractiveness index, each class name creates attractiveness dimension - key - key in the XML file - values - values in the (a star \"*\" catches all values) - points - number of influance points - range - maximum influence range in meters \n\nWhen a DataFrame is provided the additional parameter refLLA can be provided for the reference LLA coordinates in the spatial index. The spatial index works in the ENU coordinate system.\n\n\n\n\n\n","category":"type"},{"location":"reference/#OSMToolset.attractiveness-Tuple{AttractivenessSpatIndex, OpenStreetMapX.ENU}","page":"Reference","title":"OSMToolset.attractiveness","text":"attractiveness(sindex::AttractivenessSpatIndex, enu::ENU; explain::Bool=false)\n\nReturns the multidimensional attractiveness measure for the given spatial index sindex and enu cooridanates. Note that the enu coordinates must use sindex.refLLA as the reference point. If explain is set to true the result will additionally contain details about objects used to calculate the attractiveness\n\n\n\n\n\n","category":"method"},{"location":"reference/#Tiling-OSM-file","page":"Reference","title":"Tiling OSM file","text":"","category":"section"},{"location":"reference/","page":"Reference","title":"Reference","text":"calc_tiling(::AbstractString, ::Float64, ::Float64) \ncalc_tiling(::OSMToolset.Bounds, ::Float64, ::Float64)\ntile_osm_file(::AbstractString, ::Bounds; ::Integer, ::Integer, ::AbstractString)\nOSMToolset.BoundsTiles","category":"page"},{"location":"reference/#OSMToolset.calc_tiling-Tuple{AbstractString, Float64, Float64}","page":"Reference","title":"OSMToolset.calc_tiling","text":"calc_tiling(filename::AbstractString, latTileSize::Float64, lonTileSize::Float64)\n\nCalculates recommended bounds, number of rows and columns for a given filename and size of tile latTileSize x lonTileSize.\n\n\n\n\n\n","category":"method"},{"location":"reference/#OSMToolset.calc_tiling-Tuple{OSMToolset.Bounds, Float64, Float64}","page":"Reference","title":"OSMToolset.calc_tiling","text":"calc_tiling(bounds::Bounds, latTileSize::Float64, lonTileSize::Float64)\n\nCalculates recommended bounds, number of rows and columns for a given bounds and size of tile latTileSize x lonTileSize.\n\n\n\n\n\n","category":"method"},{"location":"reference/#OSMToolset.tile_osm_file-Tuple{AbstractString, OSMToolset.Bounds}","page":"Reference","title":"OSMToolset.tile_osm_file","text":"tile_osm_file(filename::AbstractString, [bounds::Bounds]; nrow::Integer, ncol::Integer, [out_dir::AbstractString]\n\nProvide the tiling functionality for maps. A filename will be open for processing and the tiling will be done around given bounds. If bounds are not given they will be calculated using getbounds function. The tiling will be performed with a matrix having nrow rows and ncol columns. The output will be written to the folder name out_dir. If none out_dir is given than as the output is written to where filename is located.\n\n\n\n\n\n","category":"method"},{"location":"reference/#OSMToolset.BoundsTiles","page":"Reference","title":"OSMToolset.BoundsTiles","text":"A set of bounds for all tiles\n\n\n\n\n\n","category":"type"},{"location":"reference/","page":"Reference","title":"Reference","text":"Helper functions","category":"page"},{"location":"reference/","page":"Reference","title":"Reference","text":" OSMToolset.FloatLon\n OSMToolset.Node\n OSMToolset.Bounds\n OSMToolset.getbounds(::AbstractString)","category":"page"},{"location":"reference/#OSMToolset.FloatLon","page":"Reference","title":"OSMToolset.FloatLon","text":"This is an AbstractFloat type representing geographic longitude as the values may wrap around\n\n\n\n\n\n","category":"type"},{"location":"reference/#OSMToolset.Node","page":"Reference","title":"OSMToolset.Node","text":"Node\n\nA node is a point in the map. It has an id, a latitude and a longitude.\nAll nodes need to be stored in memory in this format.\n\n\n\n\n\n","category":"type"},{"location":"reference/#OSMToolset.Bounds","page":"Reference","title":"OSMToolset.Bounds","text":"A range of geographic coordinates for a map\n\n\n\n\n\n","category":"type"},{"location":"reference/#OSMToolset.getbounds-Tuple{AbstractString}","page":"Reference","title":"OSMToolset.getbounds","text":"Return Bounds that can be found in the first 10 lines of the OSM file named 'filename'\n\n\n\n\n\n","category":"method"},{"location":"","page":"Home","title":"Home","text":"CurrentModule = OSMToolset","category":"page"},{"location":"#OSMToolset.jl","page":"Home","title":"OSMToolset.jl","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Documentation for OSMToolset.jl","category":"page"},{"location":"","page":"Home","title":"Home","text":"For details please go to the Reference section.","category":"page"},{"location":"#Package-features","page":"Home","title":"Package features","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"@index","category":"page"}] +[{"location":"reference/#Reference","page":"Reference","title":"Reference","text":"","category":"section"},{"location":"reference/","page":"Reference","title":"Reference","text":"CurrentModule = OSMToolset\nDocTestSetup = quote\n using OSMToolset\nend","category":"page"},{"location":"reference/#Measuring-Attractiveness-Spatial-Index","page":"Reference","title":"Measuring Attractiveness Spatial Index","text":"","category":"section"},{"location":"reference/","page":"Reference","title":"Reference","text":"find_poi(::AbstractString; ::AbstractString)\nAttractivenessSpatIndex\nattractiveness(::AttractivenessSpatIndex, ::ENU; ::Bool)\nattractiveness(::AttractivenessSpatIndex, ::Float64; ::Float64)","category":"page"},{"location":"reference/#OSMToolset.find_poi-Tuple{AbstractString}","page":"Reference","title":"OSMToolset.find_poi","text":"find_poi(filename::AbstractString; attract_config::AttractivenessConfig=__builtin_attract)\n\nGenerates a DataFrame with points of interests and their attractivenss from a given XML filename.\n\nThis DataFrame can be later used with AttractivenessSpatIndex to build an attractivenss spatial index.\n\nThe attractiveness values for the index will be used ones from the attract_config file. By default builtin_attract_path will be used but you can define your own index.\n\n\n\n\n\n","category":"method"},{"location":"reference/#OSMToolset.AttractivenessSpatIndex","page":"Reference","title":"OSMToolset.AttractivenessSpatIndex","text":"AttractivenessSpatIndex(filename::AbstractString)\nAttractivenessSpatIndex(df::AbstractDataFrame)\n\nBuilds an attractivness spatial index basing on data in some CSV file o a DataFrame\n\nThe CSV file or DataFrame should have the following columns: - class - data class in attractiveness index, each class name creates attractiveness dimension - key - key in the XML file - values - values in the (a star \"*\" catches all values) - points - number of influance points - range - maximum influence range in meters \n\nWhen a DataFrame is provided the additional parameter refLLA can be provided for the reference LLA coordinates in the spatial index. The spatial index works in the ENU coordinate system.\n\n\n\n\n\n","category":"type"},{"location":"reference/#OSMToolset.attractiveness-Tuple{AttractivenessSpatIndex, OpenStreetMapX.ENU}","page":"Reference","title":"OSMToolset.attractiveness","text":"attractiveness(sindex::AttractivenessSpatIndex, enu::ENU, aggregator::Function=+; explain::Bool=false)\n\nReturns the multidimensional attractiveness measure for the given spatial index sindex and enu cooridanates. Note that the enu coordinates must use sindex.refLLA as the reference point. If explain is set to true the result will additionally contain details about objects used to calculate the attractiveness.\n\nAttractiveness will be aggregagated in a way defined by the aggregator paramterr\n\n\n\n\n\n","category":"method"},{"location":"reference/#Tiling-OSM-file","page":"Reference","title":"Tiling OSM file","text":"","category":"section"},{"location":"reference/","page":"Reference","title":"Reference","text":"calc_tiling(::AbstractString, ::Float64, ::Float64) \ncalc_tiling(::OSMToolset.Bounds, ::Float64, ::Float64)\ntile_osm_file(::AbstractString, ::Bounds; ::Integer, ::Integer, ::AbstractString)\nOSMToolset.BoundsTiles","category":"page"},{"location":"reference/#OSMToolset.calc_tiling-Tuple{AbstractString, Float64, Float64}","page":"Reference","title":"OSMToolset.calc_tiling","text":"calc_tiling(filename::AbstractString, latTileSize::Float64, lonTileSize::Float64)\n\nCalculates recommended bounds, number of rows and columns for a given filename and size of tile latTileSize x lonTileSize.\n\n\n\n\n\n","category":"method"},{"location":"reference/#OSMToolset.calc_tiling-Tuple{OSMToolset.Bounds, Float64, Float64}","page":"Reference","title":"OSMToolset.calc_tiling","text":"calc_tiling(bounds::Bounds, latTileSize::Float64, lonTileSize::Float64)\n\nCalculates recommended bounds, number of rows and columns for a given bounds and size of tile latTileSize x lonTileSize.\n\n\n\n\n\n","category":"method"},{"location":"reference/#OSMToolset.tile_osm_file-Tuple{AbstractString, OSMToolset.Bounds}","page":"Reference","title":"OSMToolset.tile_osm_file","text":"tile_osm_file(filename::AbstractString, [bounds::Bounds]; nrow::Integer, ncol::Integer, [out_dir::AbstractString]\n\nProvide the tiling functionality for maps. A filename will be open for processing and the tiling will be done around given bounds. If bounds are not given they will be calculated using getbounds function. The tiling will be performed with a matrix having nrow rows and ncol columns. The output will be written to the folder name out_dir. If none out_dir is given than as the output is written to where filename is located.\n\n\n\n\n\n","category":"method"},{"location":"reference/#OSMToolset.BoundsTiles","page":"Reference","title":"OSMToolset.BoundsTiles","text":"A set of bounds for all tiles\n\n\n\n\n\n","category":"type"},{"location":"reference/","page":"Reference","title":"Reference","text":"Helper functions","category":"page"},{"location":"reference/","page":"Reference","title":"Reference","text":" OSMToolset.FloatLon\n OSMToolset.Node\n OSMToolset.Bounds\n OSMToolset.getbounds(::AbstractString)","category":"page"},{"location":"reference/#OSMToolset.FloatLon","page":"Reference","title":"OSMToolset.FloatLon","text":"This is an AbstractFloat type representing geographic longitude as the values may wrap around\n\n\n\n\n\n","category":"type"},{"location":"reference/#OSMToolset.Node","page":"Reference","title":"OSMToolset.Node","text":"Node\n\nA node is a point in the map. It has an id, a latitude and a longitude.\nAll nodes need to be stored in memory in this format.\n\n\n\n\n\n","category":"type"},{"location":"reference/#OSMToolset.Bounds","page":"Reference","title":"OSMToolset.Bounds","text":"A range of geographic coordinates for a map\n\n\n\n\n\n","category":"type"},{"location":"reference/#OSMToolset.getbounds-Tuple{AbstractString}","page":"Reference","title":"OSMToolset.getbounds","text":"Return Bounds that can be found in the first 10 lines of the OSM file named 'filename'\n\n\n\n\n\n","category":"method"},{"location":"","page":"Home","title":"Home","text":"CurrentModule = OSMToolset","category":"page"},{"location":"#OSMToolset.jl","page":"Home","title":"OSMToolset.jl","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Documentation for OSMToolset.jl","category":"page"},{"location":"","page":"Home","title":"Home","text":"For details please go to the Reference section.","category":"page"},{"location":"#Package-features","page":"Home","title":"Package features","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"@index","category":"page"}] }