Changes between Version 45 and Version 46 of PostGIS_Raster_SoC_Idea_2012/Distance_Analysis_Tools/document

Timestamp:

Aug 20, 2012, 10:51:54 AM (12 years ago)

Author:

qliu

Comment:

—

PostGIS_Raster_SoC_Idea_2012/Distance_Analysis_Tools/document

@@ -26 +26 @@
 '''Name'''
 ST_EuclideanDistance - One raster, One band version:
- Create a new one band raster generated from a point coverage and aligned with the provided reference raster or with raster specifications. The pixel values in the new raster represent the Euclidean distance from each pixel to the source points.
+ Creates a new one band raster generated from a point coverage and aligned with the provided reference raster or with raster specifications. The pixel values in the new raster represent the Euclidean distance from each pixel to the source points.
 
 '''Synopsis'''
@@ -40 +40 @@
  Source points are passed in by the database schema, table name and the geometry column name of the point coverage.
  It is assumed that both the input reference raster and the output new raster has only 1 band.
- If pixeltype is passed in, then the new raster will have a bond of that pixel type. If pixeltype is passed NULL, then the new raster band will have the same pixel type as the reference raster band. 
+ If pixeltype is passed in, then the new raster will have a band of that pixel type. If pixeltype is passed NULL, then the new raster band will have the same pixel type as the reference raster band. 
  In the reference raster variant, it will use the same nodatavalue as the reference raster. In the raster specifications variant where no reference raster is provided, both nodatavalue and pixeltype have to be passed in with a NOT NULL value. 
 
-
+----
 === Objectives ===
 
@@ -239 +239 @@
 == Creating a Cost-weighted Distance Raster in PostGIS Raster ==
 [[BR]][[BR]]
+
+=== ST_CostDistance ===
+
+'''Name'''
+ST_CostDistance - One raster, One band version:
+ Creates a new one band raster generated from a point coverage and a one band cost raster, and aligned with the provided reference raster or with raster specifications. The pixel values in the new raster represent the least accumulative cost of traversing the cost surface from source points to each cell.
+
+'''Synopsis'''
+[[BR]]
+ ST_CostDistance(refrast raster,pixeltype text,costrast raster,sourceschema text,sourcetable text,sourcegeomcolumn text,double precision = -1);
+
+ ST_CostDistance(width integer,height integer,rastulx float8,rastuly float8,rastscalex float8,rastscaley float8,rastskewx float8,rastskewy float8,rastsrid integer,rastndv float8,pixeltype text,costrast raster,sourceschema text,sourcetable text,sourcegeomcolumn text,double precision = -1);
+[[BR]]
+
+'''Description'''
+[[BR]]
+ Create a new one band raster generated from a point coverage as source points and a one band raster as the cost surface. Pixel values in the output raster represent the least accumulative cost of traversing the cost surface from source points to each cell. A reference raster will be provided, otherwise the raster specifications are provided. The new raster will have the same georeference, width and height as the reference raster or the raster specifications.
+ Source points are passed in by the database schema, table name and the geometry column name of the point coverage.
+ It is assumed that the input reference raster, cost raster and the output new raster has only 1 band.
+ If pixeltype is passed in, then the new raster will have a band of that pixel type. If pixeltype is passed NULL, then the new raster band will have the same pixel type as the reference raster band. 
+ In the reference raster variant, it will use the same nodatavalue as the reference raster. In the raster specifications variant where no reference raster is provided, both nodatavalue and pixeltype have to be passed in with a NOT NULL value.
+ If the source point coverage is out of the cost raster extent, a one band new raster will be returned with nodatavalue as pixel values. For this version, it is assumed that cost raster is not a tiled raster coverage but a only one band one raster. Thus, any source points that are out side of the cost raster extent will have not cost surface to travel through and consequently have nodatavalue as pixel value for the new output cost distance raster.
+
+----
 === Objectives ===