├── .Rbuildignore ├── BinaryFiles ├── .gitignore ├── inst ├── extdata │ ├── gallery_connected_links.csv │ └── gallery_connected.graph └── CITATION ├── tests ├── testthat.R └── testthat │ └── test-base.R ├── exec ├── depthmapXcli_macos ├── depthmapXcli_linux64 └── depthmapXcli_win64.exe ├── rdepthmap.Rproj ├── DESCRIPTION ├── README.md ├── R ├── cliHelp.R ├── generateRandomCapString.R ├── refIDtoIndex.R ├── makeTempPointFile.R ├── getTopFeatures.R ├── allFewestLineMap.R ├── stepdepth.R ├── axialAnalysis.R ├── convertMap.R ├── vga.R ├── depthmapXcli.R ├── segmentAnalysis.R ├── import.R ├── shapegraphToIGraph.R ├── agentAnalysis.R ├── isovist.R ├── matchPointsToLines.R ├── link.R ├── prepareVGA.R ├── export.R └── palettes.R ├── man ├── cliHelp.Rd ├── refIDtoIndex.Rd ├── processPointMap.Rd ├── getTopFeatures.Rd ├── createGrid.Rd ├── matchPointsToLines.Rd ├── fillGrid.Rd ├── shapegraphToIGraph.Rd ├── stepdepth.Rd ├── VGA.Rd ├── import.Rd ├── makeVGAGraph.Rd ├── axialAnalysis.Rd ├── convertMap.Rd ├── palettes.Rd ├── segmentAnalysis.Rd ├── isovist.Rd ├── linkMapCoords.Rd ├── export.Rd └── agentAnalysis.Rd ├── NAMESPACE └── LICENSE /.Rbuildignore: -------------------------------------------------------------------------------- 1 | ^.*\.Rproj$ 2 | ^\.Rproj\.user$ 3 | -------------------------------------------------------------------------------- /BinaryFiles: -------------------------------------------------------------------------------- 1 | exec/depthmapX_macos 2 | exec/depthmapX_win64.exe 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .Rproj.user 2 | .Rhistory 3 | .RData 4 | .Ruserdata 5 | .DS_Store 6 | -------------------------------------------------------------------------------- /inst/extdata/gallery_connected_links.csv: -------------------------------------------------------------------------------- 1 | RefFrom,RefTo 2 | 786467,4128814 3 | 3014677,5636125 4 | -------------------------------------------------------------------------------- /tests/testthat.R: -------------------------------------------------------------------------------- 1 | library(testthat) 2 | library(rdepthmap) 3 | 4 | test_check("rdepthmap") 5 | -------------------------------------------------------------------------------- /exec/depthmapXcli_macos: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/pklampros/rdepthmap/HEAD/exec/depthmapXcli_macos -------------------------------------------------------------------------------- /exec/depthmapXcli_linux64: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/pklampros/rdepthmap/HEAD/exec/depthmapXcli_linux64 -------------------------------------------------------------------------------- /exec/depthmapXcli_win64.exe: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/pklampros/rdepthmap/HEAD/exec/depthmapXcli_win64.exe -------------------------------------------------------------------------------- /inst/extdata/gallery_connected.graph: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/pklampros/rdepthmap/HEAD/inst/extdata/gallery_connected.graph -------------------------------------------------------------------------------- /rdepthmap.Rproj: -------------------------------------------------------------------------------- 1 | Version: 1.0 2 | 3 | RestoreWorkspace: Default 4 | SaveWorkspace: Default 5 | AlwaysSaveHistory: Default 6 | 7 | EnableCodeIndexing: Yes 8 | UseSpacesForTab: Yes 9 | NumSpacesForTab: 2 10 | Encoding: UTF-8 11 | 12 | RnwWeave: Sweave 13 | LaTeX: pdfLaTeX 14 | 15 | AutoAppendNewline: Yes 16 | StripTrailingWhitespace: Yes 17 | 18 | BuildType: Package 19 | PackageUseDevtools: Yes 20 | PackageInstallArgs: --no-multiarch --with-keep.source 21 | -------------------------------------------------------------------------------- /inst/CITATION: -------------------------------------------------------------------------------- 1 | year <- sub("-.*", "", meta$Date) 2 | note <- sprintf("R package version %s", meta$Version) 3 | citableRoles = c("cre", "aut") 4 | authors <- as.person(meta['Author']) 5 | citableAuthors = authors[unlist(lapply(authors, function(author) { 6 | length(intersect(author$role, citableRoles)) > 0 7 | }))] 8 | 9 | bibentry(bibtype = "Misc", 10 | title = "{rdepthmap}: R and depthmapX CLI interface", 11 | author = citableAuthors, 12 | year = year, 13 | note = note, 14 | version = meta$Version, 15 | url = "https://github.com/orange-vertex/rdepthmap") 16 | -------------------------------------------------------------------------------- /DESCRIPTION: -------------------------------------------------------------------------------- 1 | Package: rdepthmap 2 | Type: Package 3 | Title: R and depthmapX CLI interface 4 | Date: 2023-10-25 5 | Version: 0.2.0 6 | Authors@R: c( 7 | person("Petros", "Koutsolampros", email = "petros.koutsolampros.11@ucl.ac.uk", role = c("cre", "aut")), 8 | person("Fani", "Kostourou", role = c("aut", "ctb")), 9 | person("Kimon", "Krenz", role = "ctb"), 10 | person("University College London", role = "fnd"), 11 | person("Spacelab", role = "fnd")) 12 | Description: This package interfaces with the depthmapX CLI with the aim of modifying .graph files. 13 | License: GPL-3 + file LICENSE 14 | Encoding: UTF-8 15 | LazyData: true 16 | Depends: 17 | sp, sf, igraph 18 | Suggests: 19 | testthat 20 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Notice: 2 | This package has been replaced by https://github.com/spatialnous/alcyon which uses depthmapX's sala library directly instead of through the CLI. 3 | 4 | ## rdepthmap 5 | An R package to interface with the depthmapXcli 6 | 7 | ### How to install: 8 | ``` 9 | install.packages("devtools") 10 | library(devtools) 11 | install_github("orange-vertex/rdepthmap") 12 | library(rdepthmap) 13 | ``` 14 | Windows users might need to also install [Rtools](https://cran.r-project.org/bin/windows/Rtools/) 15 | 16 | A demonstration of the package took place in the [“Space syntax analysis in R” workshop](http://www.12sssbeijing.com/proceeding/) of the 12th International Space Syntax Symposium (SSS12) in China on the 8th of July 2019, the content of which you may find [here](https://github.com/orange-vertex/12_sss_workshop). 17 | -------------------------------------------------------------------------------- /R/cliHelp.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Petros Koutsolampros 2 | # 3 | # This file is part of rdepthmap 4 | # 5 | # rdepthmap is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # rdepthmap is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with rdepthmap If not, see . 17 | 18 | cliHelp = function(cliPath = getDefaultCLILocation()) { 19 | system2(cliPath, c("-h")); 20 | } 21 | -------------------------------------------------------------------------------- /R/generateRandomCapString.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Petros Koutsolampros 2 | # 3 | # This file is part of rdepthmap 4 | # 5 | # rdepthmap is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # rdepthmap is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with rdepthmap If not, see . 17 | 18 | generateRandomCapString <- function(n = 10) { 19 | paste(sample(LETTERS, n, TRUE), collapse = "") 20 | } 21 | -------------------------------------------------------------------------------- /R/refIDtoIndex.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Petros Koutsolampros 2 | # 3 | # This file is part of rdepthmap 4 | # 5 | # rdepthmap is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # rdepthmap is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with rdepthmap If not, see . 17 | 18 | refIDtoIndex = function(refID) { 19 | i = bitwShiftR(refID, 16); 20 | j = bitwAnd(refID, 0x0000FFFF); 21 | return(data.frame(i,j)); 22 | } 23 | 24 | indexToRefID = function(i, j) { 25 | return(bitwShiftL(i, 16) + j); 26 | } 27 | -------------------------------------------------------------------------------- /R/makeTempPointFile.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Petros Koutsolampros 2 | # 3 | # This file is part of rdepthmap 4 | # 5 | # rdepthmap is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # rdepthmap is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with rdepthmap If not, see . 17 | 18 | makeTempPointFile = function(pointsX, pointsY, sep = "\t") { 19 | tmpPtz = tempfile(fileext = ".csv"); 20 | dt = data.frame(x = pointsX, y = pointsY) 21 | write.table(dt, tmpPtz, row.names = F, quote = F, sep = sep) 22 | tmpPtz 23 | } 24 | -------------------------------------------------------------------------------- /R/getTopFeatures.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Kimon Krenz 2 | # Copyright 2019 Petros Koutsolampros 3 | # 4 | # This file is part of rdepthmap 5 | # 6 | # rdepthmap is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # rdepthmap is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with rdepthmap If not, see . 18 | 19 | getTopFeatures = function(spatialDataFrame, column, percent) { 20 | numberOfFeatures = nrow(spatialDataFrame) 21 | orderedFeatureIDs = order(spatialDataFrame[[column]]) 22 | spatialDataFrame[tail(orderedFeatureIDs, percent*numberOfFeatures),] 23 | } 24 | -------------------------------------------------------------------------------- /man/cliHelp.Rd: -------------------------------------------------------------------------------- 1 | % Copyright 2019 Petros Koutsolampros 2 | % 3 | % This file is part of rdepthmap 4 | % 5 | % rdepthmap is free software: you can redistribute it and/or modify 6 | % it under the terms of the GNU General Public License as published by 7 | % the Free Software Foundation, either version 3 of the License, or 8 | % (at your option) any later version. 9 | % 10 | % rdepthmap is distributed in the hope that it will be useful, 11 | % but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | % GNU General Public License for more details. 14 | % 15 | % You should have received a copy of the GNU General Public License 16 | % along with rdepthmap If not, see . 17 | 18 | \name{cliHelp} 19 | \alias{cliHelp} 20 | \title{ 21 | Help / Usage 22 | } 23 | \description{ 24 | Provides help and usage information from the depthmapXcli. 25 | } 26 | \usage{ 27 | cliHelp(cliPath = getDefaultCLILocation()) 28 | } 29 | \arguments{ 30 | \item{cliPath}{ 31 | Optional. Provide the path to a different CLI. 32 | } 33 | } 34 | \value{ 35 | Prints the output from the depthmapXcli. 36 | } 37 | \author{ 38 | Petros Koutsolampros 39 | } 40 | -------------------------------------------------------------------------------- /man/refIDtoIndex.Rd: -------------------------------------------------------------------------------- 1 | % Copyright 2019 Petros Koutsolampros 2 | % 3 | % This file is part of rdepthmap 4 | % 5 | % rdepthmap is free software: you can redistribute it and/or modify 6 | % it under the terms of the GNU General Public License as published by 7 | % the Free Software Foundation, either version 3 of the License, or 8 | % (at your option) any later version. 9 | % 10 | % rdepthmap is distributed in the hope that it will be useful, 11 | % but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | % GNU General Public License for more details. 14 | % 15 | % You should have received a copy of the GNU General Public License 16 | % along with rdepthmap If not, see . 17 | 18 | \name{refIDtoIndex} 19 | \alias{refIDtoIndex} 20 | \title{ 21 | Ref ID to index 22 | } 23 | \description{ 24 | Converts a depthmapX "Ref" ID to the indices (x,y) of a pixel 25 | } 26 | \usage{ 27 | refIDtoIndex(refID) 28 | } 29 | \arguments{ 30 | \item{refID}{ 31 | The Ref ID 32 | } 33 | } 34 | \value{ 35 | A pair of indices (x,y) 36 | } 37 | \author{ 38 | Petros Koutsolampros 39 | } 40 | \examples{ 41 | idx = refIDtoIndex(852645) 42 | # outputs: 43 | # i j 44 | # 1 13 677 45 | } 46 | -------------------------------------------------------------------------------- /R/allFewestLineMap.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Petros Koutsolampros 2 | # 3 | # This file is part of rdepthmap 4 | # 5 | # rdepthmap is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # rdepthmap is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with rdepthmap If not, see . 17 | 18 | allFewestLineMap = function(graphFileIn, graphFileOut = NA, seedX, seedY, calculateFewest = TRUE, 19 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 20 | if (is.na(graphFileOut)) graphFileOut = graphFileIn; 21 | params = c("-f", formatForCLI(graphFileIn), 22 | "-o", formatForCLI(graphFileOut), 23 | "-m", "AXIAL", 24 | "-xl", paste0(seedX, ",", seedY)) 25 | if (calculateFewest) params = c(params, "-xf") 26 | depthmapXcli(params, cliPath, verbose); 27 | } 28 | -------------------------------------------------------------------------------- /R/stepdepth.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Petros Koutsolampros 2 | # 3 | # This file is part of rdepthmap 4 | # 5 | # rdepthmap is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # rdepthmap is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with rdepthmap If not, see . 17 | 18 | stepdepth = function(graphFileIn, graphFileOut = NA, depthType, fromX, fromY, 19 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 20 | 21 | if (!(depthType %in% c("metric", "angular", "visual"))) { 22 | stop(paste0("Unknown depthType: ", depthType)) 23 | } 24 | 25 | tmpPtz = makeTempPointFile(fromX, fromY); 26 | 27 | params = c("-f", formatForCLI(graphFileIn), 28 | "-o", formatForCLI(graphFileOut), 29 | "-m", "STEPDEPTH", 30 | "-sdt", depthType, 31 | "-sdf", formatForCLI(tmpPtz)); 32 | depthmapXcli(params, cliPath, verbose); 33 | invisible(file.remove(tmpPtz)); 34 | } 35 | -------------------------------------------------------------------------------- /R/axialAnalysis.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Fani Kostourou 2 | # Copyright 2019 Petros Koutsolampros 3 | # 4 | # This file is part of rdepthmap 5 | # 6 | # rdepthmap is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # rdepthmap is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with rdepthmap If not, see . 18 | 19 | axialAnalysis = function(graphFileIn, graphFileOut = NA, radii, includeChoice = FALSE, 20 | includeLocal = FALSE, includeIntermediateMetrics = FALSE, 21 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 22 | if (is.na(graphFileOut)) graphFileOut = graphFileIn; 23 | params = c("-f", formatForCLI(graphFileIn), 24 | "-o", formatForCLI(graphFileOut), 25 | "-m", "AXIAL", 26 | "-xa", paste(radii, collapse = ",")) 27 | if (includeChoice) params = c(params, "-xac") 28 | if (includeLocal) params = c(params, "-xal") 29 | if (includeIntermediateMetrics) params = c(params, "-xar") 30 | depthmapXcli(params, cliPath, verbose); 31 | } 32 | -------------------------------------------------------------------------------- /man/processPointMap.Rd: -------------------------------------------------------------------------------- 1 | % Copyright 2019 Petros Koutsolampros 2 | % 3 | % This file is part of rdepthmap 4 | % 5 | % rdepthmap is free software: you can redistribute it and/or modify 6 | % it under the terms of the GNU General Public License as published by 7 | % the Free Software Foundation, either version 3 of the License, or 8 | % (at your option) any later version. 9 | % 10 | % rdepthmap is distributed in the hope that it will be useful, 11 | % but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | % GNU General Public License for more details. 14 | % 15 | % You should have received a copy of the GNU General Public License 16 | % along with rdepthmap If not, see . 17 | 18 | \name{processPointMap} 19 | \alias{processPointMap} 20 | \alias{processPointMapAndLinks} 21 | \title{ 22 | Import a PointMap 23 | } 24 | \description{ 25 | The processPointMap* functions are provided to import exported map data back into R 26 | } 27 | \usage{ 28 | processPointMap(mapPath, scale = 1, sep = "\t") 29 | processPointMapAndLinks(mapPath, linkPath = NA, scale = 1, sep = "\t") 30 | } 31 | \arguments{ 32 | \item{mapPath}{ 33 | Path to pointmap map CSV 34 | } 35 | \item{linkPath}{ 36 | Path to pointmap links CSV 37 | } 38 | \item{scale}{ 39 | Multiplier to rescale map after import 40 | } 41 | \item{sep}{ 42 | Optional. Separator for import 43 | } 44 | } 45 | \value{ 46 | Returns a SptialPixelsDataFrame 47 | } 48 | 49 | \author{ 50 | Petros Koutsolampros 51 | } 52 | -------------------------------------------------------------------------------- /man/getTopFeatures.Rd: -------------------------------------------------------------------------------- 1 | % Copyright 2019 Kimon Krenz 2 | % Copyright 2019 Petros Koutsolampros 3 | % 4 | % This file is part of rdepthmap 5 | % 6 | % rdepthmap is free software: you can redistribute it and/or modify 7 | % it under the terms of the GNU General Public License as published by 8 | % the Free Software Foundation, either version 3 of the License, or 9 | % (at your option) any later version. 10 | % 11 | % rdepthmap is distributed in the hope that it will be useful, 12 | % but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | % GNU General Public License for more details. 15 | % 16 | % You should have received a copy of the GNU General Public License 17 | % along with rdepthmap If not, see . 18 | 19 | \name{getTopFeatures} 20 | \alias{getTopFeatures} 21 | \title{ 22 | Extract top x percent of features 23 | } 24 | \description{ 25 | Sorts features by a specific column and extracts the top x percent 26 | } 27 | \usage{ 28 | getTopFeatures(spatialDataFrame, column, percent) 29 | } 30 | %- maybe also 'usage' for other objects documented here. 31 | \arguments{ 32 | \item{spatialDataFrame}{ 33 | The spatial data frame to export the features from 34 | } 35 | \item{column}{ 36 | The column to use to extract the features from 37 | } 38 | \item{percent}{ 39 | Percentage of features (to total) to extract 40 | } 41 | } 42 | \value{ 43 | Returns a new spatial data frame with the top x features. 44 | } 45 | \author{ 46 | Kimon Krenz 47 | Petros Koutsolampros 48 | } 49 | -------------------------------------------------------------------------------- /man/createGrid.Rd: -------------------------------------------------------------------------------- 1 | % Copyright 2019 Petros Koutsolampros 2 | % 3 | % This file is part of rdepthmap 4 | % 5 | % rdepthmap is free software: you can redistribute it and/or modify 6 | % it under the terms of the GNU General Public License as published by 7 | % the Free Software Foundation, either version 3 of the License, or 8 | % (at your option) any later version. 9 | % 10 | % rdepthmap is distributed in the hope that it will be useful, 11 | % but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | % GNU General Public License for more details. 14 | % 15 | % You should have received a copy of the GNU General Public License 16 | % along with rdepthmap If not, see . 17 | 18 | \name{createGrid} 19 | \alias{createGrid} 20 | \title{ 21 | Create a VGA grid 22 | } 23 | \description{ 24 | Creates a VGA-ready grid with a given cell size. 25 | } 26 | \usage{ 27 | createGrid(graphFileIn, graphFileOut = NA, gridSize, 28 | cliPath = getDefaultCLILocation(), verbose = FALSE) 29 | } 30 | \arguments{ 31 | \item{graphFileIn}{ 32 | The input graph file. 33 | } 34 | \item{graphFileOut}{ 35 | The output graph file. If ommited will use the input file. 36 | } 37 | \item{gridSize}{ 38 | Cell size of the grid. 39 | } 40 | \item{cliPath}{ 41 | Optional. Provide the path to a different CLI. 42 | } 43 | \item{verbose}{ 44 | Optional. Show more information of the process. 45 | } 46 | } 47 | \value{ 48 | No value returned, process is between files. 49 | } 50 | \author{ 51 | Petros Koutsolampros 52 | } 53 | -------------------------------------------------------------------------------- /man/matchPointsToLines.Rd: -------------------------------------------------------------------------------- 1 | % Copyright 2019 Kimon Krenz 2 | % Copyright 2019 Petros Koutsolampros 3 | % 4 | % This file is part of rdepthmap 5 | % 6 | % rdepthmap is free software: you can redistribute it and/or modify 7 | % it under the terms of the GNU General Public License as published by 8 | % the Free Software Foundation, either version 3 of the License, or 9 | % (at your option) any later version. 10 | % 11 | % rdepthmap is distributed in the hope that it will be useful, 12 | % but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | % GNU General Public License for more details. 15 | % 16 | % You should have received a copy of the GNU General Public License 17 | % along with rdepthmap If not, see . 18 | 19 | \name{matchPointsToLines} 20 | \alias{matchPointsToLines} 21 | \title{ 22 | Match points to their closest line 23 | } 24 | \description{ 25 | Matches (spatial-join) points to lines. Finds the point closest to a line. One point is attached to one line, thus if fewer points than lines are given then some lines will have no point attached. 26 | } 27 | \usage{ 28 | matchPointsToLines(points, lines, getIndex = FALSE) 29 | } 30 | \arguments{ 31 | \item{points}{ 32 | Points to attach. 33 | } 34 | \item{lines}{ 35 | Lines to attach to. 36 | } 37 | \item{getIndex}{ 38 | Get the index returned and not the data. 39 | } 40 | } 41 | \value{ 42 | If getIndex is TRUE then the index of the points as they relate to the matching lines are given. If not, then the data from the points dataframe is returned. 43 | } 44 | \author{ 45 | Petros Koutsolampros 46 | } 47 | -------------------------------------------------------------------------------- /man/fillGrid.Rd: -------------------------------------------------------------------------------- 1 | % Copyright 2019 Petros Koutsolampros 2 | % 3 | % This file is part of rdepthmap 4 | % 5 | % rdepthmap is free software: you can redistribute it and/or modify 6 | % it under the terms of the GNU General Public License as published by 7 | % the Free Software Foundation, either version 3 of the License, or 8 | % (at your option) any later version. 9 | % 10 | % rdepthmap is distributed in the hope that it will be useful, 11 | % but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | % GNU General Public License for more details. 14 | % 15 | % You should have received a copy of the GNU General Public License 16 | % along with rdepthmap If not, see . 17 | 18 | \name{fillGrid} 19 | \alias{fillGrid} 20 | \title{ 21 | Fill a VGA grid 22 | } 23 | \description{ 24 | Fills a VGA-ready grid at specfied points. 25 | } 26 | \usage{ 27 | fillGrid(graphFileIn, graphFileOut = NA, fillX, fillY, 28 | cliPath = getDefaultCLILocation(), verbose = FALSE) 29 | } 30 | \arguments{ 31 | \item{graphFileIn}{ 32 | The input graph file. 33 | } 34 | \item{graphFileOut}{ 35 | The output graph file. If ommited will use the input file. 36 | } 37 | \item{fillX}{ 38 | Fill point(s) x-coordinate(s). 39 | } 40 | \item{fillY}{ 41 | Fill point(s) end y-coordinate(s). 42 | } 43 | \item{cliPath}{ 44 | Optional. Provide the path to a different CLI. 45 | } 46 | \item{verbose}{ 47 | Optional. Show more information of the process. 48 | } 49 | } 50 | \value{ 51 | No value returned, process is between files. 52 | } 53 | \author{ 54 | Petros Koutsolampros 55 | } 56 | -------------------------------------------------------------------------------- /R/convertMap.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Petros Koutsolampros 2 | # 3 | # This file is part of rdepthmap 4 | # 5 | # rdepthmap is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # rdepthmap is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with rdepthmap If not, see . 17 | 18 | convertMap = function(graphFileIn, graphFileOut = NA, newMapType, newMapName = generateRandomCapString(10), 19 | removeInputMap = FALSE, copyAttributes = FALSE, stubLengthToRemove = NA, 20 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 21 | if (is.na(graphFileOut)) graphFileOut = graphFileIn; 22 | if (!(newMapType %in% c("drawing", "axial", "segment", "data", "convex"))) { 23 | stop(paste0("Unknown map type: ", newMapType)) 24 | } 25 | params = c("-f", formatForCLI(graphFileIn), 26 | "-o", formatForCLI(graphFileOut), 27 | "-m", "MAPCONVERT", 28 | "-co", newMapType, 29 | "-con", formatForCLI(newMapName)) 30 | if (removeInputMap) params = c(params, "-cir") 31 | if (copyAttributes) params = c(params, "-coc") 32 | if (!is.na(stubLengthToRemove)) params = c(params, "-crsl", stubLengthToRemove) 33 | depthmapXcli(params, cliPath, verbose); 34 | } 35 | -------------------------------------------------------------------------------- /man/shapegraphToIGraph.Rd: -------------------------------------------------------------------------------- 1 | % Copyright 2019 Fani Kostourou 2 | % Copyright 2019 Petros Koutsolampros 3 | % 4 | % This file is part of rdepthmap 5 | % 6 | % rdepthmap is free software: you can redistribute it and/or modify 7 | % it under the terms of the GNU General Public License as published by 8 | % the Free Software Foundation, either version 3 of the License, or 9 | % (at your option) any later version. 10 | % 11 | % rdepthmap is distributed in the hope that it will be useful, 12 | % but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | % GNU General Public License for more details. 15 | % 16 | % You should have received a copy of the GNU General Public License 17 | % along with rdepthmap If not, see . 18 | 19 | \name{shapegraphToIGraph} 20 | \alias{shapegraphToIGraph} 21 | %- Also NEED an '\alias' for EACH other topic documented here. 22 | \title{ 23 | Conversion of shapegraph to igraph 24 | } 25 | \description{ 26 | Creates igraph based on the connections and the x,y coordinates of the centroids of shapes in a shapegraph (axial,segment, convex). Specify weightcolumn to assign weight to graph edges. 27 | } 28 | \usage{ 29 | shapegraphToIGraph(graphFile, weightcolumn = NA) 30 | } 31 | \arguments{ 32 | \item{graphFile}{ 33 | The input graph file. 34 | } 35 | \item{weightcolumn}{ 36 | Optional.The variable used to assign weight to graph edges 37 | } 38 | } 39 | \details{ 40 | If weightcolumn is provided, edge connections weight is calculated by taking the average of the variable of the connected nodes. 41 | } 42 | \value{ 43 | Returns graph.data.frame. 44 | } 45 | \author{ 46 | Fani Kostourou 47 | Petros Koutsolampros 48 | } 49 | -------------------------------------------------------------------------------- /R/vga.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Petros Koutsolampros 2 | # 3 | # This file is part of rdepthmap 4 | # 5 | # rdepthmap is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # rdepthmap is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with rdepthmap If not, see . 17 | 18 | VGA = function(graphFileIn, graphFileOut = NA, vgaMode, radii, 19 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 20 | if (is.na(graphFileOut)) graphFileOut = graphFileIn; 21 | if (!(vgaMode %in% c("isovist", "visibility-global", "visibility-local", 22 | "metric", "angular", "thruvision"))) { 23 | stop(paste0("Unknown VGA mode: ", vgaMode)) 24 | } 25 | params = c("-f", formatForCLI(graphFileIn), 26 | "-o", formatForCLI(graphFileOut), 27 | "-m", "VGA", 28 | "-vr", paste0(radii, collapse = ",")) 29 | if (vgaMode %in% c("isovist", "metric", "angular", "thruvision")) { 30 | params = c(params, "-vm", vgaMode); 31 | } else if (vgaMode == "visibility-global") { 32 | params = c(params, "-vm", "visibility"); 33 | params = c(params, "-vg") 34 | } else if (vgaMode == "visibility-local") { 35 | params = c(params, "-vm", "visibility"); 36 | params = c(params, "-vl") 37 | } 38 | depthmapXcli(params, cliPath, verbose); 39 | } 40 | -------------------------------------------------------------------------------- /man/stepdepth.Rd: -------------------------------------------------------------------------------- 1 | % Copyright 2019 Petros Koutsolampros 2 | % 3 | % This file is part of rdepthmap 4 | % 5 | % rdepthmap is free software: you can redistribute it and/or modify 6 | % it under the terms of the GNU General Public License as published by 7 | % the Free Software Foundation, either version 3 of the License, or 8 | % (at your option) any later version. 9 | % 10 | % rdepthmap is distributed in the hope that it will be useful, 11 | % but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | % GNU General Public License for more details. 14 | % 15 | % You should have received a copy of the GNU General Public License 16 | % along with rdepthmap If not, see . 17 | 18 | \name{stepdepth} 19 | \alias{stepdepth} 20 | \title{ 21 | Step depth 22 | } 23 | \description{ 24 | Calculates step depth from a specific origin 25 | } 26 | \usage{ 27 | stepdepth(graphFileIn, graphFileOut, depthType, fromX, fromY, 28 | cliPath = getDefaultCLILocation(), verbose = FALSE) 29 | } 30 | \arguments{ 31 | \item{graphFileIn}{ 32 | The input graph file. 33 | } 34 | \item{graphFileOut}{ 35 | The output graph file. If ommited will use the input file. 36 | } 37 | \item{depthType}{ 38 | The type of depth to measure steps in. Can be "metric", "angular" or "visual". 39 | } 40 | \item{fromX}{ 41 | The x-value of the origin point. 42 | } 43 | \item{fromY}{ 44 | The x-value of the origin point. 45 | } 46 | \item{cliPath}{ 47 | Optional. Provide the path to a different CLI. 48 | } 49 | \item{verbose}{ 50 | Optional. Show more information of the process. 51 | } 52 | } 53 | \value{ 54 | No value returned, process is between files. 55 | } 56 | \author{ 57 | Petros Koutsolampros 58 | } 59 | -------------------------------------------------------------------------------- /tests/testthat/test-base.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Petros Koutsolampros 2 | # 3 | # This file is part of rdepthmap 4 | # 5 | # rdepthmap is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # rdepthmap is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with rdepthmap If not, see . 17 | 18 | context("Base tests") 19 | library(sf) 20 | 21 | test_that("proper formatForCLI output", { 22 | expect_equal(formatForCLI("A map"), "\"A map\"") 23 | }) 24 | 25 | test_that("export", { 26 | graphFileIn = system.file("extdata", "gallery_connected.graph", package = "rdepthmap") 27 | graphFileOut = tempfile(fileext = ".graph") 28 | testOutputMap = system.file("extdata", "gallery_connected_vga.csv", package = "rdepthmap") 29 | testOutputLinks = system.file("extdata", "gallery_connected_links.csv", package = "rdepthmap") 30 | 31 | createGrid(graphFileIn, graphFileOut, gridSize = 0.04) 32 | fillGrid(graphFileOut, fillX = 1.3, fillY = 7) 33 | makeVGAGraph(graphFileOut) 34 | 35 | expect_equal(processPointMap(testOutputMap, sep = ","), getPointmapData(graphFileIn)) 36 | expect_equal(read.csv(testOutputLinks), getPointmapLinks(graphFileIn)) 37 | expect_equal(processPointMapAndLinks(testOutputMap, testOutputLinks, sep = ","), 38 | getPointmapDataAndLinks(graphFileIn)); 39 | file.remove(graphFileOut) 40 | }) 41 | -------------------------------------------------------------------------------- /man/VGA.Rd: -------------------------------------------------------------------------------- 1 | % Copyright 2019 Petros Koutsolampros 2 | % 3 | % This file is part of rdepthmap 4 | % 5 | % rdepthmap is free software: you can redistribute it and/or modify 6 | % it under the terms of the GNU General Public License as published by 7 | % the Free Software Foundation, either version 3 of the License, or 8 | % (at your option) any later version. 9 | % 10 | % rdepthmap is distributed in the hope that it will be useful, 11 | % but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | % GNU General Public License for more details. 14 | % 15 | % You should have received a copy of the GNU General Public License 16 | % along with rdepthmap If not, see . 17 | 18 | \name{VGA} 19 | \alias{VGA} 20 | \title{ 21 | Visibility Graph Analysis 22 | } 23 | \description{ 24 | Calls the depthmapXcli to carry out Visibility Graph Analysis on the currently visible map 25 | } 26 | \usage{ 27 | VGA(graphFileIn, graphFileOut, vgaMode, radii, 28 | cliPath = getDefaultCLILocation(), verbose = FALSE) 29 | } 30 | \arguments{ 31 | \item{graphFileIn}{ 32 | The input graph file. 33 | } 34 | \item{graphFileOut}{ 35 | The output graph file. If ommited will use the input file. 36 | } 37 | \item{vgaMode}{ 38 | The VGA mode. One of: 39 | "isovist", 40 | "visiblity-global", 41 | "visiblity-local", 42 | "metric", 43 | "angular" or 44 | "thruvision" 45 | } 46 | \item{radii}{ 47 | One or more radii to limit the analysis at. 48 | } 49 | \item{cliPath}{ 50 | Optional. Provide the path to a different CLI. 51 | } 52 | \item{verbose}{ 53 | Optional. Show more information of the process. 54 | } 55 | } 56 | \value{ 57 | No value returned, process is between files. 58 | } 59 | \author{ 60 | Petros Koutsolampros 61 | } 62 | -------------------------------------------------------------------------------- /man/import.Rd: -------------------------------------------------------------------------------- 1 | % Copyright 2019 Fani Kostourou 2 | % Copyright 2019 Petros Koutsolampros 3 | % 4 | % This file is part of rdepthmap 5 | % 6 | % rdepthmap is free software: you can redistribute it and/or modify 7 | % it under the terms of the GNU General Public License as published by 8 | % the Free Software Foundation, either version 3 of the License, or 9 | % (at your option) any later version. 10 | % 11 | % rdepthmap is distributed in the hope that it will be useful, 12 | % but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | % GNU General Public License for more details. 15 | % 16 | % You should have received a copy of the GNU General Public License 17 | % along with rdepthmap If not, see . 18 | 19 | \name{import} 20 | \alias{import} 21 | \alias{importLines} 22 | \title{ 23 | Import data into a graph file 24 | } 25 | \description{ 26 | Import data into a graph file. importLines specifically imports SpatialLines or SpatialLinesDataFrame objects. 27 | } 28 | \usage{ 29 | import(filesToImport, graphFileOut, cliPath = getDefaultCLILocation(), verbose = FALSE) 30 | importLines(linesIn, graphFileOut, cliPath = getDefaultCLILocation(), verbose = FALSE) 31 | } 32 | \arguments{ 33 | \item{filesToImport}{ 34 | A file to import. Currently CSV, TSV and DXF files are accepted 35 | } 36 | \item{linesIn}{ 37 | A SpatialLines or SpatialLinesDataFrame object. 38 | } 39 | \item{graphFileOut}{ 40 | The output graph file. 41 | } 42 | \item{cliPath}{ 43 | Optional. Provide the path to a different CLI. 44 | } 45 | \item{verbose}{ 46 | Optional. Show more information of the process. 47 | } 48 | } 49 | \value{ 50 | No value returned, process is between files. 51 | } 52 | \author{ 53 | Petros Koutsolampros 54 | Fani Kostourou 55 | } 56 | -------------------------------------------------------------------------------- /R/depthmapXcli.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Petros Koutsolampros 2 | # 3 | # This file is part of rdepthmap 4 | # 5 | # rdepthmap is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # rdepthmap is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with rdepthmap If not, see . 17 | 18 | getDefaultCLILocation = function() { 19 | depthmapXcli = NA 20 | switch(Sys.info()[['sysname']], 21 | Windows= {depthmapXcli = "depthmapXcli_win64.exe"}, 22 | Linux = {depthmapXcli = "depthmapXcli_linux64"}, 23 | Darwin = {depthmapXcli = "depthmapXcli_macos"}) 24 | if(is.na(depthmapXcli)) {stop("Unknown operating system")} 25 | system.file("exec", depthmapXcli, package = "rdepthmap") 26 | } 27 | 28 | depthmapXcli = function(params, cliPath = getDefaultCLILocation(), verbose = FALSE) { 29 | suppressWarnings({ 30 | cmdData = system2(cliPath, params, stdout = T); 31 | }) 32 | if (("status" %in% names(attributes(cmdData))) && attr(cmdData,"status") != 0) { 33 | # errored 34 | for (d in cmdData) { 35 | if (startsWith(d, "Usage")) { 36 | break; 37 | } 38 | errTxt = d 39 | } 40 | stop(errTxt) 41 | } 42 | if (verbose) cat(cmdData, sep = "\n") 43 | } 44 | 45 | formatForCLI = function(filePath) { 46 | if (startsWith(filePath, "\"")) { 47 | return(filePath) 48 | } 49 | return(paste0("\"", filePath, "\"")) 50 | } 51 | -------------------------------------------------------------------------------- /NAMESPACE: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Petros Koutsolampros 2 | # Copyright 2019 Fani Kostourou 3 | # 4 | # This file is part of rdepthmap 5 | # 6 | # rdepthmap is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # rdepthmap is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with rdepthmap If not, see . 18 | 19 | export("refIDtoIndex", "processPointMap", "processPointMapAndLinks", "matchPointsToLines", "getTopFeatures") 20 | export("getShapeGraph", "getPointmapData", "getPointmapLinks", "getPointmapDataAndLinks") 21 | export("isovist", "isovist2pts", "makeIsovists", "stepdepth", "export", "convertMap", "cliHelp", "import", "importLines") 22 | export("VGA", "axialAnalysis", "segmentAnalysis", "linkMapCoords", "linkMapRefs", "agentAnalysis") 23 | export("createGrid", "fillGrid", "makeVGAGraph", "unmakeVGAGraph") 24 | export("makeDepthmapClassicColour", "depthmap.classic.colour") 25 | export("makeAxmanesqueColour", "depthmap.axmanesque.colour") 26 | export("makePurpleOrangeColour", "depthmap.purpleorange.colour") 27 | export("makeBlueRedColour", "depthmap.bluered.colour") 28 | export("makeGreyScaleColour", "depthmap.grayscale.colour") 29 | export("makeNiceHSBColour", "depthmap.nicehsb.colour") 30 | export("shapegraphToIGraph", "getShapeGraphConnections", "getShapeGraphLinksUnlinks") 31 | 32 | import("sp", "sf") 33 | importFrom("utils", "read.csv", "write.table", "tail","read.table") 34 | importFrom("igraph", "graph.data.frame", "E", "E<-") 35 | -------------------------------------------------------------------------------- /R/segmentAnalysis.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Fani Kostourou 2 | # Copyright 2019 Petros Koutsolampros 3 | # 4 | # This file is part of rdepthmap 5 | # 6 | # rdepthmap is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # rdepthmap is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with rdepthmap If not, see . 18 | 19 | segmentAnalysis = function(graphFileIn, graphFileOut = NA, analysisType, radii, radiusType, 20 | tulipBins = NA, weightWithColumn = NA, includeChoice = FALSE, 21 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 22 | if (is.na(graphFileOut)) graphFileOut = graphFileIn; 23 | if (!(analysisType %in% c("tulip", "metric", "angular", "topological"))) { 24 | stop(paste0("Unknown segment analysis type: ", analysisType)) 25 | } 26 | if (!(radiusType %in% c("steps", "metric", "angular"))) { 27 | stop(paste0("Unknown radius type: ", radiusType)) 28 | } 29 | params = c("-f", formatForCLI(graphFileIn), 30 | "-o", formatForCLI(graphFileOut), 31 | "-m", "SEGMENT", 32 | "-st", analysisType, 33 | "-sr", paste(radii, collapse = ","), 34 | "-srt", radiusType) 35 | if (includeChoice) params = c(params, "-sic") 36 | if (!is.na(tulipBins)) params = c(params, "-stb", tulipBins) 37 | if (!is.na(weightWithColumn)) params = c(params, "-swa", formatForCLI(weightWithColumn)) 38 | depthmapXcli(params, cliPath, verbose); 39 | } 40 | -------------------------------------------------------------------------------- /man/makeVGAGraph.Rd: -------------------------------------------------------------------------------- 1 | % Copyright 2019 Petros Koutsolampros 2 | % 3 | % This file is part of rdepthmap 4 | % 5 | % rdepthmap is free software: you can redistribute it and/or modify 6 | % it under the terms of the GNU General Public License as published by 7 | % the Free Software Foundation, either version 3 of the License, or 8 | % (at your option) any later version. 9 | % 10 | % rdepthmap is distributed in the hope that it will be useful, 11 | % but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | % GNU General Public License for more details. 14 | % 15 | % You should have received a copy of the GNU General Public License 16 | % along with rdepthmap If not, see . 17 | 18 | \name{makeVGAGraph} 19 | \alias{makeVGAGraph} 20 | \alias{unmakeVGAGraph} 21 | \title{ 22 | Make/Unmake the VGA Graph. 23 | } 24 | \description{ 25 | Makes or unmakes the graph. 26 | } 27 | \usage{ 28 | makeVGAGraph(graphFileIn, graphFileOut = NA, maxVisibility = NA, boundaryGraph = FALSE, 29 | cliPath = getDefaultCLILocation(), verbose = FALSE) 30 | unmakeVGAGraph(graphFileIn, graphFileOut = NA, removeLinks = FALSE, 31 | cliPath = getDefaultCLILocation(), verbose = FALSE) 32 | } 33 | \arguments{ 34 | \item{graphFileIn}{ 35 | The input graph file. 36 | } 37 | \item{graphFileOut}{ 38 | The output graph file. If ommited will use the input file. 39 | } 40 | \item{maxVisibility}{ 41 | Set a maximum visibility distance when making the graph. 42 | } 43 | \item{boundaryGraph}{ 44 | Create a boundary graph when making the graph. 45 | } 46 | \item{removeLinks}{ 47 | Remove existing links when unmaking the graph. 48 | } 49 | \item{cliPath}{ 50 | Optional. Provide the path to a different CLI. 51 | } 52 | \item{verbose}{ 53 | Optional. Show more information of the process. 54 | } 55 | } 56 | \value{ 57 | No value returned, process is between files. 58 | } 59 | \author{ 60 | Petros Koutsolampros 61 | } 62 | -------------------------------------------------------------------------------- /R/import.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Fani Kostourou 2 | # Copyright 2019 Petros Koutsolampros 3 | # 4 | # This file is part of rdepthmap 5 | # 6 | # rdepthmap is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # rdepthmap is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with rdepthmap If not, see . 18 | 19 | import = function(filesToImport, graphFileOut, 20 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 21 | params = c("-f", formatForCLI(filesToImport[1]), 22 | "-o", formatForCLI(graphFileOut), 23 | "-m", "IMPORT"); 24 | for (fileToImport in tail(filesToImport, length(filesToImport) - 1)) { 25 | params = c(params, "-if", fileToImport) 26 | } 27 | depthmapXcli(params, cliPath, verbose); 28 | } 29 | 30 | importLines = function(linesIn, graphFileOut, 31 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 32 | if (class(linesIn)[1] != "sf") { 33 | stop(paste0("Lines in can only be of type sf, not: ", 34 | class(linesIn)[1])) 35 | } 36 | 37 | startCoords = st_coordinates(st_line_sample(linesIn, sample=c(0))) 38 | endCoords = st_coordinates(st_line_sample(linesIn, sample=c(1))) 39 | 40 | linesDF = st_drop_geometry(linesIn) 41 | linesDF['x1'] = startCoords[,'X'] 42 | linesDF['y1'] = startCoords[,'Y'] 43 | linesDF['x2'] = endCoords[,'X'] 44 | linesDF['y2'] = endCoords[,'Y'] 45 | 46 | tmpGraph = tempfile(fileext = ".tsv"); 47 | write.table(linesDF, tmpGraph, row.names = F, quote = F, sep = "\t") 48 | 49 | rdepthmap::import(tmpGraph, graphFileOut) 50 | } 51 | -------------------------------------------------------------------------------- /man/axialAnalysis.Rd: -------------------------------------------------------------------------------- 1 | % Copyright 2019 Fani Kostourou 2 | % Copyright 2019 Petros Koutsolampros 3 | % 4 | % This file is part of rdepthmap 5 | % 6 | % rdepthmap is free software: you can redistribute it and/or modify 7 | % it under the terms of the GNU General Public License as published by 8 | % the Free Software Foundation, either version 3 of the License, or 9 | % (at your option) any later version. 10 | % 11 | % rdepthmap is distributed in the hope that it will be useful, 12 | % but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | % GNU General Public License for more details. 15 | % 16 | % You should have received a copy of the GNU General Public License 17 | % along with rdepthmap If not, see . 18 | 19 | \name{axialAnalysis} 20 | \alias{axialAnalysis} 21 | \title{ 22 | Axial Analysis 23 | } 24 | \description{ 25 | Calls the depthmapXcli to carry out Axial Analysis on the currently visible map 26 | } 27 | \usage{ 28 | axialAnalysis(graphFileIn, graphFileOut, radii, includeChoice = FALSE, 29 | includeLocal = FALSE, includeIntermediateMetrics = FALSE, 30 | cliPath = getDefaultCLILocation(), verbose = FALSE) 31 | } 32 | \arguments{ 33 | \item{graphFileIn}{ 34 | The input graph file. 35 | } 36 | \item{graphFileOut}{ 37 | The output graph file. If ommited will use the input file. 38 | } 39 | \item{radii}{ 40 | One or more radii to limit the analysis at. 41 | } 42 | \item{includeChoice}{ 43 | Set to TRUE to include choice. 44 | } 45 | \item{includeLocal}{ 46 | Set to TRUE to include local measures. 47 | } 48 | \item{includeIntermediateMetrics}{ 49 | Set to TRUE to include intermediate measures (RA, RRA and total depth). 50 | } 51 | \item{cliPath}{ 52 | Optional. Provide the path to a different CLI. 53 | } 54 | \item{verbose}{ 55 | Optional. Show more information of the process. 56 | } 57 | } 58 | \value{ 59 | No value returned, process is between files. 60 | } 61 | \author{ 62 | Petros Koutsolampros 63 | Fani Kostourou 64 | } 65 | -------------------------------------------------------------------------------- /R/shapegraphToIGraph.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Fani Kostourou 2 | # Copyright 2019 Petros Koutsolampros 3 | # 4 | # This file is part of rdepthmap 5 | # 6 | # rdepthmap is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # rdepthmap is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with rdepthmap If not, see . 18 | 19 | shapegraphToIGraph = function(graphFile, weightcolumn = NA){ 20 | ogr = rdepthmap::getShapeGraph(graphFile) 21 | linksunlinks = rdepthmap::getShapeGraphLinksUnlinks(graphFile) 22 | links = linksunlinks[linksunlinks$link == 1,] 23 | links = links[,c("refA","refB")] 24 | unlinks = linksunlinks[linksunlinks$link == 0,] 25 | unlinks = unlinks[,c("refA","refB")] 26 | connections = rdepthmap::getShapeGraphConnections(graphFile) 27 | if (nrow(connections) == 0) { 28 | edges = links 29 | } else { 30 | edges = connections 31 | } 32 | 33 | for (i in 1:nrow(edges)){ 34 | edges[i, ] = sort(edges[i,c("refA","refB")]) 35 | } 36 | edges = edges[!duplicated(edges),] 37 | 38 | ogr$x = as.data.frame(sf::st_centroid(ogr))[,1] 39 | ogr$y = as.data.frame(sf::st_centroid(ogr))[,2] 40 | 41 | refA = edges$refA 42 | refB = edges$refB 43 | Depth_Ref = ogr$Depthmap_Ref 44 | ogr = ogr[,c("Depthmap_Ref",names(ogr)[names(ogr) != "Depthmap_Ref"])] 45 | if (!is.na(weightcolumn)) { 46 | edges$weight = ((ogr[[match(refA, Depth_Ref), weightcolumn]])+(ogr[[match(refB, Depth_Ref), weightcolumn]]))/2 47 | graph = graph.data.frame(edges, directed = FALSE, vertices = st_drop_geometry(ogr)) 48 | E(graph)$weight = edges$weight 49 | } else { 50 | graph = graph.data.frame(edges, directed = FALSE, vertices = st_drop_geometry(ogr)) 51 | } 52 | return(graph); 53 | } 54 | -------------------------------------------------------------------------------- /man/convertMap.Rd: -------------------------------------------------------------------------------- 1 | % Copyright 2019 Petros Koutsolampros 2 | % 3 | % This file is part of rdepthmap 4 | % 5 | % rdepthmap is free software: you can redistribute it and/or modify 6 | % it under the terms of the GNU General Public License as published by 7 | % the Free Software Foundation, either version 3 of the License, or 8 | % (at your option) any later version. 9 | % 10 | % rdepthmap is distributed in the hope that it will be useful, 11 | % but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | % GNU General Public License for more details. 14 | % 15 | % You should have received a copy of the GNU General Public License 16 | % along with rdepthmap If not, see . 17 | 18 | \name{convertMap} 19 | \alias{convertMap} 20 | \title{ 21 | Convert Map 22 | } 23 | \description{ 24 | Converts the currently visible map in the graph file to another type of map 25 | } 26 | \usage{ 27 | convertMap(graphFileIn, graphFileOut, newMapType, 28 | newMapName = generateRandomCapString(10), removeInputMap = FALSE, 29 | copyAttributes = FALSE, stubLengthToRemove = NA, 30 | cliPath = getDefaultCLILocation(), verbose = FALSE) 31 | } 32 | \arguments{ 33 | \item{graphFileIn}{ 34 | The input graph file. 35 | } 36 | \item{graphFileOut}{ 37 | The output graph file. If ommited will use the input file. 38 | } 39 | \item{newMapType}{ 40 | The new map type. Can be one of: 41 | "drawing", 42 | "axial", 43 | "segment", 44 | "data" or 45 | "convex" 46 | } 47 | \item{newMapName}{ 48 | The new map name. If no name is given creates one with 10 random characters 49 | } 50 | \item{removeInputMap}{ 51 | Set to TRUE to remove the input map 52 | } 53 | \item{copyAttributes}{ 54 | Set to TRUE to copy attributes to output map (Only between DATA, AXIAL and SEGMENT) 55 | } 56 | \item{stubLengthToRemove}{ 57 | Percent of line length of axial stubs to remove (Only for AXIAL -> SEGMENT) 58 | } 59 | \item{cliPath}{ 60 | Optional. Provide the path to a different CLI 61 | } 62 | \item{verbose}{ 63 | Optional. Show more information of the process 64 | } 65 | } 66 | \value{ 67 | No value returned, process is between files 68 | } 69 | \author{ 70 | Petros Koutsolampros 71 | } 72 | -------------------------------------------------------------------------------- /R/agentAnalysis.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Petros Koutsolampros 2 | # 3 | # This file is part of rdepthmap 4 | # 5 | # rdepthmap is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # rdepthmap is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with rdepthmap If not, see . 17 | 18 | agentAnalysis = function(graphFileIn, graphFileOut = NA, lookMode, timesteps, releaseRate, 19 | agentFOV, agentSteps, agentLife, originX = NA, originY = NA, 20 | locationSeed = 0, numberOfTrails = NA, outputType = "graph", 21 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 22 | if (is.na(graphFileOut)) graphFileOut = graphFileIn; 23 | if (!(lookMode %in% c("standard", "los-length", "occ-length", "occ-any", "occ-group-45", 24 | "occ-group-60", "occ-furthest", "bin-far-dist", "bin-angle", 25 | "bin-far-dist-angle", "bin-memory"))) { 26 | stop(paste0("Unknown agent look mode: ", lookMode)) 27 | } 28 | if (!(outputType %in% c("graph", "gatecounts", "trails"))) { 29 | stop(paste0("Unknown output type: ", outputType)) 30 | } 31 | params = c("-f", formatForCLI(graphFileIn), 32 | "-o", formatForCLI(graphFileOut), 33 | "-m", "AGENTS", 34 | "-am", lookMode, 35 | "-ats", timesteps, 36 | "-arr", releaseRate, 37 | "-afov", agentFOV, 38 | "-asteps", agentSteps, 39 | "-alife", agentLife, 40 | "-alocseed", locationSeed, 41 | "-ot", outputType) 42 | if (!is.na(numberOfTrails)) params = c(params, "-atrails", numberOfTrails) 43 | if (!is.na(originX)) { 44 | source("makeTempPointFile") 45 | tmpPtz = makeTempPointFile(originX, originY); 46 | params = c(params, "-alocfile", tmpPtz) 47 | } 48 | depthmapXcli(params, cliPath, verbose); 49 | } 50 | -------------------------------------------------------------------------------- /man/palettes.Rd: -------------------------------------------------------------------------------- 1 | % Copyright 2019 Fani Kostourou 2 | % Copyright 2019 Petros Koutsolampros 3 | % 4 | % This file is part of rdepthmap 5 | % 6 | % rdepthmap is free software: you can redistribute it and/or modify 7 | % it under the terms of the GNU General Public License as published by 8 | % the Free Software Foundation, either version 3 of the License, or 9 | % (at your option) any later version. 10 | % 11 | % rdepthmap is distributed in the hope that it will be useful, 12 | % but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | % GNU General Public License for more details. 15 | % 16 | % You should have received a copy of the GNU General Public License 17 | % along with rdepthmap If not, see . 18 | 19 | \name{palettes} 20 | \alias{depthmap.classic.colour} 21 | \alias{makeDepthmapClassicColour} 22 | \alias{depthmap.axmanesque.colour} 23 | \alias{makeAxmanesqueColour} 24 | \alias{depthmap.purpleorange.colour} 25 | \alias{makePurpleOrangeColour} 26 | \alias{depthmap.bluered.colour} 27 | \alias{makeBlueRedColour} 28 | \alias{depthmap.grayscale.colour} 29 | \alias{makeGreyScaleColour} 30 | \alias{depthmap.nicehsb.colour} 31 | \alias{makeNiceHSBColour} 32 | \title{ 33 | Colour Palettes from depthmapX 34 | } 35 | \description{ 36 | Create a single colour or a vector of n contiguous colours taken from depthmapX. 37 | } 38 | \usage{ 39 | depthmap.classic.colour(n) 40 | depthmap.axmanesque.colour(n) 41 | depthmap.purpleorange.colour(n) 42 | depthmap.bluered.colour(n) 43 | depthmap.grayscale.colour(n) 44 | depthmap.nicehsb.colour(n) 45 | 46 | makeDepthmapClassicColour(value, rangeMin, rangeMax) 47 | makeAxmanesqueColour(value, rangeMin = 0, rangeMax = 1) 48 | makePurpleOrangeColour(value, rangeMin = 0, rangeMax = 1) 49 | makeBlueRedColour(value, rangeMin = 0, rangeMax = 1) 50 | makeGreyScaleColour(value, rangeMin = 0, rangeMax = 1) 51 | makeNiceHSBColour(value, rangeMin = 0, rangeMax = 1) 52 | } 53 | \arguments{ 54 | \item{n}{ 55 | Numer of colours to generate 56 | } 57 | \item{value}{ 58 | The number to generate the colour from 59 | } 60 | \item{rangeMin}{ 61 | The min value of the range 62 | } 63 | \item{rangeMax}{ 64 | The max value of the range 65 | } 66 | } 67 | \value{ 68 | Returns a single colour or a vector of colours. 69 | } 70 | \author{ 71 | Petros Koutsolampros 72 | Fani Kostourou 73 | } 74 | -------------------------------------------------------------------------------- /man/segmentAnalysis.Rd: -------------------------------------------------------------------------------- 1 | % Copyright 2019 Fani Kostourou 2 | % Copyright 2019 Petros Koutsolampros 3 | % 4 | % This file is part of rdepthmap 5 | % 6 | % rdepthmap is free software: you can redistribute it and/or modify 7 | % it under the terms of the GNU General Public License as published by 8 | % the Free Software Foundation, either version 3 of the License, or 9 | % (at your option) any later version. 10 | % 11 | % rdepthmap is distributed in the hope that it will be useful, 12 | % but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | % GNU General Public License for more details. 15 | % 16 | % You should have received a copy of the GNU General Public License 17 | % along with rdepthmap If not, see . 18 | 19 | \name{segmentAnalysis} 20 | \alias{segmentAnalysis} 21 | \title{ 22 | Segment Analysis 23 | } 24 | \description{ 25 | Calls the depthmapXcli to carry out Segment Analysis on the currently visible map 26 | } 27 | \usage{ 28 | segmentAnalysis(graphFileIn, graphFileOut, analysisType, radii, radiusType, 29 | tulipBins = NA, weightWithColumn = NA, includeChoice = FALSE, 30 | cliPath = getDefaultCLILocation(), verbose = FALSE) 31 | } 32 | %- maybe also 'usage' for other objects documented here. 33 | \arguments{ 34 | \item{graphFileIn}{ 35 | The input graph file. 36 | } 37 | \item{graphFileOut}{ 38 | The output graph file. If ommited will use the input file. 39 | } 40 | \item{analysisType}{ 41 | The type of analysis. One of: 42 | "tulip" (Angular Tulip - Faster), 43 | "angular" (Angular Full - Slower), 44 | "topological" or 45 | "metric" 46 | } 47 | \item{radii}{ 48 | One or more radii to limit the analysis at. 49 | } 50 | \item{radiusType}{ 51 | The type of radius to limit the analysus at. One of: 52 | "steps", 53 | "metric" or 54 | "angular". 55 | } 56 | \item{tulipBins}{ 57 | Number of tulip bins. Can be from 4 to 1024, 1024 approximates full angular. 58 | } 59 | \item{weightWithColumn}{ 60 | Perform weighted analysis using this attribute (only for Tulip). 61 | } 62 | \item{includeChoice}{ 63 | Set to TRUE to include choice. 64 | } 65 | \item{cliPath}{ 66 | Optional. Provide the path to a different CLI. 67 | } 68 | \item{verbose}{ 69 | Optional. Show more information of the process. 70 | } 71 | } 72 | \value{ 73 | No value returned, process is between files. 74 | } 75 | \author{ 76 | Petros Koutsolampros 77 | Fani Kostourou 78 | } 79 | -------------------------------------------------------------------------------- /man/isovist.Rd: -------------------------------------------------------------------------------- 1 | % Copyright 2019 Petros Koutsolampros 2 | % 3 | % This file is part of rdepthmap 4 | % 5 | % rdepthmap is free software: you can redistribute it and/or modify 6 | % it under the terms of the GNU General Public License as published by 7 | % the Free Software Foundation, either version 3 of the License, or 8 | % (at your option) any later version. 9 | % 10 | % rdepthmap is distributed in the hope that it will be useful, 11 | % but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | % GNU General Public License for more details. 14 | % 15 | % You should have received a copy of the GNU General Public License 16 | % along with rdepthmap If not, see . 17 | 18 | \name{isovist} 19 | \alias{isovist} 20 | \alias{isovist2pts} 21 | \alias{makeIsovists} 22 | \title{ 23 | Isovist 24 | } 25 | \description{ 26 | Creates an isovist at a specific point. 27 | To create an isovist with two points (one the origin, the other the direction) use isovist2pts. 28 | makeIsovists is a helper function that creates and imports multiple Isovists 29 | } 30 | \usage{ 31 | isovist(graphFileIn, graphFileOut, x, y, angle = NA, viewangle = NA, 32 | cliPath = getDefaultCLILocation(), verbose = FALSE) 33 | isovist2pts(graphFileIn, graphFileOut, x, y, toX, toY, viewangle, 34 | cliPath = getDefaultCLILocation(), verbose = FALSE) 35 | } 36 | %- maybe also 'usage' for other objects documented here. 37 | \arguments{ 38 | \item{graphFileIn}{ 39 | The input graph file. 40 | } 41 | \item{graphFileOut}{ 42 | The output graph file. If ommited will use the input file. 43 | } 44 | \item{x}{ 45 | The x-value of isovist origin point. 46 | } 47 | \item{y}{ 48 | The y-value of isovist origin point. 49 | } 50 | \item{angle}{ 51 | The angle defining the view orientation of the isovist (in degrees, for partial isovists). 52 | } 53 | \item{toX}{ 54 | The x-value of a second point showing the direction of a targeted isovist. 55 | } 56 | \item{toY}{ 57 | The y-value of a second point showing the direction of a targeted isovist. 58 | } 59 | \item{viewangle}{ 60 | The angle defining the view range of the isovist (in degrees, for partial isovists). 61 | } 62 | \item{cliPath}{ 63 | Optional. Provide the path to a different CLI. 64 | } 65 | \item{verbose}{ 66 | Optional. Show more information of the process. 67 | } 68 | } 69 | \value{ 70 | No value returned, process is between files. 71 | } 72 | \author{ 73 | Petros Koutsolampros 74 | } 75 | -------------------------------------------------------------------------------- /man/linkMapCoords.Rd: -------------------------------------------------------------------------------- 1 | % Copyright 2019 Fani Kostourou 2 | % Copyright 2019 Petros Koutsolampros 3 | % 4 | % This file is part of rdepthmap 5 | % 6 | % rdepthmap is free software: you can redistribute it and/or modify 7 | % it under the terms of the GNU General Public License as published by 8 | % the Free Software Foundation, either version 3 of the License, or 9 | % (at your option) any later version. 10 | % 11 | % rdepthmap is distributed in the hope that it will be useful, 12 | % but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | % GNU General Public License for more details. 15 | % 16 | % You should have received a copy of the GNU General Public License 17 | % along with rdepthmap If not, see . 18 | 19 | \name{link} 20 | \alias{linkMapCoords} 21 | \alias{linkMapRefs} 22 | \title{ 23 | Link map elements 24 | } 25 | \description{ 26 | Calls upon the depthmapXcli to link elements (cells in VGA, lines in axial/segment) 27 | } 28 | \usage{ 29 | linkMapCoords(graphFileIn, graphFileOut = NA, linkFromX, linkFromY, 30 | linkToX, linkToY, unlink = FALSE, mapTypeToLink = "pointmaps", 31 | cliPath = getDefaultCLILocation(), verbose = FALSE) 32 | linkMapRefs(graphFileIn, graphFileOut = NA, linkFrom, linkTo, 33 | mapTypeToLink = "pointmaps", unlink = FALSE, 34 | cliPath = getDefaultCLILocation(), verbose = FALSE) 35 | } 36 | \arguments{ 37 | \item{graphFileIn}{ 38 | The input graph file. 39 | } 40 | \item{graphFileOut}{ 41 | The output graph file. If ommited will use the input file. 42 | } 43 | \item{linkFromX}{ 44 | Link start x-coordinate. 45 | } 46 | \item{linkFromY}{ 47 | Link start y-coordinate. 48 | } 49 | \item{linkToX}{ 50 | Link end x-coordinate. 51 | } 52 | \item{linkToY}{ 53 | Link end y-coordinate. 54 | } 55 | \item{linkFrom}{ 56 | Link start Ref. 57 | } 58 | \item{linkTo}{ 59 | Link end Ref. 60 | } 61 | \item{unlink}{ 62 | Set to TRUE to unlink instead of linking. 63 | } 64 | \item{mapTypeToLink}{ 65 | Map type group to select displayed map from. One of: 66 | "pointmaps" (default, vga: link) or 67 | "shapegraphs" (axial:link/unlink, segment:link, convex:link) 68 | } 69 | \item{cliPath}{ 70 | Optional. Provide the path to a different CLI. 71 | } 72 | \item{verbose}{ 73 | Optional. Show more information of the process. 74 | } 75 | } 76 | \value{ 77 | No value returned, process is between files. 78 | } 79 | \author{ 80 | Petros Koutsolampros 81 | } 82 | -------------------------------------------------------------------------------- /R/isovist.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Petros Koutsolampros 2 | # 3 | # This file is part of rdepthmap 4 | # 5 | # rdepthmap is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # rdepthmap is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with rdepthmap If not, see . 17 | 18 | isovist = function(graphFileIn, graphFileOut = NA, x, y, angle = NA, viewangle = NA, 19 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 20 | if (is.na(graphFileOut)) graphFileOut = graphFileIn; 21 | tmpPtz = tempfile(fileext = ".csv") 22 | dt = data.frame(x = x, y = y) 23 | targetedIsovist = F 24 | suppressWarnings({ 25 | targetedIsovist = !is.na(angle) 26 | }) 27 | if (targetedIsovist) { 28 | dt$angle = angle; 29 | dt$viewangle = viewangle; 30 | } 31 | write.table(dt, tmpPtz, row.names = F, quote = F, sep = ",") 32 | 33 | depthmapXcli(c("-f", formatForCLI(graphFileIn), 34 | "-o", formatForCLI(graphFileOut), 35 | "-m", "ISOVIST", 36 | "-if", formatForCLI(tmpPtz)), cliPath, verbose); 37 | invisible(file.remove(tmpPtz)); 38 | } 39 | 40 | isovist2pts = function(graphFileIn, graphFileOut = NA, x, y, toX, toY, viewangle, 41 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 42 | angles = 180 * atan2(toY - y, toX - x) / pi 43 | angles = ifelse(angles < 0, 360 + angles, angles) 44 | isovist(graphFileIn, graphFileOut, x, y, angles, viewangle, cliPath, verbose); 45 | } 46 | 47 | makeIsovists = function(graphFilePath, originX, originY, scale = 1, 48 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 49 | tmpGraph = tempfile(fileext = ".graph"); 50 | rdepthmap::isovist(graphFilePath, tmpGraph, originX, originY) 51 | rdepthmap::convertMap(tmpGraph, tmpGraph, "convex") 52 | 53 | tmpMap = tempfile(fileext = ".mif") 54 | rdepthmap::export(tmpGraph, tmpMap, "shapegraph-map-mif") 55 | isovists = sf::st_read(tmpMap, geometry_column = 1L, quiet = !verbose) 56 | 57 | file.remove(tmpGraph); 58 | file.remove(tmpMap); 59 | 60 | return(elide(isovists, bb = matrix(c(0,0,1,1), ncol = 2), scale = scale)) 61 | } 62 | -------------------------------------------------------------------------------- /R/matchPointsToLines.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Kimon Krenz 2 | # Copyright 2019 Petros Koutsolampros 3 | # 4 | # This file is part of rdepthmap 5 | # 6 | # rdepthmap is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # rdepthmap is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with rdepthmap If not, see . 18 | 19 | matchPointsToLines = function(points, lines, getIndex = FALSE) { 20 | 21 | d = sf::st_distance(lines, points) 22 | 23 | # this is done to retain the name of the 24 | # row/column through filtering 25 | rownames(d) = 1:nrow(d) 26 | colnames(d) = 1:ncol(d) 27 | 28 | { 29 | # the process needs to be done for the fewer objects 30 | # i.e. if we have 1000 lines, but 10 points then the 31 | # process only needs to run 10 times 32 | mindim = min(ncol(d), nrow(d)) 33 | # create a row of matches to store the row/column names 34 | matches = matrix(ncol = 2, nrow = mindim) 35 | # first run is special as it's on the raw distance matrix 36 | i = 1 37 | matches[i,] = arrayInd(which.min(d), dim(d)) 38 | # for all other runs, except the last: 39 | lapply(2:(mindim - 1), function(i) { 40 | # filter the matrix based on the previous matches 41 | m = d[-matches[1:(i-1),1], 42 | -matches[1:(i-1),2]] 43 | # find the index of the smallest value (closest point to line) 44 | idcs = arrayInd(which.min(m), dim(m)) 45 | # add to matches, making sure to take row/column names 46 | matches[i,] <<- as.integer(c(rownames(m)[idcs[,1]], colnames(m)[idcs[,2]])) 47 | }) 48 | # for the last run R converts the matrix to a list 49 | # because there's only one row left 50 | i=mindim 51 | m = d[!(rownames(d) %in% matches[1:(i-1),1]), 52 | !(colnames(d) %in% matches[1:(i-1),2])] 53 | # reconvert to matrix 54 | m = as.matrix(m) 55 | idcs = arrayInd(which.min(as.matrix(m)), dim(as.matrix(m))) 56 | matches[i,] = as.integer(c(rownames(m)[idcs[,1]], colnames(m)[idcs[,2]])) 57 | matches <<- matches 58 | } 59 | 60 | rowidx = rep(NA, nrow(lines)) 61 | rowidx[matches[,1]] = matches[,2] 62 | if(getIndex) { 63 | return(rowidx) 64 | } else { 65 | return(points[rowidx,]) 66 | } 67 | } 68 | -------------------------------------------------------------------------------- /R/link.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Fani Kostourou 2 | # Copyright 2019 Petros Koutsolampros 3 | # 4 | # This file is part of rdepthmap 5 | # 6 | # rdepthmap is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # rdepthmap is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with rdepthmap If not, see . 18 | 19 | linkMapCoords = function(graphFileIn, graphFileOut = NA, linkFromX, linkFromY, 20 | linkToX, linkToY, unlink = FALSE, mapTypeToLink = "pointmaps", 21 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 22 | if (is.na(graphFileOut)) graphFileOut = graphFileIn; 23 | if (!(mapTypeToLink %in% c("pointmaps", "shapegraphs"))) { 24 | stop(paste0("Unknown map type: ", mapTypeToLink)) 25 | } 26 | 27 | tmpPtz = tempfile(fileext = ".tsv"); 28 | dt = data.frame(x1 = linkFromX, y1 = linkFromY, x2 = linkToX, y2 = linkToY) 29 | write.table(dt, tmpPtz, row.names = F, quote = F, sep = "\t") 30 | 31 | 32 | params = c("-f", formatForCLI(graphFileIn), 33 | "-o", formatForCLI(graphFileOut), 34 | "-m", "LINK", 35 | "-lmt", mapTypeToLink, 36 | "-lm", ifelse(unlink, "unlink", "link"), 37 | "-lt", "coords", 38 | "-lf", tmpPtz) 39 | 40 | 41 | depthmapXcli(params, cliPath, verbose); 42 | removed = file.remove(tmpPtz) 43 | } 44 | 45 | linkMapRefs = function(graphFileIn, graphFileOut = NA, linkFrom, linkTo, 46 | mapTypeToLink = "pointmaps", unlink = FALSE, 47 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 48 | if (is.na(graphFileOut)) graphFileOut = graphFileIn; 49 | if (!(mapTypeToLink %in% c("pointmaps", "shapegraphs"))) { 50 | stop(paste0("Unknown map type: ", mapTypeToLink)) 51 | } 52 | 53 | tmpPtz = tempfile(fileext = ".tsv"); 54 | dt = data.frame(reffrom = linkFrom, refto = linkTo) 55 | write.table(dt, tmpPtz, row.names = F, quote = F, sep = "\t") 56 | 57 | 58 | params = c("-f", formatForCLI(graphFileIn), 59 | "-o", formatForCLI(graphFileOut), 60 | "-m", "LINK", 61 | "-lmt", mapTypeToLink, 62 | "-lm", ifelse(unlink, "unlink", "link"), 63 | "-lt", "refs", 64 | "-lf", tmpPtz) 65 | 66 | depthmapXcli(params, cliPath, verbose); 67 | removed = file.remove(tmpPtz) 68 | } 69 | -------------------------------------------------------------------------------- /R/prepareVGA.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Petros Koutsolampros 2 | # 3 | # This file is part of rdepthmap 4 | # 5 | # rdepthmap is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # rdepthmap is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with rdepthmap If not, see . 17 | 18 | createGrid = function(graphFileIn, graphFileOut = NA, gridSize, 19 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 20 | if (is.na(graphFileOut)) graphFileOut = graphFileIn; 21 | params = c("-f", formatForCLI(graphFileIn), 22 | "-o", formatForCLI(graphFileOut), 23 | "-m", "VISPREP", 24 | "-pg", gridSize) 25 | depthmapXcli(params, cliPath, verbose); 26 | } 27 | 28 | fillGrid = function(graphFileIn, graphFileOut = NA, fillX, fillY, 29 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 30 | if (is.na(graphFileOut)) graphFileOut = graphFileIn; 31 | tmpPtz = tempfile(fileext = ".tsv"); 32 | dt = data.frame(x = fillX, y = fillY) 33 | write.table(dt, tmpPtz, row.names = F, quote = F, sep = "\t") 34 | 35 | params = c("-f", formatForCLI(graphFileIn), 36 | "-o", formatForCLI(graphFileOut), 37 | "-m", "VISPREP", 38 | "-pf", tmpPtz) 39 | 40 | depthmapXcli(params, cliPath, verbose); 41 | removed = file.remove(tmpPtz) 42 | } 43 | 44 | makeVGAGraph = function(graphFileIn, graphFileOut = NA, maxVisibility = NA, boundaryGraph = FALSE, 45 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 46 | if (is.na(graphFileOut)) graphFileOut = graphFileIn; 47 | params = c("-f", formatForCLI(graphFileIn), 48 | "-o", formatForCLI(graphFileOut), 49 | "-m", "VISPREP", 50 | "-pm") 51 | if (!is.na(maxVisibility)) params = c(params, "-pr", maxVisibility) 52 | if (boundaryGraph) params = c(params, "-pb") 53 | 54 | depthmapXcli(params, cliPath, verbose); 55 | } 56 | 57 | unmakeVGAGraph = function(graphFileIn, graphFileOut = NA, removeLinks = FALSE, 58 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 59 | if (is.na(graphFileOut)) graphFileOut = graphFileIn; 60 | params = c("-f", formatForCLI(graphFileIn), 61 | "-o", formatForCLI(graphFileOut), 62 | "-m", "VISPREP", 63 | "-pu") 64 | 65 | if (removeLinks) params = c(params, "-pl") 66 | 67 | depthmapXcli(params, cliPath, verbose); 68 | } 69 | -------------------------------------------------------------------------------- /man/export.Rd: -------------------------------------------------------------------------------- 1 | % Copyright 2019 Fani Kostourou 2 | % Copyright 2019 Petros Koutsolampros 3 | % 4 | % This file is part of rdepthmap 5 | % 6 | % rdepthmap is free software: you can redistribute it and/or modify 7 | % it under the terms of the GNU General Public License as published by 8 | % the Free Software Foundation, either version 3 of the License, or 9 | % (at your option) any later version. 10 | % 11 | % rdepthmap is distributed in the hope that it will be useful, 12 | % but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | % GNU General Public License for more details. 15 | % 16 | % You should have received a copy of the GNU General Public License 17 | % along with rdepthmap If not, see . 18 | 19 | \name{export} 20 | \alias{export} 21 | \alias{getPointmapData} 22 | \alias{getPointmapLinks} 23 | \alias{getPointmapDataAndLinks} 24 | \alias{getShapeGraph} 25 | \alias{getShapeGraphConnections} 26 | \alias{getShapeGraphLinksUnlinks} 27 | \title{ 28 | Export data 29 | } 30 | \description{ 31 | Exports data from a graph file. The getPointmap* functions are provided for convenience to export to temporary file and import to R directly. 32 | } 33 | \usage{ 34 | export(graphFileIn, fileOut, exportType, 35 | cliPath = getDefaultCLILocation(), verbose = FALSE) 36 | 37 | getPointmapData(graphFileIn, scale = 1, 38 | cliPath = getDefaultCLILocation(), verbose = FALSE) 39 | getPointmapLinks(graphFileIn, 40 | cliPath = getDefaultCLILocation(), verbose = FALSE) 41 | getPointmapDataAndLinks(graphFileIn, scale = 1, 42 | cliPath = getDefaultCLILocation(), verbose = FALSE) 43 | 44 | getShapeGraph(graphFileIn, 45 | cliPath = getDefaultCLILocation(), verbose = FALSE) 46 | getShapeGraphConnections(graphFileIn, 47 | cliPath = getDefaultCLILocation(), verbose = FALSE) 48 | getShapeGraphLinksUnlinks(graphFileIn, 49 | cliPath = getDefaultCLILocation(), verbose = FALSE) 50 | } 51 | %- maybe also 'usage' for other objects documented here. 52 | \arguments{ 53 | \item{graphFileIn}{ 54 | The input .graph file. 55 | } 56 | \item{fileOut}{ 57 | The output file. 58 | } 59 | \item{exportType}{ 60 | What to export. Available types are: 61 | "pointmap-data-csv", 62 | "pointmap-connections-csv", 63 | "pointmap-links-csv", 64 | "shapegraph-map-csv", 65 | "shapegraph-map-mif", 66 | "shapegraph-connections-csv" or 67 | "shapegraph-links-unlinks-csv". 68 | } 69 | \item{scale}{ 70 | Provided for when importing a pointmap directly. Will scale the whole map. 71 | } 72 | \item{cliPath}{ 73 | Optional. Provide the path to a different CLI. 74 | } 75 | \item{verbose}{ 76 | Optional. Show more information of the process. 77 | } 78 | } 79 | \value{ 80 | No value returned, process is between files. 81 | } 82 | 83 | \author{ 84 | Petros Koutsolampros 85 | Fani Kostourou 86 | } 87 | -------------------------------------------------------------------------------- /man/agentAnalysis.Rd: -------------------------------------------------------------------------------- 1 | % Copyright 2019 Petros Koutsolampros 2 | % 3 | % This file is part of rdepthmap 4 | % 5 | % rdepthmap is free software: you can redistribute it and/or modify 6 | % it under the terms of the GNU General Public License as published by 7 | % the Free Software Foundation, either version 3 of the License, or 8 | % (at your option) any later version. 9 | % 10 | % rdepthmap is distributed in the hope that it will be useful, 11 | % but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | % GNU General Public License for more details. 14 | % 15 | % You should have received a copy of the GNU General Public License 16 | % along with rdepthmap If not, see . 17 | 18 | \name{agentAnalysis} 19 | \alias{agentAnalysis} 20 | \title{ 21 | Agent Analysis 22 | } 23 | \description{ 24 | Calls the depthmapXcli to carry out Agent Analysis on the currently visible map 25 | } 26 | \usage{ 27 | agentAnalysis(graphFileIn, graphFileOut = NA, lookMode, timesteps, releaseRate, 28 | agentFOV, agentSteps, agentLife, originX = NA, originY = NA, 29 | locationSeed = 0, numberOfTrails = NA, outputType = "graph", 30 | cliPath = getDefaultCLILocation(), verbose = FALSE) 31 | } 32 | \arguments{ 33 | \item{graphFileIn}{ 34 | The input graph file. 35 | } 36 | \item{graphFileOut}{ 37 | The output graph file. If ommited will use the input file. 38 | } 39 | \item{lookMode}{ 40 | Agent look mode. One of: 41 | "standard", 42 | "los-length" (Line of Sight length), 43 | "occ-length" (Occluded length), 44 | "occ-any" (Any occlusions), 45 | "occ-group-45" (Occlusion group bins - 45 degrees), 46 | "occ-group-60" (Occlusion group bins - 60 degrees), 47 | "occ-furthest" (Furthest occlusion per bin), 48 | "bin-far-dist" (Per bin far distance weighted), 49 | "bin-angle" (Per bin angle weighted), 50 | "bin-far-dist-angle" (Per bin far-distance and angle weighted) or 51 | "bin-memory" (Per bin memory). 52 | } 53 | \item{timesteps}{ 54 | Number of total system timesteps. 55 | } 56 | \item{releaseRate}{ 57 | Agent release rate (likelyhood of release per timestep). 58 | } 59 | \item{agentFOV}{ 60 | Agent field-of-view (out of 32 bins = 360). 61 | } 62 | \item{agentSteps}{ 63 | Agent steps before turn decision. 64 | } 65 | \item{agentLife}{ 66 | Agent total lifetime (in timesteps). 67 | } 68 | \item{originX}{ 69 | Agent starting point (x coordinates). 70 | } 71 | \item{originY}{ 72 | Agent starting point (y coordinates). 73 | } 74 | \item{locationSeed}{ 75 | Agents to start at random locations with specific seed (0 to 10). Default is 0. 76 | } 77 | \item{numberOfTrails}{ 78 | Record trails for this amount of agents (set to 0 to record all, with max possible currently = 50). 79 | } 80 | \item{outputType}{ 81 | Set output type. One of: 82 | "graph" (graph file, default), 83 | "gatecounts" (csv with cells of grid with gate counts) or 84 | "trails" (csv with lines showing path traversed by each agent). 85 | } 86 | \item{cliPath}{ 87 | Optional. Provide the path to a different CLI. 88 | } 89 | \item{verbose}{ 90 | Optional. Show more information of the process. 91 | } 92 | } 93 | \value{ 94 | No value returned, process is between files. 95 | } 96 | \author{ 97 | Petros Koutsolampros 98 | } 99 | -------------------------------------------------------------------------------- /R/export.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Fani Kostourou 2 | # Copyright 2019 Petros Koutsolampros 3 | # 4 | # This file is part of rdepthmap 5 | # 6 | # rdepthmap is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # rdepthmap is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with rdepthmap If not, see . 18 | 19 | export = function(graphFileIn, fileOut, exportType, 20 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 21 | depthmapXcli(c("-f", formatForCLI(graphFileIn), 22 | "-o", formatForCLI(fileOut), 23 | "-m", "EXPORT", 24 | "-em", exportType), cliPath, verbose); 25 | } 26 | 27 | getPointmapData = function(graphFileIn, scale = 1, 28 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 29 | mapFile = tempfile(fileext = ".csv"); 30 | rdepthmap::export(graphFileIn, mapFile, "pointmap-data-csv", cliPath, verbose) 31 | dpm = processPointMap(mapFile, scale, ",") 32 | file.remove(mapFile) 33 | return(dpm); 34 | } 35 | 36 | getPointmapLinks = function(graphFileIn, 37 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 38 | csvFile = tempfile(fileext = ".csv"); 39 | rdepthmap::export(graphFileIn, csvFile, "pointmap-links-csv", cliPath, verbose) 40 | links = read.csv(csvFile) 41 | file.remove(csvFile) 42 | return(links); 43 | } 44 | 45 | 46 | getPointmapDataAndLinks = function(graphFileIn, scale = 1, 47 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 48 | mapFile = tempfile(fileext = ".csv"); 49 | rdepthmap::export(graphFileIn, mapFile, "pointmap-data-csv") 50 | linkFile = tempfile(fileext = ".csv"); 51 | rdepthmap::export(graphFileIn, linkFile, "pointmap-links-csv") 52 | dpm = processPointMapAndLinks(mapFile, linkFile, scale, ",") 53 | file.remove(mapFile) 54 | file.remove(linkFile) 55 | return(dpm); 56 | } 57 | 58 | processPointMap = function(mapPath, scale = 1, sep = "\t") { 59 | pointMapData = read.csv(mapPath, sep = sep); 60 | pointMapData$x = pointMapData$x*scale; 61 | pointMapData$y = pointMapData$y*scale; 62 | pointMapData = cbind(pointMapData, refIDtoIndex(pointMapData$Ref)); 63 | xycols = c("x","y"); 64 | pointMapPoints = pointMapData[, xycols]; 65 | pointMapData = pointMapData[,!(names(pointMapData) %in% xycols)]; 66 | dpm = SpatialPointsDataFrame(pointMapPoints, data = pointMapData); 67 | makeGridded = function() {gridded(dpm) <<- TRUE} 68 | suppressWarnings(makeGridded()) 69 | return(list(map = dpm, importScale = scale)); 70 | } 71 | 72 | processPointMapAndLinks = function(mapPath, linkPath = NA, scale = 1, sep = "\t") { 73 | pointMap = processPointMap(mapPath, scale, sep) 74 | pointMap$links = NA 75 | if (!is.na(linkPath)) { 76 | pointMap$links = read.csv(linkPath, sep = sep) 77 | } 78 | return(pointMap); 79 | } 80 | 81 | getShapeGraph = function(graphFileIn, 82 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 83 | mapFile = tempfile(fileext = ".mif") 84 | rdepthmap::export(graphFileIn, mapFile, "shapegraph-map-mif", cliPath, verbose) 85 | ogr = sf::st_read(mapFile, geometry_column = 1L, quiet = !verbose) 86 | file.remove(mapFile) 87 | return(ogr); 88 | } 89 | 90 | getShapeGraphConnections = function(graphFileIn, 91 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 92 | connectionsFile = tempfile(fileext = ".csv") 93 | rdepthmap::export(graphFileIn, connectionsFile, "shapegraph-connections-csv", cliPath, verbose) 94 | csv = read.table(connectionsFile,header = TRUE, sep = ",") 95 | file.remove(connectionsFile) 96 | return(csv); 97 | } 98 | 99 | getShapeGraphLinksUnlinks = function(graphFileIn, 100 | cliPath = getDefaultCLILocation(), verbose = FALSE) { 101 | linksunlinksFile = tempfile(fileext = ".csv") 102 | rdepthmap::export(graphFileIn, linksunlinksFile, "shapegraph-links-unlinks-csv", cliPath, verbose) 103 | csv = read.table(linksunlinksFile,header = TRUE, sep = ",") 104 | file.remove(linksunlinksFile) 105 | return(csv); 106 | } 107 | -------------------------------------------------------------------------------- /R/palettes.R: -------------------------------------------------------------------------------- 1 | # Copyright 2019 Fani Kostourou 2 | # Copyright 2019 Petros Koutsolampros 3 | # 4 | # This file is part of rdepthmap 5 | # 6 | # rdepthmap is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # rdepthmap is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with rdepthmap If not, see . 18 | 19 | makeDepthmapClassicColour = function(value, rangeMin, rangeMax) { 20 | if (rangeMin > rangeMax) { 21 | value = 1.0 - value; 22 | rangeMin = 1.0 - rangeMin; 23 | rangeMax = 1.0 - rangeMax; 24 | } 25 | green = rangeMin + (rangeMax - rangeMin) / 10.0; 26 | r = g = b = 0; 27 | offset = 0.0333; 28 | 29 | htmlByte = function(colorByte) { 30 | return(floor((colorByte + offset) * 15.0) * 17); 31 | } 32 | 33 | # NB previously included colour muting: the 1.0 was originally 0.9 to mute the colours slightly 34 | if ((value >= 0.0) && (value < rangeMin)) { 35 | r = htmlByte(0.5 * (rangeMin - value)/rangeMin) 36 | b = 0xFF; 37 | } 38 | else if ((value >= rangeMin) && (value < (green + rangeMin)/2.0)) { 39 | b = 0xFF; 40 | g = htmlByte(2.0*(value - rangeMin)/(green - rangeMin)) 41 | } 42 | else if ((value >= (green + rangeMin)/2.0) && (value < green)) { 43 | b = htmlByte(2.0*(green - value)/(green - rangeMin)) 44 | g = 0xFF; 45 | } 46 | else if ((value >= green) && (value < (green + rangeMax)/2.0)) { 47 | g = 0xFF; 48 | r = htmlByte(2.0*(value - green)/(rangeMax - green)) 49 | } 50 | else if ((value >= (green + rangeMax)/2.0) && (value < rangeMax)) { 51 | g = htmlByte(2.0*(rangeMax - value)/(rangeMax - green)) 52 | r = 0xFF; 53 | } 54 | else if (value >= rangeMax) { 55 | r = 0xFF; 56 | b = htmlByte(0.5 * (value - rangeMax)/(1.0 - rangeMax)) 57 | } 58 | return(grDevices::rgb(r/255.0,g/255.0,b/255.0)); 59 | } 60 | depthmap.classic.colour = function(n) { 61 | unlist(lapply(0:(n - 1), function(i) { 62 | makeDepthmapClassicColour(i/n, 0, 1) 63 | })) 64 | } 65 | 66 | makeAxmanesqueColour = function(value, rangeMin = 0, rangeMax = 1) { 67 | g_nicecolor = c( 68 | "#3333DD", # 0 blue 69 | "#3388DD", # 1 70 | "#22CCDD", # 2 71 | "#22CCBB", # 3 72 | "#22DD88", # 4 73 | "#88DD22", # 5 74 | "#BBCC22", # 6 75 | "#DDCC22", # 7 76 | "#DD8833", # 8 77 | "#DD3333" # 9 red 78 | ); 79 | f = (value - rangeMin) / (rangeMax - rangeMin); 80 | if (rangeMin > rangeMax) { 81 | f = 1.0 - f; 82 | } 83 | return(g_nicecolor[1 + as.integer((f - 1e-9) * length(g_nicecolor))]); 84 | } 85 | depthmap.axmanesque.colour = function(n) { 86 | unlist(lapply(0:(n - 1), function(i) { 87 | makeAxmanesqueColour(i/n) 88 | })) 89 | } 90 | 91 | makePurpleOrangeColour = function(value, rangeMin = 0, rangeMax = 1) { 92 | g_purpleorange = c( 93 | "#542788", # 0 purple 94 | "#998EC3", # 1 95 | "#D8DAEB", # 2 96 | "#F7F7F7", # 3 97 | "#FEE0B6", # 4 98 | "#F1A340", # 5 99 | "#B35806" # 6 orange 100 | ); 101 | f = (value - rangeMin) / (rangeMax - rangeMin); 102 | if (rangeMin > rangeMax) { 103 | f = 1.0 - f; 104 | } 105 | return(g_purpleorange[1 + as.integer((f - 1e-9) * length(g_purpleorange))]); 106 | } 107 | depthmap.purpleorange.colour = function(n) { 108 | unlist(lapply(0:(n - 1), function(i) { 109 | makePurpleOrangeColour(i/n) 110 | })) 111 | } 112 | 113 | makeBlueRedColour = function(value, rangeMin = 0, rangeMax = 1) { 114 | g_bluered = c( 115 | "#4575B4", # 0 blue 116 | "#91BFDB", # 1 117 | "#E0F3F8", # 2 118 | "#FFFFBF", # 3 119 | "#FEE090", # 4 120 | "#FC8D59", # 5 121 | "#D73027" # 6 red 122 | ); 123 | f = (value - rangeMin) / (rangeMax - rangeMin); 124 | if (rangeMin > rangeMax) { 125 | f = 1.0 - f; 126 | } 127 | return(g_bluered[1 + as.integer((f - 1e-9) * length(g_bluered))]); 128 | } 129 | depthmap.bluered.colour = function(n) { 130 | unlist(lapply(0:(n - 1), function(i) { 131 | makeBlueRedColour(i/n) 132 | })) 133 | } 134 | 135 | makeGreyScaleColour = function(value, rangeMin = 0, rangeMax = 1) { 136 | g_greyscale = c( 137 | "#000000", # 0 black 138 | "#444444", # 1 139 | "#777777", # 2 140 | "#AAAAAA", # 3 141 | "#CCCCCC", # 4 142 | "#EEEEEE", # 5 143 | "#FFFFFF" # 6 white 144 | ); 145 | f = (value - rangeMin) / (rangeMax - rangeMin); 146 | if (rangeMin > rangeMax) { 147 | f = 1.0 - f; 148 | } 149 | return(g_greyscale[1 + as.integer((f - 1e-9) * length(g_greyscale))]); 150 | } 151 | depthmap.grayscale.colour = function(n) { 152 | unlist(lapply(0:(n - 1), function(i) { 153 | makeGreyScaleColour(i/n) 154 | })) 155 | } 156 | 157 | makeNiceHSBColour = function(value, rangeMin = 0, rangeMax = 1) { 158 | g_nicecolorhsb = c( 159 | "#3333DD", # 0 blue 160 | "#3377DD", # 1 161 | "#33BBDD", # 2 162 | "#33DDBB", # 3 163 | "#33DD55", # 4 164 | "#55DD33", # 5 165 | "#BBDD33", # 6 166 | "#DDBB33", # 7 167 | "#DD7733", # 8 168 | "#DD3333" # 9 red 169 | ); 170 | f = (value - rangeMin) / (rangeMax - rangeMin); 171 | if (rangeMin > rangeMax) { 172 | f = 1.0 - f; 173 | } 174 | return(g_nicecolorhsb[1 + as.integer((f - 1e-9) * length(g_nicecolorhsb))]); 175 | } 176 | depthmap.nicehsb.colour = function(n) { 177 | unlist(lapply(0:(n - 1), function(i) { 178 | makeNiceHSBColour(i/n) 179 | })) 180 | } 181 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------