Processes
This page documents the processes available with the default configuration of raven.
Processes for the Raven WPS server.
- class raven.processes.HydroBasinsSelectionProcess[source]
Bases:
Processhydrobasins-select Select a HydroBASINS watershed geometry (v1.1)
Return a watershed from the HydroSheds database as a polygon vector file.
- Parameters:
location (string) – Location coordinates (longitude, latitude) for point of interest.
aggregate_upstream (boolean, optional) – Attempt to capture both the containing basin and all tributary basins from point
- Returns:
feature (application/geo+json) – Geographic representation of shape properties.
upstream_ids (application/json) – List of all tributary sub-basins according to their HydroBASINS IDs, including the downstream basin.
- class raven.processes.NALCMSZonalStatisticsProcess[source]
Bases:
Processnalcms-zonal-stats NALCMS Land Use Zonal Statistics (v1.0)
Return zonal statistics and land-use cover for the CEC NALCMS based on the boundaries of a vector file.
- Parameters:
shape (application/geo+json, application/gml+xml, application/json, application/x-zipped-shp, application/zip) – An ESRI Shapefile, GML, JSON, GeoJSON, or single layer GeoPackage. The ESRI Shapefile must be zipped and contain the .shp, .shx, and .dbf.
raster (image/tiff; subtype=geotiff, optional) – The Land Use raster to be queried. Default is the CEC NALCMS 2010. Provided raster must use the UN FAO Land Cover Classification System (19 types). (Commission for Environmental Cooperation North American Land Change Monitoring System, Latifovic, R., Homer, C., Ressl, R., Pouliot, D., Hossain, S.N., Colditz, R.R.,Olthof, I., Giri, C., Victoria, A., (2012). North American land change monitoring system. In: Giri, C., (Ed), Remote Sensing of Land Use and Land Cover: Principles and Applications, CRC-Press, pp. 303-324)
simple_categories (boolean, optional) – Use simplified land classification categories for hydrological modeling purposes.
band (integer, optional) – Band of raster examined to perform zonal statistics.
select_all_touching (boolean, optional) – Additionally select boundary pixels that are touched by shape.
- Returns:
features (application/geo+json) – Category pixel counts using either standard or simplified UNFAO categories
statistics (application/json) – Land-use type pixel counts using either standard or simplified UNFAO categories.
- class raven.processes.NALCMSZonalStatisticsRasterProcess[source]
Bases:
Processnalcms-zonal-stats-raster NALCMS Land Use Zonal Statistics with raster output (v1.0)
Return zonal statistics, land-use cover, and raster grid for the CEC NALCMS based on the boundaries of a vector file.
- Parameters:
shape (application/geo+json, application/gml+xml, application/json, application/x-zipped-shp, application/zip) – An ESRI Shapefile, GML, JSON, GeoJSON, or single layer GeoPackage. The ESRI Shapefile must be zipped and contain the .shp, .shx, and .dbf.
raster (image/tiff; subtype=geotiff, optional) –
The Land Use raster to be queried. Default is the CEC NALCMS 2010. Provided raster must use the UN FAO Land Cover Classification System (19 types). (Commission for Environmental Cooperation North American Land Change Monitoring System, Latifovic, R., Homer, C., Ressl, R., Pouliot, D., Hossain, S.N., Colditz, R.R.,Olthof, I., Giri, C., Victoria, A., (2012). North American land change monitoring system. In: Giri, C., (Ed), Remote Sensing of Land Use and Land Cover: Principles and Applications, CRC-Press, pp. 303-324)
simple_categories (boolean, optional) – Use simplified land classification categories for hydrological modeling purposes.
band (integer, optional) – Band of raster examined to perform zonal statistics.
select_all_touching (boolean, optional) – Additionally select boundary pixels that are touched by shape.
- Returns:
features (application/geo+json) – Category pixel counts using either standard or simplified UNFAO categories
statistics (application/json) – Land-use type pixel counts using either standard or simplified UNFAO categories.
raster (application/metalink+xml; version=4.0) – Zipped raster grid(s) of land-use using either standard or simplified UNFAO categories.
- class raven.processes.RasterSubsetProcess[source]
Bases:
Processraster-subset Raster Subset (v1.0)
Return a masked raster based on boundaries of a vector file.
- Parameters:
shape (application/geo+json, application/gml+xml, application/json, application/x-zipped-shp, application/zip) – An ESRI Shapefile, GML, JSON, GeoJSON, or single layer GeoPackage. The ESRI Shapefile must be zipped and contain the .shp, .shx, and .dbf.
raster (image/tiff; subtype=geotiff, optional) – The DEM to be queried. Defaults to the EarthEnv-DEM90 product. (EarthEnv-DEM90, Robinson, Natalie, James Regetz, and Robert P. Guralnick (2014). EarthEnv-DEM90: A Nearly-Global, Void-Free, Multi-Scale Smoothed, 90m Digital Elevation Model from Fused ASTER and SRTM Data. ISPRS Journal of Photogrammetry and Remote Sensing 87: 57–67.)
band (integer, optional) – Band of raster examined to perform zonal statistics.
select_all_touching (boolean, optional) – Additionally select boundary pixels that are touched by shape.
- Returns:
raster – Elevation statistics: min, max, mean, median, sum, nodata
- Return type:
application/metalink+xml; version=4.0, image/tiff; subtype=geotiff
- class raven.processes.ShapePropertiesProcess[source]
Bases:
Processshape-properties Shape Properties (v1.0)
Return shape area in square metres based on line boundaries of a polygonal vector file.
- Parameters:
shape (application/gml+xml, application/geo+json, application/x-zipped-shp, application/json, application/zip) – An ESRI Shapefile, GML, GeoPackage, JSON or GeoJSON file. The ESRI Shapefile must be zipped and contain the .shp, .shx, and .dbf.
projected_crs (integer) – Coordinate Reference System for area calculation (Default: EPSG:6622, NAD83(CSRS) / Quebec Lambert)
- Returns:
properties – Geographic representations and descriptions of shape properties: centroid coordinates, area, perimeter and gravelius index.
- Return type:
application/json
- class raven.processes.TerrainAnalysisProcess[source]
Bases:
Processterrain-analysis Terrain Analysis (v1.0)
Return shape area in square metres based on line boundaries of a polygonal vector file.
- Parameters:
raster (image/tiff; subtype=geotiff, optional) –
The DEM to be queried. Defaults to the EarthEnv-DEM90 product. (EarthEnv-DEM90, Robinson, Natalie, James Regetz, and Robert P. Guralnick (2014). EarthEnv-DEM90: A Nearly-Global, Void-Free, Multi-Scale Smoothed, 90m Digital Elevation Model from Fused ASTER and SRTM Data. ISPRS Journal of Photogrammetry and Remote Sensing 87: 57–67.)
shape (application/geo+json, application/gml+xml, application/json, application/x-zipped-shp, application/zip) – An ESRI Shapefile, GML, JSON, GeoJSON, or single layer GeoPackage. The ESRI Shapefile must be zipped and contain the .shp, .shx, and .dbf.
projected_crs (integer) – Coordinate Reference System for terrain analysis (Default: EPSG:6622, ‘NAD83(CSRS) / Quebec Lambert’. The CRS chosen should be projected and appropriate for the region of interest.
select_all_touching (boolean, optional) – Additionally select boundary pixels that are touched by shape.
- Returns:
properties (application/json) – DEM properties (mean elevation, slope, and aspect) for each geometry.
dem (image/tiff; subtype=geotiff, application/metalink+xml; version=4.0) – DEM GeoTIFF image
- class raven.processes.ZonalStatisticsProcess[source]
Bases:
Processzonal-stats Raster Zonal Statistics (v1.0)
Return zonal statistics based on the boundaries of a vector file.
- Parameters:
shape (application/geo+json, application/gml+xml, application/json, application/x-zipped-shp, application/zip) – An ESRI Shapefile, GML, JSON, GeoJSON, or single layer GeoPackage. The ESRI Shapefile must be zipped and contain the .shp, .shx, and .dbf.
raster (image/tiff; subtype=geotiff, optional) –
The DEM to be queried. Defaults to the EarthEnv-DEM90 product. (EarthEnv-DEM90, Robinson, Natalie, James Regetz, and Robert P. Guralnick (2014). EarthEnv-DEM90: A Nearly-Global, Void-Free, Multi-Scale Smoothed, 90m Digital Elevation Model from Fused ASTER and SRTM Data. ISPRS Journal of Photogrammetry and Remote Sensing 87: 57–67.)
band (integer, optional) – Band of raster examined to perform zonal statistics.
categorical (boolean) – Return distinct pixel categories
select_all_touching (boolean, optional) – Additionally select boundary pixels that are touched by shape.
- Returns:
statistics – Land-use type pixel counts using either standard or simplified UNFAO categories.
- Return type:
application/json