Changes between Version 148 and Version 149 of WKTRaster/SpecificationWorking03

Timestamp:

07/14/11 16:05:25 (2 years ago)

Author:

dustymugs

Comment:

ST_Resample, ST_Rescale, ST_Reskew, ST_SnapToGrid

WKTRaster/SpecificationWorking03

@@ -401 +401 @@
 '''ST_ValuePercent(raster, value) -> double precision - done see below'''
 
-'''ST_Resample(raster, method, originx, originy, pixelsizex, pixelsizey) -> raster'''
-
- * Implemented as a wrapper around GDAL like done for ST_DumpAsPolygons()
- * Resampling methods are the same as the one priovided by GDAL
-
- '''Variants'''
-
- * The '''first series of variants''' only change the pixelsize of the raster.
-
- 1) ST_Resample(raster, pixelsize) - modify pixelsize only and resample using the default method
-
- 2) ST_Resample(raster, method, pixelsize) - modify pixelsize and resample using the specified method
-
- 3) ST_Resample(raster, pixelsizex, pixelsizey) - modify pixelsize with different values for x and y using the default method
-
- 4) ST_Resample(raster, method, pixelsizex, pixelsizey) - modify pixelsize with different values for x and y using the specified method
-
- * The '''second series of variants''' realign the raster and change the pixelsize
-
- 5) ST_Resample(raster, x, y, pixelsize) - realign and modify pixelsize using the default method
-
- 6) ST_Resample(raster, method, x, y, pixelsize) - realign and modify pixelsize using the specified method
-
- 7) ST_Resample(raster, x, y, pixelsizex, pixelsizey) - realign and modify pixelsize with different values for x and y using the default method
-
- 8) ST_Resample(raster, method, x, y, pixelsizex, pixelsizey) - realign and modify pixelsize with different values for x and y using the specified method
-
- 9) ST_Resample(raster, x, y, pixelsizex, pixelsizey, skewx, skewy) - realign and modify pixelsize and skew with different values for x and y using the default method
-
- 10) ST_Resample(raster, method, x, y, pixelsizex, pixelsizey, skewx, skewy) - realign and modify pixelsize and skew with different values for x and y using the specified method
-
- * The '''third series of variants''' align and resample the raster to match the alignment, pixelsize and skew of an existing raster.
- 
- 11) ST_Resample(destraster, sourceraster)
-
- '''Questions'''
-
- * Should there be a band parameter?
- * How does GDAL allow resampling?
- * Which methods GDAL supports? ArcGIS supports NEAREST | BILINEAR | CUBIC | MAJORITY
- * Does GDAL support change in skew?
+'''ST_Resample(raster, method, originx, originy, pixelsizex, pixelsizey) -> raster - done see below'''
 
 '''ST_SelectByValue(raster, 'expression') -> same type as first argument'''
@@ -2746 +2706 @@
 ST_Transform enables the end-user to reproject a raster to a new projection.  Unlike the ST_Transform function for geometries, ST_Transform for rasters depends upon the specificiation of a resampling algorithm and an error tolerance.  In addition, reprojecting a raster will probably change the scale of the pixels.  Therefore, ST_Transform for rasters can be more involved than the ST_Transform for geometries.
 
+''If a skewed raster is provided to ST_Transform, the output raster will be deskewed (zero skew in X and Y axes thus "north up").  To preserve the skew, use ST_Resample.''
+
 1. ST_Transform(rast raster, srid integer, algorithm text DEFAULT '!NearestNeighbour', maxerr double precision DEFAULT 0.125, scalex double precision DEFAULT 0, scaley double precision DEFAULT 0)
 
@@ -3241 +3203 @@
 
     nband is assumed to be 1. roundto is assumed to be 0, so no rounding takes place. exclude_nodata_value is assumed to be TRUE.
+
+----
+
+'''ST_Resample(raster, method, originx, originy, pixelsizex, pixelsizey) -> raster'''
+
+ST_Resample is the main function underlying the ST_Transform, ST_Rescale, ST_Reskew and ST_SnapToGrid functions.  ST_Resample provides the ability to change a raster's projection, adjust the scale of the raster within its extent, change the skew (or deskew) and "dissolve" the raster to a grid.
+
+''If a skewed raster is provided to ST_Resample and skewx and/or skewy are not provided, the output raster will be deskewed (zero skew in X and Y axes thus "north up")''
+
+1. ST_Resample(
+        rast raster,
+        srid integer DEFAULT NULL,
+        scalex double precision DEFAULT 0, scaley double precision DEFAULT 0,
+        gridx double precision DEFAULT NULL, gridy double precision DEFAULT NULL,
+        skewx double precision DEFAULT 0, skewy double precision DEFAULT 0,
+        algorithm text DEFAULT 'NearestNeighbour', maxerr double precision DEFAULT 0.125
+) -> raster
+
+  srid: the SRID that the function will use to reproject the raster to.  If NULL, the raster's SRID will be used.
+
+  scalex: the scale/pixel size in the X axis of the resampled raster.  If scalex and scaley are zero (0), the resampled raster's scale will be autocomputed.  If provided, scaley must also be provided.
+
+  scaley: the scale/pixel size in the Y axis of the resampled raster.  If scalex and scaley are zero (0), the resampled raster's scale will be autocomputed.  If provided, scalex must also be provided.
+
+  gridx: the X coordinate of a point on the grid to which the raster will be aligned.  Value is in the resampled raster's world coordinates.  If provided, gridy must also be provided.
+
+  gridy: the Y coordinate of a point on the grid to which the raster will be aligned.  Value is in the resampled raster's world coordinates.  If provided, gridx must also be provided.
+
+  skewx: the skew along the X axis of the resampled raster.  If skewx and skewy are zero (0), the resampled raster will be "north up".
+
+  skewy: the skew along the Y axis of the resampled raster.  If skewx and skewy are zero (0), the resampled raster will be "north up".
+
+  algorithm: the algorithm to use when resampling the raster. default is 'NearestNeighbour'. possible algorithms are:
+
+{{{
+NearestNeighbour (default.  fastest performance but worst interpolation)
+
+NearestNeighbor (for those wanting to use the American spelling)
+
+Bilinear
+
+Cubic
+
+CubicSpline
+
+Lanczos
+}}}
+
+  maxerr: the threshold for approximation by the resampling algorithm (in pixel units). default is 0.125, which is the same value used in GDAL gdalwarp utility. if set to zero, no approximation takes place. 
+
+2. ST_Resample(
+        rast raster,
+        ref raster,
+        algorithm text DEFAULT 'NearestNeighbour', maxerr double precision DEFAULT 0.125
+) -> raster
+
+  ref: the reference raster to which rast will copy the scalex, scaley, skewx, skewy and srid.  In addition, the upperleft corner of ref will be used as a grid point to align rast.
+
+----
+
+'''ST_Rescale(raster, scalex, scaley) -> raster'''
+
+ST_Rescale is a focused function of ST_Resample for changing the X and Y scale without affecting the extent of the raster.
+
+''If a skewed raster is provided to ST_Rescale, the output raster will be deskewed (zero skew in X and Y axes thus "north up").  To preserve the skew, use ST_Resample.''
+
+1. ST_Rescale(rast raster, scalex double precision, scaley double precision, algorithm text DEFAULT 'NearestNeighbour', maxerr double precision DEFAULT 0.125) -> raster
+
+  scalex: the scale/pixel size in the X axis of the resampled raster
+
+  scaley: the scale/pixel size in the Y axis of the resampled raster
+
+2. ST_Rescale(rast raster, scalexy double precision, algorithm text DEFAULT 'NearestNeighbour', maxerr double precision DEFAULT 0.125) -> raster
+
+  scalexy: the scale/pixel size in the X and Y axes of the resampled raster.
+
+----
+
+'''ST_Reskew(raster, skewx, skewy) -> raster'''
+
+ST_Reskew is a focused function of ST_Resample for changing the skew along the X and Y axes.
+
+1. ST_Reskew(rast raster, skewx double precision, skewy double precision, algorithm text DEFAULT 'NearestNeighbour', maxerr double precision DEFAULT 0.125) -> raster
+
+  skewx: the skew along the X axis of the resampled raster.  If skewx and skewy are zero (0), the resampled raster will be "north up".
+
+  skewy: the skew along the Y axis of the resampled raster.  If skewx and skewy are zero (0), the resampled raster will be "north up".
+
+2. ST_Reskew(rast raster, skewxy double precision, algorithm text DEFAULT 'NearestNeighbour', maxerr double precision DEFAULT 0.125) -> raster
+
+  skewxy: the skew along both X and Y axes of the resampled raster.  If skewxy is zero (0), the resampled raster will be "north up".
+
+----
+
+'''ST_SnapToGrid(raster, gridx, gridy)'''
+
+ST_SnapToGrid provides the ability to align a raster to grid (possibly that of a coverage).  The returned raster has its upper-left corner placed at the closest valid grid point to the source raster's upper-left corner without losing a data.  The same is done for the lower-right corner.
+
+''If a skewed raster is provided to ST_SnapToGrid, the output raster will be deskewed (zero skew in X and Y axes thus "north up").  To preserve the skew, use ST_Resample.''
+
+1. ST_SnapToGrid(
+        rast raster,
+        gridx double precision, gridy double precision,
+        algorithm text DEFAULT 'NearestNeighbour', maxerr double precision DEFAULT 0.125,
+        scalex double precision DEFAULT 0, scaley double precision DEFAULT 0
+) -> raster
+
+  gridx: the X coordinate of a point on the grid to which the raster will be aligned.  Value is in the raster's world coordinates.
+
+  gridy: the Y coordinate of a point on the grid to which the raster will be aligned.  Value is in the raster's world coordinates.
+
+  scalex: the scale/pixel size in the X axis of the resampled raster.  This is also the scale of the grid to which the raster is being "snapped".  If provided, scaley must be provided.  If scalex and scaley are zero, the input raster's scale will be used.
+
+  scaley: the scale/pixel size in the Y axis of the resampled raster.  This is also the scale of the grid to which the raster is being "snapped"  If provided, scalex must be provided.  If scalex and scaley are zero, the input raster's scale will be used.
+
+2. ST_SnapToGrid(
+        rast raster,
+        gridx double precision, gridy double precision,
+        scalex double precision, scaley double precision,
+        algorithm text DEFAULT 'NearestNeighbour', maxerr double precision DEFAULT 0.125
+) -> raster
+
+3. ST_SnapToGrid(
+        rast raster,
+        gridx double precision, gridy double precision,
+        scalexy double precision,
+        algorithm text DEFAULT 'NearestNeighbour', maxerr double precision DEFAULT 0.125
+) -> raster
+
+  scalexy: the scale/pixel size in the X and Y axes of the resampled raster.
+
+~~ * Implemented as a wrapper around GDAL like done for ST_DumpAsPolygons()~~
+~~ * Resampling methods are the same as the one priovided by GDAL~~
+
+~~ '''Variants'''~~
+
+~~ * The '''first series of variants''' only change the pixelsize of the raster.~~
+
+~~ 1) ST_Resample(raster, pixelsize) - modify pixelsize only and resample using the default method~~
+
+~~ 2) ST_Resample(raster, method, pixelsize) - modify pixelsize and resample using the specified method~~
+
+~~ 3) ST_Resample(raster, pixelsizex, pixelsizey) - modify pixelsize with different values for x and y using the default method~~
+
+~~ 4) ST_Resample(raster, method, pixelsizex, pixelsizey) - modify pixelsize with different values for x and y using the specified method~~
+
+~~ * The '''second series of variants''' realign the raster and change the pixelsize~~
+
+~~ 5) ST_Resample(raster, x, y, pixelsize) - realign and modify pixelsize using the default method~~
+
+~~ 6) ST_Resample(raster, method, x, y, pixelsize) - realign and modify pixelsize using the specified method~~
+
+~~ 7) ST_Resample(raster, x, y, pixelsizex, pixelsizey) - realign and modify pixelsize with different values for x and y using the default method~~
+
+~~ 8) ST_Resample(raster, method, x, y, pixelsizex, pixelsizey) - realign and modify pixelsize with different values for x and y using the specified method~~
+
+~~ 9) ST_Resample(raster, x, y, pixelsizex, pixelsizey, skewx, skewy) - realign and modify pixelsize and skew with different values for x and y using the default method~~
+
+~~ 10) ST_Resample(raster, method, x, y, pixelsizex, pixelsizey, skewx, skewy) - realign and modify pixelsize and skew with different values for x and y using the specified method~~
+
+~~ * The '''third series of variants''' align and resample the raster to match the alignment, pixelsize and skew of an existing raster.~~
+ 
+~~ 11) ST_Resample(destraster, sourceraster)~~
+
+~~ '''Questions'''~~
+
+~~ * Should there be a band parameter?~~
+
+~~ * How does GDAL allow resampling?~~
+
+~~ * Which methods GDAL supports? ArcGIS supports NEAREST | BILINEAR | CUBIC | MAJORITY~~
+
+~~ * Does GDAL support change in skew?~~
+