Rastershapefile genereren (Join)

Grid Statistics 1.0

Gebruik onderstaande URL-sjablonen om op basis van de Join-methode vierkantstatistieken te berekenen (of op te vragen) en deze als rastershapefile te downloaden. Een rastershapefile wordt gegenereerd als ESRI Shapefile.

Ondersteunde HTTP-methoden

GET

URL-sjablonen

Bereken eenmalig een vierkantstatistiek en vraag deze als rastershapefile op
http://api.gisblox.com/REST/v1/gridstatistics/join/getshapefile?file=file&cellSize=cellSize&observMin=observMin&joinType=joinType&format=format&key=PersoonlijkeGISBloxSleutel
Bereken een vierkantstatistiek, sla deze berekening op en vraag het resultaat als rastershapefile op
http://api.gisblox.com/REST/v1/gridstatistics/join/getshapefile?file=file&calcName=calcName&cellSize=cellSize&observMin=observMin&joinType=joinType&format=format&key=PersoonlijkeGISBloxSleutel
Vraag het resultaat van een bestaande berekening als rastershapefile op
http://api.gisblox.com/REST/v1/gridstatistics/join/getshapefile?calcName=calcName&format=format&key=PersoonlijkeGISBloxSleutel

Sjabloonparameters

Opmerking
Kijk op de Algemene types en parameters-pagina voor informatie over de algemene respons-types en parameters die deze URL gebruikt.


Parameternamen en -waarden zijn niet hoofdlettergevoelig.
Parameter Omschrijving Waarde
file Optioneel De naam van het bronbestand in uw documentbibliotheek waarvoor een nieuwe calculatie gemaakt moet worden. Een string met de bestandsnaam.
Voorbeeld: file=Wonen2014
calcName Optioneel De naam van een eerder uitgevoerde calculatie. Indien deze parameter gecombineerd wordt met de file-parameter, dan wordt de uit te voeren calculatie onder deze naam opgeslagen, zodat deze later via de calcName parameter op te vragen is. Een string met de calculatienaam.
Voorbeeld: calcName=ResulaatWonen2014
cellSize Vereist Een maat voor de grootte van de vierkanten waarvoor de statistiek wordt berekend. De parameterwaarde staat voor de lengte van één zijde van het vierkant, in gehele meters. Invoer van waarde 100 leidt dus tot een statistiek opgebouwd uit de geometrie van vierkanten van 100 bij 100 meter. Een string met een getal in het waardebereik 25...315.000.
Voorbeeld: cellSize=100
observMin Vereist Het minimale aantal puntwaarnemingen dat zich binnen het vierkant (cellSize) moet bevinden voordat de betreffende statistiek (average/count/sum) wordt berekend. Een string met een geheel getal in het waardebereik 0...16.000.000.
Voorbeeld: observMin=5
joinType Vereist Het type statistiek dat berekend moet worden. Eén van de volgende opties:
  • Avg - het gemiddelde van de meetwaarden binnen het vierkant
  • Count - het aantal meetwaarden binnen het vierkant
  • Sum - de som van de meetwaarden binnen het vierkant
Voorbeeld: joinType=Avg
format Optioneel Het output-formaat van de respons. Eén van de volgende opties:
  • xml [standaardwaarde]
  • json
Voorbeeld: format=json
key Vereist Specificeert de GISBlox API-sleutel die voor dit verzoek gebruikt moet worden. Een geldige GISBlox API-sleutel.
Voorbeeld: key=abc1234def56789

Respons

Als antwoord op een HTTP-verzoek wordt een respons-object geretourneerd. Afhankelijk van de waarde van input-parameter format, heeft het respons-object het volgende output-formaat:

  • XML (application/xml)
  • JSON (application/json)

Resultaat

Het resultaat van onderstaande voorbeelden wordt geretourneerd als een RasterShapeFile-resource binnen het generieke Response-type. Kijk voor meer informatie over de RasterShapeFile-resource op de pagina over het RasterShapeFile-type. Voor informatie over de overige algemene types en parameters kijkt u op de Algemene types en parameters-pagina.

Attribuuttabel

De attribuuttabel van de shapefile in het ZIP-bestand van het RasterShapeFileData-element van het RasterShapeFile-type heeft de volgende structuur:

Attribuut Omschrijving
C28992R... Het cellocatie-coderingsattribuut. Zie voor meer informatie de FieldNameCL-parameter van het CalcResultJoin-type:
Voorbeeld: C28992R50
MaxRange Bij de Join-methode heeft dit attribuut de vaste waarde -9999.
Voorbeeld: -9999
N Het totaal aantal puntwaarnemingen waarop de berekening gebaseerd is. Bij de Join-methode is dit altijd gelijk aan het aantal puntwaarnemingen binnen het vierkant (NCell).
Voorbeeld: 65
NCell Het aantal puntwaarnemingen binnen het vierkant.
Voorbeeld: 65
Z De uitkomst van de berekening (aantal, gemiddelde of som). Opmerking: als NCell (en ook N) lager is dan de waarde van de observMin-parameter, maar groter dan nul, dan krijgt Z de waarde -9998. Als NCell (en ook N) gelijk is aan nul, dan wordt Z -9999.
Voorbeeld: 25

Voorbeelden

Bereken eenmalig een vierkantstatistiek op basis van de Join-methode en vraag deze als rastershapefile op

In onderstaand voorbeeld wordt een rastershapefile gemaakt op basis van de Join-methode met als bronbestand WozWon2012. De vierkantsgrootte is ingesteld op 100x100 meter en er moeten zich minimaal 5 puntwaarnemingen binnen het vierkant bevinden. De statistiek berekent het gemiddelde van de meetwaarden binnen het vierkant. Het resultaat wordt niet opgeslagen.

http://api.gisblox.com/REST/v1/gridstatistics/join/getshapefile?file=WozWon2012&cellSize=100&observMin=5&joinType=Avg&key=PersoonlijkeGISBloxSleutel

Bereken een vierkantstatistiek op basis van de Join-methode, sla de calculatie op en retourneer het resultaat als rastershapefile

In onderstaand voorbeeld wordt een rastershapefile gemaakt op basis van de Join-methode met als bronbestand WozWon2012 en opgeslagen onder de naam ResultaatWozWon2012. De vierkantsgrootte is ingesteld op 100x100 meter en er moeten zich minimaal 5 puntwaarnemingen binnen het vierkant bevinden. De statistiek berekent het gemiddelde van de meetwaarden binnen het vierkant.

http://api.gisblox.com/REST/v1/gridstatistics/join/getshapefile?file=WozWon2012&calcName=ResultaatWozWon2012&cellSize=100&observMin=5&joinType=Avg&key=PersoonlijkeGISBloxSleutel

Vraag het resultaat van een bestaande Join-berekening als rastershapefile op

In onderstaand voorbeeld wordt de bestaande Join-berekening ResultaatWozWon2012 geopend en geretourneerd als rastershapefile.

http://api.gisblox.com/REST/v1/gridstatistics/join/getshapefile?calcName=ResultaatWozWon2012&key=PersoonlijkeGISBloxSleutel

XML Response

                    
<Response xmlns="http://schemas.gisblox.com/rest/v1/gridstatistics" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Copyright>Copyright © 2011-2017 Bartels Online. All rights reserved. This API cannot be accessed and the content and any results may not be used, reproduced or transmitted in any manner without express written permission from Bartels Online.</Copyright>
  <StatusCode>200</StatusCode>
  <StatusDescription>OK</StatusDescription>
  <ErrorDetails />
  <TraceId>8FF19DAE-A073-40B8-BEF0-51070CAB9E86/080bef1c-7959-4e66-9581-751510403f3e/-216484779</TraceId>
  <Resource i:type="RasterShapeFile">
    <ItemId>1</ItemId>
    <CalculationJobId>ff7aa84e-b3b1-4644-9656-0e1bb3275bbc</CalculationJobId>
    <CalculationParameters i:type="CalcInputJoin">
      <CalculationName>ResultaatWozWon2012</CalculationName>
      <CellSize>100</CellSize>
      <DataFileName>WozWon2012</DataFileName>
      <InsufficientValue>-9998</InsufficientValue>
      <NoData>-9999</NoData>
      <ObservMin>5</ObservMin>
      <JoinType>Avg</JoinType>
    </CalculationParameters>
    <CalculationResult i:type="CalcResultJoin">
      <BBoxColMax>32</BBoxColMax>
      <BBoxRowMax>20</BBoxRowMax>
      <BBoxXLo>90200</BBoxXLo>
      <BBoxYLo>437700</BBoxYLo>
      <FieldNameCL>C28992R100</FieldNameCL>
      <RMPCharge>320</RMPCharge>
      <Warnings i:nil="true" />
      <ZMax>531.71428571428567</ZMax>
      <ZMin>86.036144578313255</ZMin>
    </CalculationResult>
    <MimeType>application/zip</MimeType>
    <RasterShapeFileData>UEsDBBQAAAAIAM6BRER4PiV80CUAAGRUAQAXACQAU ...</RasterShapeFileData>
  </Resource>
</Response>
                

JSON Response

                    
{
    "Copyright": "Copyright © 2011-2017 Bartels Online. All rights reserved. This API cannot be accessed and the content and any results may not be used, reproduced or transmitted in any manner without express written permission from Bartels Online.",
    "StatusCode": 200,
    "StatusDescription": "OK",
    "ErrorDetails": "",
    "TraceId": "8FF19DAE-A073-40B8-BEF0-51070CAB9E86\/9f4f8b22-7e60-4659-9ec2-fd05c404fe46\/-1447804870",
    "Resource": {
        "__type": "RasterShapeFile:http:\/\/schemas.gisblox.com\/rest\/v1\/gridstatistics",
        "ItemId": 1,
        "CalculationJobId": "ff7aa84e-b3b1-4644-9656-0e1bb3275bbc",
        "CalculationParameters": {
            "__type": "CalcInputJoin:http:\/\/schemas.gisblox.com\/rest\/v1\/gridstatistics",
            "CalculationName": "ResultaatWozWon2012",
            "CellSize": 100,
            "DataFileName": "WozWon2012",
            "InsufficientValue": -9998,
            "NoData": -9999,
            "ObservMin": 5,
            "JoinType": "Avg"
        },
        "CalculationResult": {
            "__type": "CalcResultJoin:http:\/\/schemas.gisblox.com\/rest\/v1\/gridstatistics",
            "BBoxColMax": 32,
            "BBoxRowMax": 20,
            "BBoxXLo": 90200,
            "BBoxYLo": 437700,
            "FieldNameCL": "C28992R100",
            "RMPCharge": 320,
            "Warnings": null,
            "ZMax": 531.71428571428567,
            "ZMin": 86.036144578313255
        },
        "MimeType": "application\/zip",
        "RasterShapeFileData": [80, 75, 3, 4, 20, 0, 0, 0, 8, 0, 224, 129, 68, 68, 120,  ...]
    }
}
                

Rastershapefile

De shapefile wordt in een ZIP-bestand (als byte array) verstuurd. Om het daadwerkelijke ZIP-bestand te genereren, serialiseert u de data in element RasterShapeFileData naar een bestand. Onderstaand voorbeeldcode in C# dat met behulp van de Write-methode van het System.IO.FileStream-object de data in element RasterShapeFileData schrijft naar een bestand:

                    
string bestandsnaam = @"C:\MijnShapeFile.zip";
using (System.IO.FileStream fs = new System.IO.FileStream(bestandsnaam, System.IO.FileMode.Create, System.IO.FileAccess.Write))
{
   byte[] bestandsData = // Methode die de data in element RasterShapeFileData leest	
   fs.Write(bestandsData, 0, bestandsData.Length);
}
                

HTTP-statuscodes

Opmerking
Meer details over deze HTTP-statuscode zijn te vinden in artikel Statuscodes en foutafhandeling.

Na een succesvol verzoek wordt de volgende HTTP-statuscode geretourneerd.

  • 200

Na een niet-succesvol verzoek wordt een van de volgende foutcodes geretourneerd.

  • 400
  • 401
  • 404
  • 500
  • 503

Verwante onderwerpen

Laatst gewijzigd: 2018-10-18