PostGIS  2.5.0dev-r@@SVN_REVISION@@
librtcore.h
Go to the documentation of this file.
1 /*
2  *
3  * WKTRaster - Raster Types for PostGIS
4  * http://trac.osgeo.org/postgis/wiki/WKTRaster
5  *
6  * Copyright (C) 2011-2013 Regents of the University of California
7  * <bkpark@ucdavis.edu>
8  * Copyright (C) 2010-2011 Jorge Arevalo <jorge.arevalo@deimos-space.com>
9  * Copyright (C) 2010-2011 David Zwarg <dzwarg@azavea.com>
10  * Copyright (C) 2009-2011 Pierre Racine <pierre.racine@sbf.ulaval.ca>
11  * Copyright (C) 2009-2011 Mateusz Loskot <mateusz@loskot.net>
12  * Copyright (C) 2008-2009 Sandro Santilli <strk@kbt.io>
13  * Copyright (C) 2013 Nathaneil Hunter Clay <clay.nathaniel@gmail.com
14  *
15  * This program is free software; you can redistribute it and/or
16  * modify it under the terms of the GNU General Public License
17  * as published by the Free Software Foundation; either version 2
18  * of the License, or (at your option) any later version.
19  *
20  * This program is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23  * GNU General Public License for more details.
24  *
25  * You should have received a copy of the GNU General Public License
26  * along with this program; if not, write to the Free Software Foundation,
27  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
28  *
29  */
30 
48 /******************************************************************************
49 * Some rules for *.(c|h) files in rt_core
50 *
51 * All functions in rt_core that receive a band index parameter
52 * must be 0-based
53 *
54 * Variables and functions internal for a public function should be prefixed
55 * with _rti_, e.g. _rti_iterator_arg.
56 ******************************************************************************/
57 
58 #ifndef LIBRTCORE_H_INCLUDED
59 #define LIBRTCORE_H_INCLUDED
60 
61 /* define the systems */
62 #if defined(__linux__) /* (predefined) */
63 #if !defined(LINUX)
64 #define LINUX
65 #endif
66 #if !defined(UNIX)
67 #define UNIX /* make sure this is defined */
68 #endif
69 #endif
70 
71 
72 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__OpenBSD__) /* seems to work like Linux... */
73 #if !defined(LINUX)
74 #define LINUX
75 #endif
76 #if !defined(UNIX)
77 #define UNIX /* make sure this is defined */
78 #endif
79 #endif
80 
81 #if defined(__GNU__) /* GNU/Hurd is also like Linux */
82 #if !defined(LINUX)
83 #define LINUX
84 #endif
85 #if !defined(UNIX)
86 #define UNIX /* make sure this is defined */
87 #endif
88 #endif
89 
90 #if defined(__MSDOS__)
91 #if !defined(MSDOS)
92 #define MSDOS /* make sure this is defined */
93 #endif
94 #endif
95 
96 #if defined(__WIN32__) || defined(__NT__) || defined(_WIN32)
97 #if !defined(WIN32)
98 #define WIN32
99 #endif
100 #if defined(__BORLANDC__) && defined(MSDOS) /* Borland always defines MSDOS */
101 #undef MSDOS
102 #endif
103 #endif
104 
105 #if defined(__APPLE__)
106 #if !defined(UNIX)
107 #define UNIX
108 #endif
109 #endif
110 
111 #if defined(sun) || defined(__sun)
112 #if !defined(UNIX)
113 #define UNIX
114 #endif
115 #endif
116 
117 #include <stdio.h> /* for printf, sprintf */
118 #include <stdlib.h> /* For size_t, srand and rand */
119 #include <stdint.h> /* For C99 int types */
120 #include <string.h> /* for memcpy, strlen, etc */
121 #include <float.h> /* for FLT_EPSILON, DBL_EPSILON and float type limits */
122 #include <limits.h> /* for integer type limits */
123 
124 #include "liblwgeom.h"
125 
126 #include "gdal_alg.h"
127 #include "gdal_frmts.h"
128 #include "gdal.h"
129 #include "gdalwarper.h"
130 #include "cpl_vsi.h"
131 #include "cpl_conv.h"
132 #include "ogr_api.h"
133 #include "ogr_srs_api.h"
134 
135 #include "../../postgis_config.h"
136 #include "../raster_config.h"
137 
138 #ifndef __GNUC__
139 # define __attribute__ (x)
140 #endif
141 
145 typedef struct rt_raster_t* rt_raster;
146 typedef struct rt_band_t* rt_band;
147 typedef struct rt_pixel_t* rt_pixel;
148 typedef struct rt_mask_t* rt_mask;
149 typedef struct rt_geomval_t* rt_geomval;
150 typedef struct rt_bandstats_t* rt_bandstats;
151 typedef struct rt_histogram_t* rt_histogram;
152 typedef struct rt_quantile_t* rt_quantile;
156 
157 typedef struct rt_iterator_t* rt_iterator;
159 
161 typedef struct rt_colormap_t* rt_colormap;
162 
163 /* envelope information */
164 typedef struct {
165  double MinX;
166  double MaxX;
167  double MinY;
168  double MaxY;
169 
170  double UpperLeftX;
171  double UpperLeftY;
172 } rt_envelope;
173 
178 /* function return error states */
179 typedef enum {
180  ES_NONE = 0, /* no error */
181  ES_ERROR = 1 /* generic error */
182 } rt_errorstate;
183 
184 /* Pixel types */
185 typedef enum {
186  PT_1BB=0, /* 1-bit boolean */
187  PT_2BUI=1, /* 2-bit unsigned integer */
188  PT_4BUI=2, /* 4-bit unsigned integer */
189  PT_8BSI=3, /* 8-bit signed integer */
190  PT_8BUI=4, /* 8-bit unsigned integer */
191  PT_16BSI=5, /* 16-bit signed integer */
192  PT_16BUI=6, /* 16-bit unsigned integer */
193  PT_32BSI=7, /* 32-bit signed integer */
194  PT_32BUI=8, /* 32-bit unsigned integer */
195  PT_32BF=10, /* 32-bit float */
196  PT_64BF=11, /* 64-bit float */
198 } rt_pixtype;
199 
200 typedef enum {
207 } rt_extenttype;
208 
217 typedef enum {
225 
229 typedef void* (*rt_allocator)(size_t size);
230 typedef void* (*rt_reallocator)(void *mem, size_t size);
231 typedef void (*rt_deallocator)(void *mem);
232 typedef void (*rt_message_handler)(const char* string, va_list ap)
233  __attribute__ (( format(printf,1,0) ));
234 
235 /*******************************************************************
236  * Functions that may be used by the raster core function's caller
237  * (for example: rt_pg functions, test functions, future loader/exporter)
238  *******************************************************************/
242 extern void rt_install_default_allocators(void);
243 
244 
249 extern void* rtalloc(size_t size);
250 extern void* rtrealloc(void* mem, size_t size);
251 extern void rtdealloc(void* mem);
252 
253 /******************************************************************/
254 
255 
259 void rterror(const char *fmt, ...);
260 void rtinfo(const char *fmt, ...);
261 void rtwarn(const char *fmt, ...);
262 
263 
267 void * default_rt_allocator(size_t size);
268 void * default_rt_reallocator(void * mem, size_t size);
269 void default_rt_deallocator(void * mem);
270 void default_rt_error_handler(const char * fmt, va_list ap);
271 void default_rt_warning_handler(const char * fmt, va_list ap);
272 void default_rt_info_handler(const char * fmt, va_list ap);
273 
274 
275 /* Debugging macros */
276 #if POSTGIS_DEBUG_LEVEL > 0
277 
278 /* Display a simple message at NOTICE level */
279 #define RASTER_DEBUG(level, msg) \
280  do { \
281  if (POSTGIS_DEBUG_LEVEL >= level) \
282  rtinfo("[%s:%s:%d] " msg, __FILE__, __func__, __LINE__); \
283  } while (0);
284 
285 /* Display a formatted message at NOTICE level (like printf, with variadic arguments) */
286 #define RASTER_DEBUGF(level, msg, ...) \
287  do { \
288  if (POSTGIS_DEBUG_LEVEL >= level) \
289  rtinfo("[%s:%s:%d] " msg, __FILE__, __func__, __LINE__, __VA_ARGS__); \
290  } while (0);
291 
292 #else
293 
294 /* Empty prototype that can be optimised away by the compiler for non-debug builds */
295 #define RASTER_DEBUG(level, msg) \
296  ((void) 0)
297 
298 /* Empty prototype that can be optimised away by the compiler for non-debug builds */
299 #define RASTER_DEBUGF(level, msg, ...) \
300  ((void) 0)
301 
302 #endif
303 
304 /*- memory context -------------------------------------------------------*/
305 
306 void rt_set_handlers(rt_allocator allocator, rt_reallocator reallocator,
307  rt_deallocator deallocator, rt_message_handler error_handler,
308  rt_message_handler info_handler, rt_message_handler warning_handler);
309 
310 
311 
312 /*- rt_pixtype --------------------------------------------------------*/
313 
321 int rt_pixtype_size(rt_pixtype pixtype);
322 
332 int rt_pixtype_alignment(rt_pixtype pixtype);
333 
334 /* Return human-readable name of pixel type */
335 const char* rt_pixtype_name(rt_pixtype pixtype);
336 
337 /* Return pixel type index from human-readable name */
338 rt_pixtype rt_pixtype_index_from_name(const char* pixname);
339 
347 double rt_pixtype_get_min_value(rt_pixtype pixtype);
348 
360  rt_pixtype pixtype,
361  double val, double refval,
362  int *isequal
363 );
364 
365 /*- rt_pixel ----------------------------------------------------------*/
366 
367 /*
368  * Convert an array of rt_pixel objects to two 2D arrays of value and NODATA.
369  * The dimensions of the returned 2D array are [Y][X], going by row Y and
370  * then column X.
371  *
372  * @param npixel : array of rt_pixel objects
373  * @param count : number of elements in npixel
374  * @param mask : mask to be respected when returning array
375  * @param x : the column of the center pixel (0-based)
376  * @param y : the line of the center pixel (0-based)
377  * @param distancex : the number of pixels around the specified pixel
378  * along the X axis
379  * @param distancey : the number of pixels around the specified pixel
380  * along the Y axis
381  * @param value : pointer to pointer for 2D value array
382  * @param nodata : pointer to pointer for 2D NODATA array
383  * @param dimx : size of value and nodata along the X axis
384  * @param dimy : size of value and nodata along the Y axis
385  *
386  * @return ES_NONE on success, ES_ERROR on error
387  */
389  rt_pixel npixel,uint32_t count,
390  rt_mask mask,
391  int x, int y,
392  uint16_t distancex, uint16_t distancey,
393  double ***value,
394  int ***nodata,
395  int *dimx, int *dimy
396 );
397 
398 /*- rt_band ----------------------------------------------------------*/
399 
420 rt_band rt_band_new_inline(
421  uint16_t width, uint16_t height,
422  rt_pixtype pixtype,
423  uint32_t hasnodata, double nodataval,
424  uint8_t* data
425 );
426 
446 rt_band rt_band_new_offline(
447  uint16_t width, uint16_t height,
448  rt_pixtype pixtype,
449  uint32_t hasnodata, double nodataval,
450  uint8_t bandNum, const char* path
451 );
452 
463 rt_band rt_band_duplicate(rt_band band);
464 
474 int rt_band_is_offline(rt_band band);
475 
484 const char* rt_band_get_ext_path(rt_band band);
485 
496 
505 
513 uint16_t rt_band_get_width(rt_band band);
514 
522 uint16_t rt_band_get_height(rt_band band);
523 
533 int rt_band_get_ownsdata_flag(rt_band band);
534 
535 /* set ownsdata flag */
536 void rt_band_set_ownsdata_flag(rt_band band, int flag);
537 
545 void* rt_band_get_data(rt_band band);
546 
557 
563 void rt_band_destroy(rt_band band);
564 
572 int rt_band_get_hasnodata_flag(rt_band band);
573 
579 void rt_band_set_hasnodata_flag(rt_band band, int flag);
580 
589 rt_errorstate rt_band_set_isnodata_flag(rt_band band, int flag);
590 
598 int rt_band_get_isnodata_flag(rt_band band);
599 
610 rt_errorstate rt_band_set_nodata(rt_band band, double val, int *converted);
611 
620 rt_errorstate rt_band_get_nodata(rt_band band, double *nodata);
621 
642  rt_band band,
643  int x, int y,
644  void *vals, uint32_t len
645 );
646 
659  rt_band band,
660  int x, int y,
661  double val,
662  int *converted
663 );
664 
686  rt_band band,
687  int x, int y,
688  uint16_t len,
689  void **vals, uint16_t *nvals
690 );
691 
705  rt_band band,
706  int x, int y,
707  double *value,
708  int *nodata
709 );
710 
729  rt_band band,
730  int x, int y,
731  uint16_t distancex, uint16_t distancey,
732  int exclude_nodata_value,
733  rt_pixel *npixels
734 );
735 
748  rt_band band, int exclude_nodata_value,
749  double *searchset, int searchcount,
750  rt_pixel *pixels
751 );
752 
760 double rt_band_get_min_value(rt_band band);
761 
769 int rt_band_check_is_nodata(rt_band band);
770 
781 int rt_band_clamped_value_is_nodata(rt_band band, double val);
782 
797  rt_band band,
798  double val,
799  double *newval, int *corrected
800 );
801 
815 rt_bandstats rt_band_get_summary_stats(
816  rt_band band,
817  int exclude_nodata_value, double sample, int inc_vals,
818  uint64_t *cK, double *cM, double *cQ
819 );
820 
839 rt_histogram rt_band_get_histogram(
840  rt_bandstats stats,
841  uint32_t bin_count, double *bin_widths, uint32_t bin_widths_count,
842  int right, double min, double max,
843  uint32_t *rtn_count
844 );
845 
857 rt_quantile rt_band_get_quantiles(rt_bandstats stats,
858  double *quantiles, int quantiles_count, uint32_t *rtn_count);
859 
860 struct quantile_llist;
862  struct quantile_llist **list,
863  uint32_t list_count
864 );
865 
893 rt_quantile rt_band_get_quantiles_stream(
894  rt_band band,
895  int exclude_nodata_value, double sample,
896  uint64_t cov_count,
897  struct quantile_llist **qlls, uint32_t *qlls_count,
898  double *quantiles, uint32_t quantiles_count,
899  uint32_t *rtn_count
900 );
901 
916 rt_valuecount rt_band_get_value_count(
917  rt_band band, int exclude_nodata_value,
918  double *search_values, uint32_t search_values_count, double roundto,
919  uint32_t *rtn_total, uint32_t *rtn_count
920 );
921 
934 rt_band rt_band_reclass(
935  rt_band srcband, rt_pixtype pixtype,
936  uint32_t hasnodata, double nodataval,
937  rt_reclassexpr *exprset, int exprcount
938 );
939 
940 /*- rt_raster --------------------------------------------------------*/
941 
953 rt_raster rt_raster_new(uint32_t width, uint32_t height);
954 
965 rt_raster rt_raster_from_wkb(const uint8_t* wkb, uint32_t wkbsize);
966 
977 rt_raster rt_raster_from_hexwkb(const char* hexwkb, uint32_t hexwkbsize);
978 
988 uint8_t *rt_raster_to_wkb(rt_raster raster, int outasin, uint32_t *wkbsize);
989 
1000 char *rt_raster_to_hexwkb(rt_raster raster, int outasin, uint32_t *hexwkbsize);
1001 
1012 void rt_raster_destroy(rt_raster raster);
1013 
1014 /* Get number of bands */
1015 uint16_t rt_raster_get_num_bands(rt_raster raster);
1016 
1025 rt_band rt_raster_get_band(rt_raster raster, int bandNum);
1026 
1027 /* Get number of rows */
1028 uint16_t rt_raster_get_width(rt_raster raster);
1029 
1030 /* Get number of columns */
1031 uint16_t rt_raster_get_height(rt_raster raster);
1032 
1043 int rt_raster_add_band(rt_raster raster, rt_band band, int index);
1044 
1058  rt_raster raster,
1059  rt_pixtype pixtype,
1060  double initialvalue,
1061  uint32_t hasnodata, double nodatavalue,
1062  int index
1063 );
1064 
1074 void rt_raster_set_scale(rt_raster raster,
1075  double scaleX, double scaleY);
1076 
1084 double rt_raster_get_x_scale(rt_raster raster);
1085 
1093 double rt_raster_get_y_scale(rt_raster raster);
1094 
1104 void rt_raster_set_offsets(rt_raster raster,
1105  double x, double y);
1106 
1115 double rt_raster_get_x_offset(rt_raster raster);
1116 
1125 double rt_raster_get_y_offset(rt_raster raster);
1126 
1134 void rt_raster_set_skews(rt_raster raster,
1135  double skewX, double skewY);
1136 
1143 double rt_raster_get_x_skew(rt_raster raster);
1144 
1151 double rt_raster_get_y_skew(rt_raster raster);
1152 
1165 void rt_raster_get_phys_params(rt_raster rast,
1166  double *i_mag, double *j_mag, double *theta_i, double *theta_ij) ;
1167 
1183 void rt_raster_set_phys_params(rt_raster rast,
1184  double i_mag, double j_mag, double theta_i, double theta_ij) ;
1185 
1186 
1202 void rt_raster_calc_phys_params(double xscale,
1203  double xskew, double yskew, double yscale,
1204  double *i_mag, double *j_mag, double *theta_i, double *theta_ij) ;
1205 
1206 
1223 int rt_raster_calc_gt_coeff(double i_mag,
1224  double j_mag, double theta_i, double theta_ij,
1225  double *xscale, double *xskew, double *yskew, double *yscale) ;
1226 
1233 void rt_raster_set_srid(rt_raster raster, int32_t srid);
1234 
1241 int32_t rt_raster_get_srid(rt_raster raster);
1242 
1253  rt_raster raster,
1254  double *gt, double *igt
1255 );
1256 
1264  double *gt);
1265 
1274  double *gt);
1275 
1289  rt_raster raster,
1290  double xr, double yr,
1291  double* xw, double* yw,
1292  double *gt
1293 );
1294 
1308  rt_raster raster,
1309  double xw, double yw,
1310  double *xr, double *yr,
1311  double *igt
1312 );
1313 
1327 
1339 
1349 
1364  rt_raster raster, int nband,
1365  LWGEOM **perimeter
1366 );
1367 
1368 /*
1369  * Compute skewed extent that covers unskewed extent.
1370  *
1371  * @param envelope : unskewed extent of type rt_envelope
1372  * @param skew : pointer to 2-element array (x, y) of skew
1373  * @param scale : pointer to 2-element array (x, y) of scale
1374  * @param tolerance : value between 0 and 1 where the smaller the tolerance
1375  * results in an extent approaching the "minimum" skewed extent.
1376  * If value <= 0, tolerance = 0.1. If value > 1, tolerance = 1.
1377  *
1378  * @return skewed raster who's extent covers unskewed extent, NULL on error
1379  */
1380 rt_raster
1382  rt_envelope extent,
1383  double *skew,
1384  double *scale,
1385  double tolerance
1386 );
1387 
1402 LWPOLY* rt_raster_pixel_as_polygon(rt_raster raster, int x, int y);
1403 
1417 rt_errorstate rt_raster_surface(rt_raster raster, int nband, LWMPOLY **surface);
1418 
1436 rt_geomval
1438  rt_raster raster, int nband,
1439  int exclude_nodata_value,
1440  int * pnElements
1441 );
1442 
1449 void* rt_raster_serialize(rt_raster raster);
1450 
1459 rt_raster rt_raster_deserialize(void* serialized, int header_only);
1460 
1468 int rt_raster_is_empty(rt_raster raster);
1469 
1478 int rt_raster_has_band(rt_raster raster, int nband);
1479 
1495  rt_raster torast, rt_raster fromrast,
1496  int fromindex, int toindex
1497 );
1498 
1510 rt_raster rt_raster_from_band(rt_raster raster, uint32_t *bandNums,
1511  int count);
1512 
1522 rt_band rt_raster_replace_band(rt_raster raster, rt_band band,
1523  int index);
1524 
1533 rt_raster rt_raster_clone(rt_raster raster, uint8_t deep);
1534 
1547 uint8_t *rt_raster_to_gdal(rt_raster raster, const char *srs,
1548  char *format, char **options, uint64_t *gdalsize);
1549 
1559 rt_gdaldriver rt_raster_gdal_drivers(uint32_t *drv_count, uint8_t cancc);
1560 
1577 GDALDatasetH rt_raster_to_gdal_mem(
1578  rt_raster raster,
1579  const char *srs,
1580  uint32_t *bandNums,
1581  int *excludeNodataValues,
1582  int count,
1583  GDALDriverH *rtn_drv, int *destroy_rtn_drv
1584 );
1585 
1593 rt_raster rt_raster_from_gdal_dataset(GDALDatasetH ds);
1594 
1625 rt_raster rt_raster_gdal_warp(
1626  rt_raster raster,
1627  const char *src_srs, const char *dst_srs,
1628  double *scale_x, double *scale_y,
1629  int *width, int *height,
1630  double *ul_xw, double *ul_yw,
1631  double *grid_xw, double *grid_yw,
1632  double *skew_x, double *skew_y,
1633  GDALResampleAlg resample_alg, double max_err);
1634 
1661 rt_raster rt_raster_gdal_rasterize(const unsigned char *wkb,
1662  uint32_t wkb_len, const char *srs,
1663  uint32_t num_bands, rt_pixtype *pixtype,
1664  double *init, double *value,
1665  double *nodata, uint8_t *hasnodata,
1666  int *width, int *height,
1667  double *scale_x, double *scale_y,
1668  double *ul_xw, double *ul_yw,
1669  double *grid_xw, double *grid_yw,
1670  double *skew_x, double *skew_y,
1671  char **options
1672 );
1673 
1691  rt_raster rast1, int nband1,
1692  rt_raster rast2, int nband2,
1693  int *intersects
1694 );
1695 
1713  rt_raster rast1, int nband1,
1714  rt_raster rast2, int nband2,
1715  int *overlaps
1716 );
1717 
1735  rt_raster rast1, int nband1,
1736  rt_raster rast2, int nband2,
1737  int *contains
1738 );
1739 
1757  rt_raster rast1, int nband1,
1758  rt_raster rast2, int nband2,
1759  int *contains
1760 );
1761 
1779  rt_raster rast1, int nband1,
1780  rt_raster rast2, int nband2,
1781  int *touches
1782 );
1783 
1801  rt_raster rast1, int nband1,
1802  rt_raster rast2, int nband2,
1803  int *covers
1804 );
1805 
1823  rt_raster rast1, int nband1,
1824  rt_raster rast2, int nband2,
1825  int *coveredby
1826 );
1827 
1847  rt_raster rast1, int nband1,
1848  rt_raster rast2, int nband2,
1849  double distance,
1850  int *dwithin
1851 );
1852 
1872  rt_raster rast1, int nband1,
1873  rt_raster rast2, int nband2,
1874  double distance,
1875  int *dfwithin
1876 );
1877 
1878 /*
1879  * Return ES_ERROR if error occurred in function.
1880  * Paramter aligned returns non-zero if two rasters are aligned
1881  *
1882  * @param rast1 : the first raster for alignment test
1883  * @param rast2 : the second raster for alignment test
1884  * @param *aligned : non-zero value if the two rasters are aligned
1885  * @param *reason : reason why rasters are not aligned
1886  *
1887  * @return ES_NONE if success, ES_ERROR if error
1888  */
1890  rt_raster rast1,
1891  rt_raster rast2,
1892  int *aligned, char **reason
1893 );
1894 
1895 /*
1896  * Return raster of computed extent specified extenttype applied
1897  * on two input rasters. The raster returned should be freed by
1898  * the caller
1899  *
1900  * @param rast1 : the first raster
1901  * @param rast2 : the second raster
1902  * @param extenttype : type of extent for the output raster
1903  * @param *rtnraster : raster of computed extent
1904  * @param *offset : 4-element array indicating the X,Y offsets
1905  * for each raster. 0,1 for rast1 X,Y. 2,3 for rast2 X,Y.
1906  *
1907  * @return ES_NONE if success, ES_ERROR if error
1908  */
1911  rt_raster rast1, rt_raster rast2,
1912  rt_extenttype extenttype,
1913  rt_raster *rtnraster, double *offset
1914 );
1915 
1954  rt_iterator itrset, uint16_t itrcount,
1955  rt_extenttype extenttype, rt_raster customextent,
1956  rt_pixtype pixtype,
1957  uint8_t hasnodata, double nodataval,
1958  uint16_t distancex, uint16_t distancey,
1959  rt_mask mask,
1960  void *userarg,
1961  int (*callback)(
1962  rt_iterator_arg arg,
1963  void *userarg,
1964  double *value,
1965  int *nodata
1966  ),
1967  rt_raster *rtnraster
1968 );
1969 
1981 rt_raster rt_raster_colormap(
1982  rt_raster raster, int nband,
1983  rt_colormap colormap
1984 );
1985 
1986 /*- utilities -------------------------------------------------------*/
1987 
1988 /*
1989  * rt_core memory functions
1990  */
1991 extern void *rtalloc(size_t size);
1992 extern void *rtrealloc(void *mem, size_t size);
1993 extern void rtdealloc(void *mem);
1994 
1995 /*
1996  * GDAL driver flags
1997  */
1998 
1999 #define GDAL_ENABLE_ALL "ENABLE_ALL"
2000 #define GDAL_DISABLE_ALL "DISABLE_ALL"
2001 #define GDAL_VSICURL "VSICURL"
2002 
2003 /*
2004  * Set of functions to clamp double to int of different size
2005  */
2006 
2007 #if !defined(POSTGIS_RASTER_WARN_ON_TRUNCATION)
2008 #define POSTGIS_RASTER_WARN_ON_TRUNCATION 0
2009 #endif
2010 
2011 #define POSTGIS_RT_1BBMAX 1
2012 #define POSTGIS_RT_2BUIMAX 3
2013 #define POSTGIS_RT_4BUIMAX 15
2014 
2015 uint8_t
2016 rt_util_clamp_to_1BB(double value);
2017 
2018 uint8_t
2020 
2021 uint8_t
2023 
2024 int8_t
2026 
2027 uint8_t
2029 
2030 int16_t
2032 
2033 uint16_t
2035 
2036 int32_t
2038 
2039 uint32_t
2041 
2042 float
2043 rt_util_clamp_to_32F(double value);
2044 
2045 int
2047  double initialvalue,
2048  int32_t checkvalint, uint32_t checkvaluint,
2049  float checkvalfloat, double checkvaldouble,
2050  rt_pixtype pixtype
2051 );
2052 
2060 GDALResampleAlg
2061 rt_util_gdal_resample_alg(const char *algname);
2062 
2070 GDALDataType
2072 
2080 rt_pixtype
2081 rt_util_gdal_datatype_to_pixtype(GDALDataType gdt);
2082 
2083 /*
2084  get GDAL runtime version information
2085 */
2086 const char*
2087 rt_util_gdal_version(const char *request);
2088 
2089 /*
2090  computed extent type from c string
2091 */
2093 rt_util_extent_type(const char *name);
2094 
2095 /*
2096  convert the spatial reference string from a GDAL recognized format to either WKT or Proj4
2097 */
2098 char*
2099 rt_util_gdal_convert_sr(const char *srs, int proj4);
2100 
2101 /*
2102  is the spatial reference string supported by GDAL
2103 */
2104 int
2105 rt_util_gdal_supported_sr(const char *srs);
2106 
2118 rt_util_gdal_sr_auth_info(GDALDatasetH hds, char **authname, char **authcode);
2119 
2120 /*
2121  is GDAL configured correctly?
2122 */
2123 int
2125 
2126 /*
2127  register all GDAL drivers
2128 */
2129 int
2130 rt_util_gdal_register_all(int force_register_all);
2131 
2132 /*
2133  is the driver registered?
2134 */
2135 int
2136 rt_util_gdal_driver_registered(const char *drv);
2137 
2138 /*
2139  wrapper for GDALOpen and GDALOpenShared
2140 */
2141 GDALDatasetH
2142 rt_util_gdal_open(const char *fn, GDALAccess fn_access, int shared);
2143 
2144 void
2146  OGREnvelope env,
2147  rt_envelope *ext
2148 );
2149 
2150 void
2152  rt_envelope ext,
2153  OGREnvelope *env
2154 );
2155 
2156 LWPOLY *
2158  rt_envelope ext
2159 );
2160 
2161 int
2163  double *gt1,
2164  double *gt2
2165 );
2166 
2167 /* coordinates in RGB and HSV are floating point values between 0 and 1 */
2170  double rgb[3],
2171  double hsv[3]
2172 );
2173 
2174 /* coordinates in RGB and HSV are floating point values between 0 and 1 */
2177  double hsv[3],
2178  double rgb[3]
2179 );
2180 
2181 /*
2182  helper macros for consistent floating point equality checks
2183 */
2184 #define FLT_NEQ(x, y) (fabs(x - y) > FLT_EPSILON)
2185 #define FLT_EQ(x, y) (!FLT_NEQ(x, y))
2186 #define DBL_NEQ(x, y) (fabs(x - y) > DBL_EPSILON)
2187 #define DBL_EQ(x, y) (!DBL_NEQ(x, y))
2188 
2189 /*
2190  helper macro for symmetrical rounding
2191 */
2192 #define ROUND(x, y) (((x > 0.0) ? floor((x * pow(10, y) + 0.5)) : ceil((x * pow(10, y) - 0.5))) / pow(10, y))
2193 
2202  /*---[ 8 byte boundary ]---{ */
2203  uint32_t size; /* required by postgresql: 4 bytes */
2204  uint16_t version; /* format version (this is version 0): 2 bytes */
2205  uint16_t numBands; /* Number of bands: 2 bytes */
2206 
2207  /* }---[ 8 byte boundary ]---{ */
2208  double scaleX; /* pixel width: 8 bytes */
2209 
2210  /* }---[ 8 byte boundary ]---{ */
2211  double scaleY; /* pixel height: 8 bytes */
2212 
2213  /* }---[ 8 byte boundary ]---{ */
2214  double ipX; /* insertion point X: 8 bytes */
2215 
2216  /* }---[ 8 byte boundary ]---{ */
2217  double ipY; /* insertion point Y: 8 bytes */
2218 
2219  /* }---[ 8 byte boundary ]---{ */
2220  double skewX; /* skew about the X axis: 8 bytes */
2221 
2222  /* }---[ 8 byte boundary ]---{ */
2223  double skewY; /* skew about the Y axis: 8 bytes */
2224 
2225  /* }---[ 8 byte boundary ]--- */
2226  int32_t srid; /* Spatial reference id: 4 bytes */
2227  uint16_t width; /* pixel columns: 2 bytes */
2228  uint16_t height; /* pixel rows: 2 bytes */
2229 };
2230 
2231 /* NOTE: the initial part of this structure matches the layout
2232  * of data in the serialized form version 0, starting
2233  * from the numBands element
2234  */
2235 struct rt_raster_t {
2237  uint16_t version;
2238 
2239  /* Number of bands, all share the same dimension
2240  * and georeference */
2241  uint16_t numBands;
2242 
2243  /* Georeference (in projection units) */
2244  double scaleX; /* pixel width */
2245  double scaleY; /* pixel height */
2246  double ipX; /* geo x ordinate of the corner of upper-left pixel */
2247  double ipY; /* geo y ordinate of the corner of bottom-right pixel */
2248  double skewX; /* skew about the X axis*/
2249  double skewY; /* skew about the Y axis */
2250 
2251  int32_t srid; /* spatial reference id */
2252  uint16_t width; /* pixel columns - max 65535 */
2253  uint16_t height; /* pixel rows - max 65535 */
2254  rt_band *bands; /* actual bands */
2255 
2256 };
2257 
2259  uint8_t bandNum; /* 0-based */
2260  char* path; /* internally owned */
2261  void *mem; /* loaded external band data, internally owned */
2262 };
2263 
2264 struct rt_band_t {
2266  int32_t offline;
2267  uint16_t width;
2268  uint16_t height;
2269  int32_t hasnodata; /* a flag indicating if this band contains nodata values */
2270  int32_t isnodata; /* a flag indicating if this band is filled only with
2271  nodata values. flag CANNOT be TRUE if hasnodata is FALSE */
2272  double nodataval; /* int will be converted ... */
2273  int8_t ownsdata; /* 0, externally owned. 1, internally owned. only applies to data.mem */
2274 
2275  rt_raster raster; /* reference to parent raster */
2276 
2277  union {
2278  void* mem; /* actual data, externally owned */
2279  struct rt_extband_t offline;
2280  } data;
2281 
2282 };
2283 
2284 struct rt_pixel_t {
2285  int x; /* column */
2286  int y; /* line */
2287 
2289  double value;
2290 
2292 };
2293 
2294 struct rt_mask_t {
2295  uint16_t dimx;
2296  uint16_t dimy;
2297  double **values;
2298  int **nodata;
2299  int weighted; /* 0 if not weighted values 1 if weighted values */
2300 };
2301 
2302 /* polygon as LWPOLY with associated value */
2305  double val;
2306 };
2307 
2308 /* summary stats of specified band */
2310  double sample;
2312 
2313  double min;
2314  double max;
2315  double sum;
2316  double mean;
2317  double stddev;
2318 
2319  double *values;
2320  int sorted; /* flag indicating that values is sorted ascending by value */
2321 };
2322 
2323 /* histogram bin(s) of specified band */
2326  double percent;
2327 
2328  double min;
2329  double max;
2330 
2331  int inc_min;
2332  int inc_max;
2333 };
2334 
2335 /* quantile(s) of the specified band */
2337  double quantile;
2338  double value;
2340 };
2341 
2342 /* listed-list structures for rt_band_get_quantiles_stream */
2344  uint8_t algeq; /* AL-GEQ (1) or AL-GT (0) */
2345  double quantile;
2346  uint64_t tau; /* position in sequence */
2347 
2348  struct quantile_llist_element *head; /* H index 0 */
2349  struct quantile_llist_element *tail; /* H index last */
2350  uint32_t count; /* # of elements in H */
2351 
2352  /* faster access to elements at specific intervals */
2354  uint32_t index_max; /* max # of elements in index */
2355 
2356  uint64_t sum1; /* N1H */
2357  uint64_t sum2; /* N2H */
2358 };
2359 
2361  double value;
2363 
2366 };
2367 
2371 };
2372 
2373 /* number of times a value occurs */
2375  double value;
2377  double percent;
2378 };
2379 
2380 /* reclassification expression */
2383  double min;
2384  double max;
2385  int inc_min; /* include min */
2386  int inc_max; /* include max */
2387  int exc_min; /* exceed min */
2388  int exc_max; /* exceed max */
2389  } src, dst;
2390 };
2391 
2392 /* raster iterator */
2394  rt_raster raster;
2395  uint16_t nband; /* 0-based */
2396  uint8_t nbnodata; /* no band = treat as NODATA */
2397 };
2398 
2399 /* callback argument from raster iterator */
2401  /* # of rasters, Z-axis */
2402  uint16_t rasters;
2403  /* # of rows, Y-axis */
2405  /* # of columns, X-axis */
2407 
2408  /* axis order: Z,X,Y */
2409  /* individual pixel values */
2410  double ***values;
2411  /* 0,1 value of nodata flag */
2412  int ***nodata;
2413 
2414  /* X,Y of pixel from each input raster */
2415  int **src_pixel;
2416 
2417  /* X,Y of pixel from output raster */
2418  int dst_pixel[2];
2419 };
2420 
2421 /* gdal driver information */
2423  int idx;
2424  char *short_name;
2425  char *long_name;
2429 };
2430 
2431 /* raster colormap entry */
2434  double value;
2435  uint8_t color[4]; /* RGBA */
2436 };
2437 
2439  enum {
2443  } method;
2444 
2445  int ncolor;
2446  uint16_t nentry;
2447  rt_colormap_entry entry;
2448 };
2449 
2450 #endif /* LIBRTCORE_H_INCLUDED */
Datum coveredby(PG_FUNCTION_ARGS)
void *(* rt_allocator)(size_t size)
Global functions for memory/logging handlers.
Definition: librtcore.h:229
int32_t rt_util_clamp_to_32BSI(double value)
Definition: rt_util.c:69
int rt_raster_calc_gt_coeff(double i_mag, double j_mag, double theta_i, double theta_ij, double *xscale, double *xskew, double *yskew, double *yscale)
Calculates the coefficients of a geotransform given the physically significant parameters describing ...
Definition: rt_raster.c:314
uint64_t sum1
Definition: librtcore.h:2356
double skewY
Definition: librtcore.h:2249
double MinY
Definition: librtcore.h:167
int32_t srid
Definition: librtcore.h:2251
rt_errorstate rt_band_corrected_clamped_value(rt_band band, double val, double *newval, int *corrected)
Correct value when clamped value is equal to clamped NODATA value.
Definition: rt_band.c:1701
uint16_t nentry
Definition: librtcore.h:2446
double UpperLeftX
Definition: librtcore.h:170
int quantile_llist_destroy(struct quantile_llist **list, uint32_t list_count)
uint32_t rt_util_clamp_to_32BUI(double value)
Definition: rt_util.c:74
void * rt_raster_serialize(rt_raster raster)
Return this raster in serialized form.
Definition: rt_serialize.c:521
int rt_util_gdal_register_all(int force_register_all)
Definition: rt_util.c:334
double rt_raster_get_x_offset(rt_raster raster)
Get raster x offset, in projection units.
Definition: rt_raster.c:213
double rt_raster_get_y_skew(rt_raster raster)
Get skew about the Y axis.
Definition: rt_raster.c:190
void *(* rt_reallocator)(void *mem, size_t size)
Definition: librtcore.h:230
Datum covers(PG_FUNCTION_ARGS)
uint16_t rt_raster_get_num_bands(rt_raster raster)
Definition: rt_raster.c:372
struct quantile_llist_element * element
Definition: librtcore.h:2369
rt_errorstate rt_raster_same_alignment(rt_raster rast1, rt_raster rast2, int *aligned, char **reason)
uint32_t count
Definition: librtcore.h:2311
tuple data
Definition: ovdump.py:103
double quantile
Definition: librtcore.h:2345
void default_rt_info_handler(const char *fmt, va_list ap)
Definition: rt_context.c:93
struct quantile_llist_element * prev
Definition: librtcore.h:2364
void * mem
Definition: librtcore.h:2261
void(* rt_message_handler)(const char *string, va_list ap) __attribute__((format(printf
Definition: librtcore.h:232
uint16_t numBands
Definition: librtcore.h:2241
struct rt_pixel_t * rt_pixel
Definition: librtcore.h:147
rt_raster rt_raster_from_band(rt_raster raster, uint32_t *bandNums, int count)
Construct a new rt_raster from an existing rt_raster and an array of band numbers.
Definition: rt_raster.c:1439
struct rt_reclassexpr_t::rt_reclassrange dst
rt_geomval rt_raster_gdal_polygonize(rt_raster raster, int nband, int exclude_nodata_value, int *pnElements)
Returns a set of "geomval" value, one for each group of pixel sharing the same value for the provided...
Definition: rt_geometry.c:940
void rt_raster_set_geotransform_matrix(rt_raster raster, double *gt)
Set raster's geotransform using 6-element array.
Definition: rt_raster.c:727
struct rt_raster_t * rt_raster
Types definitions.
Definition: librtcore.h:145
double MaxY
Definition: librtcore.h:168
rt_raster raster
Definition: librtcore.h:2275
void rt_raster_get_geotransform_matrix(rt_raster raster, double *gt)
Get 6-element array of raster geotransform matrix.
Definition: rt_raster.c:706
uint32_t count
Definition: librtcore.h:2376
rt_quantile rt_band_get_quantiles_stream(rt_band band, int exclude_nodata_value, double sample, uint64_t cov_count, struct quantile_llist **qlls, uint32_t *qlls_count, double *quantiles, uint32_t quantiles_count, uint32_t *rtn_count)
Compute the default set of or requested quantiles for a coverage.
double MaxX
Definition: librtcore.h:166
rt_pixtype pixtype
Definition: librtcore.h:2265
void rt_raster_set_skews(rt_raster raster, double skewX, double skewY)
Set skews about the X and Y axis.
Definition: rt_raster.c:168
struct rt_gdaldriver_t * rt_gdaldriver
Definition: librtcore.h:154
void rt_set_handlers(rt_allocator allocator, rt_reallocator reallocator, rt_deallocator deallocator, rt_message_handler error_handler, rt_message_handler info_handler, rt_message_handler warning_handler)
This function is called when the PostgreSQL backend is taking care of the memory and we want to use p...
Definition: rt_context.c:151
double quantile
Definition: librtcore.h:2337
tuple gt
Definition: window.py:77
rt_errorstate rt_raster_from_two_rasters(rt_raster rast1, rt_raster rast2, rt_extenttype extenttype, rt_raster *rtnraster, double *offset)
Definition: rt_raster.c:3465
tuple fmt
Definition: pixval.py:92
char * short_name
Definition: librtcore.h:2424
rt_extenttype
Definition: librtcore.h:200
GDALDatasetH rt_raster_to_gdal_mem(rt_raster raster, const char *srs, uint32_t *bandNums, int *excludeNodataValues, int count, GDALDriverH *rtn_drv, int *destroy_rtn_drv)
Return GDAL dataset using GDAL MEM driver from raster.
Definition: rt_raster.c:1830
Datum contains(PG_FUNCTION_ARGS)
uint8_t color[4]
Definition: librtcore.h:2435
LWGEOM * geom
Definition: librtcore.h:2291
int rt_band_is_offline(rt_band band)
Return non-zero if the given band data is on the filesystem.
Definition: rt_band.c:228
void rterror(const char *fmt,...)
Wrappers used for reporting errors and info.
Definition: rt_context.c:199
tuple band
Definition: ovdump.py:57
rt_raster rt_raster_gdal_rasterize(const unsigned char *wkb, uint32_t wkb_len, const char *srs, uint32_t num_bands, rt_pixtype *pixtype, double *init, double *value, double *nodata, uint8_t *hasnodata, int *width, int *height, double *scale_x, double *scale_y, double *ul_xw, double *ul_yw, double *grid_xw, double *grid_yw, double *skew_x, double *skew_y, char **options)
Return a raster of the provided geometry.
Definition: rt_raster.c:2513
void * rtalloc(size_t size)
Wrappers used for managing memory.
Definition: rt_context.c:171
tuple rast
Definition: rtpixdump.py:61
void * default_rt_reallocator(void *mem, size_t size)
Definition: rt_context.c:54
rt_raster rt_raster_gdal_warp(rt_raster raster, const char *src_srs, const char *dst_srs, double *scale_x, double *scale_y, int *width, int *height, double *ul_xw, double *ul_yw, double *grid_xw, double *grid_yw, double *skew_x, double *skew_y, GDALResampleAlg resample_alg, double max_err)
Return a warped raster using GDAL Warp API.
Definition: rt_warp.c:178
void rt_raster_get_phys_params(rt_raster rast, double *i_mag, double *j_mag, double *theta_i, double *theta_ij)
Calculates and returns the physically significant descriptors embodied in the geotransform attached t...
Definition: rt_raster.c:231
void * rtrealloc(void *mem, size_t size)
Definition: rt_context.c:179
uint16_t height
Definition: librtcore.h:2268
double value
Definition: librtcore.h:2289
rt_errorstate rt_raster_covers(rt_raster rast1, int nband1, rt_raster rast2, int nband2, int *covers)
Return ES_ERROR if error occurred in function.
LWPOLY * rt_util_envelope_to_lwpoly(rt_envelope ext)
Definition: rt_util.c:435
int rt_band_get_pixel_of_value(rt_band band, int exclude_nodata_value, double *searchset, int searchcount, rt_pixel *pixels)
Search band for pixel(s) with search values.
Definition: rt_band.c:1519
rt_errorstate
Enum definitions.
Definition: librtcore.h:179
int rt_util_same_geotransform_matrix(double *gt1, double *gt2)
Definition: rt_util.c:487
rt_errorstate rt_raster_contains(rt_raster rast1, int nband1, rt_raster rast2, int nband2, int *contains)
Return ES_ERROR if error occurred in function.
#define __attribute__
Definition: librtcore.h:139
double ipY
Definition: librtcore.h:2247
tuple raster
Be careful!! Zeros function's input parameter can be a (height x width) array, not (width x height): ...
Definition: rtrowdump.py:121
rt_errorstate rt_band_set_nodata(rt_band band, double val, int *converted)
Set nodata value.
Definition: rt_band.c:600
int ** nodata
Definition: librtcore.h:2298
rt_pixtype
Definition: librtcore.h:185
Datum overlaps(PG_FUNCTION_ARGS)
void rt_band_destroy(rt_band band)
Destroy a raster band.
Definition: rt_band.c:242
rt_histogram rt_band_get_histogram(rt_bandstats stats, uint32_t bin_count, double *bin_widths, uint32_t bin_widths_count, int right, double min, double max, uint32_t *rtn_count)
Count the distribution of data.
struct rt_reclassexpr_t * rt_reclassexpr
Definition: librtcore.h:155
struct rt_quantile_t * rt_quantile
Definition: librtcore.h:152
uint8_t * rt_raster_to_wkb(rt_raster raster, int outasin, uint32_t *wkbsize)
Return this raster in WKB form.
Definition: rt_wkb.c:494
uint32_t size
Definition: librtcore.h:2236
int weighted
Definition: librtcore.h:2299
int rt_raster_is_empty(rt_raster raster)
Return TRUE if the raster is empty.
Definition: rt_raster.c:1338
uint16_t height
Definition: librtcore.h:2253
Datum touches(PG_FUNCTION_ARGS)
uint16_t dimy
Definition: librtcore.h:2296
double value
Definition: librtcore.h:2338
rt_geos_spatial_test
GEOS spatial relationship tests available.
Definition: librtcore.h:217
rt_errorstate rt_band_get_nodata(rt_band band, double *nodata)
Get NODATA value.
Definition: rt_band.c:1597
rt_errorstate rt_raster_get_convex_hull(rt_raster raster, LWGEOM **hull)
Get raster's convex hull.
Definition: rt_geometry.c:803
void default_rt_warning_handler(const char *fmt, va_list ap)
Definition: rt_context.c:80
const char * rt_band_get_ext_path(rt_band band)
Return band's external path (only valid when rt_band_is_offline returns non-zero).
Definition: rt_band.c:265
struct quantile_llist_element * next
Definition: librtcore.h:2365
unsigned int uint32_t
Definition: uthash.h:78
LWPOLY * geom
Definition: librtcore.h:2304
rt_errorstate rt_raster_cell_to_geopoint(rt_raster raster, double xr, double yr, double *xw, double *yw, double *gt)
Convert an xr, yr raster point to an xw, yw point on map.
Definition: rt_raster.c:755
int rt_pixtype_alignment(rt_pixtype pixtype)
Return alignment requirements for data in the given pixel type.
Definition: rt_pixel.c:75
rt_errorstate rt_raster_surface(rt_raster raster, int nband, LWMPOLY **surface)
Get a raster as a surface (multipolygon).
Definition: rt_geometry.c:355
uint16_t rt_util_clamp_to_16BUI(double value)
Definition: rt_util.c:64
void rt_band_set_ownsdata_flag(rt_band band, int flag)
Definition: rt_band.c:534
struct rt_reclassexpr_t::rt_reclassrange src
double ** values
Definition: librtcore.h:2297
double val
Definition: librtcore.h:2305
struct quantile_llist_element * tail
Definition: librtcore.h:2349
GDALDataType rt_util_pixtype_to_gdal_datatype(rt_pixtype pt)
Convert rt_pixtype to GDALDataType.
Definition: rt_util.c:118
double percent
Definition: librtcore.h:2326
uint16_t version
Definition: librtcore.h:2237
void rt_util_to_ogr_envelope(rt_envelope ext, OGREnvelope *env)
Definition: rt_util.c:422
int rt_util_gdal_driver_registered(const char *drv)
Definition: rt_util.c:353
uint32_t columns
Definition: librtcore.h:2406
void rtwarn(const char *fmt,...)
Definition: rt_context.c:224
uint16_t rasters
Definition: librtcore.h:2402
int rt_band_get_ownsdata_flag(rt_band band)
Return 0 (FALSE) or non-zero (TRUE) indicating if rt_band is responsible for managing the memory for ...
Definition: rt_band.c:526
Datum intersects(PG_FUNCTION_ARGS)
rt_quantile rt_band_get_quantiles(rt_bandstats stats, double *quantiles, int quantiles_count, uint32_t *rtn_count)
Compute the default set of or requested quantiles for a set of data the quantile formula used is same...
rt_errorstate rt_raster_intersects(rt_raster rast1, int nband1, rt_raster rast2, int nband2, int *intersects)
Return ES_ERROR if error occurred in function.
rt_errorstate rt_band_get_pixel(rt_band band, int x, int y, double *value, int *nodata)
Get pixel value.
Definition: rt_band.c:1088
tuple nband
Definition: pixval.py:52
enum rt_colormap_t::@7 method
rt_extenttype rt_util_extent_type(const char *name)
Definition: rt_util.c:191
void rt_raster_set_scale(rt_raster raster, double scaleX, double scaleY)
Set scale in projection units.
Definition: rt_raster.c:137
uint64_t tau
Definition: librtcore.h:2346
int rt_raster_generate_new_band(rt_raster raster, rt_pixtype pixtype, double initialvalue, uint32_t hasnodata, double nodatavalue, int index)
Generate a new inline band and add it to a raster.
Definition: rt_raster.c:485
rt_pixtype rt_pixtype_index_from_name(const char *pixname)
Definition: rt_pixel.c:80
char * rt_raster_to_hexwkb(rt_raster raster, int outasin, uint32_t *hexwkbsize)
Return this raster in HEXWKB form (null-terminated hex)
Definition: rt_wkb.c:669
rt_errorstate rt_util_rgb_to_hsv(double rgb[3], double hsv[3])
Definition: rt_util.c:503
rt_errorstate rt_band_get_pixel_line(rt_band band, int x, int y, uint16_t len, void **vals, uint16_t *nvals)
Get values of multiple pixels.
Definition: rt_band.c:1004
rt_raster rt_raster_clone(rt_raster raster, uint8_t deep)
Clone an existing raster.
Definition: rt_raster.c:1544
void rt_raster_set_offsets(rt_raster raster, double x, double y)
Set insertion points in projection units.
Definition: rt_raster.c:199
uint16_t width
Definition: librtcore.h:2252
union rt_band_t::@6 data
void rt_raster_set_phys_params(rt_raster rast, double i_mag, double j_mag, double theta_i, double theta_ij)
Calculates the geotransform coefficients and applies them to the supplied raster. ...
Definition: rt_raster.c:297
int rt_util_gdal_supported_sr(const char *srs)
Definition: rt_util.c:243
rt_errorstate rt_band_load_offline_data(rt_band band)
Load offline band's data.
Definition: rt_band.c:331
rt_raster rt_raster_from_wkb(const uint8_t *wkb, uint32_t wkbsize)
Construct an rt_raster from a binary WKB representation.
Definition: rt_wkb.c:276
int8_t rt_util_clamp_to_8BSI(double value)
Definition: rt_util.c:49
int rt_util_dbl_trunc_warning(double initialvalue, int32_t checkvalint, uint32_t checkvaluint, float checkvalfloat, double checkvaldouble, rt_pixtype pixtype)
Definition: rt_util.c:625
int rt_band_clamped_value_is_nodata(rt_band band, double val)
Compare clamped value to band's clamped NODATA value.
Definition: rt_band.c:1665
rt_band rt_raster_get_band(rt_raster raster, int bandNum)
Return Nth band, or NULL if unavailable.
Definition: rt_raster.c:381
int rt_raster_copy_band(rt_raster torast, rt_raster fromrast, int fromindex, int toindex)
Copy one band from one raster to another.
Definition: rt_raster.c:1374
rt_pixtype rt_util_gdal_datatype_to_pixtype(GDALDataType gdt)
Convert GDALDataType to rt_pixtype.
Definition: rt_util.c:153
void rtinfo(const char *fmt,...)
Definition: rt_context.c:211
int rt_band_check_is_nodata(rt_band band)
Returns TRUE if the band is only nodata values.
Definition: rt_band.c:1619
int8_t ownsdata
Definition: librtcore.h:2273
int rt_band_get_hasnodata_flag(rt_band band)
Get hasnodata flag value.
Definition: rt_band.c:541
struct rt_colormap_entry_t * rt_colormap_entry
Definition: librtcore.h:160
int count
Definition: genraster.py:56
double rt_raster_get_x_scale(rt_raster raster)
Get scale X in projection units.
Definition: rt_raster.c:150
tuple ds
Definition: pixval.py:66
LWPOLY * rt_raster_pixel_as_polygon(rt_raster raster, int x, int y)
Get a raster pixel as a polygon.
Definition: rt_geometry.c:610
uint16_t rt_band_get_width(rt_band band)
Return width of this band.
Definition: rt_band.c:507
int rt_raster_has_band(rt_raster raster, int nband)
Return TRUE if the raster has a band of this number.
Definition: rt_raster.c:1351
uint16_t rt_band_get_height(rt_band band)
Return height of this band.
Definition: rt_band.c:516
double skewX
Definition: librtcore.h:2248
rt_colormap_entry entry
Definition: librtcore.h:2447
double * values
Definition: librtcore.h:2319
rt_errorstate rt_raster_get_envelope_geom(rt_raster raster, LWGEOM **env)
Get raster's envelope as a geometry.
Definition: rt_geometry.c:670
struct rt_band_t * rt_band
Definition: librtcore.h:146
double nodataval
Definition: librtcore.h:2272
void * rt_band_get_data(rt_band band)
Get pointer to raster band data.
Definition: rt_band.c:302
double rt_pixtype_get_min_value(rt_pixtype pixtype)
Return minimum value possible for pixel type.
Definition: rt_pixel.c:148
void rt_raster_set_srid(rt_raster raster, int32_t srid)
Set raster's SRID.
Definition: rt_raster.c:363
uint32_t index_max
Definition: librtcore.h:2354
int32_t rt_raster_get_srid(rt_raster raster)
Get raster's SRID.
Definition: rt_raster.c:356
void rt_raster_destroy(rt_raster raster)
Release memory associated to a raster.
Definition: rt_raster.c:82
rt_raster raster
Definition: librtcore.h:2394
rt_band rt_raster_replace_band(rt_raster raster, rt_band band, int index)
Replace band at provided index with new band.
Definition: rt_raster.c:1502
uint8_t can_write
Definition: librtcore.h:2428
rt_errorstate rt_raster_geopoint_to_cell(rt_raster raster, double xw, double yw, double *xr, double *yr, double *igt)
Convert an xw, yw map point to a xr, yr raster point.
Definition: rt_raster.c:806
rt_bandstats rt_band_get_summary_stats(rt_band band, int exclude_nodata_value, double sample, int inc_vals, uint64_t *cK, double *cM, double *cQ)
Compute summary statistics for a band.
uint8_t nodata
Definition: librtcore.h:2288
double rt_raster_get_y_scale(rt_raster raster)
Get scale Y in projection units.
Definition: rt_raster.c:159
rt_raster rt_raster_new(uint32_t width, uint32_t height)
Construct a raster with given dimensions.
Definition: rt_raster.c:48
uint16_t width
Definition: librtcore.h:2267
double rt_raster_get_x_skew(rt_raster raster)
Get skew about the X axis.
Definition: rt_raster.c:181
tuple x
Definition: pixval.py:53
rt_band rt_band_new_inline(uint16_t width, uint16_t height, rt_pixtype pixtype, uint32_t hasnodata, double nodataval, uint8_t *data)
Create an in-db rt_band with no data.
Definition: rt_band.c:58
struct rt_histogram_t * rt_histogram
Definition: librtcore.h:151
Datum distance(PG_FUNCTION_ARGS)
rt_errorstate rt_band_get_ext_band_num(rt_band band, uint8_t *bandnum)
Return bands' external band number (only valid when rt_band_is_offline returns non-zero).
Definition: rt_band.c:278
uint16_t nband
Definition: librtcore.h:2395
uint8_t rt_util_clamp_to_4BUI(double value)
Definition: rt_util.c:44
void rt_band_set_hasnodata_flag(rt_band band, int flag)
Set hasnodata flag value.
Definition: rt_band.c:548
uint8_t rt_util_clamp_to_8BUI(double value)
Definition: rt_util.c:54
int rt_pixtype_size(rt_pixtype pixtype)
Return size in bytes of a value in the given pixtype.
Definition: rt_pixel.c:39
uint8_t rt_util_clamp_to_1BB(double value)
Definition: rt_util.c:34
struct rt_geomval_t * rt_geomval
Definition: librtcore.h:149
void rt_raster_calc_phys_params(double xscale, double xskew, double yskew, double yscale, double *i_mag, double *j_mag, double *theta_i, double *theta_ij)
Calculates the physically significant descriptors embodied in an arbitrary geotransform.
Definition: rt_raster.c:250
struct rt_mask_t * rt_mask
Definition: librtcore.h:148
struct rt_valuecount_t * rt_valuecount
Definition: librtcore.h:153
void default_rt_error_handler(const char *fmt, va_list ap)
Definition: rt_context.c:67
void(* rt_deallocator)(void *mem)
Definition: librtcore.h:231
rt_errorstate rt_pixel_set_to_array(rt_pixel npixel, uint32_t count, rt_mask mask, int x, int y, uint16_t distancex, uint16_t distancey, double ***value, int ***nodata, int *dimx, int *dimy)
Definition: rt_pixel.c:286
struct rt_bandstats_t * rt_bandstats
Definition: librtcore.h:150
uint16_t rt_raster_get_width(rt_raster raster)
Definition: rt_raster.c:121
rt_valuecount rt_band_get_value_count(rt_band band, int exclude_nodata_value, double *search_values, uint32_t search_values_count, double roundto, uint32_t *rtn_total, uint32_t *rtn_count)
Count the number of times provided value(s) occur in the band.
rt_raster rt_raster_from_hexwkb(const char *hexwkb, uint32_t hexwkbsize)
Construct an rt_raster from a text HEXWKB representation.
Definition: rt_wkb.c:406
int32_t offline
Definition: librtcore.h:2266
double *** values
Definition: librtcore.h:2410
void default_rt_deallocator(void *mem)
Definition: rt_context.c:61
rt_errorstate rt_band_set_isnodata_flag(rt_band band, int flag)
Set isnodata flag value.
Definition: rt_band.c:562
void rtdealloc(void *mem)
Definition: rt_context.c:186
Definition: librtcore.h:2432
int32_t isnodata
Definition: librtcore.h:2270
uint8_t * rt_raster_to_gdal(rt_raster raster, const char *srs, char *format, char **options, uint64_t *gdalsize)
Return formatted GDAL raster from raster.
Definition: rt_raster.c:1602
uint8_t nbnodata
Definition: librtcore.h:2396
double MinX
Definition: librtcore.h:165
rt_band rt_band_duplicate(rt_band band)
Create a new band duplicated from source band.
Definition: rt_band.c:186
Struct definitions.
Definition: librtcore.h:2201
rt_gdaldriver rt_raster_gdal_drivers(uint32_t *drv_count, uint8_t cancc)
Returns a set of available GDAL drivers.
Definition: rt_raster.c:1720
double rt_band_get_min_value(rt_band band)
Returns the minimal possible value for the band according to the pixel type.
Definition: rt_band.c:1612
rt_errorstate rt_raster_touches(rt_raster rast1, int nband1, rt_raster rast2, int nband2, int *touches)
Return ES_ERROR if error occurred in function.
rt_errorstate rt_raster_get_inverse_geotransform_matrix(rt_raster raster, double *gt, double *igt)
Get 6-element array of raster inverse geotransform matrix.
Definition: rt_raster.c:676
char * rt_util_gdal_convert_sr(const char *srs, int proj4)
Definition: rt_util.c:212
const char * rt_pixtype_name(rt_pixtype pixtype)
Definition: rt_pixel.c:110
rt_errorstate rt_raster_iterator(rt_iterator itrset, uint16_t itrcount, rt_extenttype extenttype, rt_raster customextent, rt_pixtype pixtype, uint8_t hasnodata, double nodataval, uint16_t distancex, uint16_t distancey, rt_mask mask, void *userarg, int(*callback)(rt_iterator_arg arg, void *userarg, double *value, int *nodata), rt_raster *rtnraster)
n-raster iterator.
void * default_rt_allocator(size_t size)
The default memory/logging handlers installed by lwgeom_install_default_allocators() ...
Definition: rt_context.c:47
rt_band * bands
Definition: librtcore.h:2254
char * create_options
Definition: librtcore.h:2426
struct quantile_llist_index * index
Definition: librtcore.h:2353
rt_pixtype rt_band_get_pixtype(rt_band band)
Return pixeltype of this band.
Definition: rt_band.c:498
uint8_t bandNum
Definition: librtcore.h:2259
rt_errorstate rt_band_set_pixel_line(rt_band band, int x, int y, void *vals, uint32_t len)
Set values of multiple pixels.
Definition: rt_band.c:720
void * mem
Definition: librtcore.h:2278
rt_raster rt_raster_compute_skewed_raster(rt_envelope extent, double *skew, double *scale, double tolerance)
Definition: rt_raster.c:960
char * long_name
Definition: librtcore.h:2425
uint32_t has_value
Definition: librtcore.h:2339
int rt_raster_add_band(rt_raster raster, rt_band band, int index)
Add band data to a raster.
Definition: rt_raster.c:405
uint8_t algeq
Definition: librtcore.h:2344
int32_t hasnodata
Definition: librtcore.h:2269
rt_errorstate rt_util_gdal_sr_auth_info(GDALDatasetH hds, char **authname, char **authcode)
Get auth name and code.
Definition: rt_util.c:270
uint32_t count
Definition: librtcore.h:2350
void rt_util_from_ogr_envelope(OGREnvelope env, rt_envelope *ext)
Definition: rt_util.c:406
double ipX
Definition: librtcore.h:2246
struct rt_iterator_arg_t * rt_iterator_arg
Definition: librtcore.h:158
uint8_t rt_util_clamp_to_2BUI(double value)
Definition: rt_util.c:39
int rt_band_get_isnodata_flag(rt_band band)
Get isnodata flag value.
Definition: rt_band.c:581
struct rt_colormap_t * rt_colormap
Definition: librtcore.h:161
rt_errorstate rt_raster_fully_within_distance(rt_raster rast1, int nband1, rt_raster rast2, int nband2, double distance, int *dfwithin)
Return ES_ERROR if error occurred in function.
float rt_util_clamp_to_32F(double value)
Definition: rt_util.c:79
rt_errorstate rt_band_set_pixel(rt_band band, int x, int y, double val, int *converted)
Set single pixel's value.
Definition: rt_band.c:841
int rt_util_gdal_configured(void)
Definition: rt_util.c:313
const char * rt_util_gdal_version(const char *request)
Definition: rt_util.c:180
rt_raster rt_raster_from_gdal_dataset(GDALDatasetH ds)
Return a raster from a GDAL dataset.
Definition: rt_raster.c:2186
struct quantile_llist_element * head
Definition: librtcore.h:2348
rt_errorstate rt_raster_get_perimeter(rt_raster raster, int nband, LWGEOM **perimeter)
Get raster perimeter.
Definition: rt_geometry.c:182
rt_band rt_band_reclass(rt_band srcband, rt_pixtype pixtype, uint32_t hasnodata, double nodataval, rt_reclassexpr *exprset, int exprcount)
Returns new band with values reclassified.
Definition: rt_mapalgebra.c:50
rt_errorstate rt_raster_coveredby(rt_raster rast1, int nband1, rt_raster rast2, int nband2, int *coveredby)
Return ES_ERROR if error occurred in function.
uint16_t rt_raster_get_height(rt_raster raster)
Definition: rt_raster.c:129
double scaleX
Definition: librtcore.h:2244
struct rt_iterator_t * rt_iterator
Definition: librtcore.h:157
GDALResampleAlg rt_util_gdal_resample_alg(const char *algname)
Convert cstring name to GDAL Resample Algorithm.
Definition: rt_util.c:91
char * path
Definition: librtcore.h:2260
int isnodata
Definition: librtcore.h:2433
uint32_t rt_band_get_nearest_pixel(rt_band band, int x, int y, uint16_t distancex, uint16_t distancey, int exclude_nodata_value, rt_pixel *npixels)
Get nearest pixel(s) with value (not NODATA) to specified pixel.
Definition: rt_band.c:1241
rt_raster rt_raster_colormap(rt_raster raster, int nband, rt_colormap colormap)
Returns a new raster with up to four 8BUI bands (RGBA) from applying a colormap to the user-specified...
unsigned char uint8_t
Definition: uthash.h:79
rt_errorstate rt_raster_within_distance(rt_raster rast1, int nband1, rt_raster rast2, int nband2, double distance, int *dwithin)
Return ES_ERROR if error occurred in function.
double UpperLeftY
Definition: librtcore.h:171
uint8_t can_read
Definition: librtcore.h:2427
uint16_t dimx
Definition: librtcore.h:2295
rt_raster rt_raster_deserialize(void *serialized, int header_only)
Return a raster from a serialized form.
Definition: rt_serialize.c:717
rt_errorstate rt_raster_get_envelope(rt_raster raster, rt_envelope *env)
Get raster's envelope.
Definition: rt_raster.c:873
GDALDatasetH rt_util_gdal_open(const char *fn, GDALAccess fn_access, int shared)
Definition: rt_util.c:379
double rt_raster_get_y_offset(rt_raster raster)
Get raster y offset, in projection units.
Definition: rt_raster.c:222
rt_errorstate rt_util_hsv_to_rgb(double hsv[3], double rgb[3])
Definition: rt_util.c:557
double value
Definition: librtcore.h:2434
tuple y
Definition: pixval.py:54
uint64_t sum2
Definition: librtcore.h:2357
void(*) voi rt_install_default_allocators)(void)
Apply the default memory management (malloc() and free()) and error handlers.
double scaleY
Definition: librtcore.h:2245
rt_errorstate rt_pixtype_compare_clamped_values(rt_pixtype pixtype, double val, double refval, int *isequal)
Test to see if two values are equal when clamped.
Definition: rt_pixel.c:200
This library is the generic geometry handling section of PostGIS.
uint32_t count
Definition: librtcore.h:2325
rt_band rt_band_new_offline(uint16_t width, uint16_t height, rt_pixtype pixtype, uint32_t hasnodata, double nodataval, uint8_t bandNum, const char *path)
Create an out-db rt_band.
Definition: rt_band.c:119
int16_t rt_util_clamp_to_16BSI(double value)
Definition: rt_util.c:59
rt_errorstate rt_raster_contains_properly(rt_raster rast1, int nband1, rt_raster rast2, int nband2, int *contains)
Return ES_ERROR if error occurred in function.
rt_errorstate rt_raster_overlaps(rt_raster rast1, int nband1, rt_raster rast2, int nband2, int *overlaps)
Return ES_ERROR if error occurred in function.