pnvdb Documentation Release Jan Tore Kyrdalen

Transkript

1 pnvdb Documentation Release Jan Tore Kyrdalen Oct 31, 2017

2

3 Contents 1 Installation 3 2 Getting started 5 3 Methods status objekt objekt_type vegreferanse posisjon areas objekt_typer hent Classes Nvdb Objekt Objekt_type Vegreferanse Posisjon Area i

4 ii

5 pnvdb Documentation, Release pnvdb stands for python veg database and is a python wrapper for the NVDB Rest API Data pulled from the API is licensed under Norsk lisens for offentlige data NLOD Contents: Contents 1

6 pnvdb Documentation, Release Contents

7 CHAPTER 1 Installation pip install pnvdb 3

8 pnvdb Documentation, Release Chapter 1. Installation

9 CHAPTER 2 Getting started Start with initalizing an instance of pnvdb: import pnvdb nvdb = pnvdb.nvdb(client='your-app-name', contact='your-contact-information') Now we can test our connection to NVDB: print(nvdb.status()) To work with a spesific nvdb object, we can initialize it like this: objekt = nvdb.objekt(objekt_type=67, nvdb_id= ) This will get us access to a number of attributes assosiated with this object. Let s print them out: print(objekt.metadata) print(objekt.vegreferanser) print(objekt.egengeometri) print(objekt.geometri) print(objekt.barn) These are all dictionaries containing information to this spesific object. 5

10 pnvdb Documentation, Release Chapter 2. Getting started

11 CHAPTER 3 Methods The following methods are avaliable in the Nvdb class in pnvdb. initialize it as following: import pnvdb nvdb = pnvdb.nvdb(client='your-app-name', contact='your-contact-information') status Method for getting information about the current status of the API API endpoint status Code example: >>> status = nvdb.status() >>> print(status['datakatalog']['versjon']) 2.10 objekt Method for creating a spesific nvdb python Objekt API endpoint vegobjekter Code example: >>> obj = nvdb.objekt(objekt_type=67, nvdb_id= ) >>> print(obj.metadata) {'versjon': 3, 'type': {'navn': 'Tunnelløp', 'id': 67}, 'startdato': ' ', 'sist_modifisert': ' :15:50'} 7

12 pnvdb Documentation, Release metadata - Dictionary geometri - Well known text foreldre - List of Objekt barn - List of Objekt vegreferanser - List of Vegreferanse Methods dump() objekt_type Method for creating a spesific nvdb python Objekt_type API endpoint vegobjekttyper Code example: >>> obj = nvdb.objekt_type(objekt_type=67) >>> print(obj.metadata) {'objektliste_dato': ' ', 'sosinvdbnavn': 'Tunnelløp_67', 'sorteringsnummer ': 5460, 'navn': 'Tunnelløp', 'kategorier': [], 'veiledning': '', 'stedfesting': 'LINJE', 'id': 67, 'beskrivelse': 'Utgravd eller utstøpt passasje gjennom jord/ fjell eller under større lokk. Har normalt inngang og utgang i dagen. I spesielle tilfeller, f.eks når forgreninger eller kryss, kan det være utgang mot annet tunnelløp eller inngang fra annet tunnelløp. Se også Undergang, Skredoverbygg og Høydebegrensning.'} metadata - Dictionary relasjonstyper - Dictionary egenskapstyper List of dictionaries styringsparametere - Dictionary foreldre - List of Objekt barn - List of Objekt Methods dump() - returns the raw result form the API 8 Chapter 3. Methods

13 pnvdb Documentation, Release vegreferanse Returns Vegreferanse of specified location API endpoint veg Code example: >>> vegref = nvdb.vegreferanse('1600ev6hp12m1000') >>> print(vegref.geometri) POINT Z ( ) detaljert - dictionary veglenke - dictionary geometri - Well known text posisjon Returns a Posisjon object API endpoint posisjon Code example: >>> pos = nvdb.posisjon(x=269815,y= ) >>> print(pos.vegreferanse) 1600 Rv706 hp52 m344 vegreferanse - Vegreferanse areas Returns an Area object for different type of areas API endpoint omrader Avaliable areas : * regioner * fylker * vegavdelinger * kommuner * kontraktsomrader * riksvegruter Code example: >>> for fylke in nvdb.fylker(): >>> print(fylke.metadata['navn']) Østfold Akershus Oslo vegreferanse 9

14 pnvdb Documentation, Release metadata - Dictionary kartutsnitt - Dictionary senterpunkt - Dictionary objekt - Objekt objekt_typer Returns Objekt_type of every avaliable obj type in nvdb Code example: >>> objects = nvdb.objekt_typer() >>> print(objects[0].metadata) {'objektliste_dato': ' ', 'sosinvdbnavn': 'Skjerm_3', 'navn': 'Skjerm', 'id ': 3, 'kategorier': [], 'stedfesting': 'LINJE', 'sorteringsnummer': 4760, 'veiledning': '', 'beskrivelse': 'En frittstående konstruksjon som skal være et hinder for f.eks støyutbredelse'} hent Return a generator object that can be itterated over to fetch the results of the query. API endpoint vegobjekter Code example: >>> area_filter = {'fylke':'2'} # Akershus >>> objekt_type = 581 # Tunnels >>> objects = nvdb.hent(objekt_type, area_filter) >>> for obj in objects: >>> for egenskap in obj.egenskaper: >>> if egenskap['id'] == 5225: >>> print(egenskap['verdi']) Furusmotunnelen Blåkollen tunnel Hagantunnelen Chapter 3. Methods

15 CHAPTER 4 Classes Nvdb The main class for interfacing with the API. Objekt Class for individual nvdb-objects. metadata - Dictionary geometri - Well known text foreldre - List of Objekt barn - List of Objekt vegreferanser - List of Vegreferanse Objekt_type Class for individual nvdb-object types. (Data catalogue) metadata - Dictionary relasjonstyper - Dictionary 11

16 pnvdb Documentation, Release egenskapstyper List of dictionaries styringsparametere - Dictionary foreldre - List of Objekt barn - List of Objekt Vegreferanse Class for working with road refferences. detaljert - dictionary veglenke - dictionary geometri - Well known text Posisjon Class for connecting coordinates to road refferences Vegreferanse Area Class for area objects. metadata - Dictionary kartutsnitt - Dictionary senterpunkt - Dictionary objekt - Objekt Link to pnvdb on Github 12 Chapter 4. Classes