1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766 10767 10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562 11563 11564 11565 11566 11567 11568 11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672 11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685 11686 11687 11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720 11721 11722 11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735 11736 11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776 11777 11778 11779 11780 11781 11782 11783 11784 11785 11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796 11797 11798 11799 11800 11801 11802 11803 11804 11805 11806 11807 11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821 11822 11823 11824 11825 11826 11827 11828 11829 11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090 12091 12092 12093 12094 12095 12096 12097 12098 12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129
|
/******************************************************************************
* $Id$
*
* Name: gdalmultidim.cpp
* Project: GDAL Core
* Purpose: GDAL Core C++/Private implementation for multidimensional support
* Author: Even Rouault <even.rouault at spatialys.com>
*
******************************************************************************
* Copyright (c) 2019, Even Rouault <even.rouault at spatialys.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
****************************************************************************/
#include <assert.h>
#include <algorithm>
#include <limits>
#include <queue>
#include <set>
#include <ctype.h> // isalnum
#include "cpl_error_internal.h"
#include "gdal_priv.h"
#include "gdal_pam.h"
#include "gdal_utils.h"
#include "cpl_safemaths.hpp"
#include "ogrsf_frmts.h"
#if defined(__clang__) || defined(_MSC_VER)
#define COMPILER_WARNS_ABOUT_ABSTRACT_VBASE_INIT
#endif
/************************************************************************/
/* GetPAM() */
/************************************************************************/
static std::shared_ptr<GDALPamMultiDim>
GetPAM(const std::shared_ptr<GDALMDArray> &poParent)
{
auto poPamArray = dynamic_cast<GDALPamMDArray *>(poParent.get());
if (poPamArray)
return poPamArray->GetPAM();
return nullptr;
}
/************************************************************************/
/* GDALMDArrayUnscaled */
/************************************************************************/
class GDALMDArrayUnscaled final : public GDALPamMDArray
{
private:
std::shared_ptr<GDALMDArray> m_poParent{};
GDALExtendedDataType m_dt;
bool m_bHasNoData;
double m_adfNoData[2]{std::numeric_limits<double>::quiet_NaN(),
std::numeric_limits<double>::quiet_NaN()};
protected:
explicit GDALMDArrayUnscaled(const std::shared_ptr<GDALMDArray> &poParent)
: GDALAbstractMDArray(std::string(),
"Unscaled view of " + poParent->GetFullName()),
GDALPamMDArray(std::string(),
"Unscaled view of " + poParent->GetFullName(),
::GetPAM(poParent)),
m_poParent(std::move(poParent)),
m_dt(GDALExtendedDataType::Create(
GDALDataTypeIsComplex(
m_poParent->GetDataType().GetNumericDataType())
? GDT_CFloat64
: GDT_Float64)),
m_bHasNoData(m_poParent->GetRawNoDataValue() != nullptr)
{
}
bool IRead(const GUInt64 *arrayStartIdx, const size_t *count,
const GInt64 *arrayStep, const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType,
void *pDstBuffer) const override;
bool IWrite(const GUInt64 *arrayStartIdx, const size_t *count,
const GInt64 *arrayStep, const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType,
const void *pSrcBuffer) override;
bool IAdviseRead(const GUInt64 *arrayStartIdx, const size_t *count,
CSLConstList papszOptions) const override
{
return m_poParent->AdviseRead(arrayStartIdx, count, papszOptions);
}
public:
static std::shared_ptr<GDALMDArrayUnscaled>
Create(const std::shared_ptr<GDALMDArray> &poParent)
{
auto newAr(std::shared_ptr<GDALMDArrayUnscaled>(
new GDALMDArrayUnscaled(poParent)));
newAr->SetSelf(newAr);
return newAr;
}
bool IsWritable() const override
{
return m_poParent->IsWritable();
}
const std::string &GetFilename() const override
{
return m_poParent->GetFilename();
}
const std::vector<std::shared_ptr<GDALDimension>> &
GetDimensions() const override
{
return m_poParent->GetDimensions();
}
const GDALExtendedDataType &GetDataType() const override
{
return m_dt;
}
const std::string &GetUnit() const override
{
return m_poParent->GetUnit();
}
std::shared_ptr<OGRSpatialReference> GetSpatialRef() const override
{
return m_poParent->GetSpatialRef();
}
const void *GetRawNoDataValue() const override
{
return m_bHasNoData ? &m_adfNoData[0] : nullptr;
}
bool SetRawNoDataValue(const void *pRawNoData) override
{
m_bHasNoData = true;
memcpy(m_adfNoData, pRawNoData, m_dt.GetSize());
return true;
}
std::vector<GUInt64> GetBlockSize() const override
{
return m_poParent->GetBlockSize();
}
std::shared_ptr<GDALAttribute>
GetAttribute(const std::string &osName) const override
{
return m_poParent->GetAttribute(osName);
}
std::vector<std::shared_ptr<GDALAttribute>>
GetAttributes(CSLConstList papszOptions = nullptr) const override
{
return m_poParent->GetAttributes(papszOptions);
}
bool SetUnit(const std::string &osUnit) override
{
return m_poParent->SetUnit(osUnit);
}
bool SetSpatialRef(const OGRSpatialReference *poSRS) override
{
return m_poParent->SetSpatialRef(poSRS);
}
std::shared_ptr<GDALAttribute>
CreateAttribute(const std::string &osName,
const std::vector<GUInt64> &anDimensions,
const GDALExtendedDataType &oDataType,
CSLConstList papszOptions = nullptr) override
{
return m_poParent->CreateAttribute(osName, anDimensions, oDataType,
papszOptions);
}
};
/************************************************************************/
/* ~GDALIHasAttribute() */
/************************************************************************/
GDALIHasAttribute::~GDALIHasAttribute() = default;
/************************************************************************/
/* GetAttribute() */
/************************************************************************/
/** Return an attribute by its name.
*
* If the attribute does not exist, nullptr should be silently returned.
*
* @note Driver implementation: this method will fallback to
* GetAttributeFromAttributes() is not explicitly implemented
*
* Drivers known to implement it for groups and arrays: MEM, netCDF.
*
* This is the same as the C function GDALGroupGetAttribute() or
* GDALMDArrayGetAttribute().
*
* @param osName Attribute name
* @return the attribute, or nullptr if it does not exist or an error occurred.
*/
std::shared_ptr<GDALAttribute>
GDALIHasAttribute::GetAttribute(const std::string &osName) const
{
return GetAttributeFromAttributes(osName);
}
/************************************************************************/
/* GetAttributeFromAttributes() */
/************************************************************************/
/** Possible fallback implementation for GetAttribute() using GetAttributes().
*/
std::shared_ptr<GDALAttribute>
GDALIHasAttribute::GetAttributeFromAttributes(const std::string &osName) const
{
auto attrs(GetAttributes());
for (const auto &attr : attrs)
{
if (attr->GetName() == osName)
return attr;
}
return nullptr;
}
/************************************************************************/
/* GetAttributes() */
/************************************************************************/
/** Return the list of attributes contained in a GDALMDArray or GDALGroup.
*
* If the attribute does not exist, nullptr should be silently returned.
*
* @note Driver implementation: optionally implemented. If implemented,
* GetAttribute() should also be implemented.
*
* Drivers known to implement it for groups and arrays: MEM, netCDF.
*
* This is the same as the C function GDALGroupGetAttributes() or
* GDALMDArrayGetAttributes().
* @param papszOptions Driver specific options determining how attributes
* should be retrieved. Pass nullptr for default behavior.
*
* @return the attributes.
*/
std::vector<std::shared_ptr<GDALAttribute>>
GDALIHasAttribute::GetAttributes(CPL_UNUSED CSLConstList papszOptions) const
{
return {};
}
/************************************************************************/
/* CreateAttribute() */
/************************************************************************/
/** Create an attribute within a GDALMDArray or GDALGroup.
*
* The attribute might not be "physically" created until a value is written
* into it.
*
* Optionally implemented.
*
* Drivers known to implement it: MEM, netCDF
*
* This is the same as the C function GDALGroupCreateAttribute() or
* GDALMDArrayCreateAttribute()
*
* @param osName Attribute name.
* @param anDimensions List of dimension sizes, ordered from the slowest varying
* dimension first to the fastest varying dimension last.
* Empty for a scalar attribute (common case)
* @param oDataType Attribute data type.
* @param papszOptions Driver specific options determining how the attribute.
* should be created.
*
* @return the new attribute, or nullptr if case of error
*/
std::shared_ptr<GDALAttribute> GDALIHasAttribute::CreateAttribute(
CPL_UNUSED const std::string &osName,
CPL_UNUSED const std::vector<GUInt64> &anDimensions,
CPL_UNUSED const GDALExtendedDataType &oDataType,
CPL_UNUSED CSLConstList papszOptions)
{
CPLError(CE_Failure, CPLE_NotSupported,
"CreateAttribute() not implemented");
return nullptr;
}
/************************************************************************/
/* GDALGroup() */
/************************************************************************/
//! @cond Doxygen_Suppress
GDALGroup::GDALGroup(const std::string &osParentName, const std::string &osName)
: m_osName(osParentName.empty() ? "/" : osName),
m_osFullName(
!osParentName.empty()
? ((osParentName == "/" ? "/" : osParentName + "/") + osName)
: "/")
{
}
//! @endcond
/************************************************************************/
/* ~GDALGroup() */
/************************************************************************/
GDALGroup::~GDALGroup() = default;
/************************************************************************/
/* GetMDArrayNames() */
/************************************************************************/
/** Return the list of multidimensional array names contained in this group.
*
* @note Driver implementation: optionally implemented. If implemented,
* OpenMDArray() should also be implemented.
*
* Drivers known to implement it: MEM, netCDF.
*
* This is the same as the C function GDALGroupGetMDArrayNames().
*
* @param papszOptions Driver specific options determining how arrays
* should be retrieved. Pass nullptr for default behavior.
*
* @return the array names.
*/
std::vector<std::string>
GDALGroup::GetMDArrayNames(CPL_UNUSED CSLConstList papszOptions) const
{
return {};
}
/************************************************************************/
/* OpenMDArray() */
/************************************************************************/
/** Open and return a multidimensional array.
*
* @note Driver implementation: optionally implemented. If implemented,
* GetMDArrayNames() should also be implemented.
*
* Drivers known to implement it: MEM, netCDF.
*
* This is the same as the C function GDALGroupOpenMDArray().
*
* @param osName Array name.
* @param papszOptions Driver specific options determining how the array should
* be opened. Pass nullptr for default behavior.
*
* @return the array, or nullptr.
*/
std::shared_ptr<GDALMDArray>
GDALGroup::OpenMDArray(CPL_UNUSED const std::string &osName,
CPL_UNUSED CSLConstList papszOptions) const
{
return nullptr;
}
/************************************************************************/
/* GetGroupNames() */
/************************************************************************/
/** Return the list of sub-groups contained in this group.
*
* @note Driver implementation: optionally implemented. If implemented,
* OpenGroup() should also be implemented.
*
* Drivers known to implement it: MEM, netCDF.
*
* This is the same as the C function GDALGroupGetGroupNames().
*
* @param papszOptions Driver specific options determining how groups
* should be retrieved. Pass nullptr for default behavior.
*
* @return the group names.
*/
std::vector<std::string>
GDALGroup::GetGroupNames(CPL_UNUSED CSLConstList papszOptions) const
{
return {};
}
/************************************************************************/
/* OpenGroup() */
/************************************************************************/
/** Open and return a sub-group.
*
* @note Driver implementation: optionally implemented. If implemented,
* GetGroupNames() should also be implemented.
*
* Drivers known to implement it: MEM, netCDF.
*
* This is the same as the C function GDALGroupOpenGroup().
*
* @param osName Sub-group name.
* @param papszOptions Driver specific options determining how the sub-group
* should be opened. Pass nullptr for default behavior.
*
* @return the group, or nullptr.
*/
std::shared_ptr<GDALGroup>
GDALGroup::OpenGroup(CPL_UNUSED const std::string &osName,
CPL_UNUSED CSLConstList papszOptions) const
{
return nullptr;
}
/************************************************************************/
/* GetVectorLayerNames() */
/************************************************************************/
/** Return the list of layer names contained in this group.
*
* @note Driver implementation: optionally implemented. If implemented,
* OpenVectorLayer() should also be implemented.
*
* Drivers known to implement it: OpenFileGDB, FileGDB
*
* Other drivers will return an empty list. GDALDataset::GetLayerCount() and
* GDALDataset::GetLayer() should then be used.
*
* This is the same as the C function GDALGroupGetVectorLayerNames().
*
* @param papszOptions Driver specific options determining how layers
* should be retrieved. Pass nullptr for default behavior.
*
* @return the vector layer names.
* @since GDAL 3.4
*/
std::vector<std::string>
GDALGroup::GetVectorLayerNames(CPL_UNUSED CSLConstList papszOptions) const
{
return {};
}
/************************************************************************/
/* OpenVectorLayer() */
/************************************************************************/
/** Open and return a vector layer.
*
* Due to the historical ownership of OGRLayer* by GDALDataset*, the
* lifetime of the returned OGRLayer* is linked to the one of the owner
* dataset (contrary to the general design of this class where objects can be
* used independently of the object that returned them)
*
* @note Driver implementation: optionally implemented. If implemented,
* GetVectorLayerNames() should also be implemented.
*
* Drivers known to implement it: MEM, netCDF.
*
* This is the same as the C function GDALGroupOpenVectorLayer().
*
* @param osName Vector layer name.
* @param papszOptions Driver specific options determining how the layer should
* be opened. Pass nullptr for default behavior.
*
* @return the group, or nullptr.
*/
OGRLayer *GDALGroup::OpenVectorLayer(CPL_UNUSED const std::string &osName,
CPL_UNUSED CSLConstList papszOptions) const
{
return nullptr;
}
/************************************************************************/
/* GetDimensions() */
/************************************************************************/
/** Return the list of dimensions contained in this group and used by its
* arrays.
*
* This is for dimensions that can potentially be used by several arrays.
* Not all drivers might implement this. To retrieve the dimensions used by
* a specific array, use GDALMDArray::GetDimensions().
*
* Drivers known to implement it: MEM, netCDF
*
* This is the same as the C function GDALGroupGetDimensions().
*
* @param papszOptions Driver specific options determining how groups
* should be retrieved. Pass nullptr for default behavior.
*
* @return the dimensions.
*/
std::vector<std::shared_ptr<GDALDimension>>
GDALGroup::GetDimensions(CPL_UNUSED CSLConstList papszOptions) const
{
return {};
}
/************************************************************************/
/* GetStructuralInfo() */
/************************************************************************/
/** Return structural information on the group.
*
* This may be the compression, etc..
*
* The return value should not be freed and is valid until GDALGroup is
* released or this function called again.
*
* This is the same as the C function GDALGroupGetStructuralInfo().
*/
CSLConstList GDALGroup::GetStructuralInfo() const
{
return nullptr;
}
/************************************************************************/
/* CreateGroup() */
/************************************************************************/
/** Create a sub-group within a group.
*
* Optionally implemented by drivers.
*
* Drivers known to implement it: MEM, netCDF
*
* This is the same as the C function GDALGroupCreateGroup().
*
* @param osName Sub-group name.
* @param papszOptions Driver specific options determining how the sub-group
* should be created.
*
* @return the new sub-group, or nullptr in case of error.
*/
std::shared_ptr<GDALGroup>
GDALGroup::CreateGroup(CPL_UNUSED const std::string &osName,
CPL_UNUSED CSLConstList papszOptions)
{
CPLError(CE_Failure, CPLE_NotSupported, "CreateGroup() not implemented");
return nullptr;
}
/************************************************************************/
/* CreateDimension() */
/************************************************************************/
/** Create a dimension within a group.
*
* @note Driver implementation: drivers supporting CreateDimension() should
* implement this method, but do not have necessarily to implement
* GDALGroup::GetDimensions().
*
* Drivers known to implement it: MEM, netCDF
*
* This is the same as the C function GDALGroupCreateDimension().
*
* @param osName Dimension name.
* @param osType Dimension type (might be empty, and ignored by drivers)
* @param osDirection Dimension direction (might be empty, and ignored by
* drivers)
* @param nSize Number of values indexed by this dimension. Should be > 0.
* @param papszOptions Driver specific options determining how the dimension
* should be created.
*
* @return the new dimension, or nullptr if case of error
*/
std::shared_ptr<GDALDimension> GDALGroup::CreateDimension(
CPL_UNUSED const std::string &osName, CPL_UNUSED const std::string &osType,
CPL_UNUSED const std::string &osDirection, CPL_UNUSED GUInt64 nSize,
CPL_UNUSED CSLConstList papszOptions)
{
CPLError(CE_Failure, CPLE_NotSupported,
"CreateDimension() not implemented");
return nullptr;
}
/************************************************************************/
/* CreateMDArray() */
/************************************************************************/
/** Create a multidimensional array within a group.
*
* It is recommended that the GDALDimension objects passed in aoDimensions
* belong to this group, either by retrieving them with GetDimensions()
* or creating a new one with CreateDimension().
*
* Optionally implemented.
*
* Drivers known to implement it: MEM, netCDF
*
* This is the same as the C function GDALGroupCreateMDArray().
*
* @note Driver implementation: drivers should take into account the possibility
* that GDALDimension object passed in aoDimensions might belong to a different
* group / dataset / driver and act accordingly.
*
* @param osName Array name.
* @param aoDimensions List of dimensions, ordered from the slowest varying
* dimension first to the fastest varying dimension last.
* Might be empty for a scalar array (if supported by
* driver)
* @param oDataType Array data type.
* @param papszOptions Driver specific options determining how the array
* should be created.
*
* @return the new array, or nullptr if case of error
*/
std::shared_ptr<GDALMDArray> GDALGroup::CreateMDArray(
CPL_UNUSED const std::string &osName,
CPL_UNUSED const std::vector<std::shared_ptr<GDALDimension>> &aoDimensions,
CPL_UNUSED const GDALExtendedDataType &oDataType,
CPL_UNUSED CSLConstList papszOptions)
{
CPLError(CE_Failure, CPLE_NotSupported, "CreateMDArray() not implemented");
return nullptr;
}
/************************************************************************/
/* GetTotalCopyCost() */
/************************************************************************/
/** Return a total "cost" to copy the group.
*
* Used as a parameter for CopFrom()
*/
GUInt64 GDALGroup::GetTotalCopyCost() const
{
GUInt64 nCost = COPY_COST;
nCost += GetAttributes().size() * GDALAttribute::COPY_COST;
auto groupNames = GetGroupNames();
for (const auto &name : groupNames)
{
auto subGroup = OpenGroup(name);
if (subGroup)
{
nCost += subGroup->GetTotalCopyCost();
}
}
auto arrayNames = GetMDArrayNames();
for (const auto &name : arrayNames)
{
auto array = OpenMDArray(name);
if (array)
{
nCost += array->GetTotalCopyCost();
}
}
return nCost;
}
/************************************************************************/
/* CopyFrom() */
/************************************************************************/
/** Copy the content of a group into a new (generally empty) group.
*
* @param poDstRootGroup Destination root group. Must NOT be nullptr.
* @param poSrcDS Source dataset. Might be nullptr (but for correct behavior
* of some output drivers this is not recommended)
* @param poSrcGroup Source group. Must NOT be nullptr.
* @param bStrict Whether to enable stict mode. In strict mode, any error will
* stop the copy. In relaxed mode, the copy will be attempted to
* be pursued.
* @param nCurCost Should be provided as a variable initially set to 0.
* @param nTotalCost Total cost from GetTotalCopyCost().
* @param pfnProgress Progress callback, or nullptr.
* @param pProgressData Progress user data, or nulptr.
* @param papszOptions Creation options. Currently, only array creation
* options are supported. They must be prefixed with
* "ARRAY:" . The scope may be further restricted to arrays of a certain
* dimension by adding "IF(DIM={ndims}):" after "ARRAY:".
* For example, "ARRAY:IF(DIM=2):BLOCKSIZE=256,256" will
* restrict BLOCKSIZE=256,256 to arrays of dimension 2.
* Restriction to arrays of a given name is done with adding
* "IF(NAME={name}):" after "ARRAY:". {name} can also be
* a full qualified name.
* A non-driver specific ARRAY option, "AUTOSCALE=YES" can
* be used to ask (non indexing) variables of type Float32 or Float64 to be
* scaled to UInt16 with scale and offset values being computed from the minimum
* and maximum of the source array. The integer data type used can be set with
* AUTOSCALE_DATA_TYPE=Byte/UInt16/Int16/UInt32/Int32.
*
* @return true in case of success (or partial success if bStrict == false).
*/
bool GDALGroup::CopyFrom(const std::shared_ptr<GDALGroup> &poDstRootGroup,
GDALDataset *poSrcDS,
const std::shared_ptr<GDALGroup> &poSrcGroup,
bool bStrict, GUInt64 &nCurCost,
const GUInt64 nTotalCost, GDALProgressFunc pfnProgress,
void *pProgressData, CSLConstList papszOptions)
{
if (pfnProgress == nullptr)
pfnProgress = GDALDummyProgress;
#define EXIT_OR_CONTINUE_IF_NULL(x) \
if (!(x)) \
{ \
if (bStrict) \
return false; \
continue; \
} \
(void)0
try
{
nCurCost += GDALGroup::COPY_COST;
const auto srcDims = poSrcGroup->GetDimensions();
std::map<std::string, std::shared_ptr<GDALDimension>>
mapExistingDstDims;
std::map<std::string, std::string> mapSrcVariableNameToIndexedDimName;
for (const auto &dim : srcDims)
{
auto dstDim = CreateDimension(dim->GetName(), dim->GetType(),
dim->GetDirection(), dim->GetSize());
EXIT_OR_CONTINUE_IF_NULL(dstDim);
mapExistingDstDims[dim->GetName()] = dstDim;
auto poIndexingVarSrc(dim->GetIndexingVariable());
if (poIndexingVarSrc)
{
mapSrcVariableNameToIndexedDimName[poIndexingVarSrc
->GetName()] =
dim->GetName();
}
}
auto attrs = poSrcGroup->GetAttributes();
for (const auto &attr : attrs)
{
auto dstAttr =
CreateAttribute(attr->GetName(), attr->GetDimensionsSize(),
attr->GetDataType());
EXIT_OR_CONTINUE_IF_NULL(dstAttr);
auto raw(attr->ReadAsRaw());
if (!dstAttr->Write(raw.data(), raw.size()) && bStrict)
return false;
}
if (!attrs.empty())
{
nCurCost += attrs.size() * GDALAttribute::COPY_COST;
if (!pfnProgress(double(nCurCost) / nTotalCost, "", pProgressData))
return false;
}
auto arrayNames = poSrcGroup->GetMDArrayNames();
for (const auto &name : arrayNames)
{
auto srcArray = poSrcGroup->OpenMDArray(name);
EXIT_OR_CONTINUE_IF_NULL(srcArray);
// Map source dimensions to target dimensions
std::vector<std::shared_ptr<GDALDimension>> dstArrayDims;
const auto &srcArrayDims(srcArray->GetDimensions());
for (const auto &dim : srcArrayDims)
{
auto dstDim = poDstRootGroup->OpenDimensionFromFullname(
dim->GetFullName());
if (dstDim && dstDim->GetSize() == dim->GetSize())
{
dstArrayDims.emplace_back(dstDim);
}
else
{
auto oIter = mapExistingDstDims.find(dim->GetName());
if (oIter != mapExistingDstDims.end() &&
oIter->second->GetSize() == dim->GetSize())
{
dstArrayDims.emplace_back(oIter->second);
}
else
{
std::string newDimName;
if (oIter == mapExistingDstDims.end())
{
newDimName = dim->GetName();
}
else
{
std::string newDimNamePrefix(name + '_' +
dim->GetName());
newDimName = newDimNamePrefix;
int nIterCount = 2;
while (mapExistingDstDims.find(newDimName) !=
mapExistingDstDims.end())
{
newDimName = newDimNamePrefix +
CPLSPrintf("_%d", nIterCount);
nIterCount++;
}
}
dstDim = CreateDimension(newDimName, dim->GetType(),
dim->GetDirection(),
dim->GetSize());
if (!dstDim)
return false;
mapExistingDstDims[newDimName] = dstDim;
dstArrayDims.emplace_back(dstDim);
}
}
}
CPLStringList aosArrayCO;
bool bAutoScale = false;
GDALDataType eAutoScaleType = GDT_UInt16;
for (CSLConstList papszIter = papszOptions; papszIter && *papszIter;
++papszIter)
{
if (STARTS_WITH_CI(*papszIter, "ARRAY:"))
{
const char *pszOption = *papszIter + strlen("ARRAY:");
if (STARTS_WITH_CI(pszOption, "IF(DIM="))
{
const char *pszNext = strchr(pszOption, ':');
if (pszNext != nullptr)
{
int nDim = atoi(pszOption + strlen("IF(DIM="));
if (static_cast<size_t>(nDim) ==
dstArrayDims.size())
{
pszOption = pszNext + 1;
}
else
{
pszOption = nullptr;
}
}
}
else if (STARTS_WITH_CI(pszOption, "IF(NAME="))
{
const char *pszName = pszOption + strlen("IF(NAME=");
const char *pszNext = strchr(pszName, ':');
if (pszNext != nullptr && pszNext > pszName &&
pszNext[-1] == ')')
{
CPLString osName;
osName.assign(pszName, pszNext - pszName - 1);
if (osName == srcArray->GetName() ||
osName == srcArray->GetFullName())
{
pszOption = pszNext + 1;
}
else
{
pszOption = nullptr;
}
}
}
if (pszOption)
{
if (STARTS_WITH_CI(pszOption, "AUTOSCALE="))
{
bAutoScale =
CPLTestBool(pszOption + strlen("AUTOSCALE="));
}
else if (STARTS_WITH_CI(pszOption,
"AUTOSCALE_DATA_TYPE="))
{
const char *pszDataType =
pszOption + strlen("AUTOSCALE_DATA_TYPE=");
eAutoScaleType = GDALGetDataTypeByName(pszDataType);
if (eAutoScaleType != GDT_Byte &&
eAutoScaleType != GDT_UInt16 &&
eAutoScaleType != GDT_Int16 &&
eAutoScaleType != GDT_UInt32 &&
eAutoScaleType != GDT_Int32 &&
eAutoScaleType != GDT_UInt64 &&
eAutoScaleType != GDT_Int64)
{
CPLError(CE_Failure, CPLE_NotSupported,
"Unsupported value for "
"AUTOSCALE_DATA_TYPE");
return false;
}
}
else
{
aosArrayCO.AddString(pszOption);
}
}
}
}
auto oIterDimName =
mapSrcVariableNameToIndexedDimName.find(srcArray->GetName());
const auto &srcArrayType = srcArray->GetDataType();
std::shared_ptr<GDALMDArray> dstArray;
// Only autoscale non-indexing variables
bool bHasOffset = false;
bool bHasScale = false;
if (bAutoScale && srcArrayType.GetClass() == GEDTC_NUMERIC &&
(srcArrayType.GetNumericDataType() == GDT_Float32 ||
srcArrayType.GetNumericDataType() == GDT_Float64) &&
srcArray->GetOffset(&bHasOffset) == 0.0 && !bHasOffset &&
srcArray->GetScale(&bHasScale) == 1.0 && !bHasScale &&
oIterDimName == mapSrcVariableNameToIndexedDimName.end())
{
constexpr bool bApproxOK = false;
constexpr bool bForce = true;
double dfMin = 0.0;
double dfMax = 0.0;
if (srcArray->GetStatistics(bApproxOK, bForce, &dfMin, &dfMax,
nullptr, nullptr, nullptr, nullptr,
nullptr) != CE_None)
{
CPLError(CE_Failure, CPLE_AppDefined,
"Could not retrieve statistics for array %s",
srcArray->GetName().c_str());
return false;
}
double dfDTMin = 0;
double dfDTMax = 0;
#define setDTMinMax(ctype) \
do \
{ \
dfDTMin = static_cast<double>(std::numeric_limits<ctype>::min()); \
dfDTMax = static_cast<double>(std::numeric_limits<ctype>::max()); \
} while (0)
switch (eAutoScaleType)
{
case GDT_Byte:
setDTMinMax(GByte);
break;
case GDT_UInt16:
setDTMinMax(GUInt16);
break;
case GDT_Int16:
setDTMinMax(GInt16);
break;
case GDT_UInt32:
setDTMinMax(GUInt32);
break;
case GDT_Int32:
setDTMinMax(GInt32);
break;
case GDT_UInt64:
setDTMinMax(std::uint64_t);
break;
case GDT_Int64:
setDTMinMax(std::int64_t);
break;
default:
CPLAssert(false);
}
dstArray =
CreateMDArray(srcArray->GetName(), dstArrayDims,
GDALExtendedDataType::Create(eAutoScaleType),
aosArrayCO.List());
EXIT_OR_CONTINUE_IF_NULL(dstArray);
if (srcArray->GetRawNoDataValue() != nullptr)
{
// If there's a nodata value in the source array, reserve
// DTMax for that purpose in the target scaled array
if (!dstArray->SetNoDataValue(dfDTMax))
{
CPLError(CE_Failure, CPLE_AppDefined,
"Cannot set nodata value");
return false;
}
dfDTMax--;
}
const double dfScale =
dfMax > dfMin ? (dfMax - dfMin) / (dfDTMax - dfDTMin) : 1.0;
const double dfOffset = dfMin - dfDTMin * dfScale;
if (!dstArray->SetOffset(dfOffset) ||
!dstArray->SetScale(dfScale))
{
CPLError(CE_Failure, CPLE_AppDefined,
"Cannot set scale/offset");
return false;
}
auto poUnscaled = dstArray->GetUnscaled();
if (srcArray->GetRawNoDataValue() != nullptr)
{
poUnscaled->SetNoDataValue(
srcArray->GetNoDataValueAsDouble());
}
// Copy source array into unscaled array
if (!poUnscaled->CopyFrom(poSrcDS, srcArray.get(), bStrict,
nCurCost, nTotalCost, pfnProgress,
pProgressData))
{
return false;
}
}
else
{
dstArray = CreateMDArray(srcArray->GetName(), dstArrayDims,
srcArrayType, aosArrayCO.List());
EXIT_OR_CONTINUE_IF_NULL(dstArray);
if (!dstArray->CopyFrom(poSrcDS, srcArray.get(), bStrict,
nCurCost, nTotalCost, pfnProgress,
pProgressData))
{
return false;
}
}
// If this array is the indexing variable of a dimension, link them
// together.
if (oIterDimName != mapSrcVariableNameToIndexedDimName.end())
{
auto oCorrespondingDimIter =
mapExistingDstDims.find(oIterDimName->second);
if (oCorrespondingDimIter != mapExistingDstDims.end())
{
CPLErrorHandlerPusher oHandlerPusher(CPLQuietErrorHandler);
CPLErrorStateBackuper oErrorStateBackuper;
oCorrespondingDimIter->second->SetIndexingVariable(
dstArray);
}
}
}
auto groupNames = poSrcGroup->GetGroupNames();
for (const auto &name : groupNames)
{
auto srcSubGroup = poSrcGroup->OpenGroup(name);
EXIT_OR_CONTINUE_IF_NULL(srcSubGroup);
auto dstSubGroup = CreateGroup(name);
EXIT_OR_CONTINUE_IF_NULL(dstSubGroup);
if (!dstSubGroup->CopyFrom(
poDstRootGroup, poSrcDS, srcSubGroup, bStrict, nCurCost,
nTotalCost, pfnProgress, pProgressData, papszOptions))
return false;
}
if (!pfnProgress(double(nCurCost) / nTotalCost, "", pProgressData))
return false;
return true;
}
catch (const std::exception &e)
{
CPLError(CE_Failure, CPLE_AppDefined, "%s", e.what());
return false;
}
}
/************************************************************************/
/* GetInnerMostGroup() */
/************************************************************************/
//! @cond Doxygen_Suppress
const GDALGroup *
GDALGroup::GetInnerMostGroup(const std::string &osPathOrArrayOrDim,
std::shared_ptr<GDALGroup> &curGroupHolder,
std::string &osLastPart) const
{
if (osPathOrArrayOrDim.empty() || osPathOrArrayOrDim[0] != '/')
return nullptr;
const GDALGroup *poCurGroup = this;
CPLStringList aosTokens(
CSLTokenizeString2(osPathOrArrayOrDim.c_str(), "/", 0));
if (aosTokens.size() == 0)
{
return nullptr;
}
for (int i = 0; i < aosTokens.size() - 1; i++)
{
curGroupHolder = poCurGroup->OpenGroup(aosTokens[i], nullptr);
if (!curGroupHolder)
{
CPLError(CE_Failure, CPLE_AppDefined, "Cannot find group %s",
aosTokens[i]);
return nullptr;
}
poCurGroup = curGroupHolder.get();
}
osLastPart = aosTokens[aosTokens.size() - 1];
return poCurGroup;
}
//! @endcond
/************************************************************************/
/* OpenMDArrayFromFullname() */
/************************************************************************/
/** Get an array from its fully qualified name */
std::shared_ptr<GDALMDArray>
GDALGroup::OpenMDArrayFromFullname(const std::string &osFullName,
CSLConstList papszOptions) const
{
std::string osName;
std::shared_ptr<GDALGroup> curGroupHolder;
auto poGroup(GetInnerMostGroup(osFullName, curGroupHolder, osName));
if (poGroup == nullptr)
return nullptr;
return poGroup->OpenMDArray(osName, papszOptions);
}
/************************************************************************/
/* ResolveMDArray() */
/************************************************************************/
/** Locate an array in a group and its subgroups by name.
*
* If osName is a fully qualified name, then OpenMDArrayFromFullname() is first
* used
* Otherwise the search will start from the group identified by osStartingPath,
* and an array whose name is osName will be looked for in this group (if
* osStartingPath is empty or "/", then the current group is used). If there
* is no match, then a recursive descendent search will be made in its
* subgroups. If there is no match in the subgroups, then the parent (if
* existing) of the group pointed by osStartingPath will be used as the new
* starting point for the search.
*
* @param osName name, qualified or not
* @param osStartingPath fully qualified name of the (sub-)group from which
* the search should be started. If this is a non-empty
* string, the group on which this method is called should
* nominally be the root group (otherwise the path will
* be interpreted as from the current group)
* @param papszOptions options to pass to OpenMDArray()
* @since GDAL 3.2
*/
std::shared_ptr<GDALMDArray>
GDALGroup::ResolveMDArray(const std::string &osName,
const std::string &osStartingPath,
CSLConstList papszOptions) const
{
if (!osName.empty() && osName[0] == '/')
{
auto poArray = OpenMDArrayFromFullname(osName, papszOptions);
if (poArray)
return poArray;
}
std::string osPath(osStartingPath);
std::set<std::string> oSetAlreadyVisited;
while (true)
{
std::shared_ptr<GDALGroup> curGroupHolder;
std::shared_ptr<GDALGroup> poGroup;
std::queue<std::shared_ptr<GDALGroup>> oQueue;
bool goOn = false;
if (osPath.empty() || osPath == "/")
{
goOn = true;
}
else
{
std::string osLastPart;
const GDALGroup *poGroupPtr =
GetInnerMostGroup(osPath, curGroupHolder, osLastPart);
if (poGroupPtr)
poGroup = poGroupPtr->OpenGroup(osLastPart);
if (poGroup && oSetAlreadyVisited.find(poGroup->GetFullName()) ==
oSetAlreadyVisited.end())
{
oQueue.push(poGroup);
goOn = true;
}
}
if (goOn)
{
do
{
const GDALGroup *groupPtr;
if (!oQueue.empty())
{
poGroup = oQueue.front();
oQueue.pop();
groupPtr = poGroup.get();
}
else
{
groupPtr = this;
}
auto poArray = groupPtr->OpenMDArray(osName, papszOptions);
if (poArray)
return poArray;
const auto aosGroupNames = groupPtr->GetGroupNames();
for (const auto &osGroupName : aosGroupNames)
{
auto poSubGroup = groupPtr->OpenGroup(osGroupName);
if (poSubGroup &&
oSetAlreadyVisited.find(poSubGroup->GetFullName()) ==
oSetAlreadyVisited.end())
{
oQueue.push(poSubGroup);
oSetAlreadyVisited.insert(poSubGroup->GetFullName());
}
}
} while (!oQueue.empty());
}
if (osPath.empty() || osPath == "/")
break;
const auto nPos = osPath.rfind('/');
if (nPos == 0)
osPath = "/";
else
{
if (nPos == std::string::npos)
break;
osPath.resize(nPos);
}
}
return nullptr;
}
/************************************************************************/
/* OpenGroupFromFullname() */
/************************************************************************/
/** Get a group from its fully qualified name.
* @since GDAL 3.2
*/
std::shared_ptr<GDALGroup>
GDALGroup::OpenGroupFromFullname(const std::string &osFullName,
CSLConstList papszOptions) const
{
std::string osName;
std::shared_ptr<GDALGroup> curGroupHolder;
auto poGroup(GetInnerMostGroup(osFullName, curGroupHolder, osName));
if (poGroup == nullptr)
return nullptr;
return poGroup->OpenGroup(osName, papszOptions);
}
/************************************************************************/
/* OpenDimensionFromFullname() */
/************************************************************************/
/** Get a dimension from its fully qualified name */
std::shared_ptr<GDALDimension>
GDALGroup::OpenDimensionFromFullname(const std::string &osFullName) const
{
std::string osName;
std::shared_ptr<GDALGroup> curGroupHolder;
auto poGroup(GetInnerMostGroup(osFullName, curGroupHolder, osName));
if (poGroup == nullptr)
return nullptr;
auto dims(poGroup->GetDimensions());
for (auto &dim : dims)
{
if (dim->GetName() == osName)
return dim;
}
return nullptr;
}
/************************************************************************/
/* ClearStatistics() */
/************************************************************************/
/**
* \brief Clear statistics.
*
* @since GDAL 3.4
*/
void GDALGroup::ClearStatistics()
{
auto groupNames = GetGroupNames();
for (const auto &name : groupNames)
{
auto subGroup = OpenGroup(name);
if (subGroup)
{
subGroup->ClearStatistics();
}
}
auto arrayNames = GetMDArrayNames();
for (const auto &name : arrayNames)
{
auto array = OpenMDArray(name);
if (array)
{
array->ClearStatistics();
}
}
}
/************************************************************************/
/* ~GDALAbstractMDArray() */
/************************************************************************/
GDALAbstractMDArray::~GDALAbstractMDArray() = default;
/************************************************************************/
/* GDALAbstractMDArray() */
/************************************************************************/
//! @cond Doxygen_Suppress
GDALAbstractMDArray::GDALAbstractMDArray(const std::string &osParentName,
const std::string &osName)
: m_osName(osName),
m_osFullName(
!osParentName.empty()
? ((osParentName == "/" ? "/" : osParentName + "/") + osName)
: osName)
{
}
//! @endcond
/************************************************************************/
/* GetDimensions() */
/************************************************************************/
/** \fn GDALAbstractMDArray::GetDimensions() const
* \brief Return the dimensions of an attribute/array.
*
* This is the same as the C functions GDALMDArrayGetDimensions() and
* similar to GDALAttributeGetDimensionsSize().
*/
/************************************************************************/
/* GetDataType() */
/************************************************************************/
/** \fn GDALAbstractMDArray::GetDataType() const
* \brief Return the data type of an attribute/array.
*
* This is the same as the C functions GDALMDArrayGetDataType() and
* GDALAttributeGetDataType()
*/
/************************************************************************/
/* GetDimensionCount() */
/************************************************************************/
/** Return the number of dimensions.
*
* Default implementation is GetDimensions().size(), and may be overridden by
* drivers if they have a faster / less expensive implementations.
*
* This is the same as the C function GDALMDArrayGetDimensionCount() or
* GDALAttributeGetDimensionCount().
*
*/
size_t GDALAbstractMDArray::GetDimensionCount() const
{
return GetDimensions().size();
}
/************************************************************************/
/* CopyValue() */
/************************************************************************/
/** Convert a value from a source type to a destination type.
*
* If dstType is GEDTC_STRING, the written value will be a pointer to a char*,
* that must be freed with CPLFree().
*/
bool GDALExtendedDataType::CopyValue(const void *pSrc,
const GDALExtendedDataType &srcType,
void *pDst,
const GDALExtendedDataType &dstType)
{
if (srcType.GetClass() == GEDTC_NUMERIC &&
dstType.GetClass() == GEDTC_NUMERIC)
{
GDALCopyWords(pSrc, srcType.GetNumericDataType(), 0, pDst,
dstType.GetNumericDataType(), 0, 1);
return true;
}
if (srcType.GetClass() == GEDTC_STRING &&
dstType.GetClass() == GEDTC_STRING)
{
const char *srcStrPtr;
memcpy(&srcStrPtr, pSrc, sizeof(const char *));
char *pszDup = srcStrPtr ? CPLStrdup(srcStrPtr) : nullptr;
*reinterpret_cast<void **>(pDst) = pszDup;
return true;
}
if (srcType.GetClass() == GEDTC_NUMERIC &&
dstType.GetClass() == GEDTC_STRING)
{
const char *str = nullptr;
switch (srcType.GetNumericDataType())
{
case GDT_Unknown:
break;
case GDT_Byte:
str = CPLSPrintf("%d", *static_cast<const GByte *>(pSrc));
break;
case GDT_UInt16:
str = CPLSPrintf("%d", *static_cast<const GUInt16 *>(pSrc));
break;
case GDT_Int16:
str = CPLSPrintf("%d", *static_cast<const GInt16 *>(pSrc));
break;
case GDT_UInt32:
str = CPLSPrintf("%u", *static_cast<const GUInt32 *>(pSrc));
break;
case GDT_Int32:
str = CPLSPrintf("%d", *static_cast<const GInt32 *>(pSrc));
break;
case GDT_UInt64:
str =
CPLSPrintf(CPL_FRMT_GUIB,
static_cast<GUIntBig>(
*static_cast<const std::uint64_t *>(pSrc)));
break;
case GDT_Int64:
str = CPLSPrintf(CPL_FRMT_GIB,
static_cast<GIntBig>(
*static_cast<const std::int64_t *>(pSrc)));
break;
case GDT_Float32:
str = CPLSPrintf("%.9g", *static_cast<const float *>(pSrc));
break;
case GDT_Float64:
str = CPLSPrintf("%.18g", *static_cast<const double *>(pSrc));
break;
case GDT_CInt16:
{
const GInt16 *src = static_cast<const GInt16 *>(pSrc);
str = CPLSPrintf("%d+%dj", src[0], src[1]);
break;
}
case GDT_CInt32:
{
const GInt32 *src = static_cast<const GInt32 *>(pSrc);
str = CPLSPrintf("%d+%dj", src[0], src[1]);
break;
}
case GDT_CFloat32:
{
const float *src = static_cast<const float *>(pSrc);
str = CPLSPrintf("%.9g+%.9gj", src[0], src[1]);
break;
}
case GDT_CFloat64:
{
const double *src = static_cast<const double *>(pSrc);
str = CPLSPrintf("%.18g+%.18gj", src[0], src[1]);
break;
}
case GDT_TypeCount:
CPLAssert(false);
break;
}
char *pszDup = str ? CPLStrdup(str) : nullptr;
*reinterpret_cast<void **>(pDst) = pszDup;
return true;
}
if (srcType.GetClass() == GEDTC_STRING &&
dstType.GetClass() == GEDTC_NUMERIC)
{
const char *srcStrPtr;
memcpy(&srcStrPtr, pSrc, sizeof(const char *));
if (dstType.GetNumericDataType() == GDT_Int64)
{
*(static_cast<int64_t *>(pDst)) =
srcStrPtr == nullptr ? 0
: static_cast<int64_t>(atoll(srcStrPtr));
}
else if (dstType.GetNumericDataType() == GDT_UInt64)
{
*(static_cast<uint64_t *>(pDst)) =
srcStrPtr == nullptr
? 0
: static_cast<uint64_t>(strtoull(srcStrPtr, nullptr, 10));
}
else
{
// FIXME GDT_UInt64
const double dfVal = srcStrPtr == nullptr ? 0 : CPLAtof(srcStrPtr);
GDALCopyWords(&dfVal, GDT_Float64, 0, pDst,
dstType.GetNumericDataType(), 0, 1);
}
return true;
}
if (srcType.GetClass() == GEDTC_COMPOUND &&
dstType.GetClass() == GEDTC_COMPOUND)
{
const auto &srcComponents = srcType.GetComponents();
const auto &dstComponents = dstType.GetComponents();
const GByte *pabySrc = static_cast<const GByte *>(pSrc);
GByte *pabyDst = static_cast<GByte *>(pDst);
std::map<std::string, const std::unique_ptr<GDALEDTComponent> *>
srcComponentMap;
for (const auto &srcComp : srcComponents)
{
srcComponentMap[srcComp->GetName()] = &srcComp;
}
for (const auto &dstComp : dstComponents)
{
auto oIter = srcComponentMap.find(dstComp->GetName());
if (oIter == srcComponentMap.end())
return false;
const auto &srcComp = *(oIter->second);
if (!GDALExtendedDataType::CopyValue(
pabySrc + srcComp->GetOffset(), srcComp->GetType(),
pabyDst + dstComp->GetOffset(), dstComp->GetType()))
{
return false;
};
}
return true;
}
return false;
}
/************************************************************************/
/* CopyValues() */
/************************************************************************/
/** Convert severals value from a source type to a destination type.
*
* If dstType is GEDTC_STRING, the written value will be a pointer to a char*,
* that must be freed with CPLFree().
*/
bool GDALExtendedDataType::CopyValues(const void *pSrc,
const GDALExtendedDataType &srcType,
GPtrDiff_t nSrcStrideInElts, void *pDst,
const GDALExtendedDataType &dstType,
GPtrDiff_t nDstStrideInElts,
size_t nValues)
{
const auto nSrcStrideInBytes =
nSrcStrideInElts * static_cast<GPtrDiff_t>(srcType.GetSize());
const auto nDstStrideInBytes =
nDstStrideInElts * static_cast<GPtrDiff_t>(dstType.GetSize());
if (srcType.GetClass() == GEDTC_NUMERIC &&
dstType.GetClass() == GEDTC_NUMERIC &&
nSrcStrideInBytes >= std::numeric_limits<int>::min() &&
nSrcStrideInBytes <= std::numeric_limits<int>::max() &&
nDstStrideInBytes >= std::numeric_limits<int>::min() &&
nDstStrideInBytes <= std::numeric_limits<int>::max())
{
GDALCopyWords64(pSrc, srcType.GetNumericDataType(),
static_cast<int>(nSrcStrideInBytes), pDst,
dstType.GetNumericDataType(),
static_cast<int>(nDstStrideInBytes), nValues);
}
else
{
const GByte *pabySrc = static_cast<const GByte *>(pSrc);
GByte *pabyDst = static_cast<GByte *>(pDst);
for (size_t i = 0; i < nValues; ++i)
{
if (!CopyValue(pabySrc, srcType, pabyDst, dstType))
return false;
pabySrc += nSrcStrideInBytes;
pabyDst += nDstStrideInBytes;
}
}
return true;
}
/************************************************************************/
/* CheckReadWriteParams() */
/************************************************************************/
//! @cond Doxygen_Suppress
bool GDALAbstractMDArray::CheckReadWriteParams(
const GUInt64 *arrayStartIdx, const size_t *count, const GInt64 *&arrayStep,
const GPtrDiff_t *&bufferStride, const GDALExtendedDataType &bufferDataType,
const void *buffer, const void *buffer_alloc_start,
size_t buffer_alloc_size, std::vector<GInt64> &tmp_arrayStep,
std::vector<GPtrDiff_t> &tmp_bufferStride) const
{
const auto lamda_error = []()
{
CPLError(CE_Failure, CPLE_AppDefined,
"Not all elements pointed by buffer will fit in "
"[buffer_alloc_start, "
"buffer_alloc_start + buffer_alloc_size[");
};
const auto &dims = GetDimensions();
if (dims.empty())
{
if (buffer_alloc_start)
{
const size_t elementSize = bufferDataType.GetSize();
const GByte *paby_buffer = static_cast<const GByte *>(buffer);
const GByte *paby_buffer_alloc_start =
static_cast<const GByte *>(buffer_alloc_start);
const GByte *paby_buffer_alloc_end =
paby_buffer_alloc_start + buffer_alloc_size;
if (paby_buffer < paby_buffer_alloc_start ||
paby_buffer + elementSize > paby_buffer_alloc_end)
{
lamda_error();
return false;
}
}
return true;
}
if (arrayStep == nullptr)
{
tmp_arrayStep.resize(dims.size(), 1);
arrayStep = tmp_arrayStep.data();
}
for (size_t i = 0; i < dims.size(); i++)
{
if (count[i] == 0)
{
CPLError(CE_Failure, CPLE_AppDefined, "count[%u] = 0 is invalid",
static_cast<unsigned>(i));
return false;
}
}
bool bufferStride_all_positive = true;
if (bufferStride == nullptr)
{
GPtrDiff_t stride = 1;
// To compute strides we must proceed from the fastest varying dimension
// (the last one), and then reverse the result
for (size_t i = dims.size(); i != 0;)
{
--i;
tmp_bufferStride.push_back(stride);
GUInt64 newStride = 0;
bool bOK;
try
{
newStride = (CPLSM(static_cast<GUInt64>(stride)) *
CPLSM(static_cast<GUInt64>(count[i])))
.v();
bOK = static_cast<size_t>(newStride) == newStride &&
newStride < std::numeric_limits<size_t>::max() / 2;
}
catch (...)
{
bOK = false;
}
if (!bOK)
{
CPLError(CE_Failure, CPLE_OutOfMemory, "Too big count values");
return false;
}
stride = static_cast<GPtrDiff_t>(newStride);
}
std::reverse(tmp_bufferStride.begin(), tmp_bufferStride.end());
bufferStride = tmp_bufferStride.data();
}
else
{
for (size_t i = 0; i < dims.size(); i++)
{
if (bufferStride[i] < 0)
{
bufferStride_all_positive = false;
break;
}
}
}
for (size_t i = 0; i < dims.size(); i++)
{
if (arrayStartIdx[i] >= dims[i]->GetSize())
{
CPLError(CE_Failure, CPLE_AppDefined,
"arrayStartIdx[%u] = " CPL_FRMT_GUIB " >= " CPL_FRMT_GUIB,
static_cast<unsigned>(i),
static_cast<GUInt64>(arrayStartIdx[i]),
static_cast<GUInt64>(dims[i]->GetSize()));
return false;
}
bool bOverflow;
if (arrayStep[i] >= 0)
{
try
{
bOverflow = (CPLSM(static_cast<GUInt64>(arrayStartIdx[i])) +
CPLSM(static_cast<GUInt64>(count[i] - 1)) *
CPLSM(static_cast<GUInt64>(arrayStep[i])))
.v() >= dims[i]->GetSize();
}
catch (...)
{
bOverflow = true;
}
if (bOverflow)
{
CPLError(CE_Failure, CPLE_AppDefined,
"arrayStartIdx[%u] + (count[%u]-1) * arrayStep[%u] "
">= " CPL_FRMT_GUIB,
static_cast<unsigned>(i), static_cast<unsigned>(i),
static_cast<unsigned>(i),
static_cast<GUInt64>(dims[i]->GetSize()));
return false;
}
}
else
{
try
{
bOverflow =
arrayStartIdx[i] <
(CPLSM(static_cast<GUInt64>(count[i] - 1)) *
CPLSM(arrayStep[i] == std::numeric_limits<GInt64>::min()
? (static_cast<GUInt64>(1) << 63)
: static_cast<GUInt64>(-arrayStep[i])))
.v();
}
catch (...)
{
bOverflow = true;
}
if (bOverflow)
{
CPLError(
CE_Failure, CPLE_AppDefined,
"arrayStartIdx[%u] + (count[%u]-1) * arrayStep[%u] < 0",
static_cast<unsigned>(i), static_cast<unsigned>(i),
static_cast<unsigned>(i));
return false;
}
}
}
if (buffer_alloc_start)
{
const size_t elementSize = bufferDataType.GetSize();
const GByte *paby_buffer = static_cast<const GByte *>(buffer);
const GByte *paby_buffer_alloc_start =
static_cast<const GByte *>(buffer_alloc_start);
const GByte *paby_buffer_alloc_end =
paby_buffer_alloc_start + buffer_alloc_size;
if (bufferStride_all_positive)
{
if (paby_buffer < paby_buffer_alloc_start)
{
lamda_error();
return false;
}
GUInt64 nOffset = elementSize;
for (size_t i = 0; i < dims.size(); i++)
{
try
{
nOffset = (CPLSM(static_cast<GUInt64>(nOffset)) +
CPLSM(static_cast<GUInt64>(bufferStride[i])) *
CPLSM(static_cast<GUInt64>(count[i] - 1)) *
CPLSM(static_cast<GUInt64>(elementSize)))
.v();
}
catch (...)
{
lamda_error();
return false;
}
}
#if SIZEOF_VOIDP == 4
if (static_cast<size_t>(nOffset) != nOffset)
{
lamda_error();
return false;
}
#endif
if (paby_buffer + nOffset > paby_buffer_alloc_end)
{
lamda_error();
return false;
}
}
else if (dims.size() < 31)
{
// Check all corners of the hypercube
const unsigned nLoops = 1U << static_cast<unsigned>(dims.size());
for (unsigned iCornerCode = 0; iCornerCode < nLoops; iCornerCode++)
{
const GByte *paby = paby_buffer;
for (unsigned i = 0; i < static_cast<unsigned>(dims.size());
i++)
{
if (iCornerCode & (1U << i))
{
// We should check for integer overflows
paby += bufferStride[i] * (count[i] - 1) * elementSize;
}
}
if (paby < paby_buffer_alloc_start ||
paby + elementSize > paby_buffer_alloc_end)
{
lamda_error();
return false;
}
}
}
}
return true;
}
//! @endcond
/************************************************************************/
/* Read() */
/************************************************************************/
/** Read part or totality of a multidimensional array or attribute.
*
* This will extract the content of a hyper-rectangle from the array into
* a user supplied buffer.
*
* If bufferDataType is of type string, the values written in pDstBuffer
* will be char* pointers and the strings should be freed with CPLFree().
*
* This is the same as the C function GDALMDArrayRead().
*
* @param arrayStartIdx Values representing the starting index to read
* in each dimension (in [0, aoDims[i].GetSize()-1] range).
* Array of GetDimensionCount() values. Must not be
* nullptr, unless for a zero-dimensional array.
*
* @param count Values representing the number of values to extract in
* each dimension.
* Array of GetDimensionCount() values. Must not be
* nullptr, unless for a zero-dimensional array.
*
* @param arrayStep Spacing between values to extract in each dimension.
* The spacing is in number of array elements, not bytes.
* If provided, must contain GetDimensionCount() values.
* If set to nullptr, [1, 1, ... 1] will be used as a
* default to indicate consecutive elements.
*
* @param bufferStride Spacing between values to store in pDstBuffer.
* The spacing is in number of array elements, not bytes.
* If provided, must contain GetDimensionCount() values.
* Negative values are possible (for example to reorder
* from bottom-to-top to top-to-bottom).
* If set to nullptr, will be set so that pDstBuffer is
* written in a compact way, with elements of the last /
* fastest varying dimension being consecutive.
*
* @param bufferDataType Data type of values in pDstBuffer.
*
* @param pDstBuffer User buffer to store the values read. Should be big
* enough to store the number of values indicated by
* count[] and with the spacing of bufferStride[].
*
* @param pDstBufferAllocStart Optional pointer that can be used to validate the
* validty of pDstBuffer. pDstBufferAllocStart
* should be the pointer returned by the malloc() or equivalent call used to
* allocate the buffer. It will generally be equal to pDstBuffer (when
* bufferStride[] values are all positive), but not necessarily. If specified,
* nDstBufferAllocSize should be also set to the appropriate value. If no
* validation is needed, nullptr can be passed.
*
* @param nDstBufferAllocSize Optional buffer size, that can be used to
* validate the validty of pDstBuffer. This is the size of the buffer starting
* at pDstBufferAllocStart. If specified, pDstBufferAllocStart should be also
* set to the appropriate value.
* If no validation is needed, 0 can be passed.
*
* @return true in case of success.
*/
bool GDALAbstractMDArray::Read(
const GUInt64 *arrayStartIdx, const size_t *count,
const GInt64 *arrayStep, // step in elements
const GPtrDiff_t *bufferStride, // stride in elements
const GDALExtendedDataType &bufferDataType, void *pDstBuffer,
const void *pDstBufferAllocStart, size_t nDstBufferAllocSize) const
{
if (!GetDataType().CanConvertTo(bufferDataType))
{
CPLError(CE_Failure, CPLE_AppDefined,
"Array data type is not convertible to buffer data type");
return false;
}
std::vector<GInt64> tmp_arrayStep;
std::vector<GPtrDiff_t> tmp_bufferStride;
if (!CheckReadWriteParams(arrayStartIdx, count, arrayStep, bufferStride,
bufferDataType, pDstBuffer, pDstBufferAllocStart,
nDstBufferAllocSize, tmp_arrayStep,
tmp_bufferStride))
{
return false;
}
return IRead(arrayStartIdx, count, arrayStep, bufferStride, bufferDataType,
pDstBuffer);
}
/************************************************************************/
/* IWrite() */
/************************************************************************/
//! @cond Doxygen_Suppress
bool GDALAbstractMDArray::IWrite(const GUInt64 *, const size_t *,
const GInt64 *, const GPtrDiff_t *,
const GDALExtendedDataType &, const void *)
{
CPLError(CE_Failure, CPLE_AppDefined, "IWrite() not implemented");
return false;
}
//! @endcond
/************************************************************************/
/* Write() */
/************************************************************************/
/** Write part or totality of a multidimensional array or attribute.
*
* This will set the content of a hyper-rectangle into the array from
* a user supplied buffer.
*
* If bufferDataType is of type string, the values read from pSrcBuffer
* will be char* pointers.
*
* This is the same as the C function GDALMDArrayWrite().
*
* @param arrayStartIdx Values representing the starting index to write
* in each dimension (in [0, aoDims[i].GetSize()-1] range).
* Array of GetDimensionCount() values. Must not be
* nullptr, unless for a zero-dimensional array.
*
* @param count Values representing the number of values to write in
* each dimension.
* Array of GetDimensionCount() values. Must not be
* nullptr, unless for a zero-dimensional array.
*
* @param arrayStep Spacing between values to write in each dimension.
* The spacing is in number of array elements, not bytes.
* If provided, must contain GetDimensionCount() values.
* If set to nullptr, [1, 1, ... 1] will be used as a
* default to indicate consecutive elements.
*
* @param bufferStride Spacing between values to read from pSrcBuffer.
* The spacing is in number of array elements, not bytes.
* If provided, must contain GetDimensionCount() values.
* Negative values are possible (for example to reorder
* from bottom-to-top to top-to-bottom).
* If set to nullptr, will be set so that pSrcBuffer is
* written in a compact way, with elements of the last /
* fastest varying dimension being consecutive.
*
* @param bufferDataType Data type of values in pSrcBuffer.
*
* @param pSrcBuffer User buffer to read the values from. Should be big
* enough to store the number of values indicated by
* count[] and with the spacing of bufferStride[].
*
* @param pSrcBufferAllocStart Optional pointer that can be used to validate the
* validty of pSrcBuffer. pSrcBufferAllocStart
* should be the pointer returned by the malloc() or equivalent call used to
* allocate the buffer. It will generally be equal to pSrcBuffer (when
* bufferStride[] values are all positive), but not necessarily. If specified,
* nSrcBufferAllocSize should be also set to the appropriate value. If no
* validation is needed, nullptr can be passed.
*
* @param nSrcBufferAllocSize Optional buffer size, that can be used to
* validate the validty of pSrcBuffer. This is the size of the buffer starting
* at pSrcBufferAllocStart. If specified, pDstBufferAllocStart should be also
* set to the appropriate value.
* If no validation is needed, 0 can be passed.
*
* @return true in case of success.
*/
bool GDALAbstractMDArray::Write(const GUInt64 *arrayStartIdx,
const size_t *count, const GInt64 *arrayStep,
const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType,
const void *pSrcBuffer,
const void *pSrcBufferAllocStart,
size_t nSrcBufferAllocSize)
{
if (!bufferDataType.CanConvertTo(GetDataType()))
{
CPLError(CE_Failure, CPLE_AppDefined,
"Buffer data type is not convertible to array data type");
return false;
}
std::vector<GInt64> tmp_arrayStep;
std::vector<GPtrDiff_t> tmp_bufferStride;
if (!CheckReadWriteParams(arrayStartIdx, count, arrayStep, bufferStride,
bufferDataType, pSrcBuffer, pSrcBufferAllocStart,
nSrcBufferAllocSize, tmp_arrayStep,
tmp_bufferStride))
{
return false;
}
return IWrite(arrayStartIdx, count, arrayStep, bufferStride, bufferDataType,
pSrcBuffer);
}
/************************************************************************/
/* GetTotalElementsCount() */
/************************************************************************/
/** Return the total number of values in the array.
*
* This is the same as the C functions GDALMDArrayGetTotalElementsCount()
* and GDALAttributeGetTotalElementsCount().
*
*/
GUInt64 GDALAbstractMDArray::GetTotalElementsCount() const
{
const auto &dims = GetDimensions();
if (dims.empty())
return 1;
GUInt64 nElts = 1;
for (const auto &dim : dims)
{
try
{
nElts = (CPLSM(static_cast<GUInt64>(nElts)) *
CPLSM(static_cast<GUInt64>(dim->GetSize())))
.v();
}
catch (...)
{
return 0;
}
}
return nElts;
}
/************************************************************************/
/* GetBlockSize() */
/************************************************************************/
/** Return the "natural" block size of the array along all dimensions.
*
* Some drivers might organize the array in tiles/blocks and reading/writing
* aligned on those tile/block boundaries will be more efficient.
*
* The returned number of elements in the vector is the same as
* GetDimensionCount(). A value of 0 should be interpreted as no hint regarding
* the natural block size along the considered dimension.
* "Flat" arrays will typically return a vector of values set to 0.
*
* The default implementation will return a vector of values set to 0.
*
* This method is used by GetProcessingChunkSize().
*
* Pedantic note: the returned type is GUInt64, so in the highly unlikeley
* theoretical case of a 32-bit platform, this might exceed its size_t
* allocation capabilities.
*
* This is the same as the C function GDALMDArrayGetBlockSize().
*
* @return the block size, in number of elements along each dimension.
*/
std::vector<GUInt64> GDALAbstractMDArray::GetBlockSize() const
{
return std::vector<GUInt64>(GetDimensionCount());
}
/************************************************************************/
/* GetProcessingChunkSize() */
/************************************************************************/
/** \brief Return an optimal chunk size for read/write operations, given the
* natural block size and memory constraints specified.
*
* This method will use GetBlockSize() to define a chunk whose dimensions are
* multiple of those returned by GetBlockSize() (unless the block define by
* GetBlockSize() is larger than nMaxChunkMemory, in which case it will be
* returned by this method).
*
* This is the same as the C function GDALMDArrayGetProcessingChunkSize().
*
* @param nMaxChunkMemory Maximum amount of memory, in bytes, to use for the
* chunk.
*
* @return the chunk size, in number of elements along each dimension.
*/
std::vector<size_t>
GDALAbstractMDArray::GetProcessingChunkSize(size_t nMaxChunkMemory) const
{
const auto &dims = GetDimensions();
const auto &nDTSize = GetDataType().GetSize();
std::vector<size_t> anChunkSize;
auto blockSize = GetBlockSize();
CPLAssert(blockSize.size() == dims.size());
size_t nChunkSize = nDTSize;
bool bOverflow = false;
constexpr auto kSIZE_T_MAX = std::numeric_limits<size_t>::max();
// Initialize anChunkSize[i] with blockSize[i] by properly clamping in
// [1, min(sizet_max, dim_size[i])]
// Also make sure that the product of all anChunkSize[i]) fits on size_t
for (size_t i = 0; i < dims.size(); i++)
{
const auto sizeDimI =
std::max(static_cast<size_t>(1),
static_cast<size_t>(
std::min(static_cast<GUInt64>(kSIZE_T_MAX),
std::min(blockSize[i], dims[i]->GetSize()))));
anChunkSize.push_back(sizeDimI);
if (nChunkSize > kSIZE_T_MAX / sizeDimI)
{
bOverflow = true;
}
else
{
nChunkSize *= sizeDimI;
}
}
if (nChunkSize == 0)
return anChunkSize;
// If the product of all anChunkSize[i] does not fit on size_t, then
// set lowest anChunkSize[i] to 1.
if (bOverflow)
{
nChunkSize = nDTSize;
bOverflow = false;
for (size_t i = dims.size(); i > 0;)
{
--i;
if (bOverflow || nChunkSize > kSIZE_T_MAX / anChunkSize[i])
{
bOverflow = true;
anChunkSize[i] = 1;
}
else
{
nChunkSize *= anChunkSize[i];
}
}
}
nChunkSize = nDTSize;
std::vector<size_t> anAccBlockSizeFromStart;
for (size_t i = 0; i < dims.size(); i++)
{
nChunkSize *= anChunkSize[i];
anAccBlockSizeFromStart.push_back(nChunkSize);
}
if (nChunkSize <= nMaxChunkMemory / 2)
{
size_t nVoxelsFromEnd = 1;
for (size_t i = dims.size(); i > 0;)
{
--i;
const auto nCurBlockSize =
anAccBlockSizeFromStart[i] * nVoxelsFromEnd;
const auto nMul = nMaxChunkMemory / nCurBlockSize;
if (nMul >= 2)
{
const auto nSizeThisDim(dims[i]->GetSize());
const auto nBlocksThisDim =
DIV_ROUND_UP(nSizeThisDim, anChunkSize[i]);
anChunkSize[i] = static_cast<size_t>(std::min(
anChunkSize[i] *
std::min(static_cast<GUInt64>(nMul), nBlocksThisDim),
nSizeThisDim));
}
nVoxelsFromEnd *= anChunkSize[i];
}
}
return anChunkSize;
}
/************************************************************************/
/* SetUnit() */
/************************************************************************/
/** Set the variable unit.
*
* Values should conform as much as possible with those allowed by
* the NetCDF CF conventions:
* http://cfconventions.org/Data/cf-conventions/cf-conventions-1.7/cf-conventions.html#units
* but others might be returned.
*
* Few examples are "meter", "degrees", "second", ...
* Empty value means unknown.
*
* This is the same as the C function GDALMDArraySetUnit()
*
* @note Driver implementation: optionally implemented.
*
* @param osUnit unit name.
* @return true in case of success.
*/
bool GDALMDArray::SetUnit(CPL_UNUSED const std::string &osUnit)
{
CPLError(CE_Failure, CPLE_NotSupported, "SetUnit() not implemented");
return false;
}
/************************************************************************/
/* GetUnit() */
/************************************************************************/
/** Return the array unit.
*
* Values should conform as much as possible with those allowed by
* the NetCDF CF conventions:
* http://cfconventions.org/Data/cf-conventions/cf-conventions-1.7/cf-conventions.html#units
* but others might be returned.
*
* Few examples are "meter", "degrees", "second", ...
* Empty value means unknown.
*
* This is the same as the C function GDALMDArrayGetUnit()
*/
const std::string &GDALMDArray::GetUnit() const
{
static const std::string emptyString;
return emptyString;
}
/************************************************************************/
/* SetSpatialRef() */
/************************************************************************/
/** Assign a spatial reference system object to the the array.
*
* This is the same as the C function GDALMDArraySetSpatialRef().
*/
bool GDALMDArray::SetSpatialRef(CPL_UNUSED const OGRSpatialReference *poSRS)
{
CPLError(CE_Failure, CPLE_NotSupported, "SetSpatialRef() not implemented");
return false;
}
/************************************************************************/
/* GetSpatialRef() */
/************************************************************************/
/** Return the spatial reference system object associated with the array.
*
* This is the same as the C function GDALMDArrayGetSpatialRef().
*/
std::shared_ptr<OGRSpatialReference> GDALMDArray::GetSpatialRef() const
{
return nullptr;
}
/************************************************************************/
/* GetRawNoDataValue() */
/************************************************************************/
/** Return the nodata value as a "raw" value.
*
* The value returned might be nullptr in case of no nodata value. When
* a nodata value is registered, a non-nullptr will be returned whose size in
* bytes is GetDataType().GetSize().
*
* The returned value should not be modified or freed. It is valid until
* the array is destroyed, or the next call to GetRawNoDataValue() or
* SetRawNoDataValue(), or any similar methods.
*
* @note Driver implementation: this method shall be implemented if nodata
* is supported.
*
* This is the same as the C function GDALMDArrayGetRawNoDataValue().
*
* @return nullptr or a pointer to GetDataType().GetSize() bytes.
*/
const void *GDALMDArray::GetRawNoDataValue() const
{
return nullptr;
}
/************************************************************************/
/* GetNoDataValueAsDouble() */
/************************************************************************/
/** Return the nodata value as a double.
*
* This is the same as the C function GDALMDArrayGetNoDataValueAsDouble().
*
* @param pbHasNoData Pointer to a output boolean that will be set to true if
* a nodata value exists and can be converted to double. Might be nullptr.
*
* @return the nodata value as a double. A 0.0 value might also indicate the
* absence of a nodata value or an error in the conversion (*pbHasNoData will be
* set to false then).
*/
double GDALMDArray::GetNoDataValueAsDouble(bool *pbHasNoData) const
{
const void *pNoData = GetRawNoDataValue();
double dfNoData = 0.0;
const auto &eDT = GetDataType();
const bool ok = pNoData != nullptr && eDT.GetClass() == GEDTC_NUMERIC;
if (ok)
{
GDALCopyWords(pNoData, eDT.GetNumericDataType(), 0, &dfNoData,
GDT_Float64, 0, 1);
}
if (pbHasNoData)
*pbHasNoData = ok;
return dfNoData;
}
/************************************************************************/
/* GetNoDataValueAsInt64() */
/************************************************************************/
/** Return the nodata value as a Int64.
*
* @param pbHasNoData Pointer to a output boolean that will be set to true if
* a nodata value exists and can be converted to Int64. Might be nullptr.
*
* This is the same as the C function GDALMDArrayGetNoDataValueAsInt64().
*
* @return the nodata value as a Int64
*
* @since GDAL 3.5
*/
int64_t GDALMDArray::GetNoDataValueAsInt64(bool *pbHasNoData) const
{
const void *pNoData = GetRawNoDataValue();
int64_t nNoData = GDAL_PAM_DEFAULT_NODATA_VALUE_INT64;
const auto &eDT = GetDataType();
const bool ok = pNoData != nullptr && eDT.GetClass() == GEDTC_NUMERIC;
if (ok)
{
GDALCopyWords(pNoData, eDT.GetNumericDataType(), 0, &nNoData, GDT_Int64,
0, 1);
}
if (pbHasNoData)
*pbHasNoData = ok;
return nNoData;
}
/************************************************************************/
/* GetNoDataValueAsUInt64() */
/************************************************************************/
/** Return the nodata value as a UInt64.
*
* This is the same as the C function GDALMDArrayGetNoDataValueAsUInt64().
* @param pbHasNoData Pointer to a output boolean that will be set to true if
* a nodata value exists and can be converted to UInt64. Might be nullptr.
*
* @return the nodata value as a UInt64
*
* @since GDAL 3.5
*/
uint64_t GDALMDArray::GetNoDataValueAsUInt64(bool *pbHasNoData) const
{
const void *pNoData = GetRawNoDataValue();
uint64_t nNoData = GDAL_PAM_DEFAULT_NODATA_VALUE_UINT64;
const auto &eDT = GetDataType();
const bool ok = pNoData != nullptr && eDT.GetClass() == GEDTC_NUMERIC;
if (ok)
{
GDALCopyWords(pNoData, eDT.GetNumericDataType(), 0, &nNoData,
GDT_UInt64, 0, 1);
}
if (pbHasNoData)
*pbHasNoData = ok;
return nNoData;
}
/************************************************************************/
/* SetRawNoDataValue() */
/************************************************************************/
/** Set the nodata value as a "raw" value.
*
* The value passed might be nullptr in case of no nodata value. When
* a nodata value is registered, a non-nullptr whose size in
* bytes is GetDataType().GetSize() must be passed.
*
* This is the same as the C function GDALMDArraySetRawNoDataValue().
*
* @note Driver implementation: this method shall be implemented if setting
nodata
* is supported.
* @return true in case of success.
*/
bool GDALMDArray::SetRawNoDataValue(CPL_UNUSED const void *pRawNoData)
{
CPLError(CE_Failure, CPLE_NotSupported,
"SetRawNoDataValue() not implemented");
return false;
}
/************************************************************************/
/* SetNoDataValue() */
/************************************************************************/
/** Set the nodata value as a double.
*
* If the natural data type of the attribute/array is not double, type
* conversion will occur to the type returned by GetDataType().
*
* This is the same as the C function GDALMDArraySetNoDataValueAsDouble().
*
* @return true in case of success.
*/
bool GDALMDArray::SetNoDataValue(double dfNoData)
{
void *pRawNoData = CPLMalloc(GetDataType().GetSize());
bool bRet = false;
if (GDALExtendedDataType::CopyValue(
&dfNoData, GDALExtendedDataType::Create(GDT_Float64), pRawNoData,
GetDataType()))
{
bRet = SetRawNoDataValue(pRawNoData);
}
CPLFree(pRawNoData);
return bRet;
}
/************************************************************************/
/* SetNoDataValue() */
/************************************************************************/
/** Set the nodata value as a Int64.
*
* If the natural data type of the attribute/array is not Int64, type conversion
* will occur to the type returned by GetDataType().
*
* This is the same as the C function GDALMDArraySetNoDataValueAsInt64().
*
* @return true in case of success.
*
* @since GDAL 3.5
*/
bool GDALMDArray::SetNoDataValue(int64_t nNoData)
{
void *pRawNoData = CPLMalloc(GetDataType().GetSize());
bool bRet = false;
if (GDALExtendedDataType::CopyValue(&nNoData,
GDALExtendedDataType::Create(GDT_Int64),
pRawNoData, GetDataType()))
{
bRet = SetRawNoDataValue(pRawNoData);
}
CPLFree(pRawNoData);
return bRet;
}
/************************************************************************/
/* SetNoDataValue() */
/************************************************************************/
/** Set the nodata value as a Int64.
*
* If the natural data type of the attribute/array is not Int64, type conversion
* will occur to the type returned by GetDataType().
*
* This is the same as the C function GDALMDArraySetNoDataValueAsUInt64().
*
* @return true in case of success.
*
* @since GDAL 3.5
*/
bool GDALMDArray::SetNoDataValue(uint64_t nNoData)
{
void *pRawNoData = CPLMalloc(GetDataType().GetSize());
bool bRet = false;
if (GDALExtendedDataType::CopyValue(
&nNoData, GDALExtendedDataType::Create(GDT_UInt64), pRawNoData,
GetDataType()))
{
bRet = SetRawNoDataValue(pRawNoData);
}
CPLFree(pRawNoData);
return bRet;
}
/************************************************************************/
/* SetScale() */
/************************************************************************/
/** Set the scale value to apply to raw values.
*
* unscaled_value = raw_value * GetScale() + GetOffset()
*
* This is the same as the C function GDALMDArraySetScale() /
* GDALMDArraySetScaleEx().
*
* @note Driver implementation: this method shall be implemented if setting
* scale is supported.
*
* @param dfScale scale
* @param eStorageType Data type to which create the potential attribute that
* will store the scale. Added in GDAL 3.3 If let to its GDT_Unknown value, the
* implementation will decide automatically the data type. Note that changing
* the data type after initial setting might not be supported.
* @return true in case of success.
*/
bool GDALMDArray::SetScale(CPL_UNUSED double dfScale,
CPL_UNUSED GDALDataType eStorageType)
{
CPLError(CE_Failure, CPLE_NotSupported, "SetScale() not implemented");
return false;
}
/************************************************************************/
/* SetOffset) */
/************************************************************************/
/** Set the offset value to apply to raw values.
*
* unscaled_value = raw_value * GetScale() + GetOffset()
*
* This is the same as the C function GDALMDArraySetOffset() /
* GDALMDArraySetOffsetEx().
*
* @note Driver implementation: this method shall be implemented if setting
* offset is supported.
*
* @param dfOffset Offset
* @param eStorageType Data type to which create the potential attribute that
* will store the offset. Added in GDAL 3.3 If let to its GDT_Unknown value, the
* implementation will decide automatically the data type. Note that changing
* the data type after initial setting might not be supported.
* @return true in case of success.
*/
bool GDALMDArray::SetOffset(CPL_UNUSED double dfOffset,
CPL_UNUSED GDALDataType eStorageType)
{
CPLError(CE_Failure, CPLE_NotSupported, "SetOffset() not implemented");
return false;
}
/************************************************************************/
/* GetScale() */
/************************************************************************/
/** Get the scale value to apply to raw values.
*
* unscaled_value = raw_value * GetScale() + GetOffset()
*
* This is the same as the C function GDALMDArrayGetScale().
*
* @note Driver implementation: this method shall be implemented if gettings
* scale is supported.
*
* @param pbHasScale Pointer to a output boolean that will be set to true if
* a scale value exists. Might be nullptr.
* @param peStorageType Pointer to a output GDALDataType that will be set to
* the storage type of the scale value, when known/relevant. Otherwise will be
* set to GDT_Unknown. Might be nullptr. Since GDAL 3.3
*
* @return the scale value. A 1.0 value might also indicate the
* absence of a scale value.
*/
double GDALMDArray::GetScale(CPL_UNUSED bool *pbHasScale,
CPL_UNUSED GDALDataType *peStorageType) const
{
if (pbHasScale)
*pbHasScale = false;
return 1.0;
}
/************************************************************************/
/* GetOffset() */
/************************************************************************/
/** Get the offset value to apply to raw values.
*
* unscaled_value = raw_value * GetScale() + GetOffset()
*
* This is the same as the C function GDALMDArrayGetOffset().
*
* @note Driver implementation: this method shall be implemented if gettings
* offset is supported.
*
* @param pbHasOffset Pointer to a output boolean that will be set to true if
* a offset value exists. Might be nullptr.
* @param peStorageType Pointer to a output GDALDataType that will be set to
* the storage type of the offset value, when known/relevant. Otherwise will be
* set to GDT_Unknown. Might be nullptr. Since GDAL 3.3
*
* @return the offset value. A 0.0 value might also indicate the
* absence of a offset value.
*/
double GDALMDArray::GetOffset(CPL_UNUSED bool *pbHasOffset,
CPL_UNUSED GDALDataType *peStorageType) const
{
if (pbHasOffset)
*pbHasOffset = false;
return 0.0;
}
/************************************************************************/
/* ProcessPerChunk() */
/************************************************************************/
namespace
{
enum class Caller
{
CALLER_END_OF_LOOP,
CALLER_IN_LOOP,
};
}
/** \brief Call a user-provided function to operate on an array chunk by chunk.
*
* This method is to be used when doing operations on an array, or a subset of
* it, in a chunk by chunk way.
*
* @param arrayStartIdx Values representing the starting index to use
* in each dimension (in [0, aoDims[i].GetSize()-1] range).
* Array of GetDimensionCount() values. Must not be
* nullptr, unless for a zero-dimensional array.
*
* @param count Values representing the number of values to use in
* each dimension.
* Array of GetDimensionCount() values. Must not be
* nullptr, unless for a zero-dimensional array.
*
* @param chunkSize Values representing the chunk size in each dimension.
* Might typically the output of GetProcessingChunkSize().
* Array of GetDimensionCount() values. Must not be
* nullptr, unless for a zero-dimensional array.
*
* @param pfnFunc User-provided function of type FuncProcessPerChunkType.
* Must NOT be nullptr.
*
* @param pUserData Pointer to pass as the value of the pUserData argument
* of FuncProcessPerChunkType. Might be nullptr (depends on pfnFunc.
*
* @return true in case of success.
*/
bool GDALAbstractMDArray::ProcessPerChunk(const GUInt64 *arrayStartIdx,
const GUInt64 *count,
const size_t *chunkSize,
FuncProcessPerChunkType pfnFunc,
void *pUserData)
{
const auto &dims = GetDimensions();
if (dims.empty())
{
return pfnFunc(this, nullptr, nullptr, 1, 1, pUserData);
}
// Sanity check
size_t nTotalChunkSize = 1;
for (size_t i = 0; i < dims.size(); i++)
{
const auto nSizeThisDim(dims[i]->GetSize());
if (count[i] == 0 || count[i] > nSizeThisDim ||
arrayStartIdx[i] > nSizeThisDim - count[i])
{
CPLError(CE_Failure, CPLE_AppDefined,
"Inconsistent arrayStartIdx[] / count[] values "
"regarding array size");
return false;
}
if (chunkSize[i] == 0 || chunkSize[i] > nSizeThisDim ||
chunkSize[i] > std::numeric_limits<size_t>::max() / nTotalChunkSize)
{
CPLError(CE_Failure, CPLE_AppDefined,
"Inconsistent chunkSize[] values");
return false;
}
nTotalChunkSize *= chunkSize[i];
}
size_t dimIdx = 0;
std::vector<GUInt64> chunkArrayStartIdx(dims.size());
std::vector<size_t> chunkCount(dims.size());
struct Stack
{
GUInt64 nBlockCounter = 0;
GUInt64 nBlocksMinusOne = 0;
size_t first_count = 0; // only used if nBlocks > 1
Caller return_point = Caller::CALLER_END_OF_LOOP;
};
std::vector<Stack> stack(dims.size());
GUInt64 iCurChunk = 0;
GUInt64 nChunkCount = 1;
for (size_t i = 0; i < dims.size(); i++)
{
const auto nStartBlock = arrayStartIdx[i] / chunkSize[i];
const auto nEndBlock = (arrayStartIdx[i] + count[i] - 1) / chunkSize[i];
stack[i].nBlocksMinusOne = nEndBlock - nStartBlock;
nChunkCount *= 1 + stack[i].nBlocksMinusOne;
if (stack[i].nBlocksMinusOne == 0)
{
chunkArrayStartIdx[i] = arrayStartIdx[i];
chunkCount[i] = static_cast<size_t>(count[i]);
}
else
{
stack[i].first_count = static_cast<size_t>(
(nStartBlock + 1) * chunkSize[i] - arrayStartIdx[i]);
}
}
lbl_next_depth:
if (dimIdx == dims.size())
{
++iCurChunk;
if (!pfnFunc(this, chunkArrayStartIdx.data(), chunkCount.data(),
iCurChunk, nChunkCount, pUserData))
{
return false;
}
}
else
{
if (stack[dimIdx].nBlocksMinusOne != 0)
{
stack[dimIdx].nBlockCounter = stack[dimIdx].nBlocksMinusOne;
chunkArrayStartIdx[dimIdx] = arrayStartIdx[dimIdx];
chunkCount[dimIdx] = stack[dimIdx].first_count;
stack[dimIdx].return_point = Caller::CALLER_IN_LOOP;
while (true)
{
dimIdx++;
goto lbl_next_depth;
lbl_return_to_caller_in_loop:
--stack[dimIdx].nBlockCounter;
if (stack[dimIdx].nBlockCounter == 0)
break;
chunkArrayStartIdx[dimIdx] += chunkCount[dimIdx];
chunkCount[dimIdx] = chunkSize[dimIdx];
}
chunkArrayStartIdx[dimIdx] += chunkCount[dimIdx];
chunkCount[dimIdx] =
static_cast<size_t>(arrayStartIdx[dimIdx] + count[dimIdx] -
chunkArrayStartIdx[dimIdx]);
stack[dimIdx].return_point = Caller::CALLER_END_OF_LOOP;
}
dimIdx++;
goto lbl_next_depth;
lbl_return_to_caller_end_of_loop:
if (dimIdx == 0)
goto end;
}
dimIdx--;
// cppcheck-suppress negativeContainerIndex
switch (stack[dimIdx].return_point)
{
case Caller::CALLER_END_OF_LOOP:
goto lbl_return_to_caller_end_of_loop;
case Caller::CALLER_IN_LOOP:
goto lbl_return_to_caller_in_loop;
}
end:
return true;
}
/************************************************************************/
/* GDALAttribute() */
/************************************************************************/
//! @cond Doxygen_Suppress
GDALAttribute::GDALAttribute(CPL_UNUSED const std::string &osParentName,
CPL_UNUSED const std::string &osName)
#if !defined(COMPILER_WARNS_ABOUT_ABSTRACT_VBASE_INIT)
: GDALAbstractMDArray(osParentName, osName)
#endif
{
}
//! @endcond
/************************************************************************/
/* GetDimensionSize() */
/************************************************************************/
/** Return the size of the dimensions of the attribute.
*
* This will be an empty array for a scalar (single value) attribute.
*
* This is the same as the C function GDALAttributeGetDimensionsSize().
*/
std::vector<GUInt64> GDALAttribute::GetDimensionsSize() const
{
const auto &dims = GetDimensions();
std::vector<GUInt64> ret;
ret.reserve(dims.size());
for (const auto &dim : dims)
ret.push_back(dim->GetSize());
return ret;
}
/************************************************************************/
/* GDALRawResult() */
/************************************************************************/
//! @cond Doxygen_Suppress
GDALRawResult::GDALRawResult(GByte *raw, const GDALExtendedDataType &dt,
size_t nEltCount)
: m_dt(dt), m_nEltCount(nEltCount), m_nSize(nEltCount * dt.GetSize()),
m_raw(raw)
{
}
//! @endcond
/************************************************************************/
/* GDALRawResult() */
/************************************************************************/
/** Move constructor. */
GDALRawResult::GDALRawResult(GDALRawResult &&other)
: m_dt(std::move(other.m_dt)), m_nEltCount(other.m_nEltCount),
m_nSize(other.m_nSize), m_raw(other.m_raw)
{
other.m_nEltCount = 0;
other.m_nSize = 0;
other.m_raw = nullptr;
}
/************************************************************************/
/* FreeMe() */
/************************************************************************/
void GDALRawResult::FreeMe()
{
if (m_raw && m_dt.NeedsFreeDynamicMemory())
{
GByte *pabyPtr = m_raw;
const auto nDTSize(m_dt.GetSize());
for (size_t i = 0; i < m_nEltCount; ++i)
{
m_dt.FreeDynamicMemory(pabyPtr);
pabyPtr += nDTSize;
}
}
VSIFree(m_raw);
}
/************************************************************************/
/* operator=() */
/************************************************************************/
/** Move assignment. */
GDALRawResult &GDALRawResult::operator=(GDALRawResult &&other)
{
FreeMe();
m_dt = std::move(other.m_dt);
m_nEltCount = other.m_nEltCount;
m_nSize = other.m_nSize;
m_raw = other.m_raw;
other.m_nEltCount = 0;
other.m_nSize = 0;
other.m_raw = nullptr;
return *this;
}
/************************************************************************/
/* ~GDALRawResult() */
/************************************************************************/
/** Destructor. */
GDALRawResult::~GDALRawResult()
{
FreeMe();
}
/************************************************************************/
/* StealData() */
/************************************************************************/
//! @cond Doxygen_Suppress
/** Return buffer to caller which becomes owner of it.
* Only to be used by GDALAttributeReadAsRaw().
*/
GByte *GDALRawResult::StealData()
{
GByte *ret = m_raw;
m_raw = nullptr;
m_nEltCount = 0;
m_nSize = 0;
return ret;
}
//! @endcond
/************************************************************************/
/* ReadAsRaw() */
/************************************************************************/
/** Return the raw value of an attribute.
*
*
* This is the same as the C function GDALAttributeReadAsRaw().
*/
GDALRawResult GDALAttribute::ReadAsRaw() const
{
const auto nEltCount(GetTotalElementsCount());
const auto dt(GetDataType());
const auto nDTSize(dt.GetSize());
GByte *res = static_cast<GByte *>(
VSI_MALLOC2_VERBOSE(static_cast<size_t>(nEltCount), nDTSize));
if (!res)
return GDALRawResult(nullptr, dt, 0);
const auto &dims = GetDimensions();
const auto nDims = GetDimensionCount();
std::vector<GUInt64> startIdx(1 + nDims, 0);
std::vector<size_t> count(1 + nDims);
for (size_t i = 0; i < nDims; i++)
{
count[i] = static_cast<size_t>(dims[i]->GetSize());
}
if (!Read(startIdx.data(), count.data(), nullptr, nullptr, dt, &res[0],
&res[0], static_cast<size_t>(nEltCount * nDTSize)))
{
VSIFree(res);
return GDALRawResult(nullptr, dt, 0);
}
return GDALRawResult(res, dt, static_cast<size_t>(nEltCount));
}
/************************************************************************/
/* ReadAsString() */
/************************************************************************/
/** Return the value of an attribute as a string.
*
* The returned string should not be freed, and its lifetime does not
* excess a next call to ReadAsString() on the same object, or the deletion
* of the object itself.
*
* This function will only return the first element if there are several.
*
* This is the same as the C function GDALAttributeReadAsString()
*
* @return a string, or nullptr.
*/
const char *GDALAttribute::ReadAsString() const
{
const auto nDims = GetDimensionCount();
std::vector<GUInt64> startIdx(1 + nDims, 0);
std::vector<size_t> count(1 + nDims, 1);
char *szRet = nullptr;
if (!Read(startIdx.data(), count.data(), nullptr, nullptr,
GDALExtendedDataType::CreateString(), &szRet, &szRet,
sizeof(szRet)) ||
szRet == nullptr)
{
return nullptr;
}
m_osCachedVal = szRet;
CPLFree(szRet);
return m_osCachedVal.c_str();
}
/************************************************************************/
/* ReadAsInt() */
/************************************************************************/
/** Return the value of an attribute as a integer.
*
* This function will only return the first element if there are several.
*
* It can fail if its value can be converted to integer.
*
* This is the same as the C function GDALAttributeReadAsInt()
*
* @return a integer, or INT_MIN in case of error.
*/
int GDALAttribute::ReadAsInt() const
{
const auto nDims = GetDimensionCount();
std::vector<GUInt64> startIdx(1 + nDims, 0);
std::vector<size_t> count(1 + nDims, 1);
int nRet = INT_MIN;
Read(startIdx.data(), count.data(), nullptr, nullptr,
GDALExtendedDataType::Create(GDT_Int32), &nRet, &nRet, sizeof(nRet));
return nRet;
}
/************************************************************************/
/* ReadAsDouble() */
/************************************************************************/
/** Return the value of an attribute as a double.
*
* This function will only return the first element if there are several.
*
* It can fail if its value can be converted to double.
*
* This is the same as the C function GDALAttributeReadAsInt()
*
* @return a double value.
*/
double GDALAttribute::ReadAsDouble() const
{
const auto nDims = GetDimensionCount();
std::vector<GUInt64> startIdx(1 + nDims, 0);
std::vector<size_t> count(1 + nDims, 1);
double dfRet = 0;
Read(startIdx.data(), count.data(), nullptr, nullptr,
GDALExtendedDataType::Create(GDT_Float64), &dfRet, &dfRet,
sizeof(dfRet));
return dfRet;
}
/************************************************************************/
/* ReadAsStringArray() */
/************************************************************************/
/** Return the value of an attribute as an array of strings.
*
* This is the same as the C function GDALAttributeReadAsStringArray()
*/
CPLStringList GDALAttribute::ReadAsStringArray() const
{
const auto nElts = GetTotalElementsCount();
if (nElts > static_cast<unsigned>(std::numeric_limits<int>::max() - 1))
return CPLStringList();
char **papszList = static_cast<char **>(
VSI_CALLOC_VERBOSE(static_cast<int>(nElts) + 1, sizeof(char *)));
const auto &dims = GetDimensions();
const auto nDims = GetDimensionCount();
std::vector<GUInt64> startIdx(1 + nDims, 0);
std::vector<size_t> count(1 + nDims);
for (size_t i = 0; i < nDims; i++)
{
count[i] = static_cast<size_t>(dims[i]->GetSize());
}
Read(startIdx.data(), count.data(), nullptr, nullptr,
GDALExtendedDataType::CreateString(), papszList, papszList,
sizeof(char *) * static_cast<int>(nElts));
for (int i = 0; i < static_cast<int>(nElts); i++)
{
if (papszList[i] == nullptr)
papszList[i] = CPLStrdup("");
}
return CPLStringList(papszList);
}
/************************************************************************/
/* ReadAsIntArray() */
/************************************************************************/
/** Return the value of an attribute as an array of integers.
*
* This is the same as the C function GDALAttributeReadAsIntArray().
*/
std::vector<int> GDALAttribute::ReadAsIntArray() const
{
const auto nElts = GetTotalElementsCount();
#if SIZEOF_VOIDP == 4
if (nElts > static_cast<size_t>(nElts))
return {};
#endif
std::vector<int> res(static_cast<size_t>(nElts));
const auto &dims = GetDimensions();
const auto nDims = GetDimensionCount();
std::vector<GUInt64> startIdx(1 + nDims, 0);
std::vector<size_t> count(1 + nDims);
for (size_t i = 0; i < nDims; i++)
{
count[i] = static_cast<size_t>(dims[i]->GetSize());
}
Read(startIdx.data(), count.data(), nullptr, nullptr,
GDALExtendedDataType::Create(GDT_Int32), &res[0], res.data(),
res.size() * sizeof(res[0]));
return res;
}
/************************************************************************/
/* ReadAsDoubleArray() */
/************************************************************************/
/** Return the value of an attribute as an array of double.
*
* This is the same as the C function GDALAttributeReadAsDoubleArray().
*/
std::vector<double> GDALAttribute::ReadAsDoubleArray() const
{
const auto nElts = GetTotalElementsCount();
#if SIZEOF_VOIDP == 4
if (nElts > static_cast<size_t>(nElts))
return {};
#endif
std::vector<double> res(static_cast<size_t>(nElts));
const auto &dims = GetDimensions();
const auto nDims = GetDimensionCount();
std::vector<GUInt64> startIdx(1 + nDims, 0);
std::vector<size_t> count(1 + nDims);
for (size_t i = 0; i < nDims; i++)
{
count[i] = static_cast<size_t>(dims[i]->GetSize());
}
Read(startIdx.data(), count.data(), nullptr, nullptr,
GDALExtendedDataType::Create(GDT_Float64), &res[0], res.data(),
res.size() * sizeof(res[0]));
return res;
}
/************************************************************************/
/* Write() */
/************************************************************************/
/** Write an attribute from raw values expressed in GetDataType()
*
* The values should be provided in the type of GetDataType() and there should
* be exactly GetTotalElementsCount() of them.
* If GetDataType() is a string, each value should be a char* pointer.
*
* This is the same as the C function GDALAttributeWriteRaw().
*
* @param pabyValue Buffer of nLen bytes.
* @param nLen Size of pabyValue in bytes. Should be equal to
* GetTotalElementsCount() * GetDataType().GetSize()
* @return true in case of success.
*/
bool GDALAttribute::Write(const void *pabyValue, size_t nLen)
{
if (nLen != GetTotalElementsCount() * GetDataType().GetSize())
{
CPLError(CE_Failure, CPLE_AppDefined,
"Length is not of expected value");
return false;
}
const auto &dims = GetDimensions();
const auto nDims = GetDimensionCount();
std::vector<GUInt64> startIdx(1 + nDims, 0);
std::vector<size_t> count(1 + nDims);
for (size_t i = 0; i < nDims; i++)
{
count[i] = static_cast<size_t>(dims[i]->GetSize());
}
return Write(startIdx.data(), count.data(), nullptr, nullptr, GetDataType(),
pabyValue, pabyValue, nLen);
}
/************************************************************************/
/* Write() */
/************************************************************************/
/** Write an attribute from a string value.
*
* Type conversion will be performed if needed. If the attribute contains
* multiple values, only the first one will be updated.
*
* This is the same as the C function GDALAttributeWriteString().
*
* @param pszValue Pointer to a string.
* @return true in case of success.
*/
bool GDALAttribute::Write(const char *pszValue)
{
const auto nDims = GetDimensionCount();
std::vector<GUInt64> startIdx(1 + nDims, 0);
std::vector<size_t> count(1 + nDims, 1);
return Write(startIdx.data(), count.data(), nullptr, nullptr,
GDALExtendedDataType::CreateString(), &pszValue, &pszValue,
sizeof(pszValue));
}
/************************************************************************/
/* WriteInt() */
/************************************************************************/
/** Write an attribute from a integer value.
*
* Type conversion will be performed if needed. If the attribute contains
* multiple values, only the first one will be updated.
*
* This is the same as the C function GDALAttributeWriteInt().
*
* @param nVal Value.
* @return true in case of success.
*/
bool GDALAttribute::WriteInt(int nVal)
{
const auto nDims = GetDimensionCount();
std::vector<GUInt64> startIdx(1 + nDims, 0);
std::vector<size_t> count(1 + nDims, 1);
return Write(startIdx.data(), count.data(), nullptr, nullptr,
GDALExtendedDataType::Create(GDT_Int32), &nVal, &nVal,
sizeof(nVal));
}
/************************************************************************/
/* Write() */
/************************************************************************/
/** Write an attribute from a double value.
*
* Type conversion will be performed if needed. If the attribute contains
* multiple values, only the first one will be updated.
*
* This is the same as the C function GDALAttributeWriteDouble().
*
* @param dfVal Value.
* @return true in case of success.
*/
bool GDALAttribute::Write(double dfVal)
{
const auto nDims = GetDimensionCount();
std::vector<GUInt64> startIdx(1 + nDims, 0);
std::vector<size_t> count(1 + nDims, 1);
return Write(startIdx.data(), count.data(), nullptr, nullptr,
GDALExtendedDataType::Create(GDT_Float64), &dfVal, &dfVal,
sizeof(dfVal));
}
/************************************************************************/
/* Write() */
/************************************************************************/
/** Write an attribute from an array of strings.
*
* Type conversion will be performed if needed.
*
* Exactly GetTotalElementsCount() strings must be provided
*
* This is the same as the C function GDALAttributeWriteStringArray().
*
* @param vals Array of strings.
* @return true in case of success.
*/
bool GDALAttribute::Write(CSLConstList vals)
{
if (static_cast<size_t>(CSLCount(vals)) != GetTotalElementsCount())
{
CPLError(CE_Failure, CPLE_AppDefined, "Invalid number of input values");
return false;
}
const auto nDims = GetDimensionCount();
std::vector<GUInt64> startIdx(1 + nDims, 0);
std::vector<size_t> count(1 + nDims);
const auto &dims = GetDimensions();
for (size_t i = 0; i < nDims; i++)
count[i] = static_cast<size_t>(dims[i]->GetSize());
return Write(startIdx.data(), count.data(), nullptr, nullptr,
GDALExtendedDataType::CreateString(), vals, vals,
static_cast<size_t>(GetTotalElementsCount()) * sizeof(char *));
}
/************************************************************************/
/* Write() */
/************************************************************************/
/** Write an attribute from an array of double.
*
* Type conversion will be performed if needed.
*
* Exactly GetTotalElementsCount() strings must be provided
*
* This is the same as the C function GDALAttributeWriteDoubleArray()
*
* @param vals Array of double.
* @param nVals Should be equal to GetTotalElementsCount().
* @return true in case of success.
*/
bool GDALAttribute::Write(const double *vals, size_t nVals)
{
if (nVals != GetTotalElementsCount())
{
CPLError(CE_Failure, CPLE_AppDefined, "Invalid number of input values");
return false;
}
const auto nDims = GetDimensionCount();
std::vector<GUInt64> startIdx(1 + nDims, 0);
std::vector<size_t> count(1 + nDims);
const auto &dims = GetDimensions();
for (size_t i = 0; i < nDims; i++)
count[i] = static_cast<size_t>(dims[i]->GetSize());
return Write(startIdx.data(), count.data(), nullptr, nullptr,
GDALExtendedDataType::Create(GDT_Float64), vals, vals,
static_cast<size_t>(GetTotalElementsCount()) * sizeof(double));
}
/************************************************************************/
/* GDALMDArray() */
/************************************************************************/
//! @cond Doxygen_Suppress
GDALMDArray::GDALMDArray(CPL_UNUSED const std::string &osParentName,
CPL_UNUSED const std::string &osName)
#if !defined(COMPILER_WARNS_ABOUT_ABSTRACT_VBASE_INIT)
: GDALAbstractMDArray(osParentName, osName)
#endif
{
}
//! @endcond
/************************************************************************/
/* GetTotalCopyCost() */
/************************************************************************/
/** Return a total "cost" to copy the array.
*
* Used as a parameter for CopyFrom()
*/
GUInt64 GDALMDArray::GetTotalCopyCost() const
{
return COPY_COST + GetAttributes().size() * GDALAttribute::COPY_COST +
GetTotalElementsCount() * GetDataType().GetSize();
}
/************************************************************************/
/* CopyFromAllExceptValues() */
/************************************************************************/
//! @cond Doxygen_Suppress
bool GDALMDArray::CopyFromAllExceptValues(const GDALMDArray *poSrcArray,
bool bStrict, GUInt64 &nCurCost,
const GUInt64 nTotalCost,
GDALProgressFunc pfnProgress,
void *pProgressData)
{
const bool bThisIsUnscaledArray =
dynamic_cast<GDALMDArrayUnscaled *>(this) != nullptr;
auto attrs = poSrcArray->GetAttributes();
for (const auto &attr : attrs)
{
const auto &osAttrName = attr->GetName();
if (bThisIsUnscaledArray)
{
if (osAttrName == "missing_value" || osAttrName == "_FillValue" ||
osAttrName == "valid_min" || osAttrName == "valid_max" ||
osAttrName == "valid_range")
{
continue;
}
}
auto dstAttr = CreateAttribute(osAttrName, attr->GetDimensionsSize(),
attr->GetDataType());
if (!dstAttr)
{
if (bStrict)
return false;
continue;
}
auto raw = attr->ReadAsRaw();
if (!dstAttr->Write(raw.data(), raw.size()) && bStrict)
return false;
}
if (!attrs.empty())
{
nCurCost += attrs.size() * GDALAttribute::COPY_COST;
if (pfnProgress &&
!pfnProgress(double(nCurCost) / nTotalCost, "", pProgressData))
return false;
}
auto srcSRS = poSrcArray->GetSpatialRef();
if (srcSRS)
{
SetSpatialRef(srcSRS.get());
}
const void *pNoData = poSrcArray->GetRawNoDataValue();
if (pNoData && poSrcArray->GetDataType() == GetDataType())
{
SetRawNoDataValue(pNoData);
}
const std::string &osUnit(poSrcArray->GetUnit());
if (!osUnit.empty())
{
SetUnit(osUnit);
}
bool bGotValue = false;
GDALDataType eOffsetStorageType = GDT_Unknown;
const double dfOffset =
poSrcArray->GetOffset(&bGotValue, &eOffsetStorageType);
if (bGotValue)
{
SetOffset(dfOffset, eOffsetStorageType);
}
bGotValue = false;
GDALDataType eScaleStorageType = GDT_Unknown;
const double dfScale = poSrcArray->GetScale(&bGotValue, &eScaleStorageType);
if (bGotValue)
{
SetScale(dfScale, eScaleStorageType);
}
return true;
}
//! @endcond
/************************************************************************/
/* CopyFrom() */
/************************************************************************/
/** Copy the content of an array into a new (generally empty) array.
*
* @param poSrcDS Source dataset. Might be nullptr (but for correct behavior
* of some output drivers this is not recommended)
* @param poSrcArray Source array. Should NOT be nullptr.
* @param bStrict Whether to enable stict mode. In strict mode, any error will
* stop the copy. In relaxed mode, the copy will be attempted to
* be pursued.
* @param nCurCost Should be provided as a variable initially set to 0.
* @param nTotalCost Total cost from GetTotalCopyCost().
* @param pfnProgress Progress callback, or nullptr.
* @param pProgressData Progress user data, or nulptr.
*
* @return true in case of success (or partial success if bStrict == false).
*/
bool GDALMDArray::CopyFrom(CPL_UNUSED GDALDataset *poSrcDS,
const GDALMDArray *poSrcArray, bool bStrict,
GUInt64 &nCurCost, const GUInt64 nTotalCost,
GDALProgressFunc pfnProgress, void *pProgressData)
{
if (pfnProgress == nullptr)
pfnProgress = GDALDummyProgress;
nCurCost += GDALMDArray::COPY_COST;
if (!CopyFromAllExceptValues(poSrcArray, bStrict, nCurCost, nTotalCost,
pfnProgress, pProgressData))
{
return false;
}
const auto &dims = poSrcArray->GetDimensions();
const auto nDTSize = poSrcArray->GetDataType().GetSize();
if (dims.empty())
{
std::vector<GByte> abyTmp(nDTSize);
if (!(poSrcArray->Read(nullptr, nullptr, nullptr, nullptr,
GetDataType(), &abyTmp[0]) &&
Write(nullptr, nullptr, nullptr, nullptr, GetDataType(),
&abyTmp[0])) &&
bStrict)
{
return false;
}
nCurCost += GetTotalElementsCount() * GetDataType().GetSize();
if (!pfnProgress(double(nCurCost) / nTotalCost, "", pProgressData))
return false;
}
else
{
std::vector<GUInt64> arrayStartIdx(dims.size());
std::vector<GUInt64> count(dims.size());
for (size_t i = 0; i < dims.size(); i++)
{
count[i] = static_cast<size_t>(dims[i]->GetSize());
}
struct CopyFunc
{
GDALMDArray *poDstArray = nullptr;
std::vector<GByte> abyTmp{};
GDALProgressFunc pfnProgress = nullptr;
void *pProgressData = nullptr;
GUInt64 nCurCost = 0;
GUInt64 nTotalCost = 0;
GUInt64 nTotalBytesThisArray = 0;
bool bStop = false;
static bool f(GDALAbstractMDArray *l_poSrcArray,
const GUInt64 *chunkArrayStartIdx,
const size_t *chunkCount, GUInt64 iCurChunk,
GUInt64 nChunkCount, void *pUserData)
{
const auto dt(l_poSrcArray->GetDataType());
auto data = static_cast<CopyFunc *>(pUserData);
auto poDstArray = data->poDstArray;
if (!l_poSrcArray->Read(chunkArrayStartIdx, chunkCount, nullptr,
nullptr, dt, &data->abyTmp[0]))
{
return false;
}
bool bRet =
poDstArray->Write(chunkArrayStartIdx, chunkCount, nullptr,
nullptr, dt, &data->abyTmp[0]);
if (dt.NeedsFreeDynamicMemory())
{
const auto l_nDTSize = dt.GetSize();
GByte *ptr = &data->abyTmp[0];
const size_t l_nDims(l_poSrcArray->GetDimensionCount());
size_t nEltCount = 1;
for (size_t i = 0; i < l_nDims; ++i)
{
nEltCount *= chunkCount[i];
}
for (size_t i = 0; i < nEltCount; i++)
{
dt.FreeDynamicMemory(ptr);
ptr += l_nDTSize;
}
}
if (!bRet)
{
return false;
}
double dfCurCost =
double(data->nCurCost) + double(iCurChunk) / nChunkCount *
data->nTotalBytesThisArray;
if (!data->pfnProgress(dfCurCost / data->nTotalCost, "",
data->pProgressData))
{
data->bStop = true;
return false;
}
return true;
}
};
CopyFunc copyFunc;
copyFunc.poDstArray = this;
copyFunc.nCurCost = nCurCost;
copyFunc.nTotalCost = nTotalCost;
copyFunc.nTotalBytesThisArray = GetTotalElementsCount() * nDTSize;
copyFunc.pfnProgress = pfnProgress;
copyFunc.pProgressData = pProgressData;
const char *pszSwathSize =
CPLGetConfigOption("GDAL_SWATH_SIZE", nullptr);
const size_t nMaxChunkSize =
pszSwathSize
? static_cast<size_t>(
std::min(GIntBig(std::numeric_limits<size_t>::max() / 2),
CPLAtoGIntBig(pszSwathSize)))
: static_cast<size_t>(
std::min(GIntBig(std::numeric_limits<size_t>::max() / 2),
GDALGetCacheMax64() / 4));
const auto anChunkSizes(GetProcessingChunkSize(nMaxChunkSize));
size_t nRealChunkSize = nDTSize;
for (const auto &nChunkSize : anChunkSizes)
{
nRealChunkSize *= nChunkSize;
}
try
{
copyFunc.abyTmp.resize(nRealChunkSize);
}
catch (const std::exception &)
{
CPLError(CE_Failure, CPLE_OutOfMemory,
"Cannot allocate temporary buffer");
nCurCost += copyFunc.nTotalBytesThisArray;
return false;
}
if (copyFunc.nTotalBytesThisArray != 0 &&
!const_cast<GDALMDArray *>(poSrcArray)
->ProcessPerChunk(arrayStartIdx.data(), count.data(),
anChunkSizes.data(), CopyFunc::f,
©Func) &&
(bStrict || copyFunc.bStop))
{
nCurCost += copyFunc.nTotalBytesThisArray;
return false;
}
nCurCost += copyFunc.nTotalBytesThisArray;
}
return true;
}
/************************************************************************/
/* GetStructuralInfo() */
/************************************************************************/
/** Return structural information on the array.
*
* This may be the compression, etc..
*
* The return value should not be freed and is valid until GDALMDArray is
* released or this function called again.
*
* This is the same as the C function GDALMDArrayGetStructuralInfo().
*/
CSLConstList GDALMDArray::GetStructuralInfo() const
{
return nullptr;
}
/************************************************************************/
/* AdviseRead() */
/************************************************************************/
/** Advise driver of upcoming read requests.
*
* Some GDAL drivers operate more efficiently if they know in advance what
* set of upcoming read requests will be made. The AdviseRead() method allows
* an application to notify the driver of the region of interest.
*
* Many drivers just ignore the AdviseRead() call, but it can dramatically
* accelerate access via some drivers. One such case is when reading through
* a DAP dataset with the netCDF driver (a in-memory cache array is then created
* with the region of interest defined by AdviseRead())
*
* This is the same as the C function GDALMDArrayAdviseRead().
*
* @param arrayStartIdx Values representing the starting index to read
* in each dimension (in [0, aoDims[i].GetSize()-1] range).
* Array of GetDimensionCount() values.
* Can be nullptr as a synonymous for [0 for i in
* range(GetDimensionCount() ]
*
* @param count Values representing the number of values to extract in
* each dimension.
* Array of GetDimensionCount() values.
* Can be nullptr as a synonymous for
* [ aoDims[i].GetSize() - arrayStartIdx[i] for i in
* range(GetDimensionCount() ]
*
* @param papszOptions Driver specific options, or nullptr. Consult driver
* documentation.
*
* @return true in case of success (ignoring the advice is a success)
*
* @since GDAL 3.2
*/
bool GDALMDArray::AdviseRead(const GUInt64 *arrayStartIdx, const size_t *count,
CSLConstList papszOptions) const
{
const auto nDimCount = GetDimensionCount();
if (nDimCount == 0)
return true;
std::vector<GUInt64> tmp_arrayStartIdx;
if (arrayStartIdx == nullptr)
{
tmp_arrayStartIdx.resize(nDimCount);
arrayStartIdx = tmp_arrayStartIdx.data();
}
std::vector<size_t> tmp_count;
if (count == nullptr)
{
tmp_count.resize(nDimCount);
const auto &dims = GetDimensions();
for (size_t i = 0; i < nDimCount; i++)
{
const GUInt64 nSize = dims[i]->GetSize() - arrayStartIdx[i];
#if SIZEOF_VOIDP < 8
if (nSize != static_cast<size_t>(nSize))
{
CPLError(CE_Failure, CPLE_AppDefined, "Integer overflow");
return false;
}
#endif
tmp_count[i] = static_cast<size_t>(nSize);
}
count = tmp_count.data();
}
std::vector<GInt64> tmp_arrayStep;
std::vector<GPtrDiff_t> tmp_bufferStride;
const GInt64 *arrayStep = nullptr;
const GPtrDiff_t *bufferStride = nullptr;
if (!CheckReadWriteParams(arrayStartIdx, count, arrayStep, bufferStride,
GDALExtendedDataType::Create(GDT_Unknown),
nullptr, nullptr, 0, tmp_arrayStep,
tmp_bufferStride))
{
return false;
}
return IAdviseRead(arrayStartIdx, count, papszOptions);
}
/************************************************************************/
/* IAdviseRead() */
/************************************************************************/
//! @cond Doxygen_Suppress
bool GDALMDArray::IAdviseRead(const GUInt64 *, const size_t *,
CSLConstList /* papszOptions*/) const
{
return true;
}
//! @endcond
/************************************************************************/
/* MassageName() */
/************************************************************************/
//! @cond Doxygen_Suppress
/*static*/ std::string GDALMDArray::MassageName(const std::string &inputName)
{
std::string ret;
for (const char ch : inputName)
{
if (!isalnum(ch))
ret += '_';
else
ret += ch;
}
return ret;
}
//! @endcond
/************************************************************************/
/* GetCacheRootGroup() */
/************************************************************************/
//! @cond Doxygen_Suppress
std::shared_ptr<GDALGroup>
GDALMDArray::GetCacheRootGroup(bool bCanCreate,
std::string &osCacheFilenameOut) const
{
const auto &osFilename = GetFilename();
if (osFilename.empty())
{
CPLError(CE_Failure, CPLE_AppDefined,
"Cannot cache an array with an empty filename");
return nullptr;
}
osCacheFilenameOut = osFilename + ".gmac";
const char *pszProxy = PamGetProxy(osCacheFilenameOut.c_str());
if (pszProxy != nullptr)
osCacheFilenameOut = pszProxy;
std::unique_ptr<GDALDataset> poDS;
VSIStatBufL sStat;
if (VSIStatL(osCacheFilenameOut.c_str(), &sStat) == 0)
{
poDS.reset(GDALDataset::Open(osCacheFilenameOut.c_str(),
GDAL_OF_MULTIDIM_RASTER | GDAL_OF_UPDATE,
nullptr, nullptr, nullptr));
}
if (poDS)
{
CPLDebug("GDAL", "Opening cache %s", osCacheFilenameOut.c_str());
return poDS->GetRootGroup();
}
if (bCanCreate)
{
const char *pszDrvName = "netCDF";
GDALDriver *poDrv = GetGDALDriverManager()->GetDriverByName(pszDrvName);
if (poDrv == nullptr)
{
CPLError(CE_Failure, CPLE_AppDefined, "Cannot get driver %s",
pszDrvName);
return nullptr;
}
{
CPLErrorHandlerPusher oHandlerPusher(CPLQuietErrorHandler);
CPLErrorStateBackuper oErrorStateBackuper;
poDS.reset(poDrv->CreateMultiDimensional(osCacheFilenameOut.c_str(),
nullptr, nullptr));
}
if (!poDS)
{
pszProxy = PamAllocateProxy(osCacheFilenameOut.c_str());
if (pszProxy)
{
osCacheFilenameOut = pszProxy;
poDS.reset(poDrv->CreateMultiDimensional(
osCacheFilenameOut.c_str(), nullptr, nullptr));
}
}
if (poDS)
{
CPLDebug("GDAL", "Creating cache %s", osCacheFilenameOut.c_str());
return poDS->GetRootGroup();
}
else
{
CPLError(CE_Failure, CPLE_AppDefined,
"Cannot create %s. Set the GDAL_PAM_PROXY_DIR "
"configuration option to write the cache in "
"another directory",
osCacheFilenameOut.c_str());
}
}
return nullptr;
}
//! @endcond
/************************************************************************/
/* Cache() */
/************************************************************************/
/** Cache the content of the array into an auxiliary filename.
*
* The main purpose of this method is to be able to cache views that are
* expensive to compute, such as transposed arrays.
*
* The array will be stored in a file whose name is the one of
* GetFilename(), with an extra .gmac extension (stands for GDAL
* Multidimensional Array Cache). The cache is a netCDF dataset.
*
* If the .gmac file cannot be written next to the dataset, the
* GDAL_PAM_PROXY_DIR will be used, if set, to write the cache file into that
* directory.
*
* The GDALMDArray::Read() method will automatically use the cache when it
* exists. There is no timestamp checks between the source array and the cached
* array. If the source arrays changes, the cache must be manually deleted.
*
* This is the same as the C function GDALMDArrayCache()
*
* @note Driver implementation: optionally implemented.
*
* @param papszOptions List of options, null terminated, or NULL. Currently
* the only option supported is BLOCKSIZE=bs0,bs1,...,bsN
* to specify the block size of the cached array.
* @return true in case of success.
*/
bool GDALMDArray::Cache(CSLConstList papszOptions) const
{
std::string osCacheFilename;
auto poRG = GetCacheRootGroup(true, osCacheFilename);
if (!poRG)
return false;
const std::string osCachedArrayName(MassageName(GetFullName()));
if (poRG->OpenMDArray(osCachedArrayName))
{
CPLError(CE_Failure, CPLE_NotSupported,
"An array with same name %s already exists in %s",
osCachedArrayName.c_str(), osCacheFilename.c_str());
return false;
}
CPLStringList aosOptions;
aosOptions.SetNameValue("COMPRESS", "DEFLATE");
const auto &aoDims = GetDimensions();
std::vector<std::shared_ptr<GDALDimension>> aoNewDims;
if (!aoDims.empty())
{
std::string osBlockSize(
CSLFetchNameValueDef(papszOptions, "BLOCKSIZE", ""));
if (osBlockSize.empty())
{
const auto anBlockSize = GetBlockSize();
int idxDim = 0;
for (auto nBlockSize : anBlockSize)
{
if (idxDim > 0)
osBlockSize += ',';
if (nBlockSize == 0)
nBlockSize = 256;
nBlockSize = std::min(nBlockSize, aoDims[idxDim]->GetSize());
osBlockSize +=
std::to_string(static_cast<uint64_t>(nBlockSize));
idxDim++;
}
}
aosOptions.SetNameValue("BLOCKSIZE", osBlockSize.c_str());
int idxDim = 0;
for (const auto &poDim : aoDims)
{
auto poNewDim = poRG->CreateDimension(
osCachedArrayName + '_' + std::to_string(idxDim),
poDim->GetType(), poDim->GetDirection(), poDim->GetSize());
if (!poNewDim)
return false;
aoNewDims.emplace_back(poNewDim);
idxDim++;
}
}
auto poCachedArray = poRG->CreateMDArray(osCachedArrayName, aoNewDims,
GetDataType(), aosOptions.List());
if (!poCachedArray)
{
CPLError(CE_Failure, CPLE_NotSupported, "Cannot create %s in %s",
osCachedArrayName.c_str(), osCacheFilename.c_str());
return false;
}
GUInt64 nCost = 0;
return poCachedArray->CopyFrom(nullptr, this,
false, // strict
nCost, GetTotalCopyCost(), nullptr, nullptr);
}
/************************************************************************/
/* Read() */
/************************************************************************/
bool GDALMDArray::Read(const GUInt64 *arrayStartIdx, const size_t *count,
const GInt64 *arrayStep, // step in elements
const GPtrDiff_t *bufferStride, // stride in elements
const GDALExtendedDataType &bufferDataType,
void *pDstBuffer, const void *pDstBufferAllocStart,
size_t nDstBufferAllocSize) const
{
if (!m_bHasTriedCachedArray)
{
m_bHasTriedCachedArray = true;
if (IsCacheable())
{
const auto &osFilename = GetFilename();
if (!osFilename.empty() &&
!EQUAL(CPLGetExtension(osFilename.c_str()), "gmac"))
{
std::string osCacheFilename;
auto poRG = GetCacheRootGroup(false, osCacheFilename);
if (poRG)
{
const std::string osCachedArrayName(
MassageName(GetFullName()));
m_poCachedArray = poRG->OpenMDArray(osCachedArrayName);
if (m_poCachedArray)
{
const auto &dims = GetDimensions();
const auto &cachedDims =
m_poCachedArray->GetDimensions();
const size_t nDims = dims.size();
bool ok =
m_poCachedArray->GetDataType() == GetDataType() &&
cachedDims.size() == nDims;
for (size_t i = 0; ok && i < nDims; ++i)
{
ok = dims[i]->GetSize() == cachedDims[i]->GetSize();
}
if (ok)
{
CPLDebug("GDAL", "Cached array for %s found in %s",
osCachedArrayName.c_str(),
osCacheFilename.c_str());
}
else
{
CPLError(CE_Warning, CPLE_AppDefined,
"Cached array %s in %s has incompatible "
"characteristics with current array.",
osCachedArrayName.c_str(),
osCacheFilename.c_str());
m_poCachedArray.reset();
}
}
}
}
}
}
const auto array = m_poCachedArray ? m_poCachedArray.get() : this;
if (!array->GetDataType().CanConvertTo(bufferDataType))
{
CPLError(CE_Failure, CPLE_AppDefined,
"Array data type is not convertible to buffer data type");
return false;
}
std::vector<GInt64> tmp_arrayStep;
std::vector<GPtrDiff_t> tmp_bufferStride;
if (!array->CheckReadWriteParams(arrayStartIdx, count, arrayStep,
bufferStride, bufferDataType, pDstBuffer,
pDstBufferAllocStart, nDstBufferAllocSize,
tmp_arrayStep, tmp_bufferStride))
{
return false;
}
return array->IRead(arrayStartIdx, count, arrayStep, bufferStride,
bufferDataType, pDstBuffer);
}
//! @cond Doxygen_Suppress
/************************************************************************/
/* IsTransposedRequest() */
/************************************************************************/
bool GDALMDArray::IsTransposedRequest(
const size_t *count,
const GPtrDiff_t *bufferStride) const // stride in elements
{
/*
For example:
count = [2,3,4]
strides = [12, 4, 1] (2-1)*12+(3-1)*4+(4-1)*1=23 ==> row major
stride [12, 1, 3] (2-1)*12+(3-1)*1+(4-1)*3=23 ==>
(axis[0],axis[2],axis[1]) transposition [1, 8, 2] (2-1)*1+
(3-1)*8+(4-1)*2=23 ==> (axis[2],axis[1],axis[0]) transposition
*/
const size_t nDims(GetDimensionCount());
size_t nCurStrideForRowMajorStrides = 1;
bool bRowMajorStrides = true;
size_t nElts = 1;
size_t nLastIdx = 0;
for (size_t i = nDims; i > 0;)
{
--i;
if (bufferStride[i] < 0)
return false;
if (static_cast<size_t>(bufferStride[i]) !=
nCurStrideForRowMajorStrides)
{
bRowMajorStrides = false;
}
// Integer overflows have already been checked in CheckReadWriteParams()
nCurStrideForRowMajorStrides *= count[i];
nElts *= count[i];
nLastIdx += static_cast<size_t>(bufferStride[i]) * (count[i] - 1);
}
if (bRowMajorStrides)
return false;
return nLastIdx == nElts - 1;
}
/************************************************************************/
/* CopyToFinalBufferSameDataType() */
/************************************************************************/
template <size_t N>
void CopyToFinalBufferSameDataType(const void *pSrcBuffer, void *pDstBuffer,
size_t nDims, const size_t *count,
const GPtrDiff_t *bufferStride)
{
std::vector<size_t> anStackCount(nDims);
std::vector<GByte *> pabyDstBufferStack(nDims + 1);
const GByte *pabySrcBuffer = static_cast<const GByte *>(pSrcBuffer);
pabyDstBufferStack[0] = static_cast<GByte *>(pDstBuffer);
size_t iDim = 0;
lbl_next_depth:
if (iDim == nDims - 1)
{
size_t n = count[iDim];
GByte *pabyDstBuffer = pabyDstBufferStack[iDim];
const auto bufferStrideLastDim = bufferStride[iDim] * N;
while (n > 0)
{
--n;
memcpy(pabyDstBuffer, pabySrcBuffer, N);
pabyDstBuffer += bufferStrideLastDim;
pabySrcBuffer += N;
}
}
else
{
anStackCount[iDim] = count[iDim];
while (true)
{
++iDim;
pabyDstBufferStack[iDim] = pabyDstBufferStack[iDim - 1];
goto lbl_next_depth;
lbl_return_to_caller_in_loop:
--iDim;
--anStackCount[iDim];
if (anStackCount[iDim] == 0)
break;
pabyDstBufferStack[iDim] += bufferStride[iDim] * N;
}
}
if (iDim > 0)
goto lbl_return_to_caller_in_loop;
}
/************************************************************************/
/* CopyToFinalBuffer() */
/************************************************************************/
static void CopyToFinalBuffer(const void *pSrcBuffer,
const GDALExtendedDataType &eSrcDataType,
void *pDstBuffer,
const GDALExtendedDataType &eDstDataType,
size_t nDims, const size_t *count,
const GPtrDiff_t *bufferStride)
{
const size_t nSrcDataTypeSize(eSrcDataType.GetSize());
// Use specialized implementation for well-known data types when no
// type conversion is needed
if (eSrcDataType == eDstDataType)
{
if (nSrcDataTypeSize == 1)
{
CopyToFinalBufferSameDataType<1>(pSrcBuffer, pDstBuffer, nDims,
count, bufferStride);
return;
}
else if (nSrcDataTypeSize == 2)
{
CopyToFinalBufferSameDataType<2>(pSrcBuffer, pDstBuffer, nDims,
count, bufferStride);
return;
}
else if (nSrcDataTypeSize == 4)
{
CopyToFinalBufferSameDataType<4>(pSrcBuffer, pDstBuffer, nDims,
count, bufferStride);
return;
}
else if (nSrcDataTypeSize == 8)
{
CopyToFinalBufferSameDataType<8>(pSrcBuffer, pDstBuffer, nDims,
count, bufferStride);
return;
}
}
const size_t nDstDataTypeSize(eDstDataType.GetSize());
std::vector<size_t> anStackCount(nDims);
std::vector<GByte *> pabyDstBufferStack(nDims + 1);
const GByte *pabySrcBuffer = static_cast<const GByte *>(pSrcBuffer);
pabyDstBufferStack[0] = static_cast<GByte *>(pDstBuffer);
size_t iDim = 0;
lbl_next_depth:
if (iDim == nDims - 1)
{
GDALExtendedDataType::CopyValues(pabySrcBuffer, eSrcDataType, 1,
pabyDstBufferStack[iDim], eDstDataType,
bufferStride[iDim], count[iDim]);
pabySrcBuffer += count[iDim] * nSrcDataTypeSize;
}
else
{
anStackCount[iDim] = count[iDim];
while (true)
{
++iDim;
pabyDstBufferStack[iDim] = pabyDstBufferStack[iDim - 1];
goto lbl_next_depth;
lbl_return_to_caller_in_loop:
--iDim;
--anStackCount[iDim];
if (anStackCount[iDim] == 0)
break;
pabyDstBufferStack[iDim] += bufferStride[iDim] * nDstDataTypeSize;
}
}
if (iDim > 0)
goto lbl_return_to_caller_in_loop;
}
/************************************************************************/
/* Transpose2D() */
/************************************************************************/
template <class T>
static void Transpose2D(T *dst, const T *src, size_t src_height,
size_t src_width)
{
constexpr size_t blocksize = 32;
for (size_t i = 0; i < src_height; i += blocksize)
{
for (size_t j = 0; j < src_width; j += blocksize)
{
// transpose the block beginning at [i,j]
const size_t max_k = std::min(i + blocksize, src_height);
for (size_t k = i; k < max_k; ++k)
{
const size_t max_l = std::min(j + blocksize, src_width);
for (size_t l = j; l < max_l; ++l)
{
dst[k + l * src_height] = src[l + k * src_width];
}
}
}
}
}
/************************************************************************/
/* TransposeLast2Dims() */
/************************************************************************/
static bool TransposeLast2Dims(void *pDstBuffer,
const GDALExtendedDataType &eDT,
const size_t nDims, const size_t *count,
const size_t nEltsNonLast2Dims)
{
const size_t nEltsLast2Dims = count[nDims - 2] * count[nDims - 1];
const auto nDTSize = eDT.GetSize();
void *pTempBufferForLast2DimsTranspose =
VSI_MALLOC2_VERBOSE(nEltsLast2Dims, nDTSize);
if (pTempBufferForLast2DimsTranspose == nullptr)
return false;
GByte *pabyDstBuffer = static_cast<GByte *>(pDstBuffer);
for (size_t i = 0; i < nEltsNonLast2Dims; ++i)
{
if (nDTSize == 1)
{
Transpose2D(
static_cast<uint8_t *>(pTempBufferForLast2DimsTranspose),
reinterpret_cast<const uint8_t *>(pabyDstBuffer),
count[nDims - 2], count[nDims - 1]);
}
else if (nDTSize == 2)
{
Transpose2D(
static_cast<uint16_t *>(pTempBufferForLast2DimsTranspose),
reinterpret_cast<const uint16_t *>(pabyDstBuffer),
count[nDims - 2], count[nDims - 1]);
}
else if (nDTSize == 4)
{
Transpose2D(
static_cast<uint32_t *>(pTempBufferForLast2DimsTranspose),
reinterpret_cast<const uint32_t *>(pabyDstBuffer),
count[nDims - 2], count[nDims - 1]);
}
else if (nDTSize == 8)
{
Transpose2D(
static_cast<uint64_t *>(pTempBufferForLast2DimsTranspose),
reinterpret_cast<const uint64_t *>(pabyDstBuffer),
count[nDims - 2], count[nDims - 1]);
}
else
{
CPLAssert(false);
}
memcpy(pabyDstBuffer, pTempBufferForLast2DimsTranspose,
nDTSize * nEltsLast2Dims);
pabyDstBuffer += nDTSize * nEltsLast2Dims;
}
VSIFree(pTempBufferForLast2DimsTranspose);
return true;
}
/************************************************************************/
/* ReadForTransposedRequest() */
/************************************************************************/
// Using the netCDF/HDF5 APIs to read a slice with strides that express a
// transposed view yield to extremely poor/unusable performance. This fixes
// this by using temporary memory to read in a contiguous buffer in a
// row-major order, and then do the transposition to the final buffer.
bool GDALMDArray::ReadForTransposedRequest(
const GUInt64 *arrayStartIdx, const size_t *count, const GInt64 *arrayStep,
const GPtrDiff_t *bufferStride, const GDALExtendedDataType &bufferDataType,
void *pDstBuffer) const
{
const size_t nDims(GetDimensionCount());
if (nDims == 0)
{
CPLAssert(false);
return false; // shouldn't happen
}
size_t nElts = 1;
for (size_t i = 0; i < nDims; ++i)
nElts *= count[i];
std::vector<GPtrDiff_t> tmpBufferStrides(nDims);
tmpBufferStrides.back() = 1;
for (size_t i = nDims - 1; i > 0;)
{
--i;
tmpBufferStrides[i] = tmpBufferStrides[i + 1] * count[i + 1];
}
const auto &eDT = GetDataType();
const auto nDTSize = eDT.GetSize();
if (bufferDataType == eDT && nDims >= 2 && bufferStride[nDims - 2] == 1 &&
static_cast<size_t>(bufferStride[nDims - 1]) == count[nDims - 2] &&
(nDTSize == 1 || nDTSize == 2 || nDTSize == 4 || nDTSize == 8))
{
// Optimization of the optimization if only the last 2 dims are
// transposed that saves on temporary buffer allocation
const size_t nEltsLast2Dims = count[nDims - 2] * count[nDims - 1];
size_t nCurStrideForRowMajorStrides = nEltsLast2Dims;
bool bRowMajorStridesForNonLast2Dims = true;
size_t nEltsNonLast2Dims = 1;
for (size_t i = nDims - 2; i > 0;)
{
--i;
if (static_cast<size_t>(bufferStride[i]) !=
nCurStrideForRowMajorStrides)
{
bRowMajorStridesForNonLast2Dims = false;
}
// Integer overflows have already been checked in
// CheckReadWriteParams()
nCurStrideForRowMajorStrides *= count[i];
nEltsNonLast2Dims *= count[i];
}
if (bRowMajorStridesForNonLast2Dims)
{
// We read in the final buffer!
if (!IRead(arrayStartIdx, count, arrayStep, tmpBufferStrides.data(),
eDT, pDstBuffer))
{
return false;
}
return TransposeLast2Dims(pDstBuffer, eDT, nDims, count,
nEltsNonLast2Dims);
}
}
void *pTempBuffer = VSI_MALLOC2_VERBOSE(nElts, eDT.GetSize());
if (pTempBuffer == nullptr)
return false;
if (!IRead(arrayStartIdx, count, arrayStep, tmpBufferStrides.data(), eDT,
pTempBuffer))
{
VSIFree(pTempBuffer);
return false;
}
CopyToFinalBuffer(pTempBuffer, eDT, pDstBuffer, bufferDataType, nDims,
count, bufferStride);
if (eDT.NeedsFreeDynamicMemory())
{
GByte *pabyPtr = static_cast<GByte *>(pTempBuffer);
for (size_t i = 0; i < nElts; ++i)
{
eDT.FreeDynamicMemory(pabyPtr);
pabyPtr += nDTSize;
}
}
VSIFree(pTempBuffer);
return true;
}
//! @endcond
/************************************************************************/
/* GDALSlicedMDArray */
/************************************************************************/
class GDALSlicedMDArray final : public GDALPamMDArray
{
private:
std::shared_ptr<GDALMDArray> m_poParent{};
std::vector<std::shared_ptr<GDALDimension>> m_dims{};
std::vector<size_t> m_mapDimIdxToParentDimIdx{}; // of size m_dims.size()
std::vector<Range>
m_parentRanges{}; // of size m_poParent->GetDimensionCount()
mutable std::vector<GUInt64> m_parentStart;
mutable std::vector<size_t> m_parentCount;
mutable std::vector<GInt64> m_parentStep;
mutable std::vector<GPtrDiff_t> m_parentStride;
void PrepareParentArrays(const GUInt64 *arrayStartIdx, const size_t *count,
const GInt64 *arrayStep,
const GPtrDiff_t *bufferStride) const;
protected:
explicit GDALSlicedMDArray(
const std::shared_ptr<GDALMDArray> &poParent,
const std::string &viewExpr,
std::vector<std::shared_ptr<GDALDimension>> &&dims,
std::vector<size_t> &&mapDimIdxToParentDimIdx,
std::vector<Range> &&parentRanges)
: GDALAbstractMDArray(std::string(), "Sliced view of " +
poParent->GetFullName() +
" (" + viewExpr + ")"),
GDALPamMDArray(std::string(),
"Sliced view of " + poParent->GetFullName() + " (" +
viewExpr + ")",
::GetPAM(poParent)),
m_poParent(std::move(poParent)), m_dims(std::move(dims)),
m_mapDimIdxToParentDimIdx(std::move(mapDimIdxToParentDimIdx)),
m_parentRanges(parentRanges),
m_parentStart(m_poParent->GetDimensionCount()),
m_parentCount(m_poParent->GetDimensionCount(), 1),
m_parentStep(m_poParent->GetDimensionCount()),
m_parentStride(m_poParent->GetDimensionCount())
{
}
bool IRead(const GUInt64 *arrayStartIdx, const size_t *count,
const GInt64 *arrayStep, const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType,
void *pDstBuffer) const override;
bool IWrite(const GUInt64 *arrayStartIdx, const size_t *count,
const GInt64 *arrayStep, const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType,
const void *pSrcBuffer) override;
bool IAdviseRead(const GUInt64 *arrayStartIdx, const size_t *count,
CSLConstList papszOptions) const override;
public:
static std::shared_ptr<GDALSlicedMDArray>
Create(const std::shared_ptr<GDALMDArray> &poParent,
const std::string &viewExpr,
std::vector<std::shared_ptr<GDALDimension>> &&dims,
std::vector<size_t> &&mapDimIdxToParentDimIdx,
std::vector<Range> &&parentRanges)
{
CPLAssert(dims.size() == mapDimIdxToParentDimIdx.size());
CPLAssert(parentRanges.size() == poParent->GetDimensionCount());
auto newAr(std::shared_ptr<GDALSlicedMDArray>(new GDALSlicedMDArray(
poParent, viewExpr, std::move(dims),
std::move(mapDimIdxToParentDimIdx), std::move(parentRanges))));
newAr->SetSelf(newAr);
return newAr;
}
bool IsWritable() const override
{
return m_poParent->IsWritable();
}
const std::string &GetFilename() const override
{
return m_poParent->GetFilename();
}
const std::vector<std::shared_ptr<GDALDimension>> &
GetDimensions() const override
{
return m_dims;
}
const GDALExtendedDataType &GetDataType() const override
{
return m_poParent->GetDataType();
}
const std::string &GetUnit() const override
{
return m_poParent->GetUnit();
}
// bool SetUnit(const std::string& osUnit) override { return
// m_poParent->SetUnit(osUnit); }
std::shared_ptr<OGRSpatialReference> GetSpatialRef() const override
{
auto poSrcSRS = m_poParent->GetSpatialRef();
if (!poSrcSRS)
return nullptr;
auto srcMapping = poSrcSRS->GetDataAxisToSRSAxisMapping();
std::vector<int> dstMapping;
for (int srcAxis : srcMapping)
{
bool bFound = false;
for (size_t i = 0; i < m_mapDimIdxToParentDimIdx.size(); i++)
{
if (static_cast<int>(m_mapDimIdxToParentDimIdx[i]) ==
srcAxis - 1)
{
dstMapping.push_back(static_cast<int>(i) + 1);
bFound = true;
break;
}
}
if (!bFound)
{
dstMapping.push_back(0);
}
}
auto poClone(std::shared_ptr<OGRSpatialReference>(poSrcSRS->Clone()));
poClone->SetDataAxisToSRSAxisMapping(dstMapping);
return poClone;
}
const void *GetRawNoDataValue() const override
{
return m_poParent->GetRawNoDataValue();
}
// bool SetRawNoDataValue(const void* pRawNoData) override { return
// m_poParent->SetRawNoDataValue(pRawNoData); }
double GetOffset(bool *pbHasOffset,
GDALDataType *peStorageType) const override
{
return m_poParent->GetOffset(pbHasOffset, peStorageType);
}
double GetScale(bool *pbHasScale,
GDALDataType *peStorageType) const override
{
return m_poParent->GetScale(pbHasScale, peStorageType);
}
// bool SetOffset(double dfOffset) override { return
// m_poParent->SetOffset(dfOffset); }
// bool SetScale(double dfScale) override { return
// m_poParent->SetScale(dfScale); }
std::vector<GUInt64> GetBlockSize() const override
{
std::vector<GUInt64> ret(GetDimensionCount());
const auto parentBlockSize(m_poParent->GetBlockSize());
for (size_t i = 0; i < m_mapDimIdxToParentDimIdx.size(); ++i)
{
const auto iOldAxis = m_mapDimIdxToParentDimIdx[i];
if (iOldAxis != static_cast<size_t>(-1))
{
ret[i] = parentBlockSize[iOldAxis];
}
}
return ret;
}
std::shared_ptr<GDALAttribute>
GetAttribute(const std::string &osName) const override
{
return m_poParent->GetAttribute(osName);
}
std::vector<std::shared_ptr<GDALAttribute>>
GetAttributes(CSLConstList papszOptions = nullptr) const override
{
return m_poParent->GetAttributes(papszOptions);
}
};
/************************************************************************/
/* PrepareParentArrays() */
/************************************************************************/
void GDALSlicedMDArray::PrepareParentArrays(
const GUInt64 *arrayStartIdx, const size_t *count, const GInt64 *arrayStep,
const GPtrDiff_t *bufferStride) const
{
const size_t nParentDimCount = m_parentRanges.size();
for (size_t i = 0; i < nParentDimCount; i++)
{
// For dimensions in parent that have no existence in sliced array
m_parentStart[i] = m_parentRanges[i].m_nStartIdx;
}
for (size_t i = 0; i < m_dims.size(); i++)
{
const auto iParent = m_mapDimIdxToParentDimIdx[i];
if (iParent != static_cast<size_t>(-1))
{
m_parentStart[iParent] =
m_parentRanges[iParent].m_nIncr >= 0
? m_parentRanges[iParent].m_nStartIdx +
arrayStartIdx[i] * m_parentRanges[iParent].m_nIncr
: m_parentRanges[iParent].m_nStartIdx -
arrayStartIdx[i] *
static_cast<GUInt64>(
-m_parentRanges[iParent].m_nIncr);
m_parentCount[iParent] = count[i];
if (arrayStep)
{
m_parentStep[iParent] =
count[i] == 1 ? 1 :
// other checks should have ensured this does
// not overflow
arrayStep[i] * m_parentRanges[iParent].m_nIncr;
}
if (bufferStride)
{
m_parentStride[iParent] = bufferStride[i];
}
}
}
}
/************************************************************************/
/* IRead() */
/************************************************************************/
bool GDALSlicedMDArray::IRead(const GUInt64 *arrayStartIdx, const size_t *count,
const GInt64 *arrayStep,
const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType,
void *pDstBuffer) const
{
PrepareParentArrays(arrayStartIdx, count, arrayStep, bufferStride);
return m_poParent->Read(m_parentStart.data(), m_parentCount.data(),
m_parentStep.data(), m_parentStride.data(),
bufferDataType, pDstBuffer);
}
/************************************************************************/
/* IWrite() */
/************************************************************************/
bool GDALSlicedMDArray::IWrite(const GUInt64 *arrayStartIdx,
const size_t *count, const GInt64 *arrayStep,
const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType,
const void *pSrcBuffer)
{
PrepareParentArrays(arrayStartIdx, count, arrayStep, bufferStride);
return m_poParent->Write(m_parentStart.data(), m_parentCount.data(),
m_parentStep.data(), m_parentStride.data(),
bufferDataType, pSrcBuffer);
}
/************************************************************************/
/* IAdviseRead() */
/************************************************************************/
bool GDALSlicedMDArray::IAdviseRead(const GUInt64 *arrayStartIdx,
const size_t *count,
CSLConstList papszOptions) const
{
PrepareParentArrays(arrayStartIdx, count, nullptr, nullptr);
return m_poParent->AdviseRead(m_parentStart.data(), m_parentCount.data(),
papszOptions);
}
/************************************************************************/
/* CreateSlicedArray() */
/************************************************************************/
static std::shared_ptr<GDALMDArray>
CreateSlicedArray(const std::shared_ptr<GDALMDArray> &self,
const std::string &viewExpr, const std::string &activeSlice,
bool bRenameDimensions,
std::vector<GDALMDArray::ViewSpec> &viewSpecs)
{
const auto &srcDims(self->GetDimensions());
if (srcDims.empty())
{
CPLError(CE_Failure, CPLE_AppDefined, "Cannot slice a 0-d array");
return nullptr;
}
CPLStringList aosTokens(CSLTokenizeString2(activeSlice.c_str(), ",", 0));
const auto nTokens = static_cast<size_t>(aosTokens.size());
std::vector<std::shared_ptr<GDALDimension>> newDims;
std::vector<size_t> mapDimIdxToParentDimIdx;
std::vector<GDALSlicedMDArray::Range> parentRanges;
newDims.reserve(nTokens);
mapDimIdxToParentDimIdx.reserve(nTokens);
parentRanges.reserve(nTokens);
bool bGotEllipsis = false;
size_t nCurSrcDim = 0;
for (size_t i = 0; i < nTokens; i++)
{
const char *pszIdxSpec = aosTokens[i];
if (EQUAL(pszIdxSpec, "..."))
{
if (bGotEllipsis)
{
CPLError(CE_Failure, CPLE_AppDefined,
"Only one single ellipsis is supported");
return nullptr;
}
bGotEllipsis = true;
const auto nSubstitutionCount = srcDims.size() - (nTokens - 1);
for (size_t j = 0; j < nSubstitutionCount; j++, nCurSrcDim++)
{
parentRanges.emplace_back(0, 1);
newDims.push_back(srcDims[nCurSrcDim]);
mapDimIdxToParentDimIdx.push_back(nCurSrcDim);
}
continue;
}
else if (EQUAL(pszIdxSpec, "newaxis") ||
EQUAL(pszIdxSpec, "np.newaxis"))
{
newDims.push_back(std::make_shared<GDALDimension>(
std::string(), "newaxis", std::string(), std::string(), 1));
mapDimIdxToParentDimIdx.push_back(static_cast<size_t>(-1));
continue;
}
else if (CPLGetValueType(pszIdxSpec) == CPL_VALUE_INTEGER)
{
if (nCurSrcDim >= srcDims.size())
{
CPLError(CE_Failure, CPLE_AppDefined, "Too many values in %s",
activeSlice.c_str());
return nullptr;
}
auto nVal = CPLAtoGIntBig(pszIdxSpec);
GUInt64 nDimSize = srcDims[nCurSrcDim]->GetSize();
if ((nVal >= 0 && static_cast<GUInt64>(nVal) >= nDimSize) ||
(nVal < 0 && nDimSize < static_cast<GUInt64>(-nVal)))
{
CPLError(CE_Failure, CPLE_AppDefined,
"Index " CPL_FRMT_GIB " is out of bounds", nVal);
return nullptr;
}
if (nVal < 0)
nVal += nDimSize;
parentRanges.emplace_back(nVal, 0);
}
else
{
if (nCurSrcDim >= srcDims.size())
{
CPLError(CE_Failure, CPLE_AppDefined, "Too many values in %s",
activeSlice.c_str());
return nullptr;
}
CPLStringList aosRangeTokens(
CSLTokenizeString2(pszIdxSpec, ":", CSLT_ALLOWEMPTYTOKENS));
int nRangeTokens = aosRangeTokens.size();
if (nRangeTokens > 3)
{
CPLError(CE_Failure, CPLE_AppDefined, "Too many : in %s",
pszIdxSpec);
return nullptr;
}
if (nRangeTokens <= 1)
{
CPLError(CE_Failure, CPLE_AppDefined, "Invalid value %s",
pszIdxSpec);
return nullptr;
}
const char *pszStart = aosRangeTokens[0];
const char *pszEnd = aosRangeTokens[1];
const char *pszInc = (nRangeTokens == 3) ? aosRangeTokens[2] : "";
GDALSlicedMDArray::Range range;
const GUInt64 nDimSize(srcDims[nCurSrcDim]->GetSize());
range.m_nIncr = EQUAL(pszInc, "") ? 1 : CPLAtoGIntBig(pszInc);
if (range.m_nIncr == 0 ||
range.m_nIncr == std::numeric_limits<GInt64>::min())
{
CPLError(CE_Failure, CPLE_AppDefined, "Invalid increment");
return nullptr;
}
auto startIdx(CPLAtoGIntBig(pszStart));
if (startIdx < 0)
{
if (nDimSize < static_cast<GUInt64>(-startIdx))
startIdx = 0;
else
startIdx = nDimSize + startIdx;
}
const bool bPosIncr = range.m_nIncr > 0;
range.m_nStartIdx = startIdx;
range.m_nStartIdx = EQUAL(pszStart, "")
? (bPosIncr ? 0 : nDimSize - 1)
: range.m_nStartIdx;
if (range.m_nStartIdx >= nDimSize - 1)
range.m_nStartIdx = nDimSize - 1;
auto endIdx(CPLAtoGIntBig(pszEnd));
if (endIdx < 0)
{
const auto positiveEndIdx = static_cast<GUInt64>(-endIdx);
if (nDimSize < positiveEndIdx)
endIdx = 0;
else
endIdx = nDimSize - positiveEndIdx;
}
GUInt64 nEndIdx = endIdx;
nEndIdx = EQUAL(pszEnd, "") ? (!bPosIncr ? 0 : nDimSize) : nEndIdx;
if ((bPosIncr && range.m_nStartIdx >= nEndIdx) ||
(!bPosIncr && range.m_nStartIdx <= nEndIdx))
{
CPLError(CE_Failure, CPLE_AppDefined,
"Output dimension of size 0 is not allowed");
return nullptr;
}
int inc = (EQUAL(pszEnd, "") && !bPosIncr) ? 1 : 0;
const auto nAbsIncr = std::abs(range.m_nIncr);
const GUInt64 newSize =
bPosIncr
? DIV_ROUND_UP(nEndIdx - range.m_nStartIdx, nAbsIncr)
: DIV_ROUND_UP(inc + range.m_nStartIdx - nEndIdx, nAbsIncr);
if (range.m_nStartIdx == 0 && range.m_nIncr == 1 &&
newSize == srcDims[nCurSrcDim]->GetSize())
{
newDims.push_back(srcDims[nCurSrcDim]);
}
else
{
std::string osNewDimName(srcDims[nCurSrcDim]->GetName());
if (bRenameDimensions)
{
osNewDimName =
"subset_" + srcDims[nCurSrcDim]->GetName() +
CPLSPrintf("_" CPL_FRMT_GUIB "_" CPL_FRMT_GIB
"_" CPL_FRMT_GUIB,
static_cast<GUIntBig>(range.m_nStartIdx),
static_cast<GIntBig>(range.m_nIncr),
static_cast<GUIntBig>(newSize));
}
newDims.push_back(std::make_shared<GDALDimension>(
std::string(), osNewDimName, srcDims[nCurSrcDim]->GetType(),
range.m_nIncr > 0 ? srcDims[nCurSrcDim]->GetDirection()
: std::string(),
newSize));
}
mapDimIdxToParentDimIdx.push_back(nCurSrcDim);
parentRanges.emplace_back(range);
}
nCurSrcDim++;
}
for (; nCurSrcDim < srcDims.size(); nCurSrcDim++)
{
parentRanges.emplace_back(0, 1);
newDims.push_back(srcDims[nCurSrcDim]);
mapDimIdxToParentDimIdx.push_back(nCurSrcDim);
}
GDALMDArray::ViewSpec viewSpec;
viewSpec.m_mapDimIdxToParentDimIdx = mapDimIdxToParentDimIdx;
viewSpec.m_parentRanges = parentRanges;
viewSpecs.emplace_back(std::move(viewSpec));
return GDALSlicedMDArray::Create(self, viewExpr, std::move(newDims),
std::move(mapDimIdxToParentDimIdx),
std::move(parentRanges));
}
/************************************************************************/
/* GDALExtractFieldMDArray */
/************************************************************************/
class GDALExtractFieldMDArray final : public GDALPamMDArray
{
private:
std::shared_ptr<GDALMDArray> m_poParent{};
GDALExtendedDataType m_dt;
std::string m_srcCompName;
mutable std::vector<GByte> m_pabyNoData{};
protected:
GDALExtractFieldMDArray(const std::shared_ptr<GDALMDArray> &poParent,
const std::string &fieldName,
const std::unique_ptr<GDALEDTComponent> &srcComp)
: GDALAbstractMDArray(std::string(), "Extract field " + fieldName +
" of " +
poParent->GetFullName()),
GDALPamMDArray(std::string(),
"Extract field " + fieldName + " of " +
poParent->GetFullName(),
::GetPAM(poParent)),
m_poParent(poParent), m_dt(srcComp->GetType()),
m_srcCompName(srcComp->GetName())
{
m_pabyNoData.resize(m_dt.GetSize());
}
bool IRead(const GUInt64 *arrayStartIdx, const size_t *count,
const GInt64 *arrayStep, const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType,
void *pDstBuffer) const override;
bool IAdviseRead(const GUInt64 *arrayStartIdx, const size_t *count,
CSLConstList papszOptions) const override
{
return m_poParent->AdviseRead(arrayStartIdx, count, papszOptions);
}
public:
static std::shared_ptr<GDALExtractFieldMDArray>
Create(const std::shared_ptr<GDALMDArray> &poParent,
const std::string &fieldName,
const std::unique_ptr<GDALEDTComponent> &srcComp)
{
auto newAr(std::shared_ptr<GDALExtractFieldMDArray>(
new GDALExtractFieldMDArray(poParent, fieldName, srcComp)));
newAr->SetSelf(newAr);
return newAr;
}
~GDALExtractFieldMDArray()
{
m_dt.FreeDynamicMemory(&m_pabyNoData[0]);
}
bool IsWritable() const override
{
return m_poParent->IsWritable();
}
const std::string &GetFilename() const override
{
return m_poParent->GetFilename();
}
const std::vector<std::shared_ptr<GDALDimension>> &
GetDimensions() const override
{
return m_poParent->GetDimensions();
}
const GDALExtendedDataType &GetDataType() const override
{
return m_dt;
}
const std::string &GetUnit() const override
{
return m_poParent->GetUnit();
}
std::shared_ptr<OGRSpatialReference> GetSpatialRef() const override
{
return m_poParent->GetSpatialRef();
}
const void *GetRawNoDataValue() const override
{
const void *parentNoData = m_poParent->GetRawNoDataValue();
if (parentNoData == nullptr)
return nullptr;
m_dt.FreeDynamicMemory(&m_pabyNoData[0]);
memset(&m_pabyNoData[0], 0, m_dt.GetSize());
std::vector<std::unique_ptr<GDALEDTComponent>> comps;
comps.emplace_back(std::unique_ptr<GDALEDTComponent>(
new GDALEDTComponent(m_srcCompName, 0, m_dt)));
auto tmpDT(GDALExtendedDataType::Create(std::string(), m_dt.GetSize(),
std::move(comps)));
GDALExtendedDataType::CopyValue(parentNoData, m_poParent->GetDataType(),
&m_pabyNoData[0], tmpDT);
return &m_pabyNoData[0];
}
double GetOffset(bool *pbHasOffset,
GDALDataType *peStorageType) const override
{
return m_poParent->GetOffset(pbHasOffset, peStorageType);
}
double GetScale(bool *pbHasScale,
GDALDataType *peStorageType) const override
{
return m_poParent->GetScale(pbHasScale, peStorageType);
}
std::vector<GUInt64> GetBlockSize() const override
{
return m_poParent->GetBlockSize();
}
};
/************************************************************************/
/* IRead() */
/************************************************************************/
bool GDALExtractFieldMDArray::IRead(const GUInt64 *arrayStartIdx,
const size_t *count,
const GInt64 *arrayStep,
const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType,
void *pDstBuffer) const
{
std::vector<std::unique_ptr<GDALEDTComponent>> comps;
comps.emplace_back(std::unique_ptr<GDALEDTComponent>(
new GDALEDTComponent(m_srcCompName, 0, bufferDataType)));
auto tmpDT(GDALExtendedDataType::Create(
std::string(), bufferDataType.GetSize(), std::move(comps)));
return m_poParent->Read(arrayStartIdx, count, arrayStep, bufferStride,
tmpDT, pDstBuffer);
}
/************************************************************************/
/* CreateFieldNameExtractArray() */
/************************************************************************/
static std::shared_ptr<GDALMDArray>
CreateFieldNameExtractArray(const std::shared_ptr<GDALMDArray> &self,
const std::string &fieldName)
{
CPLAssert(self->GetDataType().GetClass() == GEDTC_COMPOUND);
const std::unique_ptr<GDALEDTComponent> *srcComp = nullptr;
for (const auto &comp : self->GetDataType().GetComponents())
{
if (comp->GetName() == fieldName)
{
srcComp = ∁
break;
}
}
if (srcComp == nullptr)
{
CPLError(CE_Failure, CPLE_AppDefined, "Cannot find field %s",
fieldName.c_str());
return nullptr;
}
return GDALExtractFieldMDArray::Create(self, fieldName, *srcComp);
}
/************************************************************************/
/* GetView() */
/************************************************************************/
/** Return a view of the array using slicing or field access.
*
* The slice expression uses the same syntax as NumPy basic slicing and
* indexing. See
* https://www.numpy.org/devdocs/reference/arrays.indexing.html#basic-slicing-and-indexing
* Or it can use field access by name. See
* https://www.numpy.org/devdocs/reference/arrays.indexing.html#field-access
*
* Multiple [] bracket elements can be concatenated, with a slice expression
* or field name inside each.
*
* For basic slicing and indexing, inside each [] bracket element, a list of
* indexes that apply to successive source dimensions, can be specified, using
* integer indexing (e.g. 1), range indexing (start:stop:step), ellipsis (...)
* or newaxis, using a comma separator.
*
* Examples with a 2-dimensional array whose content is [[0,1,2,3],[4,5,6,7]].
* <ul>
* <li>GetView("[1][2]"): returns a 0-dimensional/scalar array with the value
* at index 1 in the first dimension, and index 2 in the second dimension
* from the source array. That is 5</li>
* <li>GetView("[1]")->GetView("[2]"): same as above. Above is actually
* implemented internally doing this intermediate slicing approach.</li>
* <li>GetView("[1,2]"): same as above, but a bit more performant.</li>
* <li>GetView("[1]"): returns a 1-dimensional array, sliced at index 1 in the
* first dimension. That is [4,5,6,7].</li>
* <li>GetView("[:,2]"): returns a 1-dimensional array, sliced at index 2 in the
* second dimension. That is [2,6].</li>
* <li>GetView("[:,2:3:]"): returns a 2-dimensional array, sliced at index 2 in
* the second dimension. That is [[2],[6]].</li> <li>GetView("[::,2]"): Same as
* above.</li> <li>GetView("[...,2]"): same as above, in that case, since the
* ellipsis only expands to one dimension here.</li> <li>GetView("[:,::2]"):
* returns a 2-dimensional array, with even-indexed elements of the second
* dimension. That is [[0,2],[4,6]].</li> <li>GetView("[:,1::2]"): returns a
* 2-dimensional array, with odd-indexed elements of the second dimension. That
* is [[1,3],[5,7]].</li> <li>GetView("[:,1:3:]"): returns a 2-dimensional
* array, with elements of the second dimension with index in the range [1,3[.
* That is [[1,2],[5,6]].</li> <li>GetView("[::-1,:]"): returns a 2-dimensional
* array, with the values in first dimension reversed. That is
* [[4,5,6,7],[0,1,2,3]].</li> <li>GetView("[newaxis,...]"): returns a
* 3-dimensional array, with an addditional dimension of size 1 put at the
* beginning. That is [[[0,1,2,3],[4,5,6,7]]].</li>
* </ul>
*
* One difference with NumPy behavior is that ranges that would result in
* zero elements are not allowed (dimensions of size 0 not being allowed in the
* GDAL multidimensional model).
*
* For field access, the syntax to use is ["field_name"] or ['field_name'].
* Multiple field specification is not supported currently.
*
* Both type of access can be combined, e.g. GetView("[1]['field_name']")
*
* \note When using the GDAL Python bindings, natural Python syntax can be
* used. That is ar[0,::,1]["foo"] will be internally translated to
* ar.GetView("[0,::,1]['foo']")
* \note When using the C++ API and integer indexing only, you may use the
* at(idx0, idx1, ...) method.
*
* The returned array holds a reference to the original one, and thus is
* a view of it (not a copy). If the content of the original array changes,
* the content of the view array too. When using basic slicing and indexing,
* the view can be written if the underlying array is writable.
*
* This is the same as the C function GDALMDArrayGetView()
*
* @param viewExpr Expression expressing basic slicing and indexing, or field
* access.
* @return a new array, that holds a reference to the original one, and thus is
* a view of it (not a copy), or nullptr in case of error.
*/
std::shared_ptr<GDALMDArray>
GDALMDArray::GetView(const std::string &viewExpr) const
{
std::vector<ViewSpec> viewSpecs;
return GetView(viewExpr, true, viewSpecs);
}
//! @cond Doxygen_Suppress
std::shared_ptr<GDALMDArray>
GDALMDArray::GetView(const std::string &viewExpr, bool bRenameDimensions,
std::vector<ViewSpec> &viewSpecs) const
{
auto self = std::dynamic_pointer_cast<GDALMDArray>(m_pSelf.lock());
if (!self)
{
CPLError(CE_Failure, CPLE_AppDefined,
"Driver implementation issue: m_pSelf not set !");
return nullptr;
}
std::string curExpr(viewExpr);
while (true)
{
if (curExpr.empty() || curExpr[0] != '[')
{
CPLError(CE_Failure, CPLE_AppDefined,
"Slice string should start with ['");
return nullptr;
}
std::string fieldName;
size_t endExpr;
if (curExpr.size() > 2 && (curExpr[1] == '"' || curExpr[1] == '\''))
{
if (self->GetDataType().GetClass() != GEDTC_COMPOUND)
{
CPLError(CE_Failure, CPLE_AppDefined,
"Field access not allowed on non-compound data type");
return nullptr;
}
size_t idx = 2;
for (; idx < curExpr.size(); idx++)
{
const char ch = curExpr[idx];
if (ch == curExpr[1])
break;
if (ch == '\\' && idx + 1 < curExpr.size())
{
fieldName += curExpr[idx + 1];
idx++;
}
else
{
fieldName += ch;
}
}
if (idx + 1 >= curExpr.size() || curExpr[idx + 1] != ']')
{
CPLError(CE_Failure, CPLE_AppDefined,
"Invalid field access specification");
return nullptr;
}
endExpr = idx + 1;
}
else
{
endExpr = curExpr.find(']');
}
if (endExpr == std::string::npos)
{
CPLError(CE_Failure, CPLE_AppDefined, "Missing ]'");
return nullptr;
}
if (endExpr == 1)
{
CPLError(CE_Failure, CPLE_AppDefined, "[] not allowed");
return nullptr;
}
std::string activeSlice(curExpr.substr(1, endExpr - 1));
if (!fieldName.empty())
{
ViewSpec viewSpec;
viewSpec.m_osFieldName = fieldName;
viewSpecs.emplace_back(std::move(viewSpec));
}
auto newArray = !fieldName.empty()
? CreateFieldNameExtractArray(self, fieldName)
: CreateSlicedArray(self, viewExpr, activeSlice,
bRenameDimensions, viewSpecs);
if (endExpr == curExpr.size() - 1)
{
return newArray;
}
self = std::move(newArray);
curExpr = curExpr.substr(endExpr + 1);
}
}
//! @endcond
std::shared_ptr<GDALMDArray>
GDALMDArray::GetView(const std::vector<GUInt64> &indices) const
{
std::string osExpr("[");
bool bFirst = true;
for (const auto &idx : indices)
{
if (!bFirst)
osExpr += ',';
bFirst = false;
osExpr += CPLSPrintf(CPL_FRMT_GUIB, static_cast<GUIntBig>(idx));
}
return GetView(osExpr + ']');
}
/************************************************************************/
/* operator[] */
/************************************************************************/
/** Return a view of the array using field access
*
* Equivalent of GetView("['fieldName']")
*
* \note When operationg on a shared_ptr, use (*array)["fieldName"] syntax.
*/
std::shared_ptr<GDALMDArray>
GDALMDArray::operator[](const std::string &fieldName) const
{
return GetView(CPLSPrintf("['%s']", CPLString(fieldName)
.replaceAll('\\', "\\\\")
.replaceAll('\'', "\\\'")
.c_str()));
}
/************************************************************************/
/* GDALMDArrayTransposed */
/************************************************************************/
class GDALMDArrayTransposed final : public GDALPamMDArray
{
private:
std::shared_ptr<GDALMDArray> m_poParent{};
std::vector<int> m_anMapNewAxisToOldAxis{};
std::vector<std::shared_ptr<GDALDimension>> m_dims{};
mutable std::vector<GUInt64> m_parentStart;
mutable std::vector<size_t> m_parentCount;
mutable std::vector<GInt64> m_parentStep;
mutable std::vector<GPtrDiff_t> m_parentStride;
void PrepareParentArrays(const GUInt64 *arrayStartIdx, const size_t *count,
const GInt64 *arrayStep,
const GPtrDiff_t *bufferStride) const;
static std::string
MappingToStr(const std::vector<int> &anMapNewAxisToOldAxis)
{
std::string ret;
ret += '[';
for (size_t i = 0; i < anMapNewAxisToOldAxis.size(); ++i)
{
if (i > 0)
ret += ',';
ret += CPLSPrintf("%d", anMapNewAxisToOldAxis[i]);
}
ret += ']';
return ret;
}
protected:
GDALMDArrayTransposed(const std::shared_ptr<GDALMDArray> &poParent,
const std::vector<int> &anMapNewAxisToOldAxis,
std::vector<std::shared_ptr<GDALDimension>> &&dims)
: GDALAbstractMDArray(std::string(),
"Transposed view of " + poParent->GetFullName() +
" along " +
MappingToStr(anMapNewAxisToOldAxis)),
GDALPamMDArray(std::string(),
"Transposed view of " + poParent->GetFullName() +
" along " + MappingToStr(anMapNewAxisToOldAxis),
::GetPAM(poParent)),
m_poParent(std::move(poParent)),
m_anMapNewAxisToOldAxis(anMapNewAxisToOldAxis),
m_dims(std::move(dims)),
m_parentStart(m_poParent->GetDimensionCount()),
m_parentCount(m_poParent->GetDimensionCount()),
m_parentStep(m_poParent->GetDimensionCount()),
m_parentStride(m_poParent->GetDimensionCount())
{
}
bool IRead(const GUInt64 *arrayStartIdx, const size_t *count,
const GInt64 *arrayStep, const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType,
void *pDstBuffer) const override;
bool IWrite(const GUInt64 *arrayStartIdx, const size_t *count,
const GInt64 *arrayStep, const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType,
const void *pSrcBuffer) override;
bool IAdviseRead(const GUInt64 *arrayStartIdx, const size_t *count,
CSLConstList papszOptions) const override;
public:
static std::shared_ptr<GDALMDArrayTransposed>
Create(const std::shared_ptr<GDALMDArray> &poParent,
const std::vector<int> &anMapNewAxisToOldAxis)
{
const auto &parentDims(poParent->GetDimensions());
std::vector<std::shared_ptr<GDALDimension>> dims;
for (const auto iOldAxis : anMapNewAxisToOldAxis)
{
if (iOldAxis < 0)
{
dims.push_back(std::make_shared<GDALDimension>(
std::string(), "newaxis", std::string(), std::string(), 1));
}
else
{
dims.emplace_back(parentDims[iOldAxis]);
}
}
auto newAr(
std::shared_ptr<GDALMDArrayTransposed>(new GDALMDArrayTransposed(
poParent, anMapNewAxisToOldAxis, std::move(dims))));
newAr->SetSelf(newAr);
return newAr;
}
bool IsWritable() const override
{
return m_poParent->IsWritable();
}
const std::string &GetFilename() const override
{
return m_poParent->GetFilename();
}
const std::vector<std::shared_ptr<GDALDimension>> &
GetDimensions() const override
{
return m_dims;
}
const GDALExtendedDataType &GetDataType() const override
{
return m_poParent->GetDataType();
}
const std::string &GetUnit() const override
{
return m_poParent->GetUnit();
}
std::shared_ptr<OGRSpatialReference> GetSpatialRef() const override
{
auto poSrcSRS = m_poParent->GetSpatialRef();
if (!poSrcSRS)
return nullptr;
auto srcMapping = poSrcSRS->GetDataAxisToSRSAxisMapping();
std::vector<int> dstMapping;
for (int srcAxis : srcMapping)
{
bool bFound = false;
for (size_t i = 0; i < m_anMapNewAxisToOldAxis.size(); i++)
{
if (m_anMapNewAxisToOldAxis[i] == srcAxis - 1)
{
dstMapping.push_back(static_cast<int>(i) + 1);
bFound = true;
break;
}
}
if (!bFound)
{
dstMapping.push_back(0);
}
}
auto poClone(std::shared_ptr<OGRSpatialReference>(poSrcSRS->Clone()));
poClone->SetDataAxisToSRSAxisMapping(dstMapping);
return poClone;
}
const void *GetRawNoDataValue() const override
{
return m_poParent->GetRawNoDataValue();
}
// bool SetRawNoDataValue(const void* pRawNoData) override { return
// m_poParent->SetRawNoDataValue(pRawNoData); }
double GetOffset(bool *pbHasOffset,
GDALDataType *peStorageType) const override
{
return m_poParent->GetOffset(pbHasOffset, peStorageType);
}
double GetScale(bool *pbHasScale,
GDALDataType *peStorageType) const override
{
return m_poParent->GetScale(pbHasScale, peStorageType);
}
// bool SetOffset(double dfOffset) override { return
// m_poParent->SetOffset(dfOffset); }
// bool SetScale(double dfScale) override { return
// m_poParent->SetScale(dfScale); }
std::vector<GUInt64> GetBlockSize() const override
{
std::vector<GUInt64> ret(GetDimensionCount());
const auto parentBlockSize(m_poParent->GetBlockSize());
for (size_t i = 0; i < m_anMapNewAxisToOldAxis.size(); ++i)
{
const auto iOldAxis = m_anMapNewAxisToOldAxis[i];
if (iOldAxis >= 0)
{
ret[i] = parentBlockSize[iOldAxis];
}
}
return ret;
}
std::shared_ptr<GDALAttribute>
GetAttribute(const std::string &osName) const override
{
return m_poParent->GetAttribute(osName);
}
std::vector<std::shared_ptr<GDALAttribute>>
GetAttributes(CSLConstList papszOptions = nullptr) const override
{
return m_poParent->GetAttributes(papszOptions);
}
};
/************************************************************************/
/* PrepareParentArrays() */
/************************************************************************/
void GDALMDArrayTransposed::PrepareParentArrays(
const GUInt64 *arrayStartIdx, const size_t *count, const GInt64 *arrayStep,
const GPtrDiff_t *bufferStride) const
{
for (size_t i = 0; i < m_anMapNewAxisToOldAxis.size(); ++i)
{
const auto iOldAxis = m_anMapNewAxisToOldAxis[i];
if (iOldAxis >= 0)
{
m_parentStart[iOldAxis] = arrayStartIdx[i];
m_parentCount[iOldAxis] = count[i];
if (arrayStep) // only null when called from IAdviseRead()
{
m_parentStep[iOldAxis] = arrayStep[i];
}
if (bufferStride) // only null when called from IAdviseRead()
{
m_parentStride[iOldAxis] = bufferStride[i];
}
}
}
}
/************************************************************************/
/* IRead() */
/************************************************************************/
bool GDALMDArrayTransposed::IRead(const GUInt64 *arrayStartIdx,
const size_t *count, const GInt64 *arrayStep,
const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType,
void *pDstBuffer) const
{
PrepareParentArrays(arrayStartIdx, count, arrayStep, bufferStride);
return m_poParent->Read(m_parentStart.data(), m_parentCount.data(),
m_parentStep.data(), m_parentStride.data(),
bufferDataType, pDstBuffer);
}
/************************************************************************/
/* IWrite() */
/************************************************************************/
bool GDALMDArrayTransposed::IWrite(const GUInt64 *arrayStartIdx,
const size_t *count, const GInt64 *arrayStep,
const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType,
const void *pSrcBuffer)
{
PrepareParentArrays(arrayStartIdx, count, arrayStep, bufferStride);
return m_poParent->Write(m_parentStart.data(), m_parentCount.data(),
m_parentStep.data(), m_parentStride.data(),
bufferDataType, pSrcBuffer);
}
/************************************************************************/
/* IAdviseRead() */
/************************************************************************/
bool GDALMDArrayTransposed::IAdviseRead(const GUInt64 *arrayStartIdx,
const size_t *count,
CSLConstList papszOptions) const
{
PrepareParentArrays(arrayStartIdx, count, nullptr, nullptr);
return m_poParent->AdviseRead(m_parentStart.data(), m_parentCount.data(),
papszOptions);
}
/************************************************************************/
/* Transpose() */
/************************************************************************/
/** Return a view of the array whose axis have been reordered.
*
* The anMapNewAxisToOldAxis parameter should contain all the values between 0
* and GetDimensionCount() - 1, and each only once.
* -1 can be used as a special index value to ask for the insertion of a new
* axis of size 1.
* The new array will have anMapNewAxisToOldAxis.size() axis, and if i is the
* index of one of its dimension, it corresponds to the axis of index
* anMapNewAxisToOldAxis[i] from the current array.
*
* This is similar to the numpy.transpose() method
*
* The returned array holds a reference to the original one, and thus is
* a view of it (not a copy). If the content of the original array changes,
* the content of the view array too. The view can be written if the underlying
* array is writable.
*
* Note that I/O performance in such a transposed view might be poor.
*
* This is the same as the C function GDALMDArrayTranspose().
*
* @return a new array, that holds a reference to the original one, and thus is
* a view of it (not a copy), or nullptr in case of error.
*/
std::shared_ptr<GDALMDArray>
GDALMDArray::Transpose(const std::vector<int> &anMapNewAxisToOldAxis) const
{
auto self = std::dynamic_pointer_cast<GDALMDArray>(m_pSelf.lock());
if (!self)
{
CPLError(CE_Failure, CPLE_AppDefined,
"Driver implementation issue: m_pSelf not set !");
return nullptr;
}
const int nDims = static_cast<int>(GetDimensionCount());
std::vector<bool> alreadyUsedOldAxis(nDims, false);
int nCountOldAxis = 0;
for (const auto iOldAxis : anMapNewAxisToOldAxis)
{
if (iOldAxis < -1 || iOldAxis >= nDims)
{
CPLError(CE_Failure, CPLE_AppDefined, "Invalid axis number");
return nullptr;
}
if (iOldAxis >= 0)
{
if (alreadyUsedOldAxis[iOldAxis])
{
CPLError(CE_Failure, CPLE_AppDefined, "Axis %d is repeated",
iOldAxis);
return nullptr;
}
alreadyUsedOldAxis[iOldAxis] = true;
nCountOldAxis++;
}
}
if (nCountOldAxis != nDims)
{
CPLError(CE_Failure, CPLE_AppDefined,
"One or several original axis missing");
return nullptr;
}
return GDALMDArrayTransposed::Create(self, anMapNewAxisToOldAxis);
}
/************************************************************************/
/* IRead() */
/************************************************************************/
bool GDALMDArrayUnscaled::IRead(const GUInt64 *arrayStartIdx,
const size_t *count, const GInt64 *arrayStep,
const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType,
void *pDstBuffer) const
{
const double dfScale = m_poParent->GetScale();
const double dfOffset = m_poParent->GetOffset();
const bool bDTIsComplex = m_dt.GetNumericDataType() == GDT_CFloat64;
const size_t nDTSize = m_dt.GetSize();
const bool bTempBufferNeeded = (m_dt != bufferDataType);
double adfSrcNoData[2] = {0, 0};
if (m_bHasNoData)
{
GDALExtendedDataType::CopyValue(m_poParent->GetRawNoDataValue(),
m_poParent->GetDataType(),
&adfSrcNoData[0], m_dt);
}
const auto nDims = GetDimensions().size();
if (nDims == 0)
{
double adfVal[2];
if (!m_poParent->Read(arrayStartIdx, count, arrayStep, bufferStride,
m_dt, &adfVal[0]))
{
return false;
}
if (!m_bHasNoData || adfVal[0] != adfSrcNoData[0])
{
adfVal[0] = adfVal[0] * dfScale + dfOffset;
if (bDTIsComplex)
{
adfVal[1] = adfVal[1] * dfScale + dfOffset;
}
GDALExtendedDataType::CopyValue(&adfVal[0], m_dt, pDstBuffer,
bufferDataType);
}
else
{
GDALExtendedDataType::CopyValue(&m_adfNoData[0], m_dt, pDstBuffer,
bufferDataType);
}
return true;
}
std::vector<GPtrDiff_t> actualBufferStrideVector;
const GPtrDiff_t *actualBufferStridePtr = bufferStride;
void *pTempBuffer = pDstBuffer;
if (bTempBufferNeeded)
{
size_t nElts = 1;
actualBufferStrideVector.resize(nDims);
for (size_t i = 0; i < nDims; i++)
nElts *= count[i];
actualBufferStrideVector.back() = 1;
for (size_t i = nDims - 1; i > 0;)
{
--i;
actualBufferStrideVector[i] =
actualBufferStrideVector[i + 1] * count[i + 1];
}
actualBufferStridePtr = actualBufferStrideVector.data();
pTempBuffer = VSI_MALLOC2_VERBOSE(nDTSize, nElts);
if (!pTempBuffer)
return false;
}
if (!m_poParent->Read(arrayStartIdx, count, arrayStep,
actualBufferStridePtr, m_dt, pTempBuffer))
{
if (bTempBufferNeeded)
VSIFree(pTempBuffer);
return false;
}
struct Stack
{
size_t nIters = 0;
double *src_ptr = nullptr;
GByte *dst_ptr = nullptr;
GPtrDiff_t src_inc_offset = 0;
GPtrDiff_t dst_inc_offset = 0;
};
std::vector<Stack> stack(nDims);
const size_t nBufferDTSize = bufferDataType.GetSize();
for (size_t i = 0; i < nDims; i++)
{
stack[i].src_inc_offset =
actualBufferStridePtr[i] * (bDTIsComplex ? 2 : 1);
stack[i].dst_inc_offset =
static_cast<GPtrDiff_t>(bufferStride[i] * nBufferDTSize);
}
stack[0].src_ptr = static_cast<double *>(pTempBuffer);
stack[0].dst_ptr = static_cast<GByte *>(pDstBuffer);
size_t dimIdx = 0;
const size_t nDimsMinus1 = nDims - 1;
GByte abyDstNoData[16];
CPLAssert(nBufferDTSize <= sizeof(abyDstNoData));
GDALExtendedDataType::CopyValue(&m_adfNoData[0], m_dt, abyDstNoData,
bufferDataType);
lbl_next_depth:
if (dimIdx == nDimsMinus1)
{
auto nIters = count[dimIdx];
double *padfVal = stack[dimIdx].src_ptr;
GByte *dst_ptr = stack[dimIdx].dst_ptr;
while (true)
{
if (!m_bHasNoData || padfVal[0] != adfSrcNoData[0])
{
padfVal[0] = padfVal[0] * dfScale + dfOffset;
if (bDTIsComplex)
{
padfVal[1] = padfVal[1] * dfScale + dfOffset;
}
if (bTempBufferNeeded)
{
GDALExtendedDataType::CopyValue(&padfVal[0], m_dt, dst_ptr,
bufferDataType);
}
}
else
{
memcpy(dst_ptr, abyDstNoData, nBufferDTSize);
}
if ((--nIters) == 0)
break;
padfVal += stack[dimIdx].src_inc_offset;
dst_ptr += stack[dimIdx].dst_inc_offset;
}
}
else
{
stack[dimIdx].nIters = count[dimIdx];
while (true)
{
dimIdx++;
stack[dimIdx].src_ptr = stack[dimIdx - 1].src_ptr;
stack[dimIdx].dst_ptr = stack[dimIdx - 1].dst_ptr;
goto lbl_next_depth;
lbl_return_to_caller:
dimIdx--;
if ((--stack[dimIdx].nIters) == 0)
break;
stack[dimIdx].src_ptr += stack[dimIdx].src_inc_offset;
stack[dimIdx].dst_ptr += stack[dimIdx].dst_inc_offset;
}
}
if (dimIdx > 0)
goto lbl_return_to_caller;
if (bTempBufferNeeded)
VSIFree(pTempBuffer);
return true;
}
/************************************************************************/
/* IWrite() */
/************************************************************************/
bool GDALMDArrayUnscaled::IWrite(const GUInt64 *arrayStartIdx,
const size_t *count, const GInt64 *arrayStep,
const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType,
const void *pSrcBuffer)
{
const double dfScale = m_poParent->GetScale();
const double dfOffset = m_poParent->GetOffset();
const bool bDTIsComplex = m_dt.GetNumericDataType() == GDT_CFloat64;
const size_t nDTSize = m_dt.GetSize();
CPLAssert(nDTSize == 8 || nDTSize == 16);
const bool bIsBufferDataTypeNativeDataType = (m_dt == bufferDataType);
const bool bSelfAndParentHaveNoData =
m_bHasNoData && m_poParent->GetRawNoDataValue() != nullptr;
double adfSrcNoData[2] = {0, 0};
if (bSelfAndParentHaveNoData)
{
GDALExtendedDataType::CopyValue(m_poParent->GetRawNoDataValue(),
m_poParent->GetDataType(),
&adfSrcNoData[0], m_dt);
}
const auto nDims = GetDimensions().size();
if (nDims == 0)
{
double adfVal[2];
GDALExtendedDataType::CopyValue(pSrcBuffer, bufferDataType, &adfVal[0],
m_dt);
if (bSelfAndParentHaveNoData &&
(std::isnan(adfVal[0]) || adfVal[0] == m_adfNoData[0]))
{
return m_poParent->Write(arrayStartIdx, count, arrayStep,
bufferStride, m_poParent->GetDataType(),
m_poParent->GetRawNoDataValue());
}
else
{
adfVal[0] = (adfVal[0] - dfOffset) / dfScale;
if (bDTIsComplex)
{
adfVal[1] = (adfVal[1] - dfOffset) / dfScale;
}
return m_poParent->Write(arrayStartIdx, count, arrayStep,
bufferStride, m_dt, &adfVal[0]);
}
}
std::vector<GPtrDiff_t> tmpBufferStrideVector;
size_t nElts = 1;
tmpBufferStrideVector.resize(nDims);
for (size_t i = 0; i < nDims; i++)
nElts *= count[i];
tmpBufferStrideVector.back() = 1;
for (size_t i = nDims - 1; i > 0;)
{
--i;
tmpBufferStrideVector[i] = tmpBufferStrideVector[i + 1] * count[i + 1];
}
const GPtrDiff_t *tmpBufferStridePtr = tmpBufferStrideVector.data();
void *pTempBuffer = VSI_MALLOC2_VERBOSE(nDTSize, nElts);
if (!pTempBuffer)
return false;
struct Stack
{
size_t nIters = 0;
double *dst_ptr = nullptr;
const GByte *src_ptr = nullptr;
GPtrDiff_t src_inc_offset = 0;
GPtrDiff_t dst_inc_offset = 0;
};
std::vector<Stack> stack(nDims);
const size_t nBufferDTSize = bufferDataType.GetSize();
for (size_t i = 0; i < nDims; i++)
{
stack[i].dst_inc_offset =
tmpBufferStridePtr[i] * (bDTIsComplex ? 2 : 1);
stack[i].src_inc_offset =
static_cast<GPtrDiff_t>(bufferStride[i] * nBufferDTSize);
}
stack[0].dst_ptr = static_cast<double *>(pTempBuffer);
stack[0].src_ptr = static_cast<const GByte *>(pSrcBuffer);
size_t dimIdx = 0;
const size_t nDimsMinus1 = nDims - 1;
lbl_next_depth:
if (dimIdx == nDimsMinus1)
{
auto nIters = count[dimIdx];
double *dst_ptr = stack[dimIdx].dst_ptr;
const GByte *src_ptr = stack[dimIdx].src_ptr;
while (true)
{
double adfVal[2];
const double *padfSrcVal;
if (bIsBufferDataTypeNativeDataType)
{
padfSrcVal = reinterpret_cast<const double *>(src_ptr);
}
else
{
GDALExtendedDataType::CopyValue(src_ptr, bufferDataType,
&adfVal[0], m_dt);
padfSrcVal = adfVal;
}
if (bSelfAndParentHaveNoData &&
(std::isnan(padfSrcVal[0]) || padfSrcVal[0] == m_adfNoData[0]))
{
dst_ptr[0] = adfSrcNoData[0];
if (bDTIsComplex)
{
dst_ptr[1] = adfSrcNoData[1];
}
}
else
{
dst_ptr[0] = (padfSrcVal[0] - dfOffset) / dfScale;
if (bDTIsComplex)
{
dst_ptr[1] = (padfSrcVal[1] - dfOffset) / dfScale;
}
}
if ((--nIters) == 0)
break;
dst_ptr += stack[dimIdx].dst_inc_offset;
src_ptr += stack[dimIdx].src_inc_offset;
}
}
else
{
stack[dimIdx].nIters = count[dimIdx];
while (true)
{
dimIdx++;
stack[dimIdx].src_ptr = stack[dimIdx - 1].src_ptr;
stack[dimIdx].dst_ptr = stack[dimIdx - 1].dst_ptr;
goto lbl_next_depth;
lbl_return_to_caller:
dimIdx--;
if ((--stack[dimIdx].nIters) == 0)
break;
stack[dimIdx].src_ptr += stack[dimIdx].src_inc_offset;
stack[dimIdx].dst_ptr += stack[dimIdx].dst_inc_offset;
}
}
if (dimIdx > 0)
goto lbl_return_to_caller;
// If the parent array is not double/complex-double, then convert the
// values to it, before calling Write(), as some implementations can be
// very slow when doing the type conversion.
const auto &eParentDT = m_poParent->GetDataType();
const size_t nParentDTSize = eParentDT.GetSize();
if (nParentDTSize <= nDTSize / 2)
{
// Copy in-place by making sure that source and target do not overlap
const auto eNumericDT = m_dt.GetNumericDataType();
const auto eParentNumericDT = eParentDT.GetNumericDataType();
// Copy first element
{
std::vector<GByte> abyTemp(nParentDTSize);
GDALCopyWords64(static_cast<GByte *>(pTempBuffer), eNumericDT,
static_cast<int>(nDTSize), &abyTemp[0],
eParentNumericDT, static_cast<int>(nParentDTSize),
1);
memcpy(pTempBuffer, abyTemp.data(), abyTemp.size());
}
// Remaining elements
for (size_t i = 1; i < nElts; ++i)
{
GDALCopyWords(static_cast<GByte *>(pTempBuffer) + i * nDTSize,
eNumericDT, 0,
static_cast<GByte *>(pTempBuffer) + i * nParentDTSize,
eParentNumericDT, 0, 1);
}
}
const bool ret =
m_poParent->Write(arrayStartIdx, count, arrayStep, tmpBufferStridePtr,
eParentDT, pTempBuffer);
VSIFree(pTempBuffer);
return ret;
}
/************************************************************************/
/* GetUnscaled() */
/************************************************************************/
/** Return an array that is the unscaled version of the current one.
*
* That is each value of the unscaled array will be
* unscaled_value = raw_value * GetScale() + GetOffset()
*
* Starting with GDAL 3.3, the Write() method is implemented and will convert
* from unscaled values to raw values.
*
* This is the same as the C function GDALMDArrayGetUnscaled().
*
* @return a new array, that holds a reference to the original one, and thus is
* a view of it (not a copy), or nullptr in case of error.
*/
std::shared_ptr<GDALMDArray> GDALMDArray::GetUnscaled() const
{
auto self = std::dynamic_pointer_cast<GDALMDArray>(m_pSelf.lock());
if (!self)
{
CPLError(CE_Failure, CPLE_AppDefined,
"Driver implementation issue: m_pSelf not set !");
return nullptr;
}
if (GetDataType().GetClass() != GEDTC_NUMERIC)
{
CPLError(CE_Failure, CPLE_AppDefined,
"GetUnscaled() only supports numeric data type");
return nullptr;
}
const double dfScale = GetScale();
const double dfOffset = GetOffset();
if (dfScale == 1.0 && dfOffset == 0.0)
return self;
return GDALMDArrayUnscaled::Create(self);
}
/************************************************************************/
/* GDALMDArrayMask */
/************************************************************************/
class GDALMDArrayMask final : public GDALPamMDArray
{
private:
std::shared_ptr<GDALMDArray> m_poParent{};
GDALExtendedDataType m_dt{GDALExtendedDataType::Create(GDT_Byte)};
template <typename Type>
void ReadInternal(const size_t *count, const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType,
void *pDstBuffer, const void *pTempBuffer,
const GDALExtendedDataType &oTmpBufferDT,
const std::vector<GPtrDiff_t> &tmpBufferStrideVector,
bool bHasMissingValue, double dfMissingValue,
bool bHasFillValue, double dfFillValue, bool bHasValidMin,
double dfValidMin, bool bHasValidMax,
double dfValidMax) const;
protected:
explicit GDALMDArrayMask(const std::shared_ptr<GDALMDArray> &poParent)
: GDALAbstractMDArray(std::string(),
"Mask of " + poParent->GetFullName()),
GDALPamMDArray(std::string(), "Mask of " + poParent->GetFullName(),
::GetPAM(poParent)),
m_poParent(std::move(poParent))
{
}
bool IRead(const GUInt64 *arrayStartIdx, const size_t *count,
const GInt64 *arrayStep, const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType,
void *pDstBuffer) const override;
bool IAdviseRead(const GUInt64 *arrayStartIdx, const size_t *count,
CSLConstList papszOptions) const override
{
return m_poParent->AdviseRead(arrayStartIdx, count, papszOptions);
}
public:
static std::shared_ptr<GDALMDArrayMask>
Create(const std::shared_ptr<GDALMDArray> &poParent)
{
auto newAr(
std::shared_ptr<GDALMDArrayMask>(new GDALMDArrayMask(poParent)));
newAr->SetSelf(newAr);
return newAr;
}
bool IsWritable() const override
{
return false;
}
const std::string &GetFilename() const override
{
return m_poParent->GetFilename();
}
const std::vector<std::shared_ptr<GDALDimension>> &
GetDimensions() const override
{
return m_poParent->GetDimensions();
}
const GDALExtendedDataType &GetDataType() const override
{
return m_dt;
}
std::shared_ptr<OGRSpatialReference> GetSpatialRef() const override
{
return m_poParent->GetSpatialRef();
}
std::vector<GUInt64> GetBlockSize() const override
{
return m_poParent->GetBlockSize();
}
};
/************************************************************************/
/* IRead() */
/************************************************************************/
bool GDALMDArrayMask::IRead(const GUInt64 *arrayStartIdx, const size_t *count,
const GInt64 *arrayStep,
const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType,
void *pDstBuffer) const
{
size_t nElts = 1;
const size_t nDims = GetDimensionCount();
std::vector<GPtrDiff_t> tmpBufferStrideVector(nDims);
for (size_t i = 0; i < nDims; i++)
nElts *= count[i];
if (nDims > 0)
{
tmpBufferStrideVector.back() = 1;
for (size_t i = nDims - 1; i > 0;)
{
--i;
tmpBufferStrideVector[i] =
tmpBufferStrideVector[i + 1] * count[i + 1];
}
}
const auto GetSingleValNumericAttr =
[this](const char *pszAttrName, bool &bHasVal, double &dfVal)
{
auto poAttr = m_poParent->GetAttribute(pszAttrName);
if (poAttr && poAttr->GetDataType().GetClass() == GEDTC_NUMERIC)
{
const auto anDimSizes = poAttr->GetDimensionsSize();
if (anDimSizes.empty() ||
(anDimSizes.size() == 1 && anDimSizes[0] == 1))
{
bHasVal = true;
dfVal = poAttr->ReadAsDouble();
}
}
};
double dfMissingValue = 0.0;
bool bHasMissingValue = false;
GetSingleValNumericAttr("missing_value", bHasMissingValue, dfMissingValue);
double dfFillValue = 0.0;
bool bHasFillValue = false;
GetSingleValNumericAttr("_FillValue", bHasFillValue, dfFillValue);
double dfValidMin = 0.0;
bool bHasValidMin = false;
GetSingleValNumericAttr("valid_min", bHasValidMin, dfValidMin);
double dfValidMax = 0.0;
bool bHasValidMax = false;
GetSingleValNumericAttr("valid_max", bHasValidMax, dfValidMax);
{
auto poValidRange = m_poParent->GetAttribute("valid_range");
if (poValidRange && poValidRange->GetDimensionsSize().size() == 1 &&
poValidRange->GetDimensionsSize()[0] == 2 &&
poValidRange->GetDataType().GetClass() == GEDTC_NUMERIC)
{
bHasValidMin = true;
bHasValidMax = true;
auto vals = poValidRange->ReadAsDoubleArray();
CPLAssert(vals.size() == 2);
dfValidMin = vals[0];
dfValidMax = vals[1];
}
}
/* Optimized case: if we are an integer data type and that there is no */
/* attribute that can be used to set mask = 0, then fill the mask buffer */
/* directly */
if (!bHasMissingValue && !bHasFillValue && !bHasValidMin && !bHasValidMax &&
m_poParent->GetRawNoDataValue() == nullptr &&
GDALDataTypeIsInteger(m_poParent->GetDataType().GetNumericDataType()))
{
if (bufferDataType == m_dt) // Byte case
{
bool bContiguous = true;
for (size_t i = 0; i < nDims; i++)
{
if (bufferStride[i] != tmpBufferStrideVector[i])
{
bContiguous = false;
break;
}
}
if (bContiguous)
{
// CPLDebug("GDAL", "GetMask(): contiguous case");
memset(pDstBuffer, 1, nElts);
return true;
}
}
struct Stack
{
size_t nIters = 0;
GByte *dst_ptr = nullptr;
GPtrDiff_t dst_inc_offset = 0;
};
std::vector<Stack> stack(std::max(static_cast<size_t>(1), nDims));
const size_t nBufferDTSize = bufferDataType.GetSize();
for (size_t i = 0; i < nDims; i++)
{
stack[i].dst_inc_offset =
static_cast<GPtrDiff_t>(bufferStride[i] * nBufferDTSize);
}
stack[0].dst_ptr = static_cast<GByte *>(pDstBuffer);
size_t dimIdx = 0;
const size_t nDimsMinus1 = nDims > 0 ? nDims - 1 : 0;
const bool bBufferDataTypeIsByte = bufferDataType == m_dt;
GByte abyOne[16]; // 16 is sizeof GDT_CFloat64
CPLAssert(nBufferDTSize <= 16);
const GByte flag = 1;
// Coverity misses that m_dt is of type Byte
// coverity[overrun-buffer-val]
GDALExtendedDataType::CopyValue(&flag, m_dt, abyOne, bufferDataType);
lbl_next_depth:
if (dimIdx == nDimsMinus1)
{
auto nIters = nDims > 0 ? count[dimIdx] : 1;
GByte *dst_ptr = stack[dimIdx].dst_ptr;
while (true)
{
if (bBufferDataTypeIsByte)
{
*dst_ptr = flag;
}
else
{
memcpy(dst_ptr, abyOne, nBufferDTSize);
}
if ((--nIters) == 0)
break;
dst_ptr += stack[dimIdx].dst_inc_offset;
}
}
else
{
stack[dimIdx].nIters = count[dimIdx];
while (true)
{
dimIdx++;
stack[dimIdx].dst_ptr = stack[dimIdx - 1].dst_ptr;
goto lbl_next_depth;
lbl_return_to_caller:
dimIdx--;
if ((--stack[dimIdx].nIters) == 0)
break;
stack[dimIdx].dst_ptr += stack[dimIdx].dst_inc_offset;
}
}
if (dimIdx > 0)
goto lbl_return_to_caller;
return true;
}
const auto oTmpBufferDT =
GDALDataTypeIsComplex(m_poParent->GetDataType().GetNumericDataType())
? GDALExtendedDataType::Create(GDT_Float64)
: m_poParent->GetDataType();
const size_t nTmpBufferDTSize = oTmpBufferDT.GetSize();
void *pTempBuffer = VSI_MALLOC2_VERBOSE(nTmpBufferDTSize, nElts);
if (!pTempBuffer)
return false;
if (!m_poParent->Read(arrayStartIdx, count, arrayStep,
tmpBufferStrideVector.data(), oTmpBufferDT,
pTempBuffer))
{
VSIFree(pTempBuffer);
return false;
}
switch (oTmpBufferDT.GetNumericDataType())
{
case GDT_Byte:
ReadInternal<GByte>(
count, bufferStride, bufferDataType, pDstBuffer, pTempBuffer,
oTmpBufferDT, tmpBufferStrideVector, bHasMissingValue,
dfMissingValue, bHasFillValue, dfFillValue, bHasValidMin,
dfValidMin, bHasValidMax, dfValidMax);
break;
case GDT_UInt16:
ReadInternal<GUInt16>(
count, bufferStride, bufferDataType, pDstBuffer, pTempBuffer,
oTmpBufferDT, tmpBufferStrideVector, bHasMissingValue,
dfMissingValue, bHasFillValue, dfFillValue, bHasValidMin,
dfValidMin, bHasValidMax, dfValidMax);
break;
case GDT_Int16:
ReadInternal<GInt16>(
count, bufferStride, bufferDataType, pDstBuffer, pTempBuffer,
oTmpBufferDT, tmpBufferStrideVector, bHasMissingValue,
dfMissingValue, bHasFillValue, dfFillValue, bHasValidMin,
dfValidMin, bHasValidMax, dfValidMax);
break;
case GDT_UInt32:
ReadInternal<GUInt32>(
count, bufferStride, bufferDataType, pDstBuffer, pTempBuffer,
oTmpBufferDT, tmpBufferStrideVector, bHasMissingValue,
dfMissingValue, bHasFillValue, dfFillValue, bHasValidMin,
dfValidMin, bHasValidMax, dfValidMax);
break;
case GDT_Int32:
ReadInternal<GInt32>(
count, bufferStride, bufferDataType, pDstBuffer, pTempBuffer,
oTmpBufferDT, tmpBufferStrideVector, bHasMissingValue,
dfMissingValue, bHasFillValue, dfFillValue, bHasValidMin,
dfValidMin, bHasValidMax, dfValidMax);
break;
case GDT_UInt64:
ReadInternal<std::uint64_t>(
count, bufferStride, bufferDataType, pDstBuffer, pTempBuffer,
oTmpBufferDT, tmpBufferStrideVector, bHasMissingValue,
dfMissingValue, bHasFillValue, dfFillValue, bHasValidMin,
dfValidMin, bHasValidMax, dfValidMax);
break;
case GDT_Int64:
ReadInternal<std::int64_t>(
count, bufferStride, bufferDataType, pDstBuffer, pTempBuffer,
oTmpBufferDT, tmpBufferStrideVector, bHasMissingValue,
dfMissingValue, bHasFillValue, dfFillValue, bHasValidMin,
dfValidMin, bHasValidMax, dfValidMax);
break;
case GDT_Float32:
ReadInternal<float>(
count, bufferStride, bufferDataType, pDstBuffer, pTempBuffer,
oTmpBufferDT, tmpBufferStrideVector, bHasMissingValue,
dfMissingValue, bHasFillValue, dfFillValue, bHasValidMin,
dfValidMin, bHasValidMax, dfValidMax);
break;
default:
CPLAssert(oTmpBufferDT.GetNumericDataType() == GDT_Float64);
ReadInternal<double>(
count, bufferStride, bufferDataType, pDstBuffer, pTempBuffer,
oTmpBufferDT, tmpBufferStrideVector, bHasMissingValue,
dfMissingValue, bHasFillValue, dfFillValue, bHasValidMin,
dfValidMin, bHasValidMax, dfValidMax);
break;
}
VSIFree(pTempBuffer);
return true;
}
/************************************************************************/
/* IsValidForDT() */
/************************************************************************/
template <typename Type> static bool IsValidForDT(double dfVal)
{
if (std::isnan(dfVal))
return false;
if (dfVal < static_cast<double>(std::numeric_limits<Type>::lowest()))
return false;
if (dfVal > static_cast<double>(std::numeric_limits<Type>::max()))
return false;
return static_cast<double>(static_cast<Type>(dfVal)) == dfVal;
}
template <> bool IsValidForDT<double>(double)
{
return true;
}
/************************************************************************/
/* IsNan() */
/************************************************************************/
template <typename Type> inline bool IsNan(Type)
{
return false;
}
template <> bool IsNan<double>(double val)
{
return std::isnan(val);
}
template <> bool IsNan<float>(float val)
{
return std::isnan(val);
}
/************************************************************************/
/* ReadInternal() */
/************************************************************************/
template <typename Type>
void GDALMDArrayMask::ReadInternal(
const size_t *count, const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType, void *pDstBuffer,
const void *pTempBuffer, const GDALExtendedDataType &oTmpBufferDT,
const std::vector<GPtrDiff_t> &tmpBufferStrideVector, bool bHasMissingValue,
double dfMissingValue, bool bHasFillValue, double dfFillValue,
bool bHasValidMin, double dfValidMin, bool bHasValidMax,
double dfValidMax) const
{
const size_t nDims = GetDimensionCount();
const auto castValue = [](bool &bHasVal, double dfVal) -> Type
{
if (bHasVal)
{
if (IsValidForDT<Type>(dfVal))
{
return static_cast<Type>(dfVal);
}
else
{
bHasVal = false;
}
}
return 0;
};
const void *pSrcRawNoDataValue = m_poParent->GetRawNoDataValue();
bool bHasNodataValue = pSrcRawNoDataValue != nullptr;
const Type nNoDataValue =
castValue(bHasNodataValue, m_poParent->GetNoDataValueAsDouble());
const Type nMissingValue = castValue(bHasMissingValue, dfMissingValue);
const Type nFillValue = castValue(bHasFillValue, dfFillValue);
const Type nValidMin = castValue(bHasValidMin, dfValidMin);
const Type nValidMax = castValue(bHasValidMax, dfValidMax);
#define GET_MASK_FOR_SAMPLE(v) \
static_cast<GByte>(!IsNan(v) && !(bHasNodataValue && v == nNoDataValue) && \
!(bHasMissingValue && v == nMissingValue) && \
!(bHasFillValue && v == nFillValue) && \
!(bHasValidMin && v < nValidMin) && \
!(bHasValidMax && v > nValidMax))
const bool bBufferDataTypeIsByte = bufferDataType == m_dt;
/* Optimized case: Byte output and output buffer is contiguous */
if (bBufferDataTypeIsByte)
{
bool bContiguous = true;
for (size_t i = 0; i < nDims; i++)
{
if (bufferStride[i] != tmpBufferStrideVector[i])
{
bContiguous = false;
break;
}
}
if (bContiguous)
{
size_t nElts = 1;
for (size_t i = 0; i < nDims; i++)
nElts *= count[i];
for (size_t i = 0; i < nElts; i++)
{
const Type *pSrc = static_cast<const Type *>(pTempBuffer) + i;
static_cast<GByte *>(pDstBuffer)[i] =
GET_MASK_FOR_SAMPLE(*pSrc);
}
return;
}
}
const size_t nTmpBufferDTSize = oTmpBufferDT.GetSize();
struct Stack
{
size_t nIters = 0;
const GByte *src_ptr = nullptr;
GByte *dst_ptr = nullptr;
GPtrDiff_t src_inc_offset = 0;
GPtrDiff_t dst_inc_offset = 0;
};
std::vector<Stack> stack(std::max(static_cast<size_t>(1), nDims));
const size_t nBufferDTSize = bufferDataType.GetSize();
for (size_t i = 0; i < nDims; i++)
{
stack[i].src_inc_offset = static_cast<GPtrDiff_t>(
tmpBufferStrideVector[i] * nTmpBufferDTSize);
stack[i].dst_inc_offset =
static_cast<GPtrDiff_t>(bufferStride[i] * nBufferDTSize);
}
stack[0].src_ptr = static_cast<const GByte *>(pTempBuffer);
stack[0].dst_ptr = static_cast<GByte *>(pDstBuffer);
size_t dimIdx = 0;
const size_t nDimsMinus1 = nDims > 0 ? nDims - 1 : 0;
GByte abyZeroOrOne[2][16]; // 16 is sizeof GDT_CFloat64
CPLAssert(nBufferDTSize <= 16);
for (GByte flag = 0; flag <= 1; flag++)
{
// Coverity misses that m_dt is of type Byte
// coverity[overrun-buffer-val]
GDALExtendedDataType::CopyValue(&flag, m_dt, abyZeroOrOne[flag],
bufferDataType);
}
lbl_next_depth:
if (dimIdx == nDimsMinus1)
{
auto nIters = nDims > 0 ? count[dimIdx] : 1;
const GByte *src_ptr = stack[dimIdx].src_ptr;
GByte *dst_ptr = stack[dimIdx].dst_ptr;
while (true)
{
const Type *pSrc = reinterpret_cast<const Type *>(src_ptr);
const GByte flag = GET_MASK_FOR_SAMPLE(*pSrc);
if (bBufferDataTypeIsByte)
{
*dst_ptr = flag;
}
else
{
memcpy(dst_ptr, abyZeroOrOne[flag], nBufferDTSize);
}
if ((--nIters) == 0)
break;
src_ptr += stack[dimIdx].src_inc_offset;
dst_ptr += stack[dimIdx].dst_inc_offset;
}
}
else
{
stack[dimIdx].nIters = count[dimIdx];
while (true)
{
dimIdx++;
stack[dimIdx].src_ptr = stack[dimIdx - 1].src_ptr;
stack[dimIdx].dst_ptr = stack[dimIdx - 1].dst_ptr;
goto lbl_next_depth;
lbl_return_to_caller:
dimIdx--;
if ((--stack[dimIdx].nIters) == 0)
break;
stack[dimIdx].src_ptr += stack[dimIdx].src_inc_offset;
stack[dimIdx].dst_ptr += stack[dimIdx].dst_inc_offset;
}
}
if (dimIdx > 0)
goto lbl_return_to_caller;
}
/************************************************************************/
/* GetMask() */
/************************************************************************/
/** Return an array that is a mask for the current array
*
* This array will be of type Byte, with values set to 0 to indicate invalid
* pixels of the current array, and values set to 1 to indicate valid pixels.
*
* The generic implementation honours the NoDataValue, as well as various
* netCDF CF attributes: missing_value, _FillValue, valid_min, valid_max
* and valid_range.
*
* This is the same as the C function GDALMDArrayGetMask().
*
* @param papszOptions NULL-terminated list of options, or NULL.
*
* @return a new array, that holds a reference to the original one, and thus is
* a view of it (not a copy), or nullptr in case of error.
*/
std::shared_ptr<GDALMDArray>
GDALMDArray::GetMask(CPL_UNUSED CSLConstList papszOptions) const
{
auto self = std::dynamic_pointer_cast<GDALMDArray>(m_pSelf.lock());
if (!self)
{
CPLError(CE_Failure, CPLE_AppDefined,
"Driver implementation issue: m_pSelf not set !");
return nullptr;
}
if (GetDataType().GetClass() != GEDTC_NUMERIC)
{
CPLError(CE_Failure, CPLE_AppDefined,
"GetMask() only supports numeric data type");
return nullptr;
}
return GDALMDArrayMask::Create(self);
}
/************************************************************************/
/* IsRegularlySpaced() */
/************************************************************************/
/** Returns whether an array is a 1D regularly spaced array.
*
* @param[out] dfStart First value in the array
* @param[out] dfIncrement Increment/spacing between consecutive values.
* @return true if the array is regularly spaced.
*/
bool GDALMDArray::IsRegularlySpaced(double &dfStart, double &dfIncrement) const
{
dfStart = 0;
dfIncrement = 0;
if (GetDimensionCount() != 1 || GetDataType().GetClass() != GEDTC_NUMERIC)
return false;
const auto nSize = GetDimensions()[0]->GetSize();
if (nSize <= 1 || nSize > 10 * 1000 * 1000)
return false;
size_t nCount = static_cast<size_t>(nSize);
std::vector<double> adfTmp;
try
{
adfTmp.resize(nCount);
}
catch (const std::exception &)
{
return false;
}
GUInt64 anStart[1] = {0};
size_t anCount[1] = {nCount};
const auto IsRegularlySpacedInternal =
[&dfStart, &dfIncrement, &anCount, &adfTmp]()
{
dfStart = adfTmp[0];
dfIncrement = (adfTmp[anCount[0] - 1] - adfTmp[0]) / (anCount[0] - 1);
if (dfIncrement == 0)
{
return false;
}
for (size_t i = 1; i < anCount[0]; i++)
{
if (fabs((adfTmp[i] - adfTmp[i - 1]) - dfIncrement) >
1e-3 * fabs(dfIncrement))
{
return false;
}
}
return true;
};
// First try with the first block(s). This can avoid excessive processing
// time, for example with Zarr datasets.
// https://bugs.chromium.org/p/oss-fuzz/issues/detail?id=37636 and
// https://bugs.chromium.org/p/oss-fuzz/issues/detail?id=39273
const auto nBlockSize = GetBlockSize()[0];
if (nCount >= 5 && nBlockSize <= nCount / 2)
{
size_t nReducedCount =
std::max<size_t>(3, static_cast<size_t>(nBlockSize));
while (nReducedCount < 256 && nReducedCount <= (nCount - 2) / 2)
nReducedCount *= 2;
anCount[0] = nReducedCount;
if (!Read(anStart, anCount, nullptr, nullptr,
GDALExtendedDataType::Create(GDT_Float64), &adfTmp[0]))
{
return false;
}
if (!IsRegularlySpacedInternal())
{
return false;
}
// Get next values
anStart[0] = nReducedCount;
anCount[0] = nCount - nReducedCount;
}
if (!Read(anStart, anCount, nullptr, nullptr,
GDALExtendedDataType::Create(GDT_Float64),
&adfTmp[static_cast<size_t>(anStart[0])]))
{
return false;
}
return IsRegularlySpacedInternal();
}
/************************************************************************/
/* GuessGeoTransform() */
/************************************************************************/
/** Returns whether 2 specified dimensions form a geotransform
*
* @param nDimX Index of the X axis.
* @param nDimY Index of the Y axis.
* @param bPixelIsPoint Whether the geotransform should be returned
* with the pixel-is-point (pixel-center) convention
* (bPixelIsPoint = true), or with the pixel-is-area
* (top left corner convention)
* (bPixelIsPoint = false)
* @param[out] adfGeoTransform Computed geotransform
* @return true if a geotransform could be computed.
*/
bool GDALMDArray::GuessGeoTransform(size_t nDimX, size_t nDimY,
bool bPixelIsPoint,
double adfGeoTransform[6]) const
{
const auto &dims(GetDimensions());
auto poVarX = dims[nDimX]->GetIndexingVariable();
auto poVarY = dims[nDimY]->GetIndexingVariable();
double dfXStart = 0.0;
double dfXSpacing = 0.0;
double dfYStart = 0.0;
double dfYSpacing = 0.0;
if (poVarX && poVarX->GetDimensionCount() == 1 &&
poVarX->GetDimensions()[0]->GetSize() == dims[nDimX]->GetSize() &&
poVarY && poVarY->GetDimensionCount() == 1 &&
poVarY->GetDimensions()[0]->GetSize() == dims[nDimY]->GetSize() &&
poVarX->IsRegularlySpaced(dfXStart, dfXSpacing) &&
poVarY->IsRegularlySpaced(dfYStart, dfYSpacing))
{
adfGeoTransform[0] = dfXStart - (bPixelIsPoint ? 0 : dfXSpacing / 2);
adfGeoTransform[1] = dfXSpacing;
adfGeoTransform[2] = 0;
adfGeoTransform[3] = dfYStart - (bPixelIsPoint ? 0 : dfYSpacing / 2);
adfGeoTransform[4] = 0;
adfGeoTransform[5] = dfYSpacing;
return true;
}
return false;
}
/************************************************************************/
/* GDALMDArrayResampled */
/************************************************************************/
class GDALMDArrayResampledDataset;
class GDALMDArrayResampledDatasetRasterBand final : public GDALRasterBand
{
protected:
CPLErr IReadBlock(int, int, void *) override;
CPLErr IRasterIO(GDALRWFlag eRWFlag, int nXOff, int nYOff, int nXSize,
int nYSize, void *pData, int nBufXSize, int nBufYSize,
GDALDataType eBufType, GSpacing nPixelSpaceBuf,
GSpacing nLineSpaceBuf,
GDALRasterIOExtraArg *psExtraArg) override;
public:
explicit GDALMDArrayResampledDatasetRasterBand(
GDALMDArrayResampledDataset *poDSIn);
double GetNoDataValue(int *pbHasNoData) override;
};
class GDALMDArrayResampledDataset final : public GDALPamDataset
{
friend class GDALMDArrayResampled;
friend class GDALMDArrayResampledDatasetRasterBand;
std::shared_ptr<GDALMDArray> m_poArray;
size_t m_iXDim;
size_t m_iYDim;
double m_adfGeoTransform[6]{0, 1, 0, 0, 0, 1};
bool m_bHasGT = false;
mutable std::shared_ptr<OGRSpatialReference> m_poSRS{};
std::vector<GUInt64> m_anOffset{};
std::vector<size_t> m_anCount{};
std::vector<GPtrDiff_t> m_anStride{};
std::string m_osFilenameLong{};
std::string m_osFilenameLat{};
public:
GDALMDArrayResampledDataset(const std::shared_ptr<GDALMDArray> &array,
size_t iXDim, size_t iYDim)
: m_poArray(array), m_iXDim(iXDim), m_iYDim(iYDim),
m_anOffset(m_poArray->GetDimensionCount(), 0),
m_anCount(m_poArray->GetDimensionCount(), 1),
m_anStride(m_poArray->GetDimensionCount(), 0)
{
const auto &dims(m_poArray->GetDimensions());
nRasterYSize = static_cast<int>(
std::min(static_cast<GUInt64>(INT_MAX), dims[iYDim]->GetSize()));
nRasterXSize = static_cast<int>(
std::min(static_cast<GUInt64>(INT_MAX), dims[iXDim]->GetSize()));
m_bHasGT = m_poArray->GuessGeoTransform(m_iXDim, m_iYDim, false,
m_adfGeoTransform);
SetBand(1, new GDALMDArrayResampledDatasetRasterBand(this));
}
~GDALMDArrayResampledDataset()
{
if (!m_osFilenameLong.empty())
VSIUnlink(m_osFilenameLong.c_str());
if (!m_osFilenameLat.empty())
VSIUnlink(m_osFilenameLat.c_str());
}
CPLErr GetGeoTransform(double *padfGeoTransform) override
{
memcpy(padfGeoTransform, m_adfGeoTransform, 6 * sizeof(double));
return m_bHasGT ? CE_None : CE_Failure;
}
const OGRSpatialReference *GetSpatialRef() const override
{
m_poSRS = m_poArray->GetSpatialRef();
if (m_poSRS)
{
m_poSRS.reset(m_poSRS->Clone());
auto axisMapping = m_poSRS->GetDataAxisToSRSAxisMapping();
for (auto &m : axisMapping)
{
if (m == static_cast<int>(m_iXDim) + 1)
m = 1;
else if (m == static_cast<int>(m_iYDim) + 1)
m = 2;
else
m = 0;
}
m_poSRS->SetDataAxisToSRSAxisMapping(axisMapping);
}
return m_poSRS.get();
}
void SetGeolocationArray(const std::string &osFilenameLong,
const std::string &osFilenameLat)
{
m_osFilenameLong = osFilenameLong;
m_osFilenameLat = osFilenameLat;
CPLStringList aosGeoLoc;
aosGeoLoc.SetNameValue("LINE_OFFSET", "0");
aosGeoLoc.SetNameValue("LINE_STEP", "1");
aosGeoLoc.SetNameValue("PIXEL_OFFSET", "0");
aosGeoLoc.SetNameValue("PIXEL_STEP", "1");
aosGeoLoc.SetNameValue("SRS", SRS_WKT_WGS84_LAT_LONG); // FIXME?
aosGeoLoc.SetNameValue("X_BAND", "1");
aosGeoLoc.SetNameValue("X_DATASET", m_osFilenameLong.c_str());
aosGeoLoc.SetNameValue("Y_BAND", "1");
aosGeoLoc.SetNameValue("Y_DATASET", m_osFilenameLat.c_str());
aosGeoLoc.SetNameValue("GEOREFERENCING_CONVENTION", "PIXEL_CENTER");
SetMetadata(aosGeoLoc.List(), "GEOLOCATION");
}
};
/************************************************************************/
/* GDALRasterBandFromArray() */
/************************************************************************/
GDALMDArrayResampledDatasetRasterBand::GDALMDArrayResampledDatasetRasterBand(
GDALMDArrayResampledDataset *poDSIn)
{
const auto &poArray(poDSIn->m_poArray);
const auto blockSize(poArray->GetBlockSize());
nBlockYSize = (blockSize[poDSIn->m_iYDim])
? static_cast<int>(std::min(static_cast<GUInt64>(INT_MAX),
blockSize[poDSIn->m_iYDim]))
: 1;
nBlockXSize = blockSize[poDSIn->m_iXDim]
? static_cast<int>(std::min(static_cast<GUInt64>(INT_MAX),
blockSize[poDSIn->m_iXDim]))
: poDSIn->GetRasterXSize();
eDataType = poArray->GetDataType().GetNumericDataType();
eAccess = poDSIn->eAccess;
}
/************************************************************************/
/* GetNoDataValue() */
/************************************************************************/
double GDALMDArrayResampledDatasetRasterBand::GetNoDataValue(int *pbHasNoData)
{
auto l_poDS(cpl::down_cast<GDALMDArrayResampledDataset *>(poDS));
const auto &poArray(l_poDS->m_poArray);
bool bHasNodata = false;
double dfRes = poArray->GetNoDataValueAsDouble(&bHasNodata);
if (pbHasNoData)
*pbHasNoData = bHasNodata;
return dfRes;
}
/************************************************************************/
/* IReadBlock() */
/************************************************************************/
CPLErr GDALMDArrayResampledDatasetRasterBand::IReadBlock(int nBlockXOff,
int nBlockYOff,
void *pImage)
{
const int nDTSize(GDALGetDataTypeSizeBytes(eDataType));
const int nXOff = nBlockXOff * nBlockXSize;
const int nYOff = nBlockYOff * nBlockYSize;
const int nReqXSize = std::min(nRasterXSize - nXOff, nBlockXSize);
const int nReqYSize = std::min(nRasterYSize - nYOff, nBlockYSize);
GDALRasterIOExtraArg sExtraArg;
INIT_RASTERIO_EXTRA_ARG(sExtraArg);
return IRasterIO(GF_Read, nXOff, nYOff, nReqXSize, nReqYSize, pImage,
nReqXSize, nReqYSize, eDataType, nDTSize,
nDTSize * nBlockXSize, &sExtraArg);
}
/************************************************************************/
/* IRasterIO() */
/************************************************************************/
CPLErr GDALMDArrayResampledDatasetRasterBand::IRasterIO(
GDALRWFlag eRWFlag, int nXOff, int nYOff, int nXSize, int nYSize,
void *pData, int nBufXSize, int nBufYSize, GDALDataType eBufType,
GSpacing nPixelSpaceBuf, GSpacing nLineSpaceBuf,
GDALRasterIOExtraArg *psExtraArg)
{
auto l_poDS(cpl::down_cast<GDALMDArrayResampledDataset *>(poDS));
const auto &poArray(l_poDS->m_poArray);
const int nBufferDTSize(GDALGetDataTypeSizeBytes(eBufType));
if (eRWFlag == GF_Read && nXSize == nBufXSize && nYSize == nBufYSize &&
nBufferDTSize > 0 && (nPixelSpaceBuf % nBufferDTSize) == 0 &&
(nLineSpaceBuf % nBufferDTSize) == 0)
{
l_poDS->m_anOffset[l_poDS->m_iXDim] = static_cast<GUInt64>(nXOff);
l_poDS->m_anCount[l_poDS->m_iXDim] = static_cast<size_t>(nXSize);
l_poDS->m_anStride[l_poDS->m_iXDim] =
static_cast<GPtrDiff_t>(nPixelSpaceBuf / nBufferDTSize);
l_poDS->m_anOffset[l_poDS->m_iYDim] = static_cast<GUInt64>(nYOff);
l_poDS->m_anCount[l_poDS->m_iYDim] = static_cast<size_t>(nYSize);
l_poDS->m_anStride[l_poDS->m_iYDim] =
static_cast<GPtrDiff_t>(nLineSpaceBuf / nBufferDTSize);
return poArray->Read(l_poDS->m_anOffset.data(),
l_poDS->m_anCount.data(), nullptr,
l_poDS->m_anStride.data(),
GDALExtendedDataType::Create(eBufType), pData)
? CE_None
: CE_Failure;
}
return GDALRasterBand::IRasterIO(eRWFlag, nXOff, nYOff, nXSize, nYSize,
pData, nBufXSize, nBufYSize, eBufType,
nPixelSpaceBuf, nLineSpaceBuf, psExtraArg);
}
class GDALMDArrayResampled final : public GDALPamMDArray
{
private:
std::shared_ptr<GDALMDArray> m_poParent{};
std::vector<std::shared_ptr<GDALDimension>> m_apoDims;
std::vector<GUInt64> m_anBlockSize;
GDALExtendedDataType m_dt;
std::shared_ptr<OGRSpatialReference> m_poSRS{};
std::shared_ptr<GDALMDArray> m_poVarX{};
std::shared_ptr<GDALMDArray> m_poVarY{};
std::unique_ptr<GDALMDArrayResampledDataset> m_poParentDS{};
std::unique_ptr<GDALDataset> m_poReprojectedDS{};
protected:
GDALMDArrayResampled(
const std::shared_ptr<GDALMDArray> &poParent,
const std::vector<std::shared_ptr<GDALDimension>> &apoDims,
const std::vector<GUInt64> &anBlockSize)
: GDALAbstractMDArray(std::string(),
"Resampled view of " + poParent->GetFullName()),
GDALPamMDArray(std::string(),
"Resampled view of " + poParent->GetFullName(),
::GetPAM(poParent)),
m_poParent(std::move(poParent)), m_apoDims(apoDims),
m_anBlockSize(anBlockSize), m_dt(m_poParent->GetDataType())
{
CPLAssert(apoDims.size() == m_poParent->GetDimensionCount());
CPLAssert(anBlockSize.size() == m_poParent->GetDimensionCount());
}
bool IRead(const GUInt64 *arrayStartIdx, const size_t *count,
const GInt64 *arrayStep, const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType,
void *pDstBuffer) const override;
public:
static std::shared_ptr<GDALMDArrayResampled>
Create(const std::shared_ptr<GDALMDArray> &poParent,
const std::vector<std::shared_ptr<GDALDimension>> &apoNewDims,
GDALRIOResampleAlg resampleAlg,
const OGRSpatialReference *poTargetSRS, CSLConstList papszOptions);
~GDALMDArrayResampled()
{
// First close the warped VRT
m_poReprojectedDS.reset();
m_poParentDS.reset();
}
bool IsWritable() const override
{
return false;
}
const std::string &GetFilename() const override
{
return m_poParent->GetFilename();
}
const std::vector<std::shared_ptr<GDALDimension>> &
GetDimensions() const override
{
return m_apoDims;
}
const GDALExtendedDataType &GetDataType() const override
{
return m_dt;
}
std::shared_ptr<OGRSpatialReference> GetSpatialRef() const override
{
return m_poSRS;
}
std::vector<GUInt64> GetBlockSize() const override
{
return m_anBlockSize;
}
std::shared_ptr<GDALAttribute>
GetAttribute(const std::string &osName) const override
{
return m_poParent->GetAttribute(osName);
}
std::vector<std::shared_ptr<GDALAttribute>>
GetAttributes(CSLConstList papszOptions = nullptr) const override
{
return m_poParent->GetAttributes(papszOptions);
}
const std::string &GetUnit() const override
{
return m_poParent->GetUnit();
}
const void *GetRawNoDataValue() const override
{
return m_poParent->GetRawNoDataValue();
}
double GetOffset(bool *pbHasOffset,
GDALDataType *peStorageType) const override
{
return m_poParent->GetOffset(pbHasOffset, peStorageType);
}
double GetScale(bool *pbHasScale,
GDALDataType *peStorageType) const override
{
return m_poParent->GetScale(pbHasScale, peStorageType);
}
};
/************************************************************************/
/* GDALMDArrayResampled::Create() */
/************************************************************************/
std::shared_ptr<GDALMDArrayResampled> GDALMDArrayResampled::Create(
const std::shared_ptr<GDALMDArray> &poParent,
const std::vector<std::shared_ptr<GDALDimension>> &apoNewDimsIn,
GDALRIOResampleAlg resampleAlg, const OGRSpatialReference *poTargetSRS,
CSLConstList /* papszOptions */)
{
const char *pszResampleAlg = "nearest";
bool unsupported = false;
switch (resampleAlg)
{
case GRIORA_NearestNeighbour:
pszResampleAlg = "nearest";
break;
case GRIORA_Bilinear:
pszResampleAlg = "bilinear";
break;
case GRIORA_Cubic:
pszResampleAlg = "cubic";
break;
case GRIORA_CubicSpline:
pszResampleAlg = "cubicspline";
break;
case GRIORA_Lanczos:
pszResampleAlg = "lanczos";
break;
case GRIORA_Average:
pszResampleAlg = "average";
break;
case GRIORA_Mode:
pszResampleAlg = "mode";
break;
case GRIORA_Gauss:
unsupported = true;
break;
case GRIORA_RESERVED_START:
unsupported = true;
break;
case GRIORA_RESERVED_END:
unsupported = true;
break;
case GRIORA_RMS:
pszResampleAlg = "rms";
break;
}
if (unsupported)
{
CPLError(CE_Failure, CPLE_NotSupported,
"Unsupported resample method for GetResampled()");
return nullptr;
}
if (poParent->GetDimensionCount() < 2)
{
CPLError(CE_Failure, CPLE_NotSupported,
"GetResampled() only supports 2 dimensions or more");
return nullptr;
}
const auto &aoParentDims = poParent->GetDimensions();
if (apoNewDimsIn.size() != aoParentDims.size())
{
CPLError(CE_Failure, CPLE_AppDefined,
"GetResampled(): apoNewDims size should be the same as "
"GetDimensionCount()");
return nullptr;
}
std::vector<std::shared_ptr<GDALDimension>> apoNewDims;
apoNewDims.reserve(apoNewDimsIn.size());
std::vector<GUInt64> anBlockSize;
anBlockSize.reserve(apoNewDimsIn.size());
const auto &anParentBlockSize = poParent->GetBlockSize();
for (unsigned i = 0; i + 2 < apoNewDimsIn.size(); ++i)
{
if (apoNewDimsIn[i] == nullptr)
{
apoNewDims.emplace_back(aoParentDims[i]);
}
else if (apoNewDimsIn[i]->GetSize() != aoParentDims[i]->GetSize() ||
apoNewDimsIn[i]->GetName() != aoParentDims[i]->GetName())
{
CPLError(CE_Failure, CPLE_AppDefined,
"GetResampled(): apoNewDims[%u] should be the same "
"as its parent",
i);
return nullptr;
}
anBlockSize.emplace_back(anParentBlockSize[i]);
}
const size_t iYDim = poParent->GetDimensionCount() - 2;
const size_t iXDim = poParent->GetDimensionCount() - 1;
std::unique_ptr<GDALMDArrayResampledDataset> poParentDS(
new GDALMDArrayResampledDataset(poParent, iXDim, iYDim));
double dfXStart = 0.0;
double dfXSpacing = 0.0;
bool gotXSpacing = false;
auto poNewDimX = apoNewDimsIn[iXDim];
if (poNewDimX)
{
if (poNewDimX->GetSize() > static_cast<GUInt64>(INT_MAX))
{
CPLError(CE_Failure, CPLE_NotSupported,
"Too big size for X dimension");
return nullptr;
}
auto var = poNewDimX->GetIndexingVariable();
if (var)
{
if (var->GetDimensionCount() != 1 ||
var->GetDimensions()[0]->GetSize() != poNewDimX->GetSize() ||
!var->IsRegularlySpaced(dfXStart, dfXSpacing))
{
CPLError(CE_Failure, CPLE_NotSupported,
"New X dimension should be indexed by a regularly "
"spaced variable");
return nullptr;
}
gotXSpacing = true;
}
}
double dfYStart = 0.0;
double dfYSpacing = 0.0;
auto poNewDimY = apoNewDimsIn[iYDim];
bool gotYSpacing = false;
if (poNewDimY)
{
if (poNewDimY->GetSize() > static_cast<GUInt64>(INT_MAX))
{
CPLError(CE_Failure, CPLE_NotSupported,
"Too big size for Y dimension");
return nullptr;
}
auto var = poNewDimY->GetIndexingVariable();
if (var)
{
if (var->GetDimensionCount() != 1 ||
var->GetDimensions()[0]->GetSize() != poNewDimY->GetSize() ||
!var->IsRegularlySpaced(dfYStart, dfYSpacing))
{
CPLError(CE_Failure, CPLE_NotSupported,
"New Y dimension should be indexed by a regularly "
"spaced variable");
return nullptr;
}
gotYSpacing = true;
}
}
// This limitation could probably be removed
if ((gotXSpacing && !gotYSpacing) || (!gotXSpacing && gotYSpacing))
{
CPLError(CE_Failure, CPLE_NotSupported,
"Either none of new X or Y dimension should have an indexing "
"variable, or both should both should have one.");
return nullptr;
}
std::string osDstWKT;
if (poTargetSRS)
{
char *pszDstWKT = nullptr;
if (poTargetSRS->exportToWkt(&pszDstWKT) != OGRERR_NONE)
{
CPLFree(pszDstWKT);
return nullptr;
}
osDstWKT = pszDstWKT;
CPLFree(pszDstWKT);
}
// Use coordinate variables for geolocation array
const auto apoCoordinateVars = poParent->GetCoordinateVariables();
bool useGeolocationArray = false;
if (apoCoordinateVars.size() >= 2)
{
std::shared_ptr<GDALMDArray> poLongVar;
std::shared_ptr<GDALMDArray> poLatVar;
for (const auto &poCoordVar : apoCoordinateVars)
{
const auto &osName = poCoordVar->GetName();
const auto poAttr = poCoordVar->GetAttribute("standard_name");
std::string osStandardName;
if (poAttr && poAttr->GetDataType().GetClass() == GEDTC_STRING &&
poAttr->GetDimensionCount() == 0)
{
const char *pszStandardName = poAttr->ReadAsString();
if (pszStandardName)
osStandardName = pszStandardName;
}
if (osName == "lon" || osName == "longitude" ||
osStandardName == "longitude")
{
poLongVar = poCoordVar;
}
else if (osName == "lat" || osName == "latitude" ||
osStandardName == "latitude")
{
poLatVar = poCoordVar;
}
}
if (poLatVar != nullptr && poLongVar != nullptr)
{
const auto longDimCount = poLongVar->GetDimensionCount();
const auto &longDims = poLongVar->GetDimensions();
const auto latDimCount = poLatVar->GetDimensionCount();
const auto &latDims = poLatVar->GetDimensions();
const auto xDimSize = aoParentDims[iXDim]->GetSize();
const auto yDimSize = aoParentDims[iYDim]->GetSize();
if (longDimCount == 1 && longDims[0]->GetSize() == xDimSize &&
latDimCount == 1 && latDims[0]->GetSize() == yDimSize)
{
// Geolocation arrays are 1D, and of consistent size with
// the variable
useGeolocationArray = true;
}
else if ((longDimCount == 2 ||
(longDimCount == 3 && longDims[0]->GetSize() == 1)) &&
longDims[longDimCount - 2]->GetSize() == yDimSize &&
longDims[longDimCount - 1]->GetSize() == xDimSize &&
(latDimCount == 2 ||
(latDimCount == 3 && latDims[0]->GetSize() == 1)) &&
latDims[latDimCount - 2]->GetSize() == yDimSize &&
latDims[latDimCount - 1]->GetSize() == xDimSize)
{
// Geolocation arrays are 2D (or 3D with first dimension of
// size 1, as found in Sentinel 5P products), and of consistent
// size with the variable
useGeolocationArray = true;
}
else
{
CPLDebug(
"GDAL",
"Longitude and latitude coordinate variables found, "
"but their characteristics are not compatible of using "
"them as geolocation arrays");
}
if (useGeolocationArray)
{
CPLDebug("GDAL",
"Setting geolocation array from variables %s and %s",
poLongVar->GetName().c_str(),
poLatVar->GetName().c_str());
std::string osFilenameLong =
CPLSPrintf("/vsimem/%p/longitude.tif", poParent.get());
std::string osFilenameLat =
CPLSPrintf("/vsimem/%p/latitude.tif", poParent.get());
std::unique_ptr<GDALDataset> poTmpLongDS(
longDimCount == 1
? poLongVar->AsClassicDataset(0, 0)
: poLongVar->AsClassicDataset(longDimCount - 1,
longDimCount - 2));
auto hTIFFLongDS = GDALTranslate(
osFilenameLong.c_str(),
GDALDataset::ToHandle(poTmpLongDS.get()), nullptr, nullptr);
std::unique_ptr<GDALDataset> poTmpLatDS(
latDimCount == 1 ? poLatVar->AsClassicDataset(0, 0)
: poLatVar->AsClassicDataset(
latDimCount - 1, latDimCount - 2));
auto hTIFFLatDS = GDALTranslate(
osFilenameLat.c_str(),
GDALDataset::ToHandle(poTmpLatDS.get()), nullptr, nullptr);
const bool bError =
(hTIFFLatDS == nullptr || hTIFFLongDS == nullptr);
GDALClose(hTIFFLongDS);
GDALClose(hTIFFLatDS);
if (bError)
{
VSIUnlink(osFilenameLong.c_str());
VSIUnlink(osFilenameLat.c_str());
return nullptr;
}
poParentDS->SetGeolocationArray(osFilenameLong, osFilenameLat);
}
}
else
{
CPLDebug("GDAL",
"Coordinate variables available for %s, but "
"longitude and/or latitude variables were not identified",
poParent->GetName().c_str());
}
}
// Build gdalwarp arguments
CPLStringList aosArgv;
aosArgv.AddString("-of");
aosArgv.AddString("VRT");
aosArgv.AddString("-r");
aosArgv.AddString(pszResampleAlg);
if (!osDstWKT.empty())
{
aosArgv.AddString("-t_srs");
aosArgv.AddString(osDstWKT.c_str());
}
if (useGeolocationArray)
aosArgv.AddString("-geoloc");
if (gotXSpacing && gotYSpacing)
{
const double dfXMin = dfXStart - dfXSpacing / 2;
const double dfXMax =
dfXMin + dfXSpacing * static_cast<double>(poNewDimX->GetSize());
const double dfYMax = dfYStart - dfYSpacing / 2;
const double dfYMin =
dfYMax + dfYSpacing * static_cast<double>(poNewDimY->GetSize());
aosArgv.AddString("-te");
aosArgv.AddString(CPLSPrintf("%.18g", dfXMin));
aosArgv.AddString(CPLSPrintf("%.18g", dfYMin));
aosArgv.AddString(CPLSPrintf("%.18g", dfXMax));
aosArgv.AddString(CPLSPrintf("%.18g", dfYMax));
}
if (poNewDimX && poNewDimY)
{
aosArgv.AddString("-ts");
aosArgv.AddString(
CPLSPrintf("%d", static_cast<int>(poNewDimX->GetSize())));
aosArgv.AddString(
CPLSPrintf("%d", static_cast<int>(poNewDimY->GetSize())));
}
else if (poNewDimX)
{
aosArgv.AddString("-ts");
aosArgv.AddString(
CPLSPrintf("%d", static_cast<int>(poNewDimX->GetSize())));
aosArgv.AddString("0");
}
else if (poNewDimY)
{
aosArgv.AddString("-ts");
aosArgv.AddString("0");
aosArgv.AddString(
CPLSPrintf("%d", static_cast<int>(poNewDimY->GetSize())));
}
// Create a warped VRT dataset
GDALWarpAppOptions *psOptions =
GDALWarpAppOptionsNew(aosArgv.List(), nullptr);
GDALDatasetH hSrcDS = GDALDataset::ToHandle(poParentDS.get());
std::unique_ptr<GDALDataset> poReprojectedDS(GDALDataset::FromHandle(
GDALWarp("", nullptr, 1, &hSrcDS, psOptions, nullptr)));
GDALWarpAppOptionsFree(psOptions);
if (poReprojectedDS == nullptr)
return nullptr;
int nBlockXSize;
int nBlockYSize;
poReprojectedDS->GetRasterBand(1)->GetBlockSize(&nBlockXSize, &nBlockYSize);
anBlockSize.emplace_back(nBlockYSize);
anBlockSize.emplace_back(nBlockXSize);
double adfGeoTransform[6] = {0, 0, 0, 0, 0, 0};
CPLErr eErr = poReprojectedDS->GetGeoTransform(adfGeoTransform);
CPLAssert(eErr == CE_None);
CPL_IGNORE_RET_VAL(eErr);
auto poDimY = std::make_shared<GDALDimensionWeakIndexingVar>(
std::string(), "dimY", GDAL_DIM_TYPE_HORIZONTAL_Y, "NORTH",
poReprojectedDS->GetRasterYSize());
auto varY = GDALMDArrayRegularlySpaced::Create(
std::string(), poDimY->GetName(), poDimY,
adfGeoTransform[3] + adfGeoTransform[5] / 2, adfGeoTransform[5], 0);
poDimY->SetIndexingVariable(varY);
auto poDimX = std::make_shared<GDALDimensionWeakIndexingVar>(
std::string(), "dimX", GDAL_DIM_TYPE_HORIZONTAL_X, "EAST",
poReprojectedDS->GetRasterXSize());
auto varX = GDALMDArrayRegularlySpaced::Create(
std::string(), poDimX->GetName(), poDimX,
adfGeoTransform[0] + adfGeoTransform[1] / 2, adfGeoTransform[1], 0);
poDimX->SetIndexingVariable(varX);
apoNewDims.emplace_back(poDimY);
apoNewDims.emplace_back(poDimX);
auto newAr(std::shared_ptr<GDALMDArrayResampled>(
new GDALMDArrayResampled(poParent, apoNewDims, anBlockSize)));
newAr->SetSelf(newAr);
if (poTargetSRS)
{
newAr->m_poSRS.reset(poTargetSRS->Clone());
}
else
{
newAr->m_poSRS = poParent->GetSpatialRef();
}
newAr->m_poVarX = varX;
newAr->m_poVarY = varY;
newAr->m_poReprojectedDS = std::move(poReprojectedDS);
newAr->m_poParentDS = std::move(poParentDS);
return newAr;
}
/************************************************************************/
/* GDALMDArrayResampled::IRead() */
/************************************************************************/
bool GDALMDArrayResampled::IRead(const GUInt64 *arrayStartIdx,
const size_t *count, const GInt64 *arrayStep,
const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType,
void *pDstBuffer) const
{
if (bufferDataType.GetClass() != GEDTC_NUMERIC)
return false;
struct Stack
{
size_t nIters = 0;
GByte *dst_ptr = nullptr;
GPtrDiff_t dst_inc_offset = 0;
};
const auto nDims = GetDimensionCount();
std::vector<Stack> stack(nDims + 1); // +1 to avoid -Wnull-dereference
const size_t nBufferDTSize = bufferDataType.GetSize();
for (size_t i = 0; i < nDims; i++)
{
stack[i].dst_inc_offset =
static_cast<GPtrDiff_t>(bufferStride[i] * nBufferDTSize);
}
stack[0].dst_ptr = static_cast<GByte *>(pDstBuffer);
size_t dimIdx = 0;
const size_t iDimY = nDims - 2;
const size_t iDimX = nDims - 1;
// Use an array to avoid a false positive warning from CLang Static
// Analyzer about flushCaches being never read
bool flushCaches[] = {false};
lbl_next_depth:
if (dimIdx == iDimY)
{
if (flushCaches[0])
{
flushCaches[0] = false;
// When changing of 2D slice, flush GDAL 2D buffers
m_poParentDS->FlushCache(false);
m_poReprojectedDS->FlushCache(false);
}
if (!GDALMDRasterIOFromBand(m_poReprojectedDS->GetRasterBand(1),
GF_Read, iDimX, iDimY, arrayStartIdx, count,
arrayStep, bufferStride, bufferDataType,
stack[dimIdx].dst_ptr))
{
return false;
}
}
else
{
stack[dimIdx].nIters = count[dimIdx];
if (m_poParentDS->m_anOffset[dimIdx] != arrayStartIdx[dimIdx])
{
flushCaches[0] = true;
}
m_poParentDS->m_anOffset[dimIdx] = arrayStartIdx[dimIdx];
while (true)
{
dimIdx++;
stack[dimIdx].dst_ptr = stack[dimIdx - 1].dst_ptr;
goto lbl_next_depth;
lbl_return_to_caller:
dimIdx--;
if ((--stack[dimIdx].nIters) == 0)
break;
flushCaches[0] = true;
++m_poParentDS->m_anOffset[dimIdx];
stack[dimIdx].dst_ptr += stack[dimIdx].dst_inc_offset;
}
}
if (dimIdx > 0)
goto lbl_return_to_caller;
return true;
}
/************************************************************************/
/* GetResampled() */
/************************************************************************/
/** Return an array that is a resampled / reprojected view of the current array
*
* This is the same as the C function GDALMDArrayGetResampled().
*
* Currently this method can only resample along the last 2 dimensions.
*
* @param apoNewDims New dimensions. Its size should be GetDimensionCount().
* apoNewDims[i] can be NULL to let the method automatically
* determine it.
* @param resampleAlg Resampling algorithm
* @param poTargetSRS Target SRS, or nullptr
* @param papszOptions NULL-terminated list of options, or NULL.
*
* @return a new array, that holds a reference to the original one, and thus is
* a view of it (not a copy), or nullptr in case of error.
*
* @since 3.4
*/
std::shared_ptr<GDALMDArray> GDALMDArray::GetResampled(
const std::vector<std::shared_ptr<GDALDimension>> &apoNewDims,
GDALRIOResampleAlg resampleAlg, const OGRSpatialReference *poTargetSRS,
CSLConstList papszOptions) const
{
auto self = std::dynamic_pointer_cast<GDALMDArray>(m_pSelf.lock());
if (!self)
{
CPLError(CE_Failure, CPLE_AppDefined,
"Driver implementation issue: m_pSelf not set !");
return nullptr;
}
if (GetDataType().GetClass() != GEDTC_NUMERIC)
{
CPLError(CE_Failure, CPLE_AppDefined,
"GetResampled() only supports numeric data type");
return nullptr;
}
return GDALMDArrayResampled::Create(self, apoNewDims, resampleAlg,
poTargetSRS, papszOptions);
}
/************************************************************************/
/* GDALDatasetFromArray() */
/************************************************************************/
class GDALDatasetFromArray;
class GDALRasterBandFromArray final : public GDALRasterBand
{
std::vector<GUInt64> m_anOffset{};
std::vector<size_t> m_anCount{};
std::vector<GPtrDiff_t> m_anStride{};
protected:
CPLErr IReadBlock(int, int, void *) override;
CPLErr IWriteBlock(int, int, void *) override;
CPLErr IRasterIO(GDALRWFlag eRWFlag, int nXOff, int nYOff, int nXSize,
int nYSize, void *pData, int nBufXSize, int nBufYSize,
GDALDataType eBufType, GSpacing nPixelSpaceBuf,
GSpacing nLineSpaceBuf,
GDALRasterIOExtraArg *psExtraArg) override;
public:
explicit GDALRasterBandFromArray(
GDALDatasetFromArray *poDSIn,
const std::vector<GUInt64> &anOtherDimCoord);
double GetNoDataValue(int *pbHasNoData) override;
int64_t GetNoDataValueAsInt64(int *pbHasNoData) override;
uint64_t GetNoDataValueAsUInt64(int *pbHasNoData) override;
double GetOffset(int *pbHasOffset) override;
double GetScale(int *pbHasScale) override;
const char *GetUnitType() override;
};
class GDALDatasetFromArray final : public GDALDataset
{
friend class GDALRasterBandFromArray;
std::shared_ptr<GDALMDArray> m_poArray;
size_t m_iXDim;
size_t m_iYDim;
double m_adfGeoTransform[6]{0, 1, 0, 0, 0, 1};
bool m_bHasGT = false;
mutable std::shared_ptr<OGRSpatialReference> m_poSRS{};
GDALMultiDomainMetadata m_oMDD{};
public:
GDALDatasetFromArray(const std::shared_ptr<GDALMDArray> &array,
size_t iXDim, size_t iYDim)
: m_poArray(array), m_iXDim(iXDim), m_iYDim(iYDim)
{
const auto &dims(m_poArray->GetDimensions());
const auto nDimCount = dims.size();
nRasterYSize =
nDimCount < 2
? 1
: static_cast<int>(std::min(static_cast<GUInt64>(INT_MAX),
dims[iYDim]->GetSize()));
nRasterXSize = static_cast<int>(
std::min(static_cast<GUInt64>(INT_MAX), dims[iXDim]->GetSize()));
eAccess = array->IsWritable() ? GA_Update : GA_ReadOnly;
const size_t nNewDimCount = nDimCount >= 2 ? nDimCount - 2 : 0;
std::vector<GUInt64> anOtherDimCoord(nNewDimCount);
std::vector<GUInt64> anStackIters(nDimCount);
std::vector<size_t> anMapNewToOld(nNewDimCount);
for (size_t i = 0, j = 0; i < nDimCount; ++i)
{
if (i != iXDim && !(nDimCount >= 2 && i == iYDim))
{
anMapNewToOld[j] = i;
j++;
}
}
m_bHasGT = m_poArray->GuessGeoTransform(m_iXDim, m_iYDim, false,
m_adfGeoTransform);
const auto attrs(array->GetAttributes());
for (const auto &attr : attrs)
{
auto stringArray = attr->ReadAsStringArray();
std::string val;
if (stringArray.size() > 1)
{
val += '{';
}
for (int i = 0; i < stringArray.size(); ++i)
{
if (i > 0)
val += ',';
val += stringArray[i];
}
if (stringArray.size() > 1)
{
val += '}';
}
m_oMDD.SetMetadataItem(attr->GetName().c_str(), val.c_str());
}
// Instantiate bands by iterating over non-XY variables
size_t iDim = 0;
lbl_next_depth:
if (iDim < nNewDimCount)
{
anStackIters[iDim] = dims[anMapNewToOld[iDim]]->GetSize();
anOtherDimCoord[iDim] = 0;
while (true)
{
++iDim;
goto lbl_next_depth;
lbl_return_to_caller:
--iDim;
--anStackIters[iDim];
if (anStackIters[iDim] == 0)
break;
++anOtherDimCoord[iDim];
}
}
else
{
SetBand(nBands + 1,
new GDALRasterBandFromArray(this, anOtherDimCoord));
}
if (iDim > 0)
goto lbl_return_to_caller;
}
CPLErr GetGeoTransform(double *padfGeoTransform) override
{
memcpy(padfGeoTransform, m_adfGeoTransform, 6 * sizeof(double));
return m_bHasGT ? CE_None : CE_Failure;
}
const OGRSpatialReference *GetSpatialRef() const override
{
if (m_poArray->GetDimensionCount() < 2)
return nullptr;
m_poSRS = m_poArray->GetSpatialRef();
if (m_poSRS)
{
m_poSRS.reset(m_poSRS->Clone());
auto axisMapping = m_poSRS->GetDataAxisToSRSAxisMapping();
for (auto &m : axisMapping)
{
if (m == static_cast<int>(m_iXDim) + 1)
m = 1;
else if (m == static_cast<int>(m_iYDim) + 1)
m = 2;
else
m = 0;
}
m_poSRS->SetDataAxisToSRSAxisMapping(axisMapping);
}
return m_poSRS.get();
}
CPLErr SetMetadata(char **papszMetadata, const char *pszDomain) override
{
return m_oMDD.SetMetadata(papszMetadata, pszDomain);
}
char **GetMetadata(const char *pszDomain) override
{
return m_oMDD.GetMetadata(pszDomain);
}
const char *GetMetadataItem(const char *pszName,
const char *pszDomain) override
{
return m_oMDD.GetMetadataItem(pszName, pszDomain);
}
};
/************************************************************************/
/* GDALRasterBandFromArray() */
/************************************************************************/
GDALRasterBandFromArray::GDALRasterBandFromArray(
GDALDatasetFromArray *poDSIn, const std::vector<GUInt64> &anOtherDimCoord)
{
const auto &poArray(poDSIn->m_poArray);
const auto &dims(poArray->GetDimensions());
const auto nDimCount(dims.size());
const auto blockSize(poArray->GetBlockSize());
nBlockYSize = (nDimCount >= 2 && blockSize[poDSIn->m_iYDim])
? static_cast<int>(std::min(static_cast<GUInt64>(INT_MAX),
blockSize[poDSIn->m_iYDim]))
: 1;
nBlockXSize = blockSize[poDSIn->m_iXDim]
? static_cast<int>(std::min(static_cast<GUInt64>(INT_MAX),
blockSize[poDSIn->m_iXDim]))
: poDSIn->GetRasterXSize();
eDataType = poArray->GetDataType().GetNumericDataType();
eAccess = poDSIn->eAccess;
m_anOffset.resize(nDimCount);
m_anCount.resize(nDimCount, 1);
m_anStride.resize(nDimCount);
for (size_t i = 0, j = 0; i < nDimCount; ++i)
{
if (i != poDSIn->m_iXDim && !(nDimCount >= 2 && i == poDSIn->m_iYDim))
{
std::string dimName(dims[i]->GetName());
GUInt64 nIndex = anOtherDimCoord[j];
// Detect subset_{orig_dim_name}_{start}_{incr}_{size} names of
// subsetted dimensions as generated by GetView()
if (STARTS_WITH(dimName.c_str(), "subset_"))
{
CPLStringList aosTokens(
CSLTokenizeString2(dimName.c_str(), "_", 0));
if (aosTokens.size() == 5)
{
dimName = aosTokens[1];
const auto nStartDim = static_cast<GUInt64>(CPLScanUIntBig(
aosTokens[2], static_cast<int>(strlen(aosTokens[2]))));
const auto nIncrDim = CPLAtoGIntBig(aosTokens[3]);
nIndex = nIncrDim > 0 ? nStartDim + nIndex * nIncrDim
: nStartDim - (nIndex * -nIncrDim);
}
}
SetMetadataItem(
CPLSPrintf("DIM_%s_INDEX", dimName.c_str()),
CPLSPrintf(CPL_FRMT_GUIB, static_cast<GUIntBig>(nIndex)));
auto indexingVar = dims[i]->GetIndexingVariable();
if (indexingVar && indexingVar->GetDimensionCount() == 1 &&
indexingVar->GetDimensions()[0]->GetSize() ==
dims[i]->GetSize())
{
size_t nCount = 1;
const auto &dt(indexingVar->GetDataType());
std::vector<GByte> abyTmp(dt.GetSize());
if (indexingVar->Read(&(anOtherDimCoord[j]), &nCount, nullptr,
nullptr, dt, &abyTmp[0]))
{
char *pszTmp = nullptr;
GDALExtendedDataType::CopyValue(
&abyTmp[0], dt, &pszTmp,
GDALExtendedDataType::CreateString());
if (pszTmp)
{
SetMetadataItem(
CPLSPrintf("DIM_%s_VALUE", dimName.c_str()),
pszTmp);
CPLFree(pszTmp);
}
const auto unit(indexingVar->GetUnit());
if (!unit.empty())
{
SetMetadataItem(
CPLSPrintf("DIM_%s_UNIT", dimName.c_str()),
unit.c_str());
}
}
}
m_anOffset[i] = anOtherDimCoord[j];
j++;
}
}
}
/************************************************************************/
/* GetNoDataValue() */
/************************************************************************/
double GDALRasterBandFromArray::GetNoDataValue(int *pbHasNoData)
{
auto l_poDS(cpl::down_cast<GDALDatasetFromArray *>(poDS));
const auto &poArray(l_poDS->m_poArray);
bool bHasNodata = false;
const auto res = poArray->GetNoDataValueAsDouble(&bHasNodata);
if (pbHasNoData)
*pbHasNoData = bHasNodata;
return res;
}
/************************************************************************/
/* GetNoDataValueAsInt64() */
/************************************************************************/
int64_t GDALRasterBandFromArray::GetNoDataValueAsInt64(int *pbHasNoData)
{
auto l_poDS(cpl::down_cast<GDALDatasetFromArray *>(poDS));
const auto &poArray(l_poDS->m_poArray);
bool bHasNodata = false;
const auto nodata = poArray->GetNoDataValueAsInt64(&bHasNodata);
if (pbHasNoData)
*pbHasNoData = bHasNodata;
return nodata;
}
/************************************************************************/
/* GetNoDataValueAsUInt64() */
/************************************************************************/
uint64_t GDALRasterBandFromArray::GetNoDataValueAsUInt64(int *pbHasNoData)
{
auto l_poDS(cpl::down_cast<GDALDatasetFromArray *>(poDS));
const auto &poArray(l_poDS->m_poArray);
bool bHasNodata = false;
const auto nodata = poArray->GetNoDataValueAsUInt64(&bHasNodata);
if (pbHasNoData)
*pbHasNoData = bHasNodata;
return nodata;
}
/************************************************************************/
/* GetOffset() */
/************************************************************************/
double GDALRasterBandFromArray::GetOffset(int *pbHasOffset)
{
auto l_poDS(cpl::down_cast<GDALDatasetFromArray *>(poDS));
const auto &poArray(l_poDS->m_poArray);
bool bHasValue = false;
double dfRes = poArray->GetOffset(&bHasValue);
if (pbHasOffset)
*pbHasOffset = bHasValue;
return dfRes;
}
/************************************************************************/
/* GetUnitType() */
/************************************************************************/
const char *GDALRasterBandFromArray::GetUnitType()
{
auto l_poDS(cpl::down_cast<GDALDatasetFromArray *>(poDS));
const auto &poArray(l_poDS->m_poArray);
return poArray->GetUnit().c_str();
}
/************************************************************************/
/* GetScale() */
/************************************************************************/
double GDALRasterBandFromArray::GetScale(int *pbHasScale)
{
auto l_poDS(cpl::down_cast<GDALDatasetFromArray *>(poDS));
const auto &poArray(l_poDS->m_poArray);
bool bHasValue = false;
double dfRes = poArray->GetScale(&bHasValue);
if (pbHasScale)
*pbHasScale = bHasValue;
return dfRes;
}
/************************************************************************/
/* IReadBlock() */
/************************************************************************/
CPLErr GDALRasterBandFromArray::IReadBlock(int nBlockXOff, int nBlockYOff,
void *pImage)
{
const int nDTSize(GDALGetDataTypeSizeBytes(eDataType));
const int nXOff = nBlockXOff * nBlockXSize;
const int nYOff = nBlockYOff * nBlockYSize;
const int nReqXSize = std::min(nRasterXSize - nXOff, nBlockXSize);
const int nReqYSize = std::min(nRasterYSize - nYOff, nBlockYSize);
GDALRasterIOExtraArg sExtraArg;
INIT_RASTERIO_EXTRA_ARG(sExtraArg);
return IRasterIO(GF_Read, nXOff, nYOff, nReqXSize, nReqYSize, pImage,
nReqXSize, nReqYSize, eDataType, nDTSize,
nDTSize * nBlockXSize, &sExtraArg);
}
/************************************************************************/
/* IWriteBlock() */
/************************************************************************/
CPLErr GDALRasterBandFromArray::IWriteBlock(int nBlockXOff, int nBlockYOff,
void *pImage)
{
const int nDTSize(GDALGetDataTypeSizeBytes(eDataType));
const int nXOff = nBlockXOff * nBlockXSize;
const int nYOff = nBlockYOff * nBlockYSize;
const int nReqXSize = std::min(nRasterXSize - nXOff, nBlockXSize);
const int nReqYSize = std::min(nRasterYSize - nYOff, nBlockYSize);
GDALRasterIOExtraArg sExtraArg;
INIT_RASTERIO_EXTRA_ARG(sExtraArg);
return IRasterIO(GF_Write, nXOff, nYOff, nReqXSize, nReqYSize, pImage,
nReqXSize, nReqYSize, eDataType, nDTSize,
nDTSize * nBlockXSize, &sExtraArg);
}
/************************************************************************/
/* IRasterIO() */
/************************************************************************/
CPLErr GDALRasterBandFromArray::IRasterIO(GDALRWFlag eRWFlag, int nXOff,
int nYOff, int nXSize, int nYSize,
void *pData, int nBufXSize,
int nBufYSize, GDALDataType eBufType,
GSpacing nPixelSpaceBuf,
GSpacing nLineSpaceBuf,
GDALRasterIOExtraArg *psExtraArg)
{
auto l_poDS(cpl::down_cast<GDALDatasetFromArray *>(poDS));
const auto &poArray(l_poDS->m_poArray);
const int nBufferDTSize(GDALGetDataTypeSizeBytes(eBufType));
if (nXSize == nBufXSize && nYSize == nBufYSize && nBufferDTSize > 0 &&
(nPixelSpaceBuf % nBufferDTSize) == 0 &&
(nLineSpaceBuf % nBufferDTSize) == 0)
{
m_anOffset[l_poDS->m_iXDim] = static_cast<GUInt64>(nXOff);
m_anCount[l_poDS->m_iXDim] = static_cast<size_t>(nXSize);
m_anStride[l_poDS->m_iXDim] =
static_cast<GPtrDiff_t>(nPixelSpaceBuf / nBufferDTSize);
if (poArray->GetDimensionCount() >= 2)
{
m_anOffset[l_poDS->m_iYDim] = static_cast<GUInt64>(nYOff);
m_anCount[l_poDS->m_iYDim] = static_cast<size_t>(nYSize);
m_anStride[l_poDS->m_iYDim] =
static_cast<GPtrDiff_t>(nLineSpaceBuf / nBufferDTSize);
}
if (eRWFlag == GF_Read)
{
return poArray->Read(m_anOffset.data(), m_anCount.data(), nullptr,
m_anStride.data(),
GDALExtendedDataType::Create(eBufType), pData)
? CE_None
: CE_Failure;
}
else
{
return poArray->Write(m_anOffset.data(), m_anCount.data(), nullptr,
m_anStride.data(),
GDALExtendedDataType::Create(eBufType), pData)
? CE_None
: CE_Failure;
}
}
return GDALRasterBand::IRasterIO(eRWFlag, nXOff, nYOff, nXSize, nYSize,
pData, nBufXSize, nBufYSize, eBufType,
nPixelSpaceBuf, nLineSpaceBuf, psExtraArg);
}
/************************************************************************/
/* AsClassicDataset() */
/************************************************************************/
/** Return a view of this array as a "classic" GDALDataset (ie 2D)
*
* In the case of > 2D arrays, additional dimensions will be represented as
* raster bands.
*
* The "reverse" method is GDALRasterBand::AsMDArray().
*
* This is the same as the C function GDALMDArrayAsClassicDataset().
*
* @param iXDim Index of the dimension that will be used as the X/width axis.
* @param iYDim Index of the dimension that will be used as the Y/height axis.
* Ignored if the dimension count is 1.
* @return a new GDALDataset that must be freed with GDALClose(), or nullptr
*/
GDALDataset *GDALMDArray::AsClassicDataset(size_t iXDim, size_t iYDim) const
{
auto self = std::dynamic_pointer_cast<GDALMDArray>(m_pSelf.lock());
if (!self)
{
CPLError(CE_Failure, CPLE_AppDefined,
"Driver implementation issue: m_pSelf not set !");
return nullptr;
}
const auto nDimCount(GetDimensionCount());
if (nDimCount == 0)
{
CPLError(CE_Failure, CPLE_NotSupported,
"Unsupported number of dimensions");
return nullptr;
}
if (GetDataType().GetClass() != GEDTC_NUMERIC ||
GetDataType().GetNumericDataType() == GDT_Unknown)
{
CPLError(CE_Failure, CPLE_NotSupported,
"Only arrays with numeric data types "
"can be exposed as classic GDALDataset");
return nullptr;
}
if (iXDim >= nDimCount ||
(nDimCount >= 2 && (iYDim >= nDimCount || iXDim == iYDim)))
{
CPLError(CE_Failure, CPLE_NotSupported, "Invalid iXDim and/or iYDim");
return nullptr;
}
GUInt64 nBands = 1;
const auto &dims(GetDimensions());
for (size_t i = 0; i < nDimCount; ++i)
{
if (i != iXDim && !(nDimCount >= 2 && i == iYDim))
{
if (dims[i]->GetSize() > 65536 / nBands)
{
CPLError(CE_Failure, CPLE_AppDefined,
"Too many bands. Operate on a sliced view");
return nullptr;
}
nBands *= dims[i]->GetSize();
}
}
return new GDALDatasetFromArray(self, iXDim, iYDim);
}
/************************************************************************/
/* GetStatistics() */
/************************************************************************/
/**
* \brief Fetch statistics.
*
* Returns the minimum, maximum, mean and standard deviation of all
* pixel values in this array.
*
* If bForce is FALSE results will only be returned if it can be done
* quickly (i.e. without scanning the data). If bForce is FALSE and
* results cannot be returned efficiently, the method will return CE_Warning
* but no warning will have been issued. This is a non-standard use of
* the CE_Warning return value to indicate "nothing done".
*
* When cached statistics are not available, and bForce is TRUE,
* ComputeStatistics() is called.
*
* Note that file formats using PAM (Persistent Auxiliary Metadata) services
* will generally cache statistics in the .aux.xml file allowing fast fetch
* after the first request.
*
* Cached statistics can be cleared with GDALDataset::ClearStatistics().
*
* This method is the same as the C function GDALMDArrayGetStatistics().
*
* @param bApproxOK Currently ignored. In the future, should be set to true
* if statistics on the whole array are wished, or to false if a subset of it
* may be used.
*
* @param bForce If false statistics will only be returned if it can
* be done without rescanning the image.
*
* @param pdfMin Location into which to load image minimum (may be NULL).
*
* @param pdfMax Location into which to load image maximum (may be NULL).-
*
* @param pdfMean Location into which to load image mean (may be NULL).
*
* @param pdfStdDev Location into which to load image standard deviation
* (may be NULL).
*
* @param pnValidCount Number of samples whose value is different from the
* nodata value. (may be NULL)
*
* @param pfnProgress a function to call to report progress, or NULL.
*
* @param pProgressData application data to pass to the progress function.
*
* @return CE_None on success, CE_Warning if no values returned,
* CE_Failure if an error occurs.
*
* @since GDAL 3.2
*/
CPLErr GDALMDArray::GetStatistics(bool bApproxOK, bool bForce, double *pdfMin,
double *pdfMax, double *pdfMean,
double *pdfStdDev, GUInt64 *pnValidCount,
GDALProgressFunc pfnProgress,
void *pProgressData)
{
if (!bForce)
return CE_Warning;
return ComputeStatistics(bApproxOK, pdfMin, pdfMax, pdfMean, pdfStdDev,
pnValidCount, pfnProgress, pProgressData)
? CE_None
: CE_Failure;
}
/************************************************************************/
/* ComputeStatistics() */
/************************************************************************/
/**
* \brief Compute statistics.
*
* Returns the minimum, maximum, mean and standard deviation of all
* pixel values in this array.
*
* Pixels taken into account in statistics are those whose mask value
* (as determined by GetMask()) is non-zero.
*
* Once computed, the statistics will generally be "set" back on the
* owing dataset.
*
* Cached statistics can be cleared with GDALDataset::ClearStatistics().
*
* This method is the same as the C function GDALMDArrayComputeStatistics().
*
* @param bApproxOK Currently ignored. In the future, should be set to true
* if statistics on the whole array are wished, or to false if a subset of it
* may be used.
*
* @param pdfMin Location into which to load image minimum (may be NULL).
*
* @param pdfMax Location into which to load image maximum (may be NULL).-
*
* @param pdfMean Location into which to load image mean (may be NULL).
*
* @param pdfStdDev Location into which to load image standard deviation
* (may be NULL).
*
* @param pnValidCount Number of samples whose value is different from the
* nodata value. (may be NULL)
*
* @param pfnProgress a function to call to report progress, or NULL.
*
* @param pProgressData application data to pass to the progress function.
*
* @return true on success
*
* @since GDAL 3.2
*/
bool GDALMDArray::ComputeStatistics(bool bApproxOK, double *pdfMin,
double *pdfMax, double *pdfMean,
double *pdfStdDev, GUInt64 *pnValidCount,
GDALProgressFunc pfnProgress,
void *pProgressData)
{
struct StatsPerChunkType
{
const GDALMDArray *array = nullptr;
std::shared_ptr<GDALMDArray> poMask{};
double dfMin = std::numeric_limits<double>::max();
double dfMax = -std::numeric_limits<double>::max();
double dfMean = 0.0;
double dfM2 = 0.0;
GUInt64 nValidCount = 0;
std::vector<GByte> abyData{};
std::vector<double> adfData{};
std::vector<GByte> abyMaskData{};
GDALProgressFunc pfnProgress = nullptr;
void *pProgressData = nullptr;
};
const auto PerChunkFunc = [](GDALAbstractMDArray *,
const GUInt64 *chunkArrayStartIdx,
const size_t *chunkCount, GUInt64 iCurChunk,
GUInt64 nChunkCount, void *pUserData)
{
StatsPerChunkType *data = static_cast<StatsPerChunkType *>(pUserData);
const GDALMDArray *array = data->array;
const GDALMDArray *poMask = data->poMask.get();
const size_t nDims = array->GetDimensionCount();
size_t nVals = 1;
for (size_t i = 0; i < nDims; i++)
nVals *= chunkCount[i];
// Get mask
data->abyMaskData.resize(nVals);
if (!(poMask->Read(chunkArrayStartIdx, chunkCount, nullptr, nullptr,
poMask->GetDataType(), &data->abyMaskData[0])))
{
return false;
}
// Get data
const auto &oType = array->GetDataType();
if (oType.GetNumericDataType() == GDT_Float64)
{
data->adfData.resize(nVals);
if (!array->Read(chunkArrayStartIdx, chunkCount, nullptr, nullptr,
oType, &data->adfData[0]))
{
return false;
}
}
else
{
data->abyData.resize(nVals * oType.GetSize());
if (!array->Read(chunkArrayStartIdx, chunkCount, nullptr, nullptr,
oType, &data->abyData[0]))
{
return false;
}
data->adfData.resize(nVals);
GDALCopyWords64(&data->abyData[0], oType.GetNumericDataType(),
static_cast<int>(oType.GetSize()),
&data->adfData[0], GDT_Float64,
static_cast<int>(sizeof(double)),
static_cast<GPtrDiff_t>(nVals));
}
for (size_t i = 0; i < nVals; i++)
{
if (data->abyMaskData[i])
{
const double dfValue = data->adfData[i];
data->dfMin = std::min(data->dfMin, dfValue);
data->dfMax = std::max(data->dfMax, dfValue);
data->nValidCount++;
const double dfDelta = dfValue - data->dfMean;
data->dfMean += dfDelta / data->nValidCount;
data->dfM2 += dfDelta * (dfValue - data->dfMean);
}
}
if (data->pfnProgress &&
!data->pfnProgress(static_cast<double>(iCurChunk + 1) / nChunkCount,
"", data->pProgressData))
{
return false;
}
return true;
};
const auto &oType = GetDataType();
if (oType.GetClass() != GEDTC_NUMERIC ||
GDALDataTypeIsComplex(oType.GetNumericDataType()))
{
CPLError(
CE_Failure, CPLE_NotSupported,
"Statistics can only be computed on non-complex numeric data type");
return false;
}
const size_t nDims = GetDimensionCount();
std::vector<GUInt64> arrayStartIdx(nDims);
std::vector<GUInt64> count(nDims);
const auto &poDims = GetDimensions();
for (size_t i = 0; i < nDims; i++)
{
count[i] = poDims[i]->GetSize();
}
const char *pszSwathSize = CPLGetConfigOption("GDAL_SWATH_SIZE", nullptr);
const size_t nMaxChunkSize =
pszSwathSize
? static_cast<size_t>(
std::min(GIntBig(std::numeric_limits<size_t>::max() / 2),
CPLAtoGIntBig(pszSwathSize)))
: static_cast<size_t>(
std::min(GIntBig(std::numeric_limits<size_t>::max() / 2),
GDALGetCacheMax64() / 4));
StatsPerChunkType sData;
sData.array = this;
sData.poMask = GetMask(nullptr);
if (sData.poMask == nullptr)
{
return false;
}
sData.pfnProgress = pfnProgress;
sData.pProgressData = pProgressData;
if (!ProcessPerChunk(arrayStartIdx.data(), count.data(),
GetProcessingChunkSize(nMaxChunkSize).data(),
PerChunkFunc, &sData))
{
return false;
}
if (pdfMin)
*pdfMin = sData.dfMin;
if (pdfMax)
*pdfMax = sData.dfMax;
if (pdfMean)
*pdfMean = sData.dfMean;
const double dfStdDev =
sData.nValidCount > 0 ? sqrt(sData.dfM2 / sData.nValidCount) : 0.0;
if (pdfStdDev)
*pdfStdDev = dfStdDev;
if (pnValidCount)
*pnValidCount = sData.nValidCount;
SetStatistics(bApproxOK, sData.dfMin, sData.dfMax, sData.dfMean, dfStdDev,
sData.nValidCount);
return true;
}
/************************************************************************/
/* SetStatistics() */
/************************************************************************/
//! @cond Doxygen_Suppress
bool GDALMDArray::SetStatistics(bool /* bApproxStats */, double /* dfMin */,
double /* dfMax */, double /* dfMean */,
double /* dfStdDev */,
GUInt64 /* nValidCount */)
{
CPLDebug("GDAL", "Cannot save statistics on a non-PAM MDArray");
return false;
}
//! @endcond
/************************************************************************/
/* ClearStatistics() */
/************************************************************************/
/**
* \brief Clear statistics.
*
* @since GDAL 3.4
*/
void GDALMDArray::ClearStatistics()
{
}
/************************************************************************/
/* GetCoordinateVariables() */
/************************************************************************/
/**
* \brief Return coordinate variables.
*
* Coordinate variables are an alternate way of indexing an array that can
* be sometimes used. For example, an array collected through remote sensing
* might be indexed by (scanline, pixel). But there can be
* a longitude and latitude arrays alongside that are also both indexed by
* (scanline, pixel), and are referenced from operational arrays for
* reprojection purposes.
*
* For netCDF, this will return the arrays referenced by the "coordinates"
* attribute.
*
* This method is the same as the C function
* GDALMDArrayGetCoordinateVariables().
*
* @return a vector of arrays
*
* @since GDAL 3.4
*/
std::vector<std::shared_ptr<GDALMDArray>>
GDALMDArray::GetCoordinateVariables() const
{
return {};
}
/************************************************************************/
/* ~GDALExtendedDataType() */
/************************************************************************/
GDALExtendedDataType::~GDALExtendedDataType() = default;
/************************************************************************/
/* GDALExtendedDataType() */
/************************************************************************/
GDALExtendedDataType::GDALExtendedDataType(size_t nMaxStringLength,
GDALExtendedDataTypeSubType eSubType)
: m_eClass(GEDTC_STRING), m_eSubType(eSubType), m_nSize(sizeof(char *)),
m_nMaxStringLength(nMaxStringLength)
{
}
/************************************************************************/
/* GDALExtendedDataType() */
/************************************************************************/
GDALExtendedDataType::GDALExtendedDataType(GDALDataType eType)
: m_eClass(GEDTC_NUMERIC), m_eNumericDT(eType),
m_nSize(GDALGetDataTypeSizeBytes(eType))
{
}
/************************************************************************/
/* GDALExtendedDataType() */
/************************************************************************/
GDALExtendedDataType::GDALExtendedDataType(
const std::string &osName, size_t nTotalSize,
std::vector<std::unique_ptr<GDALEDTComponent>> &&components)
: m_osName(osName), m_eClass(GEDTC_COMPOUND),
m_aoComponents(std::move(components)), m_nSize(nTotalSize)
{
}
/************************************************************************/
/* GDALExtendedDataType() */
/************************************************************************/
/** Copy constructor. */
GDALExtendedDataType::GDALExtendedDataType(const GDALExtendedDataType &other)
: m_osName(other.m_osName), m_eClass(other.m_eClass),
m_eSubType(other.m_eSubType), m_eNumericDT(other.m_eNumericDT),
m_nSize(other.m_nSize), m_nMaxStringLength(other.m_nMaxStringLength)
{
if (m_eClass == GEDTC_COMPOUND)
{
for (const auto &elt : other.m_aoComponents)
{
m_aoComponents.emplace_back(new GDALEDTComponent(*elt));
}
}
}
/************************************************************************/
/* operator= () */
/************************************************************************/
/** Move assignment. */
GDALExtendedDataType &
GDALExtendedDataType::operator=(GDALExtendedDataType &&other)
{
m_osName = std::move(other.m_osName);
m_eClass = other.m_eClass;
m_eSubType = other.m_eSubType;
m_eNumericDT = other.m_eNumericDT;
m_nSize = other.m_nSize;
m_nMaxStringLength = other.m_nMaxStringLength;
m_aoComponents = std::move(other.m_aoComponents);
other.m_eClass = GEDTC_NUMERIC;
other.m_eNumericDT = GDT_Unknown;
other.m_nSize = 0;
other.m_nMaxStringLength = 0;
return *this;
}
/************************************************************************/
/* Create() */
/************************************************************************/
/** Return a new GDALExtendedDataType of class GEDTC_NUMERIC.
*
* This is the same as the C function GDALExtendedDataTypeCreate()
*
* @param eType Numeric data type.
*/
GDALExtendedDataType GDALExtendedDataType::Create(GDALDataType eType)
{
return GDALExtendedDataType(eType);
}
/************************************************************************/
/* Create() */
/************************************************************************/
/** Return a new GDALExtendedDataType of class GEDTC_COMPOUND.
*
* This is the same as the C function GDALExtendedDataTypeCreateCompound()
*
* @param osName Type name.
* @param nTotalSize Total size of the type in bytes.
* Should be large enough to store all components.
* @param components Components of the compound type.
*/
GDALExtendedDataType GDALExtendedDataType::Create(
const std::string &osName, size_t nTotalSize,
std::vector<std::unique_ptr<GDALEDTComponent>> &&components)
{
size_t nLastOffset = 0;
// Some arbitrary threshold to avoid potential integer overflows
if (nTotalSize > static_cast<size_t>(std::numeric_limits<int>::max() / 2))
{
CPLError(CE_Failure, CPLE_AppDefined, "Invalid offset/size");
return GDALExtendedDataType(GDT_Unknown);
}
for (const auto &comp : components)
{
// Check alignment too ?
if (comp->GetOffset() < nLastOffset)
{
CPLError(CE_Failure, CPLE_AppDefined, "Invalid offset/size");
return GDALExtendedDataType(GDT_Unknown);
}
nLastOffset = comp->GetOffset() + comp->GetType().GetSize();
}
if (nTotalSize < nLastOffset)
{
CPLError(CE_Failure, CPLE_AppDefined, "Invalid offset/size");
return GDALExtendedDataType(GDT_Unknown);
}
if (nTotalSize == 0 || components.empty())
{
CPLError(CE_Failure, CPLE_AppDefined, "Empty compound not allowed");
return GDALExtendedDataType(GDT_Unknown);
}
return GDALExtendedDataType(osName, nTotalSize, std::move(components));
}
/************************************************************************/
/* Create() */
/************************************************************************/
/** Return a new GDALExtendedDataType of class GEDTC_STRING.
*
* This is the same as the C function GDALExtendedDataTypeCreateString().
*
* @param nMaxStringLength maximum length of a string in bytes. 0 if
* unknown/unlimited
* @param eSubType Subtype.
*/
GDALExtendedDataType
GDALExtendedDataType::CreateString(size_t nMaxStringLength,
GDALExtendedDataTypeSubType eSubType)
{
return GDALExtendedDataType(nMaxStringLength, eSubType);
}
/************************************************************************/
/* operator==() */
/************************************************************************/
/** Equality operator.
*
* This is the same as the C function GDALExtendedDataTypeEquals().
*/
bool GDALExtendedDataType::operator==(const GDALExtendedDataType &other) const
{
if (m_eClass != other.m_eClass || m_eSubType != other.m_eSubType ||
m_nSize != other.m_nSize || m_osName != other.m_osName)
{
return false;
}
if (m_eClass == GEDTC_NUMERIC)
{
return m_eNumericDT == other.m_eNumericDT;
}
if (m_eClass == GEDTC_STRING)
{
return true;
}
CPLAssert(m_eClass == GEDTC_COMPOUND);
if (m_aoComponents.size() != other.m_aoComponents.size())
{
return false;
}
for (size_t i = 0; i < m_aoComponents.size(); i++)
{
if (!(*m_aoComponents[i] == *other.m_aoComponents[i]))
{
return false;
}
}
return true;
}
/************************************************************************/
/* CanConvertTo() */
/************************************************************************/
/** Return whether this data type can be converted to the other one.
*
* This is the same as the C function GDALExtendedDataTypeCanConvertTo().
*
* @param other Target data type for the conversion being considered.
*/
bool GDALExtendedDataType::CanConvertTo(const GDALExtendedDataType &other) const
{
if (m_eClass == GEDTC_NUMERIC)
{
if (m_eNumericDT == GDT_Unknown)
return false;
if (other.m_eClass == GEDTC_NUMERIC &&
other.m_eNumericDT == GDT_Unknown)
return false;
return other.m_eClass == GEDTC_NUMERIC ||
other.m_eClass == GEDTC_STRING;
}
if (m_eClass == GEDTC_STRING)
{
return other.m_eClass == m_eClass;
}
CPLAssert(m_eClass == GEDTC_COMPOUND);
if (other.m_eClass != GEDTC_COMPOUND)
return false;
std::map<std::string, const std::unique_ptr<GDALEDTComponent> *>
srcComponents;
for (const auto &srcComp : m_aoComponents)
{
srcComponents[srcComp->GetName()] = &srcComp;
}
for (const auto &dstComp : other.m_aoComponents)
{
auto oIter = srcComponents.find(dstComp->GetName());
if (oIter == srcComponents.end())
return false;
if (!(*(oIter->second))->GetType().CanConvertTo(dstComp->GetType()))
return false;
}
return true;
}
/************************************************************************/
/* NeedsFreeDynamicMemory() */
/************************************************************************/
/** Return whether the data type holds dynamically allocated memory, that
* needs to be freed with FreeDynamicMemory().
*
*/
bool GDALExtendedDataType::NeedsFreeDynamicMemory() const
{
switch (m_eClass)
{
case GEDTC_STRING:
return true;
case GEDTC_NUMERIC:
return false;
case GEDTC_COMPOUND:
{
for (const auto &comp : m_aoComponents)
{
if (comp->GetType().NeedsFreeDynamicMemory())
return true;
}
}
}
return false;
}
/************************************************************************/
/* FreeDynamicMemory() */
/************************************************************************/
/** Release the dynamic memory (strings typically) from a raw value.
*
* This is the same as the C function GDALExtendedDataTypeFreeDynamicMemory().
*
* @param pBuffer Raw buffer of a single element of an attribute or array value.
*/
void GDALExtendedDataType::FreeDynamicMemory(void *pBuffer) const
{
switch (m_eClass)
{
case GEDTC_STRING:
{
char *pszStr;
memcpy(&pszStr, pBuffer, sizeof(char *));
if (pszStr)
{
VSIFree(pszStr);
}
break;
}
case GEDTC_NUMERIC:
{
break;
}
case GEDTC_COMPOUND:
{
GByte *pabyBuffer = static_cast<GByte *>(pBuffer);
for (const auto &comp : m_aoComponents)
{
comp->GetType().FreeDynamicMemory(pabyBuffer +
comp->GetOffset());
}
break;
}
}
}
/************************************************************************/
/* ~GDALEDTComponent() */
/************************************************************************/
GDALEDTComponent::~GDALEDTComponent() = default;
/************************************************************************/
/* GDALEDTComponent() */
/************************************************************************/
/** constructor of a GDALEDTComponent
*
* This is the same as the C function GDALEDTComponendCreate()
*
* @param name Component name
* @param offset Offset in byte of the component in the compound data type.
* In case of nesting of compound data type, this should be
* the offset to the immediate belonging data type, not to the
* higher level one.
* @param type Component data type.
*/
GDALEDTComponent::GDALEDTComponent(const std::string &name, size_t offset,
const GDALExtendedDataType &type)
: m_osName(name), m_nOffset(offset), m_oType(type)
{
}
/************************************************************************/
/* GDALEDTComponent() */
/************************************************************************/
/** Copy constructor. */
GDALEDTComponent::GDALEDTComponent(const GDALEDTComponent &) = default;
/************************************************************************/
/* operator==() */
/************************************************************************/
/** Equality operator.
*/
bool GDALEDTComponent::operator==(const GDALEDTComponent &other) const
{
return m_osName == other.m_osName && m_nOffset == other.m_nOffset &&
m_oType == other.m_oType;
}
/************************************************************************/
/* ~GDALDimension() */
/************************************************************************/
GDALDimension::~GDALDimension() = default;
/************************************************************************/
/* GDALDimension() */
/************************************************************************/
//! @cond Doxygen_Suppress
/** Constructor.
*
* @param osParentName Parent name
* @param osName name
* @param osType type. See GetType().
* @param osDirection direction. See GetDirection().
* @param nSize size.
*/
GDALDimension::GDALDimension(const std::string &osParentName,
const std::string &osName,
const std::string &osType,
const std::string &osDirection, GUInt64 nSize)
: m_osName(osName),
m_osFullName(
!osParentName.empty()
? ((osParentName == "/" ? "/" : osParentName + "/") + osName)
: osName),
m_osType(osType), m_osDirection(osDirection), m_nSize(nSize)
{
}
//! @endcond
/************************************************************************/
/* GetIndexingVariable() */
/************************************************************************/
/** Return the variable that is used to index the dimension (if there is one).
*
* This is the array, typically one-dimensional, describing the values taken
* by the dimension.
*/
std::shared_ptr<GDALMDArray> GDALDimension::GetIndexingVariable() const
{
return nullptr;
}
/************************************************************************/
/* SetIndexingVariable() */
/************************************************************************/
/** Set the variable that is used to index the dimension.
*
* This is the array, typically one-dimensional, describing the values taken
* by the dimension.
*
* Optionally implemented by drivers.
*
* Drivers known to implement it: MEM.
*
* @param poArray Variable to use to index the dimension.
* @return true in case of success.
*/
bool GDALDimension::SetIndexingVariable(
CPL_UNUSED std::shared_ptr<GDALMDArray> poArray)
{
CPLError(CE_Failure, CPLE_NotSupported,
"SetIndexingVariable() not implemented");
return false;
}
/************************************************************************/
/************************************************************************/
/************************************************************************/
/* C API */
/************************************************************************/
/************************************************************************/
/************************************************************************/
struct GDALExtendedDataTypeHS
{
std::unique_ptr<GDALExtendedDataType> m_poImpl;
explicit GDALExtendedDataTypeHS(GDALExtendedDataType *dt) : m_poImpl(dt)
{
}
};
struct GDALEDTComponentHS
{
std::unique_ptr<GDALEDTComponent> m_poImpl;
explicit GDALEDTComponentHS(const GDALEDTComponent &component)
: m_poImpl(new GDALEDTComponent(component))
{
}
};
struct GDALGroupHS
{
std::shared_ptr<GDALGroup> m_poImpl;
explicit GDALGroupHS(const std::shared_ptr<GDALGroup> &poGroup)
: m_poImpl(poGroup)
{
}
};
struct GDALMDArrayHS
{
std::shared_ptr<GDALMDArray> m_poImpl;
explicit GDALMDArrayHS(const std::shared_ptr<GDALMDArray> &poArray)
: m_poImpl(poArray)
{
}
};
struct GDALAttributeHS
{
std::shared_ptr<GDALAttribute> m_poImpl;
explicit GDALAttributeHS(const std::shared_ptr<GDALAttribute> &poAttr)
: m_poImpl(poAttr)
{
}
};
struct GDALDimensionHS
{
std::shared_ptr<GDALDimension> m_poImpl;
explicit GDALDimensionHS(const std::shared_ptr<GDALDimension> &poDim)
: m_poImpl(poDim)
{
}
};
/************************************************************************/
/* GDALExtendedDataTypeCreate() */
/************************************************************************/
/** Return a new GDALExtendedDataType of class GEDTC_NUMERIC.
*
* This is the same as the C++ method GDALExtendedDataType::Create()
*
* The returned handle should be freed with GDALExtendedDataTypeRelease().
*
* @param eType Numeric data type.
*
* @return a new GDALExtendedDataTypeH handle, or nullptr.
*/
GDALExtendedDataTypeH GDALExtendedDataTypeCreate(GDALDataType eType)
{
return new GDALExtendedDataTypeHS(
new GDALExtendedDataType(GDALExtendedDataType::Create(eType)));
}
/************************************************************************/
/* GDALExtendedDataTypeCreateString() */
/************************************************************************/
/** Return a new GDALExtendedDataType of class GEDTC_STRING.
*
* This is the same as the C++ method GDALExtendedDataType::CreateString()
*
* The returned handle should be freed with GDALExtendedDataTypeRelease().
*
* @return a new GDALExtendedDataTypeH handle, or nullptr.
*/
GDALExtendedDataTypeH GDALExtendedDataTypeCreateString(size_t nMaxStringLength)
{
return new GDALExtendedDataTypeHS(new GDALExtendedDataType(
GDALExtendedDataType::CreateString(nMaxStringLength)));
}
/************************************************************************/
/* GDALExtendedDataTypeCreateStringEx() */
/************************************************************************/
/** Return a new GDALExtendedDataType of class GEDTC_STRING.
*
* This is the same as the C++ method GDALExtendedDataType::CreateString()
*
* The returned handle should be freed with GDALExtendedDataTypeRelease().
*
* @return a new GDALExtendedDataTypeH handle, or nullptr.
* @since GDAL 3.4
*/
GDALExtendedDataTypeH
GDALExtendedDataTypeCreateStringEx(size_t nMaxStringLength,
GDALExtendedDataTypeSubType eSubType)
{
return new GDALExtendedDataTypeHS(new GDALExtendedDataType(
GDALExtendedDataType::CreateString(nMaxStringLength, eSubType)));
}
/************************************************************************/
/* GDALExtendedDataTypeCreateCompound() */
/************************************************************************/
/** Return a new GDALExtendedDataType of class GEDTC_COMPOUND.
*
* This is the same as the C++ method GDALExtendedDataType::Create(const
* std::string&, size_t, std::vector<std::unique_ptr<GDALEDTComponent>>&&)
*
* The returned handle should be freed with GDALExtendedDataTypeRelease().
*
* @param pszName Type name.
* @param nTotalSize Total size of the type in bytes.
* Should be large enough to store all components.
* @param nComponents Number of components in comps array.
* @param comps Components.
* @return a new GDALExtendedDataTypeH handle, or nullptr.
*/
GDALExtendedDataTypeH
GDALExtendedDataTypeCreateCompound(const char *pszName, size_t nTotalSize,
size_t nComponents,
const GDALEDTComponentH *comps)
{
std::vector<std::unique_ptr<GDALEDTComponent>> compsCpp;
for (size_t i = 0; i < nComponents; i++)
{
compsCpp.emplace_back(std::unique_ptr<GDALEDTComponent>(
new GDALEDTComponent(*(comps[i]->m_poImpl.get()))));
}
auto dt = GDALExtendedDataType::Create(pszName ? pszName : "", nTotalSize,
std::move(compsCpp));
if (dt.GetClass() != GEDTC_COMPOUND)
return nullptr;
return new GDALExtendedDataTypeHS(new GDALExtendedDataType(dt));
}
/************************************************************************/
/* GDALExtendedDataTypeRelease() */
/************************************************************************/
/** Release the GDAL in-memory object associated with a GDALExtendedDataTypeH.
*
* Note: when applied on a object coming from a driver, this does not
* destroy the object in the file, database, etc...
*/
void GDALExtendedDataTypeRelease(GDALExtendedDataTypeH hEDT)
{
delete hEDT;
}
/************************************************************************/
/* GDALExtendedDataTypeGetName() */
/************************************************************************/
/** Return type name.
*
* This is the same as the C++ method GDALExtendedDataType::GetName()
*/
const char *GDALExtendedDataTypeGetName(GDALExtendedDataTypeH hEDT)
{
VALIDATE_POINTER1(hEDT, __func__, "");
return hEDT->m_poImpl->GetName().c_str();
}
/************************************************************************/
/* GDALExtendedDataTypeGetClass() */
/************************************************************************/
/** Return type class.
*
* This is the same as the C++ method GDALExtendedDataType::GetClass()
*/
GDALExtendedDataTypeClass
GDALExtendedDataTypeGetClass(GDALExtendedDataTypeH hEDT)
{
VALIDATE_POINTER1(hEDT, __func__, GEDTC_NUMERIC);
return hEDT->m_poImpl->GetClass();
}
/************************************************************************/
/* GDALExtendedDataTypeGetNumericDataType() */
/************************************************************************/
/** Return numeric data type (only valid when GetClass() == GEDTC_NUMERIC)
*
* This is the same as the C++ method GDALExtendedDataType::GetNumericDataType()
*/
GDALDataType GDALExtendedDataTypeGetNumericDataType(GDALExtendedDataTypeH hEDT)
{
VALIDATE_POINTER1(hEDT, __func__, GDT_Unknown);
return hEDT->m_poImpl->GetNumericDataType();
}
/************************************************************************/
/* GDALExtendedDataTypeGetSize() */
/************************************************************************/
/** Return data type size in bytes.
*
* This is the same as the C++ method GDALExtendedDataType::GetSize()
*/
size_t GDALExtendedDataTypeGetSize(GDALExtendedDataTypeH hEDT)
{
VALIDATE_POINTER1(hEDT, __func__, 0);
return hEDT->m_poImpl->GetSize();
}
/************************************************************************/
/* GDALExtendedDataTypeGetMaxStringLength() */
/************************************************************************/
/** Return the maximum length of a string in bytes.
*
* 0 indicates unknown/unlimited string.
*
* This is the same as the C++ method GDALExtendedDataType::GetMaxStringLength()
*/
size_t GDALExtendedDataTypeGetMaxStringLength(GDALExtendedDataTypeH hEDT)
{
VALIDATE_POINTER1(hEDT, __func__, 0);
return hEDT->m_poImpl->GetMaxStringLength();
}
/************************************************************************/
/* GDALExtendedDataTypeCanConvertTo() */
/************************************************************************/
/** Return whether this data type can be converted to the other one.
*
* This is the same as the C function GDALExtendedDataType::CanConvertTo()
*
* @param hSourceEDT Source data type for the conversion being considered.
* @param hTargetEDT Target data type for the conversion being considered.
* @return TRUE if hSourceEDT can be convert to hTargetEDT. FALSE otherwise.
*/
int GDALExtendedDataTypeCanConvertTo(GDALExtendedDataTypeH hSourceEDT,
GDALExtendedDataTypeH hTargetEDT)
{
VALIDATE_POINTER1(hSourceEDT, __func__, FALSE);
VALIDATE_POINTER1(hTargetEDT, __func__, FALSE);
return hSourceEDT->m_poImpl->CanConvertTo(*(hTargetEDT->m_poImpl));
}
/************************************************************************/
/* GDALExtendedDataTypeEquals() */
/************************************************************************/
/** Return whether this data type is equal to another one.
*
* This is the same as the C++ method GDALExtendedDataType::operator==()
*
* @param hFirstEDT First data type.
* @param hSecondEDT Second data type.
* @return TRUE if they are equal. FALSE otherwise.
*/
int GDALExtendedDataTypeEquals(GDALExtendedDataTypeH hFirstEDT,
GDALExtendedDataTypeH hSecondEDT)
{
VALIDATE_POINTER1(hFirstEDT, __func__, FALSE);
VALIDATE_POINTER1(hSecondEDT, __func__, FALSE);
return *(hFirstEDT->m_poImpl) == *(hSecondEDT->m_poImpl);
}
/************************************************************************/
/* GDALExtendedDataTypeGetSubType() */
/************************************************************************/
/** Return the subtype of a type.
*
* This is the same as the C++ method GDALExtendedDataType::GetSubType()
*
* @param hEDT Data type.
* @return subtype.
* @since 3.4
*/
GDALExtendedDataTypeSubType
GDALExtendedDataTypeGetSubType(GDALExtendedDataTypeH hEDT)
{
VALIDATE_POINTER1(hEDT, __func__, GEDTST_NONE);
return hEDT->m_poImpl->GetSubType();
}
/************************************************************************/
/* GDALExtendedDataTypeGetComponents() */
/************************************************************************/
/** Return the components of the data type (only valid when GetClass() ==
* GEDTC_COMPOUND)
*
* The returned array and its content must be freed with
* GDALExtendedDataTypeFreeComponents(). If only the array itself needs to be
* freed, CPLFree() should be called (and GDALExtendedDataTypeRelease() on
* individual array members).
*
* This is the same as the C++ method GDALExtendedDataType::GetComponents()
*
* @param hEDT Data type
* @param pnCount Pointer to the number of values returned. Must NOT be NULL.
* @return an array of *pnCount components.
*/
GDALEDTComponentH *GDALExtendedDataTypeGetComponents(GDALExtendedDataTypeH hEDT,
size_t *pnCount)
{
VALIDATE_POINTER1(hEDT, __func__, nullptr);
VALIDATE_POINTER1(pnCount, __func__, nullptr);
const auto &components = hEDT->m_poImpl->GetComponents();
auto ret = static_cast<GDALEDTComponentH *>(
CPLMalloc(sizeof(GDALEDTComponentH) * components.size()));
for (size_t i = 0; i < components.size(); i++)
{
ret[i] = new GDALEDTComponentHS(*components[i].get());
}
*pnCount = components.size();
return ret;
}
/************************************************************************/
/* GDALExtendedDataTypeFreeComponents() */
/************************************************************************/
/** Free the return of GDALExtendedDataTypeGetComponents().
*
* @param components return value of GDALExtendedDataTypeGetComponents()
* @param nCount *pnCount value returned by GDALExtendedDataTypeGetComponents()
*/
void GDALExtendedDataTypeFreeComponents(GDALEDTComponentH *components,
size_t nCount)
{
for (size_t i = 0; i < nCount; i++)
{
delete components[i];
}
CPLFree(components);
}
/************************************************************************/
/* GDALEDTComponentCreate() */
/************************************************************************/
/** Create a new GDALEDTComponent.
*
* The returned value must be freed with GDALEDTComponentRelease().
*
* This is the same as the C++ constructor GDALEDTComponent::GDALEDTComponent().
*/
GDALEDTComponentH GDALEDTComponentCreate(const char *pszName, size_t nOffset,
GDALExtendedDataTypeH hType)
{
VALIDATE_POINTER1(pszName, __func__, nullptr);
VALIDATE_POINTER1(hType, __func__, nullptr);
return new GDALEDTComponentHS(
GDALEDTComponent(pszName, nOffset, *(hType->m_poImpl.get())));
}
/************************************************************************/
/* GDALEDTComponentRelease() */
/************************************************************************/
/** Release the GDAL in-memory object associated with a GDALEDTComponentH.
*
* Note: when applied on a object coming from a driver, this does not
* destroy the object in the file, database, etc...
*/
void GDALEDTComponentRelease(GDALEDTComponentH hComp)
{
delete hComp;
}
/************************************************************************/
/* GDALEDTComponentGetName() */
/************************************************************************/
/** Return the name.
*
* The returned pointer is valid until hComp is released.
*
* This is the same as the C++ method GDALEDTComponent::GetName().
*/
const char *GDALEDTComponentGetName(GDALEDTComponentH hComp)
{
VALIDATE_POINTER1(hComp, __func__, nullptr);
return hComp->m_poImpl->GetName().c_str();
}
/************************************************************************/
/* GDALEDTComponentGetOffset() */
/************************************************************************/
/** Return the offset (in bytes) of the component in the compound data type.
*
* This is the same as the C++ method GDALEDTComponent::GetOffset().
*/
size_t GDALEDTComponentGetOffset(GDALEDTComponentH hComp)
{
VALIDATE_POINTER1(hComp, __func__, 0);
return hComp->m_poImpl->GetOffset();
}
/************************************************************************/
/* GDALEDTComponentGetType() */
/************************************************************************/
/** Return the data type of the component.
*
* This is the same as the C++ method GDALEDTComponent::GetType().
*/
GDALExtendedDataTypeH GDALEDTComponentGetType(GDALEDTComponentH hComp)
{
VALIDATE_POINTER1(hComp, __func__, nullptr);
return new GDALExtendedDataTypeHS(
new GDALExtendedDataType(hComp->m_poImpl->GetType()));
}
/************************************************************************/
/* GDALGroupRelease() */
/************************************************************************/
/** Release the GDAL in-memory object associated with a GDALGroupH.
*
* Note: when applied on a object coming from a driver, this does not
* destroy the object in the file, database, etc...
*/
void GDALGroupRelease(GDALGroupH hGroup)
{
delete hGroup;
}
/************************************************************************/
/* GDALGroupGetName() */
/************************************************************************/
/** Return the name of the group.
*
* The returned pointer is valid until hGroup is released.
*
* This is the same as the C++ method GDALGroup::GetName().
*/
const char *GDALGroupGetName(GDALGroupH hGroup)
{
VALIDATE_POINTER1(hGroup, __func__, nullptr);
return hGroup->m_poImpl->GetName().c_str();
}
/************************************************************************/
/* GDALGroupGetFullName() */
/************************************************************************/
/** Return the full name of the group.
*
* The returned pointer is valid until hGroup is released.
*
* This is the same as the C++ method GDALGroup::GetFullName().
*/
const char *GDALGroupGetFullName(GDALGroupH hGroup)
{
VALIDATE_POINTER1(hGroup, __func__, nullptr);
return hGroup->m_poImpl->GetFullName().c_str();
}
/************************************************************************/
/* GDALGroupGetMDArrayNames() */
/************************************************************************/
/** Return the list of multidimensional array names contained in this group.
*
* This is the same as the C++ method GDALGroup::GetGroupNames().
*
* @return the array names, to be freed with CSLDestroy()
*/
char **GDALGroupGetMDArrayNames(GDALGroupH hGroup, CSLConstList papszOptions)
{
VALIDATE_POINTER1(hGroup, __func__, nullptr);
auto names = hGroup->m_poImpl->GetMDArrayNames(papszOptions);
CPLStringList res;
for (const auto &name : names)
{
res.AddString(name.c_str());
}
return res.StealList();
}
/************************************************************************/
/* GDALGroupOpenMDArray() */
/************************************************************************/
/** Open and return a multidimensional array.
*
* This is the same as the C++ method GDALGroup::OpenMDArray().
*
* @return the array, to be freed with GDALMDArrayRelease(), or nullptr.
*/
GDALMDArrayH GDALGroupOpenMDArray(GDALGroupH hGroup, const char *pszMDArrayName,
CSLConstList papszOptions)
{
VALIDATE_POINTER1(hGroup, __func__, nullptr);
VALIDATE_POINTER1(pszMDArrayName, __func__, nullptr);
auto array = hGroup->m_poImpl->OpenMDArray(std::string(pszMDArrayName),
papszOptions);
if (!array)
return nullptr;
return new GDALMDArrayHS(array);
}
/************************************************************************/
/* GDALGroupOpenMDArrayFromFullname() */
/************************************************************************/
/** Open and return a multidimensional array from its fully qualified name.
*
* This is the same as the C++ method GDALGroup::OpenMDArrayFromFullname().
*
* @return the array, to be freed with GDALMDArrayRelease(), or nullptr.
*
* @since GDAL 3.2
*/
GDALMDArrayH GDALGroupOpenMDArrayFromFullname(GDALGroupH hGroup,
const char *pszFullname,
CSLConstList papszOptions)
{
VALIDATE_POINTER1(hGroup, __func__, nullptr);
VALIDATE_POINTER1(pszFullname, __func__, nullptr);
auto array = hGroup->m_poImpl->OpenMDArrayFromFullname(
std::string(pszFullname), papszOptions);
if (!array)
return nullptr;
return new GDALMDArrayHS(array);
}
/************************************************************************/
/* GDALGroupResolveMDArray() */
/************************************************************************/
/** Locate an array in a group and its subgroups by name.
*
* See GDALGroup::ResolveMDArray() for description of the behavior.
* @since GDAL 3.2
*/
GDALMDArrayH GDALGroupResolveMDArray(GDALGroupH hGroup, const char *pszName,
const char *pszStartingPoint,
CSLConstList papszOptions)
{
VALIDATE_POINTER1(hGroup, __func__, nullptr);
VALIDATE_POINTER1(pszName, __func__, nullptr);
VALIDATE_POINTER1(pszStartingPoint, __func__, nullptr);
auto array = hGroup->m_poImpl->ResolveMDArray(
std::string(pszName), std::string(pszStartingPoint), papszOptions);
if (!array)
return nullptr;
return new GDALMDArrayHS(array);
}
/************************************************************************/
/* GDALGroupGetGroupNames() */
/************************************************************************/
/** Return the list of sub-groups contained in this group.
*
* This is the same as the C++ method GDALGroup::GetGroupNames().
*
* @return the group names, to be freed with CSLDestroy()
*/
char **GDALGroupGetGroupNames(GDALGroupH hGroup, CSLConstList papszOptions)
{
VALIDATE_POINTER1(hGroup, __func__, nullptr);
auto names = hGroup->m_poImpl->GetGroupNames(papszOptions);
CPLStringList res;
for (const auto &name : names)
{
res.AddString(name.c_str());
}
return res.StealList();
}
/************************************************************************/
/* GDALGroupOpenGroup() */
/************************************************************************/
/** Open and return a sub-group.
*
* This is the same as the C++ method GDALGroup::OpenGroup().
*
* @return the sub-group, to be freed with GDALGroupRelease(), or nullptr.
*/
GDALGroupH GDALGroupOpenGroup(GDALGroupH hGroup, const char *pszSubGroupName,
CSLConstList papszOptions)
{
VALIDATE_POINTER1(hGroup, __func__, nullptr);
VALIDATE_POINTER1(pszSubGroupName, __func__, nullptr);
auto subGroup =
hGroup->m_poImpl->OpenGroup(std::string(pszSubGroupName), papszOptions);
if (!subGroup)
return nullptr;
return new GDALGroupHS(subGroup);
}
/************************************************************************/
/* GDALGroupGetVectorLayerNames() */
/************************************************************************/
/** Return the list of layer names contained in this group.
*
* This is the same as the C++ method GDALGroup::GetVectorLayerNames().
*
* @return the group names, to be freed with CSLDestroy()
* @since 3.4
*/
char **GDALGroupGetVectorLayerNames(GDALGroupH hGroup,
CSLConstList papszOptions)
{
VALIDATE_POINTER1(hGroup, __func__, nullptr);
auto names = hGroup->m_poImpl->GetVectorLayerNames(papszOptions);
CPLStringList res;
for (const auto &name : names)
{
res.AddString(name.c_str());
}
return res.StealList();
}
/************************************************************************/
/* GDALGroupOpenVectorLayer() */
/************************************************************************/
/** Open and return a vector layer.
*
* This is the same as the C++ method GDALGroup::OpenVectorLayer().
*
* Note that the vector layer is owned by its parent GDALDatasetH, and thus
* the returned handled if only valid while the parent GDALDatasetH is kept
* opened.
*
* @return the vector layer, or nullptr.
* @since 3.4
*/
OGRLayerH GDALGroupOpenVectorLayer(GDALGroupH hGroup,
const char *pszVectorLayerName,
CSLConstList papszOptions)
{
VALIDATE_POINTER1(hGroup, __func__, nullptr);
VALIDATE_POINTER1(pszVectorLayerName, __func__, nullptr);
return OGRLayer::ToHandle(hGroup->m_poImpl->OpenVectorLayer(
std::string(pszVectorLayerName), papszOptions));
}
/************************************************************************/
/* GDALGroupOpenMDArrayFromFullname() */
/************************************************************************/
/** Open and return a sub-group from its fully qualified name.
*
* This is the same as the C++ method GDALGroup::OpenGroupFromFullname().
*
* @return the sub-group, to be freed with GDALGroupRelease(), or nullptr.
*
* @since GDAL 3.2
*/
GDALGroupH GDALGroupOpenGroupFromFullname(GDALGroupH hGroup,
const char *pszFullname,
CSLConstList papszOptions)
{
VALIDATE_POINTER1(hGroup, __func__, nullptr);
VALIDATE_POINTER1(pszFullname, __func__, nullptr);
auto subGroup = hGroup->m_poImpl->OpenGroupFromFullname(
std::string(pszFullname), papszOptions);
if (!subGroup)
return nullptr;
return new GDALGroupHS(subGroup);
}
/************************************************************************/
/* GDALGroupGetDimensions() */
/************************************************************************/
/** Return the list of dimensions contained in this group and used by its
* arrays.
*
* The returned array must be freed with GDALReleaseDimensions(). If only the
* array itself needs to be freed, CPLFree() should be called (and
* GDALDimensionRelease() on individual array members).
*
* This is the same as the C++ method GDALGroup::GetDimensions().
*
* @param hGroup Group.
* @param pnCount Pointer to the number of values returned. Must NOT be NULL.
* @param papszOptions Driver specific options determining how dimensions
* should be retrieved. Pass nullptr for default behavior.
*
* @return an array of *pnCount dimensions.
*/
GDALDimensionH *GDALGroupGetDimensions(GDALGroupH hGroup, size_t *pnCount,
CSLConstList papszOptions)
{
VALIDATE_POINTER1(hGroup, __func__, nullptr);
VALIDATE_POINTER1(pnCount, __func__, nullptr);
auto dims = hGroup->m_poImpl->GetDimensions(papszOptions);
auto ret = static_cast<GDALDimensionH *>(
CPLMalloc(sizeof(GDALDimensionH) * dims.size()));
for (size_t i = 0; i < dims.size(); i++)
{
ret[i] = new GDALDimensionHS(dims[i]);
}
*pnCount = dims.size();
return ret;
}
/************************************************************************/
/* GDALGroupGetAttribute() */
/************************************************************************/
/** Return an attribute by its name.
*
* This is the same as the C++ method GDALIHasAttribute::GetAttribute()
*
* The returned attribute must be freed with GDALAttributeRelease().
*/
GDALAttributeH GDALGroupGetAttribute(GDALGroupH hGroup, const char *pszName)
{
VALIDATE_POINTER1(hGroup, __func__, nullptr);
VALIDATE_POINTER1(pszName, __func__, nullptr);
auto attr = hGroup->m_poImpl->GetAttribute(std::string(pszName));
if (attr)
return new GDALAttributeHS(attr);
return nullptr;
}
/************************************************************************/
/* GDALGroupGetAttributes() */
/************************************************************************/
/** Return the list of attributes contained in this group.
*
* The returned array must be freed with GDALReleaseAttributes(). If only the
* array itself needs to be freed, CPLFree() should be called (and
* GDALAttributeRelease() on individual array members).
*
* This is the same as the C++ method GDALGroup::GetAttributes().
*
* @param hGroup Group.
* @param pnCount Pointer to the number of values returned. Must NOT be NULL.
* @param papszOptions Driver specific options determining how attributes
* should be retrieved. Pass nullptr for default behavior.
*
* @return an array of *pnCount attributes.
*/
GDALAttributeH *GDALGroupGetAttributes(GDALGroupH hGroup, size_t *pnCount,
CSLConstList papszOptions)
{
VALIDATE_POINTER1(hGroup, __func__, nullptr);
VALIDATE_POINTER1(pnCount, __func__, nullptr);
auto attrs = hGroup->m_poImpl->GetAttributes(papszOptions);
auto ret = static_cast<GDALAttributeH *>(
CPLMalloc(sizeof(GDALAttributeH) * attrs.size()));
for (size_t i = 0; i < attrs.size(); i++)
{
ret[i] = new GDALAttributeHS(attrs[i]);
}
*pnCount = attrs.size();
return ret;
}
/************************************************************************/
/* GDALGroupGetStructuralInfo() */
/************************************************************************/
/** Return structural information on the group.
*
* This may be the compression, etc..
*
* The return value should not be freed and is valid until GDALGroup is
* released or this function called again.
*
* This is the same as the C++ method GDALGroup::GetStructuralInfo().
*/
CSLConstList GDALGroupGetStructuralInfo(GDALGroupH hGroup)
{
VALIDATE_POINTER1(hGroup, __func__, nullptr);
return hGroup->m_poImpl->GetStructuralInfo();
}
/************************************************************************/
/* GDALReleaseAttributes() */
/************************************************************************/
/** Free the return of GDALGroupGetAttributes() or GDALMDArrayGetAttributes()
*
* @param attributes return pointer of above methods
* @param nCount *pnCount value returned by above methods
*/
void GDALReleaseAttributes(GDALAttributeH *attributes, size_t nCount)
{
for (size_t i = 0; i < nCount; i++)
{
delete attributes[i];
}
CPLFree(attributes);
}
/************************************************************************/
/* GDALGroupCreateGroup() */
/************************************************************************/
/** Create a sub-group within a group.
*
* This is the same as the C++ method GDALGroup::CreateGroup().
*
* @return the sub-group, to be freed with GDALGroupRelease(), or nullptr.
*/
GDALGroupH GDALGroupCreateGroup(GDALGroupH hGroup, const char *pszSubGroupName,
CSLConstList papszOptions)
{
VALIDATE_POINTER1(hGroup, __func__, nullptr);
VALIDATE_POINTER1(pszSubGroupName, __func__, nullptr);
auto ret = hGroup->m_poImpl->CreateGroup(std::string(pszSubGroupName),
papszOptions);
if (!ret)
return nullptr;
return new GDALGroupHS(ret);
}
/************************************************************************/
/* GDALGroupCreateDimension() */
/************************************************************************/
/** Create a dimension within a group.
*
* This is the same as the C++ method GDALGroup::CreateDimension().
*
* @return the dimension, to be freed with GDALDimensionRelease(), or nullptr.
*/
GDALDimensionH GDALGroupCreateDimension(GDALGroupH hGroup, const char *pszName,
const char *pszType,
const char *pszDirection, GUInt64 nSize,
CSLConstList papszOptions)
{
VALIDATE_POINTER1(hGroup, __func__, nullptr);
VALIDATE_POINTER1(pszName, __func__, nullptr);
auto ret = hGroup->m_poImpl->CreateDimension(
std::string(pszName), std::string(pszType ? pszType : ""),
std::string(pszDirection ? pszDirection : ""), nSize, papszOptions);
if (!ret)
return nullptr;
return new GDALDimensionHS(ret);
}
/************************************************************************/
/* GDALGroupCreateMDArray() */
/************************************************************************/
/** Create a multidimensional array within a group.
*
* This is the same as the C++ method GDALGroup::CreateMDArray().
*
* @return the array, to be freed with GDALMDArrayRelease(), or nullptr.
*/
GDALMDArrayH GDALGroupCreateMDArray(GDALGroupH hGroup, const char *pszName,
size_t nDimensions,
GDALDimensionH *pahDimensions,
GDALExtendedDataTypeH hEDT,
CSLConstList papszOptions)
{
VALIDATE_POINTER1(hGroup, __func__, nullptr);
VALIDATE_POINTER1(pszName, __func__, nullptr);
VALIDATE_POINTER1(hEDT, __func__, nullptr);
std::vector<std::shared_ptr<GDALDimension>> dims;
dims.reserve(nDimensions);
for (size_t i = 0; i < nDimensions; i++)
dims.push_back(pahDimensions[i]->m_poImpl);
auto ret = hGroup->m_poImpl->CreateMDArray(std::string(pszName), dims,
*(hEDT->m_poImpl), papszOptions);
if (!ret)
return nullptr;
return new GDALMDArrayHS(ret);
}
/************************************************************************/
/* GDALGroupCreateAttribute() */
/************************************************************************/
/** Create a attribute within a group.
*
* This is the same as the C++ method GDALGroup::CreateAttribute().
*
* @return the attribute, to be freed with GDALAttributeRelease(), or nullptr.
*/
GDALAttributeH GDALGroupCreateAttribute(GDALGroupH hGroup, const char *pszName,
size_t nDimensions,
const GUInt64 *panDimensions,
GDALExtendedDataTypeH hEDT,
CSLConstList papszOptions)
{
VALIDATE_POINTER1(hGroup, __func__, nullptr);
VALIDATE_POINTER1(hEDT, __func__, nullptr);
std::vector<GUInt64> dims;
dims.reserve(nDimensions);
for (size_t i = 0; i < nDimensions; i++)
dims.push_back(panDimensions[i]);
auto ret = hGroup->m_poImpl->CreateAttribute(
std::string(pszName), dims, *(hEDT->m_poImpl), papszOptions);
if (!ret)
return nullptr;
return new GDALAttributeHS(ret);
}
/************************************************************************/
/* GDALMDArrayRelease() */
/************************************************************************/
/** Release the GDAL in-memory object associated with a GDALMDArray.
*
* Note: when applied on a object coming from a driver, this does not
* destroy the object in the file, database, etc...
*/
void GDALMDArrayRelease(GDALMDArrayH hMDArray)
{
delete hMDArray;
}
/************************************************************************/
/* GDALMDArrayGetName() */
/************************************************************************/
/** Return array name.
*
* This is the same as the C++ method GDALMDArray::GetName()
*/
const char *GDALMDArrayGetName(GDALMDArrayH hArray)
{
VALIDATE_POINTER1(hArray, __func__, nullptr);
return hArray->m_poImpl->GetName().c_str();
}
/************************************************************************/
/* GDALMDArrayGetFullName() */
/************************************************************************/
/** Return array full name.
*
* This is the same as the C++ method GDALMDArray::GetFullName()
*/
const char *GDALMDArrayGetFullName(GDALMDArrayH hArray)
{
VALIDATE_POINTER1(hArray, __func__, nullptr);
return hArray->m_poImpl->GetFullName().c_str();
}
/************************************************************************/
/* GDALMDArrayGetName() */
/************************************************************************/
/** Return the total number of values in the array.
*
* This is the same as the C++ method
* GDALAbstractMDArray::GetTotalElementsCount()
*/
GUInt64 GDALMDArrayGetTotalElementsCount(GDALMDArrayH hArray)
{
VALIDATE_POINTER1(hArray, __func__, 0);
return hArray->m_poImpl->GetTotalElementsCount();
}
/************************************************************************/
/* GDALMDArrayGetDimensionCount() */
/************************************************************************/
/** Return the number of dimensions.
*
* This is the same as the C++ method GDALAbstractMDArray::GetDimensionCount()
*/
size_t GDALMDArrayGetDimensionCount(GDALMDArrayH hArray)
{
VALIDATE_POINTER1(hArray, __func__, 0);
return hArray->m_poImpl->GetDimensionCount();
}
/************************************************************************/
/* GDALMDArrayGetDimensions() */
/************************************************************************/
/** Return the dimensions of the array
*
* The returned array must be freed with GDALReleaseDimensions(). If only the
* array itself needs to be freed, CPLFree() should be called (and
* GDALDimensionRelease() on individual array members).
*
* This is the same as the C++ method GDALAbstractMDArray::GetDimensions()
*
* @param hArray Array.
* @param pnCount Pointer to the number of values returned. Must NOT be NULL.
*
* @return an array of *pnCount dimensions.
*/
GDALDimensionH *GDALMDArrayGetDimensions(GDALMDArrayH hArray, size_t *pnCount)
{
VALIDATE_POINTER1(hArray, __func__, nullptr);
VALIDATE_POINTER1(pnCount, __func__, nullptr);
const auto &dims(hArray->m_poImpl->GetDimensions());
auto ret = static_cast<GDALDimensionH *>(
CPLMalloc(sizeof(GDALDimensionH) * dims.size()));
for (size_t i = 0; i < dims.size(); i++)
{
ret[i] = new GDALDimensionHS(dims[i]);
}
*pnCount = dims.size();
return ret;
}
/************************************************************************/
/* GDALReleaseDimensions() */
/************************************************************************/
/** Free the return of GDALGroupGetDimensions() or GDALMDArrayGetDimensions()
*
* @param dims return pointer of above methods
* @param nCount *pnCount value returned by above methods
*/
void GDALReleaseDimensions(GDALDimensionH *dims, size_t nCount)
{
for (size_t i = 0; i < nCount; i++)
{
delete dims[i];
}
CPLFree(dims);
}
/************************************************************************/
/* GDALMDArrayGetDataType() */
/************************************************************************/
/** Return the data type
*
* The return must be freed with GDALExtendedDataTypeRelease().
*/
GDALExtendedDataTypeH GDALMDArrayGetDataType(GDALMDArrayH hArray)
{
VALIDATE_POINTER1(hArray, __func__, nullptr);
return new GDALExtendedDataTypeHS(
new GDALExtendedDataType(hArray->m_poImpl->GetDataType()));
}
/************************************************************************/
/* GDALMDArrayRead() */
/************************************************************************/
/** Read part or totality of a multidimensional array.
*
* This is the same as the C++ method GDALAbstractMDArray::Read()
*
* @return TRUE in case of success.
*/
int GDALMDArrayRead(GDALMDArrayH hArray, const GUInt64 *arrayStartIdx,
const size_t *count, const GInt64 *arrayStep,
const GPtrDiff_t *bufferStride,
GDALExtendedDataTypeH bufferDataType, void *pDstBuffer,
const void *pDstBufferAllocStart,
size_t nDstBufferAllocSize)
{
VALIDATE_POINTER1(hArray, __func__, FALSE);
if ((arrayStartIdx == nullptr || count == nullptr) &&
hArray->m_poImpl->GetDimensionCount() > 0)
{
VALIDATE_POINTER1(arrayStartIdx, __func__, FALSE);
VALIDATE_POINTER1(count, __func__, FALSE);
}
VALIDATE_POINTER1(bufferDataType, __func__, FALSE);
VALIDATE_POINTER1(pDstBuffer, __func__, FALSE);
// coverity[var_deref_model]
return hArray->m_poImpl->Read(arrayStartIdx, count, arrayStep, bufferStride,
*(bufferDataType->m_poImpl), pDstBuffer,
pDstBufferAllocStart, nDstBufferAllocSize);
}
/************************************************************************/
/* GDALMDArrayWrite() */
/************************************************************************/
/** Write part or totality of a multidimensional array.
*
* This is the same as the C++ method GDALAbstractMDArray::Write()
*
* @return TRUE in case of success.
*/
int GDALMDArrayWrite(GDALMDArrayH hArray, const GUInt64 *arrayStartIdx,
const size_t *count, const GInt64 *arrayStep,
const GPtrDiff_t *bufferStride,
GDALExtendedDataTypeH bufferDataType,
const void *pSrcBuffer, const void *pSrcBufferAllocStart,
size_t nSrcBufferAllocSize)
{
VALIDATE_POINTER1(hArray, __func__, FALSE);
if ((arrayStartIdx == nullptr || count == nullptr) &&
hArray->m_poImpl->GetDimensionCount() > 0)
{
VALIDATE_POINTER1(arrayStartIdx, __func__, FALSE);
VALIDATE_POINTER1(count, __func__, FALSE);
}
VALIDATE_POINTER1(bufferDataType, __func__, FALSE);
VALIDATE_POINTER1(pSrcBuffer, __func__, FALSE);
// coverity[var_deref_model]
return hArray->m_poImpl->Write(arrayStartIdx, count, arrayStep,
bufferStride, *(bufferDataType->m_poImpl),
pSrcBuffer, pSrcBufferAllocStart,
nSrcBufferAllocSize);
}
/************************************************************************/
/* GDALMDArrayAdviseRead() */
/************************************************************************/
/** Advise driver of upcoming read requests.
*
* This is the same as the C++ method GDALMDArray::AdviseRead()
*
* @return TRUE in case of success.
*
* @since GDAL 3.2
*/
int GDALMDArrayAdviseRead(GDALMDArrayH hArray, const GUInt64 *arrayStartIdx,
const size_t *count)
{
return GDALMDArrayAdviseReadEx(hArray, arrayStartIdx, count, nullptr);
}
/************************************************************************/
/* GDALMDArrayAdviseReadEx() */
/************************************************************************/
/** Advise driver of upcoming read requests.
*
* This is the same as the C++ method GDALMDArray::AdviseRead()
*
* @return TRUE in case of success.
*
* @since GDAL 3.4
*/
int GDALMDArrayAdviseReadEx(GDALMDArrayH hArray, const GUInt64 *arrayStartIdx,
const size_t *count, CSLConstList papszOptions)
{
VALIDATE_POINTER1(hArray, __func__, FALSE);
// coverity[var_deref_model]
return hArray->m_poImpl->AdviseRead(arrayStartIdx, count, papszOptions);
}
/************************************************************************/
/* GDALMDArrayGetAttribute() */
/************************************************************************/
/** Return an attribute by its name.
*
* This is the same as the C++ method GDALIHasAttribute::GetAttribute()
*
* The returned attribute must be freed with GDALAttributeRelease().
*/
GDALAttributeH GDALMDArrayGetAttribute(GDALMDArrayH hArray, const char *pszName)
{
VALIDATE_POINTER1(hArray, __func__, nullptr);
VALIDATE_POINTER1(pszName, __func__, nullptr);
auto attr = hArray->m_poImpl->GetAttribute(std::string(pszName));
if (attr)
return new GDALAttributeHS(attr);
return nullptr;
}
/************************************************************************/
/* GDALMDArrayGetAttributes() */
/************************************************************************/
/** Return the list of attributes contained in this array.
*
* The returned array must be freed with GDALReleaseAttributes(). If only the
* array itself needs to be freed, CPLFree() should be called (and
* GDALAttributeRelease() on individual array members).
*
* This is the same as the C++ method GDALMDArray::GetAttributes().
*
* @param hArray Array.
* @param pnCount Pointer to the number of values returned. Must NOT be NULL.
* @param papszOptions Driver specific options determining how attributes
* should be retrieved. Pass nullptr for default behavior.
*
* @return an array of *pnCount attributes.
*/
GDALAttributeH *GDALMDArrayGetAttributes(GDALMDArrayH hArray, size_t *pnCount,
CSLConstList papszOptions)
{
VALIDATE_POINTER1(hArray, __func__, nullptr);
VALIDATE_POINTER1(pnCount, __func__, nullptr);
auto attrs = hArray->m_poImpl->GetAttributes(papszOptions);
auto ret = static_cast<GDALAttributeH *>(
CPLMalloc(sizeof(GDALAttributeH) * attrs.size()));
for (size_t i = 0; i < attrs.size(); i++)
{
ret[i] = new GDALAttributeHS(attrs[i]);
}
*pnCount = attrs.size();
return ret;
}
/************************************************************************/
/* GDALMDArrayCreateAttribute() */
/************************************************************************/
/** Create a attribute within an array.
*
* This is the same as the C++ method GDALMDArray::CreateAttribute().
*
* @return the attribute, to be freed with GDALAttributeRelease(), or nullptr.
*/
GDALAttributeH GDALMDArrayCreateAttribute(GDALMDArrayH hArray,
const char *pszName,
size_t nDimensions,
const GUInt64 *panDimensions,
GDALExtendedDataTypeH hEDT,
CSLConstList papszOptions)
{
VALIDATE_POINTER1(hArray, __func__, nullptr);
VALIDATE_POINTER1(pszName, __func__, nullptr);
VALIDATE_POINTER1(hEDT, __func__, nullptr);
std::vector<GUInt64> dims;
dims.reserve(nDimensions);
for (size_t i = 0; i < nDimensions; i++)
dims.push_back(panDimensions[i]);
auto ret = hArray->m_poImpl->CreateAttribute(
std::string(pszName), dims, *(hEDT->m_poImpl), papszOptions);
if (!ret)
return nullptr;
return new GDALAttributeHS(ret);
}
/************************************************************************/
/* GDALMDArrayGetRawNoDataValue() */
/************************************************************************/
/** Return the nodata value as a "raw" value.
*
* The value returned might be nullptr in case of no nodata value. When
* a nodata value is registered, a non-nullptr will be returned whose size in
* bytes is GetDataType().GetSize().
*
* The returned value should not be modified or freed.
*
* This is the same as the ++ method GDALMDArray::GetRawNoDataValue().
*
* @return nullptr or a pointer to GetDataType().GetSize() bytes.
*/
const void *GDALMDArrayGetRawNoDataValue(GDALMDArrayH hArray)
{
VALIDATE_POINTER1(hArray, __func__, nullptr);
return hArray->m_poImpl->GetRawNoDataValue();
}
/************************************************************************/
/* GDALMDArrayGetNoDataValueAsDouble() */
/************************************************************************/
/** Return the nodata value as a double.
*
* The value returned might be nullptr in case of no nodata value. When
* a nodata value is registered, a non-nullptr will be returned whose size in
* bytes is GetDataType().GetSize().
*
* This is the same as the C++ method GDALMDArray::GetNoDataValueAsDouble().
*
* @param hArray Array handle.
* @param pbHasNoDataValue Pointer to a output boolean that will be set to true
* if a nodata value exists and can be converted to double. Might be nullptr.
*
* @return the nodata value as a double. A 0.0 value might also indicate the
* absence of a nodata value or an error in the conversion (*pbHasNoDataValue
* will be set to false then).
*/
double GDALMDArrayGetNoDataValueAsDouble(GDALMDArrayH hArray,
int *pbHasNoDataValue)
{
VALIDATE_POINTER1(hArray, __func__, 0);
bool bHasNodataValue = false;
double ret = hArray->m_poImpl->GetNoDataValueAsDouble(&bHasNodataValue);
if (pbHasNoDataValue)
*pbHasNoDataValue = bHasNodataValue;
return ret;
}
/************************************************************************/
/* GDALMDArrayGetNoDataValueAsInt64() */
/************************************************************************/
/** Return the nodata value as a Int64.
*
* This is the same as the C++ method GDALMDArray::GetNoDataValueAsInt64().
*
* @param hArray Array handle.
* @param pbHasNoDataValue Pointer to a output boolean that will be set to true
* if a nodata value exists and can be converted to Int64. Might be nullptr.
*
* @return the nodata value as a Int64.
* @since GDAL 3.5
*/
int64_t GDALMDArrayGetNoDataValueAsInt64(GDALMDArrayH hArray,
int *pbHasNoDataValue)
{
VALIDATE_POINTER1(hArray, __func__, 0);
bool bHasNodataValue = false;
const auto ret = hArray->m_poImpl->GetNoDataValueAsInt64(&bHasNodataValue);
if (pbHasNoDataValue)
*pbHasNoDataValue = bHasNodataValue;
return ret;
}
/************************************************************************/
/* GDALMDArrayGetNoDataValueAsUInt64() */
/************************************************************************/
/** Return the nodata value as a UInt64.
*
* This is the same as the C++ method GDALMDArray::GetNoDataValueAsInt64().
*
* @param hArray Array handle.
* @param pbHasNoDataValue Pointer to a output boolean that will be set to true
* if a nodata value exists and can be converted to UInt64. Might be nullptr.
*
* @return the nodata value as a UInt64.
* @since GDAL 3.5
*/
uint64_t GDALMDArrayGetNoDataValueAsUInt64(GDALMDArrayH hArray,
int *pbHasNoDataValue)
{
VALIDATE_POINTER1(hArray, __func__, 0);
bool bHasNodataValue = false;
const auto ret = hArray->m_poImpl->GetNoDataValueAsUInt64(&bHasNodataValue);
if (pbHasNoDataValue)
*pbHasNoDataValue = bHasNodataValue;
return ret;
}
/************************************************************************/
/* GDALMDArraySetRawNoDataValue() */
/************************************************************************/
/** Set the nodata value as a "raw" value.
*
* This is the same as the C++ method GDALMDArray::SetRawNoDataValue(const
* void*).
*
* @return TRUE in case of success.
*/
int GDALMDArraySetRawNoDataValue(GDALMDArrayH hArray, const void *pNoData)
{
VALIDATE_POINTER1(hArray, __func__, FALSE);
return hArray->m_poImpl->SetRawNoDataValue(pNoData);
}
/************************************************************************/
/* GDALMDArraySetNoDataValueAsDouble() */
/************************************************************************/
/** Set the nodata value as a double.
*
* If the natural data type of the attribute/array is not double, type
* conversion will occur to the type returned by GetDataType().
*
* This is the same as the C++ method GDALMDArray::SetNoDataValue(double).
*
* @return TRUE in case of success.
*/
int GDALMDArraySetNoDataValueAsDouble(GDALMDArrayH hArray, double dfNoDataValue)
{
VALIDATE_POINTER1(hArray, __func__, FALSE);
return hArray->m_poImpl->SetNoDataValue(dfNoDataValue);
}
/************************************************************************/
/* GDALMDArraySetNoDataValueAsInt64() */
/************************************************************************/
/** Set the nodata value as a Int64.
*
* If the natural data type of the attribute/array is not Int64, type conversion
* will occur to the type returned by GetDataType().
*
* This is the same as the C++ method GDALMDArray::SetNoDataValue(int64_t).
*
* @return TRUE in case of success.
* @since GDAL 3.5
*/
int GDALMDArraySetNoDataValueAsInt64(GDALMDArrayH hArray, int64_t nNoDataValue)
{
VALIDATE_POINTER1(hArray, __func__, FALSE);
return hArray->m_poImpl->SetNoDataValue(nNoDataValue);
}
/************************************************************************/
/* GDALMDArraySetNoDataValueAsUInt64() */
/************************************************************************/
/** Set the nodata value as a UInt64.
*
* If the natural data type of the attribute/array is not UInt64, type
* conversion will occur to the type returned by GetDataType().
*
* This is the same as the C++ method GDALMDArray::SetNoDataValue(uint64_t).
*
* @return TRUE in case of success.
* @since GDAL 3.5
*/
int GDALMDArraySetNoDataValueAsUInt64(GDALMDArrayH hArray,
uint64_t nNoDataValue)
{
VALIDATE_POINTER1(hArray, __func__, FALSE);
return hArray->m_poImpl->SetNoDataValue(nNoDataValue);
}
/************************************************************************/
/* GDALMDArraySetScale() */
/************************************************************************/
/** Set the scale value to apply to raw values.
*
* unscaled_value = raw_value * GetScale() + GetOffset()
*
* This is the same as the C++ method GDALMDArray::SetScale().
*
* @return TRUE in case of success.
*/
int GDALMDArraySetScale(GDALMDArrayH hArray, double dfScale)
{
VALIDATE_POINTER1(hArray, __func__, FALSE);
return hArray->m_poImpl->SetScale(dfScale);
}
/************************************************************************/
/* GDALMDArraySetScaleEx() */
/************************************************************************/
/** Set the scale value to apply to raw values.
*
* unscaled_value = raw_value * GetScale() + GetOffset()
*
* This is the same as the C++ method GDALMDArray::SetScale().
*
* @return TRUE in case of success.
* @since GDAL 3.3
*/
int GDALMDArraySetScaleEx(GDALMDArrayH hArray, double dfScale,
GDALDataType eStorageType)
{
VALIDATE_POINTER1(hArray, __func__, FALSE);
return hArray->m_poImpl->SetScale(dfScale, eStorageType);
}
/************************************************************************/
/* GDALMDArraySetOffset() */
/************************************************************************/
/** Set the scale value to apply to raw values.
*
* unscaled_value = raw_value * GetScale() + GetOffset()
*
* This is the same as the C++ method GDALMDArray::SetOffset().
*
* @return TRUE in case of success.
*/
int GDALMDArraySetOffset(GDALMDArrayH hArray, double dfOffset)
{
VALIDATE_POINTER1(hArray, __func__, FALSE);
return hArray->m_poImpl->SetOffset(dfOffset);
}
/************************************************************************/
/* GDALMDArraySetOffsetEx() */
/************************************************************************/
/** Set the scale value to apply to raw values.
*
* unscaled_value = raw_value * GetOffset() + GetOffset()
*
* This is the same as the C++ method GDALMDArray::SetOffset().
*
* @return TRUE in case of success.
* @since GDAL 3.3
*/
int GDALMDArraySetOffsetEx(GDALMDArrayH hArray, double dfOffset,
GDALDataType eStorageType)
{
VALIDATE_POINTER1(hArray, __func__, FALSE);
return hArray->m_poImpl->SetOffset(dfOffset, eStorageType);
}
/************************************************************************/
/* GDALMDArrayGetScale() */
/************************************************************************/
/** Get the scale value to apply to raw values.
*
* unscaled_value = raw_value * GetScale() + GetOffset()
*
* This is the same as the C++ method GDALMDArray::GetScale().
*
* @return the scale value
*/
double GDALMDArrayGetScale(GDALMDArrayH hArray, int *pbHasValue)
{
VALIDATE_POINTER1(hArray, __func__, 0.0);
bool bHasValue = false;
double dfRet = hArray->m_poImpl->GetScale(&bHasValue);
if (pbHasValue)
*pbHasValue = bHasValue;
return dfRet;
}
/************************************************************************/
/* GDALMDArrayGetScaleEx() */
/************************************************************************/
/** Get the scale value to apply to raw values.
*
* unscaled_value = raw_value * GetScale() + GetScale()
*
* This is the same as the C++ method GDALMDArray::GetScale().
*
* @return the scale value
* @since GDAL 3.3
*/
double GDALMDArrayGetScaleEx(GDALMDArrayH hArray, int *pbHasValue,
GDALDataType *peStorageType)
{
VALIDATE_POINTER1(hArray, __func__, 0.0);
bool bHasValue = false;
double dfRet = hArray->m_poImpl->GetScale(&bHasValue, peStorageType);
if (pbHasValue)
*pbHasValue = bHasValue;
return dfRet;
}
/************************************************************************/
/* GDALMDArrayGetOffset() */
/************************************************************************/
/** Get the scale value to apply to raw values.
*
* unscaled_value = raw_value * GetScale() + GetOffset()
*
* This is the same as the C++ method GDALMDArray::GetOffset().
*
* @return the scale value
*/
double GDALMDArrayGetOffset(GDALMDArrayH hArray, int *pbHasValue)
{
VALIDATE_POINTER1(hArray, __func__, 0.0);
bool bHasValue = false;
double dfRet = hArray->m_poImpl->GetOffset(&bHasValue);
if (pbHasValue)
*pbHasValue = bHasValue;
return dfRet;
}
/************************************************************************/
/* GDALMDArrayGetOffsetEx() */
/************************************************************************/
/** Get the scale value to apply to raw values.
*
* unscaled_value = raw_value * GetScale() + GetOffset()
*
* This is the same as the C++ method GDALMDArray::GetOffset().
*
* @return the scale value
* @since GDAL 3.3
*/
double GDALMDArrayGetOffsetEx(GDALMDArrayH hArray, int *pbHasValue,
GDALDataType *peStorageType)
{
VALIDATE_POINTER1(hArray, __func__, 0.0);
bool bHasValue = false;
double dfRet = hArray->m_poImpl->GetOffset(&bHasValue, peStorageType);
if (pbHasValue)
*pbHasValue = bHasValue;
return dfRet;
}
/************************************************************************/
/* GDALMDArrayGetBlockSize() */
/************************************************************************/
/** Return the "natural" block size of the array along all dimensions.
*
* Some drivers might organize the array in tiles/blocks and reading/writing
* aligned on those tile/block boundaries will be more efficient.
*
* The returned number of elements in the vector is the same as
* GetDimensionCount(). A value of 0 should be interpreted as no hint regarding
* the natural block size along the considered dimension.
* "Flat" arrays will typically return a vector of values set to 0.
*
* The default implementation will return a vector of values set to 0.
*
* This method is used by GetProcessingChunkSize().
*
* Pedantic note: the returned type is GUInt64, so in the highly unlikeley
* theoretical case of a 32-bit platform, this might exceed its size_t
* allocation capabilities.
*
* This is the same as the C++ method GDALAbstractMDArray::GetBlockSize().
*
* @return the block size, in number of elements along each dimension.
*/
GUInt64 *GDALMDArrayGetBlockSize(GDALMDArrayH hArray, size_t *pnCount)
{
VALIDATE_POINTER1(hArray, __func__, nullptr);
VALIDATE_POINTER1(pnCount, __func__, nullptr);
auto res = hArray->m_poImpl->GetBlockSize();
auto ret = static_cast<GUInt64 *>(CPLMalloc(sizeof(GUInt64) * res.size()));
for (size_t i = 0; i < res.size(); i++)
{
ret[i] = res[i];
}
*pnCount = res.size();
return ret;
}
/***********************************************************************/
/* GDALMDArrayGetProcessingChunkSize() */
/************************************************************************/
/** \brief Return an optimal chunk size for read/write operations, given the
* natural block size and memory constraints specified.
*
* This method will use GetBlockSize() to define a chunk whose dimensions are
* multiple of those returned by GetBlockSize() (unless the block define by
* GetBlockSize() is larger than nMaxChunkMemory, in which case it will be
* returned by this method).
*
* This is the same as the C++ method
* GDALAbstractMDArray::GetProcessingChunkSize().
*
* @param hArray Array.
* @param pnCount Pointer to the number of values returned. Must NOT be NULL.
* @param nMaxChunkMemory Maximum amount of memory, in bytes, to use for the
* chunk.
*
* @return the chunk size, in number of elements along each dimension.
*/
size_t *GDALMDArrayGetProcessingChunkSize(GDALMDArrayH hArray, size_t *pnCount,
size_t nMaxChunkMemory)
{
VALIDATE_POINTER1(hArray, __func__, nullptr);
VALIDATE_POINTER1(pnCount, __func__, nullptr);
auto res = hArray->m_poImpl->GetProcessingChunkSize(nMaxChunkMemory);
auto ret = static_cast<size_t *>(CPLMalloc(sizeof(size_t) * res.size()));
for (size_t i = 0; i < res.size(); i++)
{
ret[i] = res[i];
}
*pnCount = res.size();
return ret;
}
/************************************************************************/
/* GDALMDArrayGetStructuralInfo() */
/************************************************************************/
/** Return structural information on the array.
*
* This may be the compression, etc..
*
* The return value should not be freed and is valid until GDALMDArray is
* released or this function called again.
*
* This is the same as the C++ method GDALMDArray::GetStructuralInfo().
*/
CSLConstList GDALMDArrayGetStructuralInfo(GDALMDArrayH hArray)
{
VALIDATE_POINTER1(hArray, __func__, nullptr);
return hArray->m_poImpl->GetStructuralInfo();
}
/************************************************************************/
/* GDALMDArrayGetView() */
/************************************************************************/
/** Return a view of the array using slicing or field access.
*
* The returned object should be released with GDALMDArrayRelease().
*
* This is the same as the C++ method GDALMDArray::GetView().
*/
GDALMDArrayH GDALMDArrayGetView(GDALMDArrayH hArray, const char *pszViewExpr)
{
VALIDATE_POINTER1(hArray, __func__, nullptr);
VALIDATE_POINTER1(pszViewExpr, __func__, nullptr);
auto sliced = hArray->m_poImpl->GetView(std::string(pszViewExpr));
if (!sliced)
return nullptr;
return new GDALMDArrayHS(sliced);
}
/************************************************************************/
/* GDALMDArrayTranspose() */
/************************************************************************/
/** Return a view of the array whose axis have been reordered.
*
* The returned object should be released with GDALMDArrayRelease().
*
* This is the same as the C++ method GDALMDArray::Transpose().
*/
GDALMDArrayH GDALMDArrayTranspose(GDALMDArrayH hArray, size_t nNewAxisCount,
const int *panMapNewAxisToOldAxis)
{
VALIDATE_POINTER1(hArray, __func__, nullptr);
std::vector<int> anMapNewAxisToOldAxis(nNewAxisCount);
if (nNewAxisCount)
{
memcpy(&anMapNewAxisToOldAxis[0], panMapNewAxisToOldAxis,
nNewAxisCount * sizeof(int));
}
auto reordered = hArray->m_poImpl->Transpose(anMapNewAxisToOldAxis);
if (!reordered)
return nullptr;
return new GDALMDArrayHS(reordered);
}
/************************************************************************/
/* GDALMDArrayGetUnscaled() */
/************************************************************************/
/** Return an array that is the unscaled version of the current one.
*
* That is each value of the unscaled array will be
* unscaled_value = raw_value * GetScale() + GetOffset()
*
* Starting with GDAL 3.3, the Write() method is implemented and will convert
* from unscaled values to raw values.
*
* The returned object should be released with GDALMDArrayRelease().
*
* This is the same as the C++ method GDALMDArray::GetUnscaled().
*/
GDALMDArrayH GDALMDArrayGetUnscaled(GDALMDArrayH hArray)
{
VALIDATE_POINTER1(hArray, __func__, nullptr);
auto unscaled = hArray->m_poImpl->GetUnscaled();
if (!unscaled)
return nullptr;
return new GDALMDArrayHS(unscaled);
}
/************************************************************************/
/* GDALMDArrayGetMask() */
/************************************************************************/
/** Return an array that is a mask for the current array
*
* This array will be of type Byte, with values set to 0 to indicate invalid
* pixels of the current array, and values set to 1 to indicate valid pixels.
*
* The returned object should be released with GDALMDArrayRelease().
*
* This is the same as the C++ method GDALMDArray::GetMask().
*/
GDALMDArrayH GDALMDArrayGetMask(GDALMDArrayH hArray, CSLConstList papszOptions)
{
VALIDATE_POINTER1(hArray, __func__, nullptr);
auto unscaled = hArray->m_poImpl->GetMask(papszOptions);
if (!unscaled)
return nullptr;
return new GDALMDArrayHS(unscaled);
}
/************************************************************************/
/* GDALMDArrayGetResampled() */
/************************************************************************/
/** Return an array that is a resampled / reprojected view of the current array
*
* This is the same as the C++ method GDALMDArray::GetResampled().
*
* Currently this method can only resample along the last 2 dimensions.
*
* The returned object should be released with GDALMDArrayRelease().
*
* @since 3.4
*/
GDALMDArrayH GDALMDArrayGetResampled(GDALMDArrayH hArray, size_t nNewDimCount,
const GDALDimensionH *pahNewDims,
GDALRIOResampleAlg resampleAlg,
OGRSpatialReferenceH hTargetSRS,
CSLConstList papszOptions)
{
VALIDATE_POINTER1(hArray, __func__, nullptr);
VALIDATE_POINTER1(pahNewDims, __func__, nullptr);
std::vector<std::shared_ptr<GDALDimension>> apoNewDims(nNewDimCount);
for (size_t i = 0; i < nNewDimCount; ++i)
{
if (pahNewDims[i])
apoNewDims[i] = pahNewDims[i]->m_poImpl;
}
auto poNewArray = hArray->m_poImpl->GetResampled(
apoNewDims, resampleAlg, OGRSpatialReference::FromHandle(hTargetSRS),
papszOptions);
if (!poNewArray)
return nullptr;
return new GDALMDArrayHS(poNewArray);
}
/************************************************************************/
/* GDALMDArraySetUnit() */
/************************************************************************/
/** Set the variable unit.
*
* Values should conform as much as possible with those allowed by
* the NetCDF CF conventions:
* http://cfconventions.org/Data/cf-conventions/cf-conventions-1.7/cf-conventions.html#units
* but others might be returned.
*
* Few examples are "meter", "degrees", "second", ...
* Empty value means unknown.
*
* This is the same as the C function GDALMDArraySetUnit()
*
* @param hArray array.
* @param pszUnit unit name.
* @return TRUE in case of success.
*/
int GDALMDArraySetUnit(GDALMDArrayH hArray, const char *pszUnit)
{
VALIDATE_POINTER1(hArray, __func__, FALSE);
return hArray->m_poImpl->SetUnit(pszUnit ? pszUnit : "");
}
/************************************************************************/
/* GDALMDArrayGetUnit() */
/************************************************************************/
/** Return the array unit.
*
* Values should conform as much as possible with those allowed by
* the NetCDF CF conventions:
* http://cfconventions.org/Data/cf-conventions/cf-conventions-1.7/cf-conventions.html#units
* but others might be returned.
*
* Few examples are "meter", "degrees", "second", ...
* Empty value means unknown.
*
* The return value should not be freed and is valid until GDALMDArray is
* released or this function called again.
*
* This is the same as the C++ method GDALMDArray::GetUnit().
*/
const char *GDALMDArrayGetUnit(GDALMDArrayH hArray)
{
VALIDATE_POINTER1(hArray, __func__, nullptr);
return hArray->m_poImpl->GetUnit().c_str();
}
/************************************************************************/
/* GDALMDArrayGetSpatialRef() */
/************************************************************************/
/** Assign a spatial reference system object to the the array.
*
* This is the same as the C++ method GDALMDArray::SetSpatialRef().
* @return TRUE in case of success.
*/
int GDALMDArraySetSpatialRef(GDALMDArrayH hArray, OGRSpatialReferenceH hSRS)
{
VALIDATE_POINTER1(hArray, __func__, FALSE);
return hArray->m_poImpl->SetSpatialRef(
OGRSpatialReference::FromHandle(hSRS));
}
/************************************************************************/
/* GDALMDArrayGetSpatialRef() */
/************************************************************************/
/** Return the spatial reference system object associated with the array.
*
* This is the same as the C++ method GDALMDArray::GetSpatialRef().
*
* The returned object must be freed with OSRDestroySpatialReference().
*/
OGRSpatialReferenceH GDALMDArrayGetSpatialRef(GDALMDArrayH hArray)
{
VALIDATE_POINTER1(hArray, __func__, nullptr);
auto poSRS = hArray->m_poImpl->GetSpatialRef();
return poSRS ? OGRSpatialReference::ToHandle(poSRS->Clone()) : nullptr;
}
/************************************************************************/
/* GDALMDArrayGetStatistics() */
/************************************************************************/
/**
* \brief Fetch statistics.
*
* This is the same as the C++ method GDALMDArray::GetStatistics().
*
* @since GDAL 3.2
*/
CPLErr GDALMDArrayGetStatistics(GDALMDArrayH hArray, GDALDatasetH /*hDS*/,
int bApproxOK, int bForce, double *pdfMin,
double *pdfMax, double *pdfMean,
double *pdfStdDev, GUInt64 *pnValidCount,
GDALProgressFunc pfnProgress,
void *pProgressData)
{
VALIDATE_POINTER1(hArray, __func__, CE_Failure);
return hArray->m_poImpl->GetStatistics(
CPL_TO_BOOL(bApproxOK), CPL_TO_BOOL(bForce), pdfMin, pdfMax, pdfMean,
pdfStdDev, pnValidCount, pfnProgress, pProgressData);
}
/************************************************************************/
/* GDALMDArrayComputeStatistics() */
/************************************************************************/
/**
* \brief Compute statistics.
*
* This is the same as the C++ method GDALMDArray::ComputeStatistics().
*
* @since GDAL 3.2
*/
int GDALMDArrayComputeStatistics(GDALMDArrayH hArray, GDALDatasetH /* hDS */,
int bApproxOK, double *pdfMin, double *pdfMax,
double *pdfMean, double *pdfStdDev,
GUInt64 *pnValidCount,
GDALProgressFunc pfnProgress,
void *pProgressData)
{
VALIDATE_POINTER1(hArray, __func__, FALSE);
return hArray->m_poImpl->ComputeStatistics(
CPL_TO_BOOL(bApproxOK), pdfMin, pdfMax, pdfMean, pdfStdDev,
pnValidCount, pfnProgress, pProgressData);
}
/************************************************************************/
/* GDALMDArrayGetCoordinateVariables() */
/************************************************************************/
/** Return coordinate variables.
*
* The returned array must be freed with GDALReleaseArrays(). If only the array
* itself needs to be freed, CPLFree() should be called (and
* GDALMDArrayRelease() on individual array members).
*
* This is the same as the C++ method GDALMDArray::GetCoordinateVariables()
*
* @param hArray Array.
* @param pnCount Pointer to the number of values returned. Must NOT be NULL.
*
* @return an array of *pnCount arrays.
* @since 3.4
*/
GDALMDArrayH *GDALMDArrayGetCoordinateVariables(GDALMDArrayH hArray,
size_t *pnCount)
{
VALIDATE_POINTER1(hArray, __func__, nullptr);
VALIDATE_POINTER1(pnCount, __func__, nullptr);
const auto coordinates(hArray->m_poImpl->GetCoordinateVariables());
auto ret = static_cast<GDALMDArrayH *>(
CPLMalloc(sizeof(GDALMDArrayH) * coordinates.size()));
for (size_t i = 0; i < coordinates.size(); i++)
{
ret[i] = new GDALMDArrayHS(coordinates[i]);
}
*pnCount = coordinates.size();
return ret;
}
/************************************************************************/
/* GDALReleaseArrays() */
/************************************************************************/
/** Free the return of GDALMDArrayGetCoordinateVariables()
*
* @param arrays return pointer of above methods
* @param nCount *pnCount value returned by above methods
*/
void GDALReleaseArrays(GDALMDArrayH *arrays, size_t nCount)
{
for (size_t i = 0; i < nCount; i++)
{
delete arrays[i];
}
CPLFree(arrays);
}
/************************************************************************/
/* GDALMDArrayCache() */
/************************************************************************/
/**
* \brief Cache the content of the array into an auxiliary filename.
*
* This is the same as the C++ method GDALMDArray::Cache().
*
* @since GDAL 3.4
*/
int GDALMDArrayCache(GDALMDArrayH hArray, CSLConstList papszOptions)
{
VALIDATE_POINTER1(hArray, __func__, FALSE);
return hArray->m_poImpl->Cache(papszOptions);
}
/************************************************************************/
/* GDALAttributeRelease() */
/************************************************************************/
/** Release the GDAL in-memory object associated with a GDALAttribute.
*
* Note: when applied on a object coming from a driver, this does not
* destroy the object in the file, database, etc...
*/
void GDALAttributeRelease(GDALAttributeH hAttr)
{
delete hAttr;
}
/************************************************************************/
/* GDALAttributeGetName() */
/************************************************************************/
/** Return the name of the attribute.
*
* The returned pointer is valid until hAttr is released.
*
* This is the same as the C++ method GDALAttribute::GetName().
*/
const char *GDALAttributeGetName(GDALAttributeH hAttr)
{
VALIDATE_POINTER1(hAttr, __func__, nullptr);
return hAttr->m_poImpl->GetName().c_str();
}
/************************************************************************/
/* GDALAttributeGetFullName() */
/************************************************************************/
/** Return the full name of the attribute.
*
* The returned pointer is valid until hAttr is released.
*
* This is the same as the C++ method GDALAttribute::GetFullName().
*/
const char *GDALAttributeGetFullName(GDALAttributeH hAttr)
{
VALIDATE_POINTER1(hAttr, __func__, nullptr);
return hAttr->m_poImpl->GetFullName().c_str();
}
/************************************************************************/
/* GDALAttributeGetTotalElementsCount() */
/************************************************************************/
/** Return the total number of values in the attribute.
*
* This is the same as the C++ method
* GDALAbstractMDArray::GetTotalElementsCount()
*/
GUInt64 GDALAttributeGetTotalElementsCount(GDALAttributeH hAttr)
{
VALIDATE_POINTER1(hAttr, __func__, 0);
return hAttr->m_poImpl->GetTotalElementsCount();
}
/************************************************************************/
/* GDALAttributeGetDimensionCount() */
/************************************************************************/
/** Return the number of dimensions.
*
* This is the same as the C++ method GDALAbstractMDArray::GetDimensionCount()
*/
size_t GDALAttributeGetDimensionCount(GDALAttributeH hAttr)
{
VALIDATE_POINTER1(hAttr, __func__, 0);
return hAttr->m_poImpl->GetDimensionCount();
}
/************************************************************************/
/* GDALAttributeGetDimensionsSize() */
/************************************************************************/
/** Return the dimension sizes of the attribute.
*
* The returned array must be freed with CPLFree()
*
* @param hAttr Attribute.
* @param pnCount Pointer to the number of values returned. Must NOT be NULL.
*
* @return an array of *pnCount values.
*/
GUInt64 *GDALAttributeGetDimensionsSize(GDALAttributeH hAttr, size_t *pnCount)
{
VALIDATE_POINTER1(hAttr, __func__, nullptr);
VALIDATE_POINTER1(pnCount, __func__, nullptr);
const auto &dims = hAttr->m_poImpl->GetDimensions();
auto ret = static_cast<GUInt64 *>(CPLMalloc(sizeof(GUInt64) * dims.size()));
for (size_t i = 0; i < dims.size(); i++)
{
ret[i] = dims[i]->GetSize();
}
*pnCount = dims.size();
return ret;
}
/************************************************************************/
/* GDALAttributeGetDataType() */
/************************************************************************/
/** Return the data type
*
* The return must be freed with GDALExtendedDataTypeRelease().
*/
GDALExtendedDataTypeH GDALAttributeGetDataType(GDALAttributeH hAttr)
{
VALIDATE_POINTER1(hAttr, __func__, nullptr);
return new GDALExtendedDataTypeHS(
new GDALExtendedDataType(hAttr->m_poImpl->GetDataType()));
}
/************************************************************************/
/* GDALAttributeReadAsRaw() */
/************************************************************************/
/** Return the raw value of an attribute.
*
* This is the same as the C++ method GDALAttribute::ReadAsRaw().
*
* The returned buffer must be freed with GDALAttributeFreeRawResult()
*
* @param hAttr Attribute.
* @param pnSize Pointer to the number of bytes returned. Must NOT be NULL.
*
* @return a buffer of *pnSize bytes.
*/
GByte *GDALAttributeReadAsRaw(GDALAttributeH hAttr, size_t *pnSize)
{
VALIDATE_POINTER1(hAttr, __func__, nullptr);
VALIDATE_POINTER1(pnSize, __func__, nullptr);
auto res(hAttr->m_poImpl->ReadAsRaw());
*pnSize = res.size();
auto ret = res.StealData();
if (!ret)
{
*pnSize = 0;
return nullptr;
}
return ret;
}
/************************************************************************/
/* GDALAttributeFreeRawResult() */
/************************************************************************/
/** Free the return of GDALAttributeAsRaw()
*/
void GDALAttributeFreeRawResult(GDALAttributeH hAttr, GByte *raw,
CPL_UNUSED size_t nSize)
{
VALIDATE_POINTER0(hAttr, __func__);
if (raw)
{
const auto dt(hAttr->m_poImpl->GetDataType());
const auto nDTSize(dt.GetSize());
GByte *pabyPtr = raw;
const auto nEltCount(hAttr->m_poImpl->GetTotalElementsCount());
CPLAssert(nSize == nDTSize * nEltCount);
for (size_t i = 0; i < nEltCount; ++i)
{
dt.FreeDynamicMemory(pabyPtr);
pabyPtr += nDTSize;
}
CPLFree(raw);
}
}
/************************************************************************/
/* GDALAttributeReadAsString() */
/************************************************************************/
/** Return the value of an attribute as a string.
*
* The returned string should not be freed, and its lifetime does not
* excess a next call to ReadAsString() on the same object, or the deletion
* of the object itself.
*
* This function will only return the first element if there are several.
*
* This is the same as the C++ method GDALAttribute::ReadAsString()
*
* @return a string, or nullptr.
*/
const char *GDALAttributeReadAsString(GDALAttributeH hAttr)
{
VALIDATE_POINTER1(hAttr, __func__, nullptr);
return hAttr->m_poImpl->ReadAsString();
}
/************************************************************************/
/* GDALAttributeReadAsInt() */
/************************************************************************/
/** Return the value of an attribute as a integer.
*
* This function will only return the first element if there are several.
*
* It can fail if its value can be converted to integer.
*
* This is the same as the C++ method GDALAttribute::ReadAsInt()
*
* @return a integer, or INT_MIN in case of error.
*/
int GDALAttributeReadAsInt(GDALAttributeH hAttr)
{
VALIDATE_POINTER1(hAttr, __func__, 0);
return hAttr->m_poImpl->ReadAsInt();
}
/************************************************************************/
/* GDALAttributeReadAsDouble() */
/************************************************************************/
/** Return the value of an attribute as a double.
*
* This function will only return the first element if there are several.
*
* It can fail if its value can be converted to double.
*
* This is the same as the C++ method GDALAttribute::ReadAsDoubl()
*
* @return a double value.
*/
double GDALAttributeReadAsDouble(GDALAttributeH hAttr)
{
VALIDATE_POINTER1(hAttr, __func__, 0);
return hAttr->m_poImpl->ReadAsDouble();
}
/************************************************************************/
/* GDALAttributeReadAsStringArray() */
/************************************************************************/
/** Return the value of an attribute as an array of strings.
*
* This is the same as the C++ method GDALAttribute::ReadAsStringArray()
*
* The return value must be freed with CSLDestroy().
*/
char **GDALAttributeReadAsStringArray(GDALAttributeH hAttr)
{
VALIDATE_POINTER1(hAttr, __func__, nullptr);
return hAttr->m_poImpl->ReadAsStringArray().StealList();
}
/************************************************************************/
/* GDALAttributeReadAsIntArray() */
/************************************************************************/
/** Return the value of an attribute as an array of integers.
*
* This is the same as the C++ method GDALAttribute::ReadAsIntArray()
*
* @param hAttr Attribute
* @param pnCount Pointer to the number of values returned. Must NOT be NULL.
* @return array to be freed with CPLFree(), or nullptr.
*/
int *GDALAttributeReadAsIntArray(GDALAttributeH hAttr, size_t *pnCount)
{
VALIDATE_POINTER1(hAttr, __func__, nullptr);
VALIDATE_POINTER1(pnCount, __func__, nullptr);
*pnCount = 0;
auto tmp(hAttr->m_poImpl->ReadAsIntArray());
if (tmp.empty())
return nullptr;
auto ret = static_cast<int *>(VSI_MALLOC2_VERBOSE(tmp.size(), sizeof(int)));
if (!ret)
return nullptr;
memcpy(ret, tmp.data(), tmp.size() * sizeof(int));
*pnCount = tmp.size();
return ret;
}
/************************************************************************/
/* GDALAttributeReadAsDoubleArray() */
/************************************************************************/
/** Return the value of an attribute as an array of doubles.
*
* This is the same as the C++ method GDALAttribute::ReadAsDoubleArray()
*
* @param hAttr Attribute
* @param pnCount Pointer to the number of values returned. Must NOT be NULL.
* @return array to be freed with CPLFree(), or nullptr.
*/
double *GDALAttributeReadAsDoubleArray(GDALAttributeH hAttr, size_t *pnCount)
{
VALIDATE_POINTER1(hAttr, __func__, nullptr);
VALIDATE_POINTER1(pnCount, __func__, nullptr);
*pnCount = 0;
auto tmp(hAttr->m_poImpl->ReadAsDoubleArray());
if (tmp.empty())
return nullptr;
auto ret =
static_cast<double *>(VSI_MALLOC2_VERBOSE(tmp.size(), sizeof(double)));
if (!ret)
return nullptr;
memcpy(ret, tmp.data(), tmp.size() * sizeof(double));
*pnCount = tmp.size();
return ret;
}
/************************************************************************/
/* GDALAttributeWriteRaw() */
/************************************************************************/
/** Write an attribute from raw values expressed in GetDataType()
*
* The values should be provided in the type of GetDataType() and there should
* be exactly GetTotalElementsCount() of them.
* If GetDataType() is a string, each value should be a char* pointer.
*
* This is the same as the C++ method GDALAttribute::Write(const void*, size_t).
*
* @param hAttr Attribute
* @param pabyValue Buffer of nLen bytes.
* @param nLength Size of pabyValue in bytes. Should be equal to
* GetTotalElementsCount() * GetDataType().GetSize()
* @return TRUE in case of success.
*/
int GDALAttributeWriteRaw(GDALAttributeH hAttr, const void *pabyValue,
size_t nLength)
{
VALIDATE_POINTER1(hAttr, __func__, FALSE);
return hAttr->m_poImpl->Write(pabyValue, nLength);
}
/************************************************************************/
/* GDALAttributeWriteString() */
/************************************************************************/
/** Write an attribute from a string value.
*
* Type conversion will be performed if needed. If the attribute contains
* multiple values, only the first one will be updated.
*
* This is the same as the C++ method GDALAttribute::Write(const char*)
*
* @param hAttr Attribute
* @param pszVal Pointer to a string.
* @return TRUE in case of success.
*/
int GDALAttributeWriteString(GDALAttributeH hAttr, const char *pszVal)
{
VALIDATE_POINTER1(hAttr, __func__, FALSE);
return hAttr->m_poImpl->Write(pszVal);
}
/************************************************************************/
/* GDALAttributeWriteInt() */
/************************************************************************/
/** Write an attribute from a integer value.
*
* Type conversion will be performed if needed. If the attribute contains
* multiple values, only the first one will be updated.
*
* This is the same as the C++ method GDALAttribute::WriteInt()
*
* @param hAttr Attribute
* @param nVal Value.
* @return TRUE in case of success.
*/
int GDALAttributeWriteInt(GDALAttributeH hAttr, int nVal)
{
VALIDATE_POINTER1(hAttr, __func__, FALSE);
return hAttr->m_poImpl->WriteInt(nVal);
}
/************************************************************************/
/* GDALAttributeWriteDouble() */
/************************************************************************/
/** Write an attribute from a double value.
*
* Type conversion will be performed if needed. If the attribute contains
* multiple values, only the first one will be updated.
*
* This is the same as the C++ method GDALAttribute::Write(double);
*
* @param hAttr Attribute
* @param dfVal Value.
*
* @return TRUE in case of success.
*/
int GDALAttributeWriteDouble(GDALAttributeH hAttr, double dfVal)
{
VALIDATE_POINTER1(hAttr, __func__, FALSE);
return hAttr->m_poImpl->Write(dfVal);
}
/************************************************************************/
/* GDALAttributeWriteStringArray() */
/************************************************************************/
/** Write an attribute from an array of strings.
*
* Type conversion will be performed if needed.
*
* Exactly GetTotalElementsCount() strings must be provided
*
* This is the same as the C++ method GDALAttribute::Write(CSLConstList)
*
* @param hAttr Attribute
* @param papszValues Array of strings.
* @return TRUE in case of success.
*/
int GDALAttributeWriteStringArray(GDALAttributeH hAttr,
CSLConstList papszValues)
{
VALIDATE_POINTER1(hAttr, __func__, FALSE);
return hAttr->m_poImpl->Write(papszValues);
}
/************************************************************************/
/* GDALAttributeWriteDoubleArray() */
/************************************************************************/
/** Write an attribute from an array of double.
*
* Type conversion will be performed if needed.
*
* Exactly GetTotalElementsCount() strings must be provided
*
* This is the same as the C++ method GDALAttribute::Write(const double *,
* size_t)
*
* @param hAttr Attribute
* @param padfValues Array of double.
* @param nCount Should be equal to GetTotalElementsCount().
* @return TRUE in case of success.
*/
int GDALAttributeWriteDoubleArray(GDALAttributeH hAttr,
const double *padfValues, size_t nCount)
{
VALIDATE_POINTER1(hAttr, __func__, FALSE);
return hAttr->m_poImpl->Write(padfValues, nCount);
}
/************************************************************************/
/* GDALDimensionRelease() */
/************************************************************************/
/** Release the GDAL in-memory object associated with a GDALDimension.
*
* Note: when applied on a object coming from a driver, this does not
* destroy the object in the file, database, etc...
*/
void GDALDimensionRelease(GDALDimensionH hDim)
{
delete hDim;
}
/************************************************************************/
/* GDALDimensionGetName() */
/************************************************************************/
/** Return dimension name.
*
* This is the same as the C++ method GDALDimension::GetName()
*/
const char *GDALDimensionGetName(GDALDimensionH hDim)
{
VALIDATE_POINTER1(hDim, __func__, nullptr);
return hDim->m_poImpl->GetName().c_str();
}
/************************************************************************/
/* GDALDimensionGetFullName() */
/************************************************************************/
/** Return dimension full name.
*
* This is the same as the C++ method GDALDimension::GetFullName()
*/
const char *GDALDimensionGetFullName(GDALDimensionH hDim)
{
VALIDATE_POINTER1(hDim, __func__, nullptr);
return hDim->m_poImpl->GetFullName().c_str();
}
/************************************************************************/
/* GDALDimensionGetType() */
/************************************************************************/
/** Return dimension type.
*
* This is the same as the C++ method GDALDimension::GetType()
*/
const char *GDALDimensionGetType(GDALDimensionH hDim)
{
VALIDATE_POINTER1(hDim, __func__, nullptr);
return hDim->m_poImpl->GetType().c_str();
}
/************************************************************************/
/* GDALDimensionGetDirection() */
/************************************************************************/
/** Return dimension direction.
*
* This is the same as the C++ method GDALDimension::GetDirection()
*/
const char *GDALDimensionGetDirection(GDALDimensionH hDim)
{
VALIDATE_POINTER1(hDim, __func__, nullptr);
return hDim->m_poImpl->GetDirection().c_str();
}
/************************************************************************/
/* GDALDimensionGetSize() */
/************************************************************************/
/** Return the size, that is the number of values along the dimension.
*
* This is the same as the C++ method GDALDimension::GetSize()
*/
GUInt64 GDALDimensionGetSize(GDALDimensionH hDim)
{
VALIDATE_POINTER1(hDim, __func__, 0);
return hDim->m_poImpl->GetSize();
}
/************************************************************************/
/* GDALDimensionGetIndexingVariable() */
/************************************************************************/
/** Return the variable that is used to index the dimension (if there is one).
*
* This is the array, typically one-dimensional, describing the values taken
* by the dimension.
*
* The returned value should be freed with GDALMDArrayRelease().
*
* This is the same as the C++ method GDALDimension::GetIndexingVariable()
*/
GDALMDArrayH GDALDimensionGetIndexingVariable(GDALDimensionH hDim)
{
VALIDATE_POINTER1(hDim, __func__, nullptr);
auto var(hDim->m_poImpl->GetIndexingVariable());
if (!var)
return nullptr;
return new GDALMDArrayHS(var);
}
/************************************************************************/
/* GDALDimensionSetIndexingVariable() */
/************************************************************************/
/** Set the variable that is used to index the dimension.
*
* This is the array, typically one-dimensional, describing the values taken
* by the dimension.
*
* This is the same as the C++ method GDALDimension::SetIndexingVariable()
*
* @return TRUE in case of success.
*/
int GDALDimensionSetIndexingVariable(GDALDimensionH hDim, GDALMDArrayH hArray)
{
VALIDATE_POINTER1(hDim, __func__, FALSE);
return hDim->m_poImpl->SetIndexingVariable(hArray ? hArray->m_poImpl
: nullptr);
}
/************************************************************************/
/* GDALDatasetGetRootGroup() */
/************************************************************************/
/** Return the root GDALGroup of this dataset.
*
* Only valid for multidimensional datasets.
*
* The returned value must be freed with GDALGroupRelease().
*
* This is the same as the C++ method GDALDataset::GetRootGroup().
*
* @since GDAL 3.1
*/
GDALGroupH GDALDatasetGetRootGroup(GDALDatasetH hDS)
{
VALIDATE_POINTER1(hDS, __func__, nullptr);
auto poGroup(GDALDataset::FromHandle(hDS)->GetRootGroup());
return poGroup ? new GDALGroupHS(poGroup) : nullptr;
}
/************************************************************************/
/* GDALRasterBandAsMDArray() */
/************************************************************************/
/** Return a view of this raster band as a 2D multidimensional GDALMDArray.
*
* The band must be linked to a GDALDataset. If this dataset is not already
* marked as shared, it will be, so that the returned array holds a reference
* to it.
*
* If the dataset has a geotransform attached, the X and Y dimensions of the
* returned array will have an associated indexing variable.
*
* The returned pointer must be released with GDALMDArrayRelease().
*
* This is the same as the C++ method GDALRasterBand::AsMDArray().
*
* @return a new array, or NULL.
*
* @since GDAL 3.1
*/
GDALMDArrayH GDALRasterBandAsMDArray(GDALRasterBandH hBand)
{
VALIDATE_POINTER1(hBand, __func__, nullptr);
auto poArray(GDALRasterBand::FromHandle(hBand)->AsMDArray());
if (!poArray)
return nullptr;
return new GDALMDArrayHS(poArray);
}
/************************************************************************/
/* GDALMDArrayAsClassicDataset() */
/************************************************************************/
/** Return a view of this array as a "classic" GDALDataset (ie 2D)
*
* Only 2D or more arrays are supported.
*
* In the case of > 2D arrays, additional dimensions will be represented as
* raster bands.
*
* The "reverse" method is GDALRasterBand::AsMDArray().
*
* This is the same as the C++ method GDALMDArray::AsClassicDataset().
*
* @param hArray Array.
* @param iXDim Index of the dimension that will be used as the X/width axis.
* @param iYDim Index of the dimension that will be used as the Y/height axis.
* @return a new GDALDataset that must be freed with GDALClose(), or nullptr
*/
GDALDatasetH GDALMDArrayAsClassicDataset(GDALMDArrayH hArray, size_t iXDim,
size_t iYDim)
{
VALIDATE_POINTER1(hArray, __func__, nullptr);
return GDALDataset::ToHandle(
hArray->m_poImpl->AsClassicDataset(iXDim, iYDim));
}
//! @cond Doxygen_Suppress
GDALAttributeString::GDALAttributeString(const std::string &osParentName,
const std::string &osName,
const std::string &osValue,
GDALExtendedDataTypeSubType eSubType)
: GDALAbstractMDArray(osParentName, osName),
GDALAttribute(osParentName, osName),
m_dt(GDALExtendedDataType::CreateString(0, eSubType)), m_osValue(osValue)
{
}
const std::vector<std::shared_ptr<GDALDimension>> &
GDALAttributeString::GetDimensions() const
{
return m_dims;
}
const GDALExtendedDataType &GDALAttributeString::GetDataType() const
{
return m_dt;
}
bool GDALAttributeString::IRead(const GUInt64 *, const size_t *, const GInt64 *,
const GPtrDiff_t *,
const GDALExtendedDataType &bufferDataType,
void *pDstBuffer) const
{
if (bufferDataType.GetClass() != GEDTC_STRING)
return false;
char *pszStr = static_cast<char *>(VSIMalloc(m_osValue.size() + 1));
if (!pszStr)
return false;
memcpy(pszStr, m_osValue.c_str(), m_osValue.size() + 1);
*static_cast<char **>(pDstBuffer) = pszStr;
return true;
}
GDALAttributeNumeric::GDALAttributeNumeric(const std::string &osParentName,
const std::string &osName,
double dfValue)
: GDALAbstractMDArray(osParentName, osName),
GDALAttribute(osParentName, osName),
m_dt(GDALExtendedDataType::Create(GDT_Float64)), m_dfValue(dfValue)
{
}
GDALAttributeNumeric::GDALAttributeNumeric(const std::string &osParentName,
const std::string &osName,
int nValue)
: GDALAbstractMDArray(osParentName, osName),
GDALAttribute(osParentName, osName),
m_dt(GDALExtendedDataType::Create(GDT_Int32)), m_nValue(nValue)
{
}
GDALAttributeNumeric::GDALAttributeNumeric(const std::string &osParentName,
const std::string &osName,
const std::vector<GUInt32> &anValues)
: GDALAbstractMDArray(osParentName, osName),
GDALAttribute(osParentName, osName),
m_dt(GDALExtendedDataType::Create(GDT_UInt32)), m_anValuesUInt32(anValues)
{
m_dims.push_back(std::make_shared<GDALDimension>(
std::string(), "dim0", std::string(), std::string(),
m_anValuesUInt32.size()));
}
const std::vector<std::shared_ptr<GDALDimension>> &
GDALAttributeNumeric::GetDimensions() const
{
return m_dims;
}
const GDALExtendedDataType &GDALAttributeNumeric::GetDataType() const
{
return m_dt;
}
bool GDALAttributeNumeric::IRead(const GUInt64 *arrayStartIdx,
const size_t *count, const GInt64 *arrayStep,
const GPtrDiff_t *bufferStride,
const GDALExtendedDataType &bufferDataType,
void *pDstBuffer) const
{
if (m_dims.empty())
{
if (m_dt.GetNumericDataType() == GDT_Float64)
GDALExtendedDataType::CopyValue(&m_dfValue, m_dt, pDstBuffer,
bufferDataType);
else
{
CPLAssert(m_dt.GetNumericDataType() == GDT_Int32);
GDALExtendedDataType::CopyValue(&m_nValue, m_dt, pDstBuffer,
bufferDataType);
}
}
else
{
CPLAssert(m_dt.GetNumericDataType() == GDT_UInt32);
GByte *pabyDstBuffer = static_cast<GByte *>(pDstBuffer);
for (size_t i = 0; i < count[0]; ++i)
{
GDALExtendedDataType::CopyValue(
&m_anValuesUInt32[static_cast<size_t>(arrayStartIdx[0] +
i * arrayStep[0])],
m_dt, pabyDstBuffer, bufferDataType);
pabyDstBuffer += bufferDataType.GetSize() * bufferStride[0];
}
}
return true;
}
GDALMDArrayRegularlySpaced::GDALMDArrayRegularlySpaced(
const std::string &osParentName, const std::string &osName,
const std::shared_ptr<GDALDimension> &poDim, double dfStart,
double dfIncrement, double dfOffsetInIncrement)
: GDALAbstractMDArray(osParentName, osName),
GDALMDArray(osParentName, osName), m_dfStart(dfStart),
m_dfIncrement(dfIncrement),
m_dfOffsetInIncrement(dfOffsetInIncrement), m_dims{poDim}
{
}
std::shared_ptr<GDALMDArrayRegularlySpaced> GDALMDArrayRegularlySpaced::Create(
const std::string &osParentName, const std::string &osName,
const std::shared_ptr<GDALDimension> &poDim, double dfStart,
double dfIncrement, double dfOffsetInIncrement)
{
auto poArray = std::make_shared<GDALMDArrayRegularlySpaced>(
osParentName, osName, poDim, dfStart, dfIncrement, dfOffsetInIncrement);
poArray->SetSelf(poArray);
return poArray;
}
const std::vector<std::shared_ptr<GDALDimension>> &
GDALMDArrayRegularlySpaced::GetDimensions() const
{
return m_dims;
}
const GDALExtendedDataType &GDALMDArrayRegularlySpaced::GetDataType() const
{
return m_dt;
}
std::vector<std::shared_ptr<GDALAttribute>>
GDALMDArrayRegularlySpaced::GetAttributes(CSLConstList) const
{
return m_attributes;
}
void GDALMDArrayRegularlySpaced::AddAttribute(
const std::shared_ptr<GDALAttribute> &poAttr)
{
m_attributes.emplace_back(poAttr);
}
bool GDALMDArrayRegularlySpaced::IRead(
const GUInt64 *arrayStartIdx, const size_t *count, const GInt64 *arrayStep,
const GPtrDiff_t *bufferStride, const GDALExtendedDataType &bufferDataType,
void *pDstBuffer) const
{
GByte *pabyDstBuffer = static_cast<GByte *>(pDstBuffer);
for (size_t i = 0; i < count[0]; i++)
{
const double dfVal = m_dfStart + (arrayStartIdx[0] + i * arrayStep[0] +
m_dfOffsetInIncrement) *
m_dfIncrement;
GDALExtendedDataType::CopyValue(&dfVal, m_dt, pabyDstBuffer,
bufferDataType);
pabyDstBuffer += bufferStride[0] * bufferDataType.GetSize();
}
return true;
}
GDALDimensionWeakIndexingVar::GDALDimensionWeakIndexingVar(
const std::string &osParentName, const std::string &osName,
const std::string &osType, const std::string &osDirection, GUInt64 nSize)
: GDALDimension(osParentName, osName, osType, osDirection, nSize)
{
}
std::shared_ptr<GDALMDArray>
GDALDimensionWeakIndexingVar::GetIndexingVariable() const
{
return m_poIndexingVariable.lock();
}
// cppcheck-suppress passedByValue
bool GDALDimensionWeakIndexingVar::SetIndexingVariable(
std::shared_ptr<GDALMDArray> poIndexingVariable)
{
m_poIndexingVariable = poIndexingVariable;
return true;
}
/************************************************************************/
/* GDALPamMultiDim::Private */
/************************************************************************/
struct GDALPamMultiDim::Private
{
std::string m_osFilename{};
std::string m_osPamFilename{};
struct Statistics
{
bool bHasStats = false;
bool bApproxStats = false;
double dfMin = 0;
double dfMax = 0;
double dfMean = 0;
double dfStdDev = 0;
GUInt64 nValidCount = 0;
};
struct ArrayInfo
{
std::shared_ptr<OGRSpatialReference> poSRS{};
// cppcheck-suppress unusedStructMember
Statistics stats{};
};
std::map<std::string, ArrayInfo> m_oMapArray{};
std::vector<CPLXMLTreeCloser> m_apoOtherNodes{};
bool m_bDirty = false;
bool m_bLoaded = false;
};
/************************************************************************/
/* GDALPamMultiDim */
/************************************************************************/
GDALPamMultiDim::GDALPamMultiDim(const std::string &osFilename)
: d(new Private())
{
d->m_osFilename = osFilename;
}
/************************************************************************/
/* GDALPamMultiDim::~GDALPamMultiDim() */
/************************************************************************/
GDALPamMultiDim::~GDALPamMultiDim()
{
if (d->m_bDirty)
Save();
}
/************************************************************************/
/* GDALPamMultiDim::Load() */
/************************************************************************/
void GDALPamMultiDim::Load()
{
if (d->m_bLoaded)
return;
d->m_bLoaded = true;
const char *pszProxyPam = PamGetProxy(d->m_osFilename.c_str());
d->m_osPamFilename =
pszProxyPam ? std::string(pszProxyPam) : d->m_osFilename + ".aux.xml";
CPLXMLTreeCloser oTree(nullptr);
{
CPLErrorStateBackuper oStateBackuper;
CPLErrorHandlerPusher oErrorHandlerPusher(CPLQuietErrorHandler);
oTree.reset(CPLParseXMLFile(d->m_osPamFilename.c_str()));
}
if (!oTree)
{
return;
}
const auto poPAMMultiDim = CPLGetXMLNode(oTree.get(), "=PAMDataset");
if (!poPAMMultiDim)
return;
for (CPLXMLNode *psIter = poPAMMultiDim->psChild; psIter;
psIter = psIter->psNext)
{
if (psIter->eType == CXT_Element &&
strcmp(psIter->pszValue, "Array") == 0)
{
const char *pszName = CPLGetXMLValue(psIter, "name", nullptr);
if (!pszName)
continue;
/* --------------------------------------------------------------------
*/
/* Check for an SRS node. */
/* --------------------------------------------------------------------
*/
const CPLXMLNode *psSRSNode = CPLGetXMLNode(psIter, "SRS");
if (psSRSNode)
{
std::shared_ptr<OGRSpatialReference> poSRS =
std::make_shared<OGRSpatialReference>();
poSRS->SetFromUserInput(
CPLGetXMLValue(psSRSNode, nullptr, ""),
OGRSpatialReference::SET_FROM_USER_INPUT_LIMITATIONS);
const char *pszMapping = CPLGetXMLValue(
psSRSNode, "dataAxisToSRSAxisMapping", nullptr);
if (pszMapping)
{
char **papszTokens =
CSLTokenizeStringComplex(pszMapping, ",", FALSE, FALSE);
std::vector<int> anMapping;
for (int i = 0; papszTokens && papszTokens[i]; i++)
{
anMapping.push_back(atoi(papszTokens[i]));
}
CSLDestroy(papszTokens);
poSRS->SetDataAxisToSRSAxisMapping(anMapping);
}
else
{
poSRS->SetAxisMappingStrategy(OAMS_TRADITIONAL_GIS_ORDER);
}
const char *pszCoordinateEpoch =
CPLGetXMLValue(psSRSNode, "coordinateEpoch", nullptr);
if (pszCoordinateEpoch)
poSRS->SetCoordinateEpoch(CPLAtof(pszCoordinateEpoch));
d->m_oMapArray[pszName].poSRS = poSRS;
}
const CPLXMLNode *psStatistics =
CPLGetXMLNode(psIter, "Statistics");
if (psStatistics)
{
Private::Statistics sStats;
sStats.bHasStats = true;
sStats.bApproxStats = CPLTestBool(
CPLGetXMLValue(psStatistics, "ApproxStats", "false"));
sStats.dfMin =
CPLAtofM(CPLGetXMLValue(psStatistics, "Minimum", "0"));
sStats.dfMax =
CPLAtofM(CPLGetXMLValue(psStatistics, "Maximum", "0"));
sStats.dfMean =
CPLAtofM(CPLGetXMLValue(psStatistics, "Mean", "0"));
sStats.dfStdDev =
CPLAtofM(CPLGetXMLValue(psStatistics, "StdDev", "0"));
sStats.nValidCount = static_cast<GUInt64>(CPLAtoGIntBig(
CPLGetXMLValue(psStatistics, "ValidSampleCount", "0")));
d->m_oMapArray[pszName].stats = sStats;
}
}
else
{
CPLXMLNode *psNextBackup = psIter->psNext;
psIter->psNext = nullptr;
d->m_apoOtherNodes.emplace_back(
CPLXMLTreeCloser(CPLCloneXMLTree(psIter)));
psIter->psNext = psNextBackup;
}
}
}
/************************************************************************/
/* GDALPamMultiDim::Save() */
/************************************************************************/
void GDALPamMultiDim::Save()
{
CPLXMLTreeCloser oTree(
CPLCreateXMLNode(nullptr, CXT_Element, "PAMDataset"));
for (const auto &poOtherNode : d->m_apoOtherNodes)
{
CPLAddXMLChild(oTree.get(), CPLCloneXMLTree(poOtherNode.get()));
}
for (const auto &kv : d->m_oMapArray)
{
CPLXMLNode *psArrayNode =
CPLCreateXMLNode(oTree.get(), CXT_Element, "Array");
CPLAddXMLAttributeAndValue(psArrayNode, "name", kv.first.c_str());
if (kv.second.poSRS)
{
char *pszWKT = nullptr;
{
CPLErrorStateBackuper oErrorStateBackuper;
CPLErrorHandlerPusher oErrorHandler(CPLQuietErrorHandler);
const char *const apszOptions[] = {"FORMAT=WKT2", nullptr};
kv.second.poSRS->exportToWkt(&pszWKT, apszOptions);
}
CPLXMLNode *psSRSNode =
CPLCreateXMLElementAndValue(psArrayNode, "SRS", pszWKT);
CPLFree(pszWKT);
const auto &mapping =
kv.second.poSRS->GetDataAxisToSRSAxisMapping();
CPLString osMapping;
for (size_t i = 0; i < mapping.size(); ++i)
{
if (!osMapping.empty())
osMapping += ",";
osMapping += CPLSPrintf("%d", mapping[i]);
}
CPLAddXMLAttributeAndValue(psSRSNode, "dataAxisToSRSAxisMapping",
osMapping.c_str());
const double dfCoordinateEpoch =
kv.second.poSRS->GetCoordinateEpoch();
if (dfCoordinateEpoch > 0)
{
std::string osCoordinateEpoch =
CPLSPrintf("%f", dfCoordinateEpoch);
if (osCoordinateEpoch.find('.') != std::string::npos)
{
while (osCoordinateEpoch.back() == '0')
osCoordinateEpoch.resize(osCoordinateEpoch.size() - 1);
}
CPLAddXMLAttributeAndValue(psSRSNode, "coordinateEpoch",
osCoordinateEpoch.c_str());
}
}
if (kv.second.stats.bHasStats)
{
CPLXMLNode *psMDArray =
CPLCreateXMLNode(psArrayNode, CXT_Element, "Statistics");
CPLCreateXMLElementAndValue(psMDArray, "ApproxStats",
kv.second.stats.bApproxStats ? "1"
: "0");
CPLCreateXMLElementAndValue(
psMDArray, "Minimum",
CPLSPrintf("%.18g", kv.second.stats.dfMin));
CPLCreateXMLElementAndValue(
psMDArray, "Maximum",
CPLSPrintf("%.18g", kv.second.stats.dfMax));
CPLCreateXMLElementAndValue(
psMDArray, "Mean", CPLSPrintf("%.18g", kv.second.stats.dfMean));
CPLCreateXMLElementAndValue(
psMDArray, "StdDev",
CPLSPrintf("%.18g", kv.second.stats.dfStdDev));
CPLCreateXMLElementAndValue(
psMDArray, "ValidSampleCount",
CPLSPrintf(CPL_FRMT_GUIB, kv.second.stats.nValidCount));
}
}
std::vector<CPLErrorHandlerAccumulatorStruct> aoErrors;
CPLInstallErrorHandlerAccumulator(aoErrors);
const int bSaved =
CPLSerializeXMLTreeToFile(oTree.get(), d->m_osPamFilename.c_str());
CPLUninstallErrorHandlerAccumulator();
const char *pszNewPam = nullptr;
if (!bSaved && PamGetProxy(d->m_osFilename.c_str()) == nullptr &&
((pszNewPam = PamAllocateProxy(d->m_osFilename.c_str())) != nullptr))
{
CPLErrorReset();
CPLSerializeXMLTreeToFile(oTree.get(), pszNewPam);
}
else
{
for (const auto &oError : aoErrors)
{
CPLError(oError.type, oError.no, "%s", oError.msg.c_str());
}
}
}
/************************************************************************/
/* GDALPamMultiDim::GetSpatialRef() */
/************************************************************************/
std::shared_ptr<OGRSpatialReference>
GDALPamMultiDim::GetSpatialRef(const std::string &osArrayFullName)
{
Load();
auto oIter = d->m_oMapArray.find(osArrayFullName);
if (oIter != d->m_oMapArray.end())
return oIter->second.poSRS;
return nullptr;
}
/************************************************************************/
/* GDALPamMultiDim::SetSpatialRef() */
/************************************************************************/
void GDALPamMultiDim::SetSpatialRef(const std::string &osArrayFullName,
const OGRSpatialReference *poSRS)
{
Load();
d->m_bDirty = true;
if (poSRS && !poSRS->IsEmpty())
d->m_oMapArray[osArrayFullName].poSRS.reset(poSRS->Clone());
else
d->m_oMapArray[osArrayFullName].poSRS.reset();
}
/************************************************************************/
/* GetStatistics() */
/************************************************************************/
CPLErr GDALPamMultiDim::GetStatistics(const std::string &osArrayFullName,
bool bApproxOK, double *pdfMin,
double *pdfMax, double *pdfMean,
double *pdfStdDev, GUInt64 *pnValidCount)
{
Load();
auto oIter = d->m_oMapArray.find(osArrayFullName);
if (oIter == d->m_oMapArray.end())
return CE_Failure;
const auto &stats = oIter->second.stats;
if (!stats.bHasStats)
return CE_Failure;
if (!bApproxOK && stats.bApproxStats)
return CE_Failure;
if (pdfMin)
*pdfMin = stats.dfMin;
if (pdfMax)
*pdfMax = stats.dfMax;
if (pdfMean)
*pdfMean = stats.dfMean;
if (pdfStdDev)
*pdfStdDev = stats.dfStdDev;
if (pnValidCount)
*pnValidCount = stats.nValidCount;
return CE_None;
}
/************************************************************************/
/* SetStatistics() */
/************************************************************************/
void GDALPamMultiDim::SetStatistics(const std::string &osArrayFullName,
bool bApproxStats, double dfMin,
double dfMax, double dfMean,
double dfStdDev, GUInt64 nValidCount)
{
Load();
d->m_bDirty = true;
auto &stats = d->m_oMapArray[osArrayFullName].stats;
stats.bHasStats = true;
stats.bApproxStats = bApproxStats;
stats.dfMin = dfMin;
stats.dfMax = dfMax;
stats.dfMean = dfMean;
stats.dfStdDev = dfStdDev;
stats.nValidCount = nValidCount;
}
/************************************************************************/
/* ClearStatistics() */
/************************************************************************/
void GDALPamMultiDim::ClearStatistics(const std::string &osArrayFullName)
{
Load();
d->m_bDirty = true;
d->m_oMapArray[osArrayFullName].stats.bHasStats = false;
}
/************************************************************************/
/* ClearStatistics() */
/************************************************************************/
void GDALPamMultiDim::ClearStatistics()
{
Load();
d->m_bDirty = true;
for (auto &kv : d->m_oMapArray)
kv.second.stats.bHasStats = false;
}
/************************************************************************/
/* GDALPamMDArray */
/************************************************************************/
GDALPamMDArray::GDALPamMDArray(const std::string &osParentName,
const std::string &osName,
const std::shared_ptr<GDALPamMultiDim> &poPam)
:
#if !defined(COMPILER_WARNS_ABOUT_ABSTRACT_VBASE_INIT)
GDALAbstractMDArray(osParentName, osName),
#endif
GDALMDArray(osParentName, osName), m_poPam(poPam)
{
}
/************************************************************************/
/* GDALPamMDArray::SetSpatialRef() */
/************************************************************************/
bool GDALPamMDArray::SetSpatialRef(const OGRSpatialReference *poSRS)
{
if (!m_poPam)
return false;
m_poPam->SetSpatialRef(GetFullName(), poSRS);
return true;
}
/************************************************************************/
/* GDALPamMDArray::GetSpatialRef() */
/************************************************************************/
std::shared_ptr<OGRSpatialReference> GDALPamMDArray::GetSpatialRef() const
{
if (!m_poPam)
return nullptr;
return m_poPam->GetSpatialRef(GetFullName());
}
/************************************************************************/
/* GetStatistics() */
/************************************************************************/
CPLErr GDALPamMDArray::GetStatistics(bool bApproxOK, bool bForce,
double *pdfMin, double *pdfMax,
double *pdfMean, double *pdfStdDev,
GUInt64 *pnValidCount,
GDALProgressFunc pfnProgress,
void *pProgressData)
{
if (m_poPam &&
m_poPam->GetStatistics(GetFullName(), bApproxOK, pdfMin, pdfMax,
pdfMean, pdfStdDev, pnValidCount) == CE_None)
{
return CE_None;
}
if (!bForce)
return CE_Warning;
return GDALMDArray::GetStatistics(bApproxOK, bForce, pdfMin, pdfMax,
pdfMean, pdfStdDev, pnValidCount,
pfnProgress, pProgressData);
}
/************************************************************************/
/* SetStatistics() */
/************************************************************************/
bool GDALPamMDArray::SetStatistics(bool bApproxStats, double dfMin,
double dfMax, double dfMean, double dfStdDev,
GUInt64 nValidCount)
{
if (!m_poPam)
return false;
m_poPam->SetStatistics(GetFullName(), bApproxStats, dfMin, dfMax, dfMean,
dfStdDev, nValidCount);
return true;
}
/************************************************************************/
/* ClearStatistics() */
/************************************************************************/
void GDALPamMDArray::ClearStatistics()
{
if (!m_poPam)
return;
m_poPam->ClearStatistics(GetFullName());
}
//! @endcond
|