Line data Source code
1 : /******************************************************************************
2 : *
3 : * Project: GDAL Utilities
4 : * Purpose: Command line application to convert a multidimensional raster
5 : * Author: Even Rouault,<even.rouault at spatialys.com>
6 : *
7 : * ****************************************************************************
8 : * Copyright (c) 2019, Even Rouault <even.rouault at spatialys.com>
9 : *
10 : * SPDX-License-Identifier: MIT
11 : ****************************************************************************/
12 :
13 : #include "cpl_port.h"
14 : #include "commonutils.h"
15 : #include "gdal_priv.h"
16 : #include "gdal_utils.h"
17 : #include "gdal_utils_priv.h"
18 : #include "gdalargumentparser.h"
19 : #include "vrtdataset.h"
20 : #include <algorithm>
21 : #include <map>
22 : #include <set>
23 :
24 : /************************************************************************/
25 : /* GDALMultiDimTranslateOptions */
26 : /************************************************************************/
27 :
28 : struct GDALMultiDimTranslateOptions
29 : {
30 : std::string osFormat{};
31 : CPLStringList aosCreateOptions{};
32 : std::vector<std::string> aosArraySpec{};
33 : CPLStringList aosArrayOptions{};
34 : std::vector<std::string> aosSubset{};
35 : std::vector<std::string> aosScaleFactor{};
36 : std::vector<std::string> aosGroup{};
37 : GDALProgressFunc pfnProgress = GDALDummyProgress;
38 : bool bStrict = false;
39 : void *pProgressData = nullptr;
40 : bool bUpdate = false;
41 : bool bOverwrite = false;
42 : bool bNoOverwrite = false;
43 : };
44 :
45 : /*************************************************************************/
46 : /* GDALMultiDimTranslateAppOptionsGetParser() */
47 : /************************************************************************/
48 :
49 : static std::unique_ptr<GDALArgumentParser>
50 117 : GDALMultiDimTranslateAppOptionsGetParser(
51 : GDALMultiDimTranslateOptions *psOptions,
52 : GDALMultiDimTranslateOptionsForBinary *psOptionsForBinary)
53 : {
54 : auto argParser = std::make_unique<GDALArgumentParser>(
55 117 : "gdalmdimtranslate", /* bForBinary=*/psOptionsForBinary != nullptr);
56 :
57 117 : argParser->add_description(
58 : _("Converts multidimensional data between different formats, and "
59 117 : "performs subsetting."));
60 :
61 117 : argParser->add_epilog(
62 : _("For more details, consult "
63 117 : "https://gdal.org/programs/gdalmdimtranslate.html"));
64 :
65 117 : if (psOptionsForBinary)
66 : {
67 : argParser->add_input_format_argument(
68 3 : &psOptionsForBinary->aosAllowInputDrivers);
69 : }
70 :
71 117 : argParser->add_output_format_argument(psOptions->osFormat);
72 :
73 117 : argParser->add_creation_options_argument(psOptions->aosCreateOptions);
74 :
75 117 : auto &group = argParser->add_mutually_exclusive_group();
76 117 : group.add_argument("-array")
77 234 : .metavar("<array_spec>")
78 117 : .append()
79 117 : .store_into(psOptions->aosArraySpec)
80 : .help(_(
81 117 : "Select a single array instead of converting the whole dataset."));
82 :
83 117 : argParser->add_argument("-arrayoption")
84 234 : .metavar("<NAME>=<VALUE>")
85 117 : .append()
86 1 : .action([psOptions](const std::string &s)
87 118 : { psOptions->aosArrayOptions.AddString(s.c_str()); })
88 : .help(_("Option passed to GDALGroup::GetMDArrayNames() to filter "
89 117 : "arrays."));
90 :
91 117 : group.add_argument("-group")
92 234 : .metavar("<group_spec>")
93 117 : .append()
94 117 : .store_into(psOptions->aosGroup)
95 : .help(_(
96 117 : "Select a single group instead of converting the whole dataset."));
97 :
98 : // Note: this is mutually exclusive with "view" option in -array
99 117 : argParser->add_argument("-subset")
100 234 : .metavar("<subset_spec>")
101 117 : .append()
102 117 : .store_into(psOptions->aosSubset)
103 117 : .help(_("Select a subset of the data."));
104 :
105 : // Note: this is mutually exclusive with "view" option in -array
106 117 : argParser->add_argument("-scaleaxes")
107 234 : .metavar("<scaleaxes_spec>")
108 : .action(
109 4 : [psOptions](const std::string &s)
110 : {
111 : CPLStringList aosScaleFactors(
112 4 : CSLTokenizeString2(s.c_str(), ",", 0));
113 4 : for (int j = 0; j < aosScaleFactors.size(); j++)
114 : {
115 2 : psOptions->aosScaleFactor.push_back(aosScaleFactors[j]);
116 : }
117 119 : })
118 : .help(
119 117 : _("Applies a integral scale factor to one or several dimensions."));
120 :
121 117 : argParser->add_argument("-strict")
122 117 : .flag()
123 117 : .store_into(psOptions->bStrict)
124 117 : .help(_("Turn warnings into failures."));
125 :
126 : // Undocumented option used by gdal mdim convert
127 117 : argParser->add_argument("--overwrite")
128 117 : .store_into(psOptions->bOverwrite)
129 117 : .hidden();
130 :
131 : // Undocumented option used by gdal mdim convert
132 117 : argParser->add_argument("--no-overwrite")
133 117 : .store_into(psOptions->bNoOverwrite)
134 117 : .hidden();
135 :
136 117 : if (psOptionsForBinary)
137 : {
138 : argParser->add_open_options_argument(
139 3 : psOptionsForBinary->aosOpenOptions);
140 :
141 3 : argParser->add_argument("src_dataset")
142 6 : .metavar("<src_dataset>")
143 3 : .store_into(psOptionsForBinary->osSource)
144 3 : .help(_("The source dataset name."));
145 :
146 3 : argParser->add_argument("dst_dataset")
147 6 : .metavar("<dst_dataset>")
148 3 : .store_into(psOptionsForBinary->osDest)
149 3 : .help(_("The destination file name."));
150 :
151 3 : argParser->add_quiet_argument(&psOptionsForBinary->bQuiet);
152 : }
153 :
154 117 : return argParser;
155 : }
156 :
157 : /************************************************************************/
158 : /* GDALMultiDimTranslateAppGetParserUsage() */
159 : /************************************************************************/
160 :
161 0 : std::string GDALMultiDimTranslateAppGetParserUsage()
162 : {
163 : try
164 : {
165 0 : GDALMultiDimTranslateOptions sOptions;
166 0 : GDALMultiDimTranslateOptionsForBinary sOptionsForBinary;
167 : auto argParser = GDALMultiDimTranslateAppOptionsGetParser(
168 0 : &sOptions, &sOptionsForBinary);
169 0 : return argParser->usage();
170 : }
171 0 : catch (const std::exception &err)
172 : {
173 0 : CPLError(CE_Failure, CPLE_AppDefined, "Unexpected exception: %s",
174 0 : err.what());
175 0 : return std::string();
176 : }
177 : }
178 :
179 : /************************************************************************/
180 : /* FindMinMaxIdxNumeric() */
181 : /************************************************************************/
182 :
183 40 : static void FindMinMaxIdxNumeric(const GDALMDArray *var, double *pdfTmp,
184 : const size_t nCount, const GUInt64 nStartIdx,
185 : const double dfMin, const double dfMax,
186 : const bool bSlice, bool &bFoundMinIdx,
187 : GUInt64 &nMinIdx, bool &bFoundMaxIdx,
188 : GUInt64 &nMaxIdx, bool &bLastWasReversed,
189 : bool &bEmpty, const double EPS)
190 : {
191 40 : if (nCount >= 2)
192 : {
193 40 : bool bReversed = false;
194 40 : if (pdfTmp[0] > pdfTmp[nCount - 1])
195 : {
196 19 : bReversed = true;
197 19 : std::reverse(pdfTmp, pdfTmp + nCount);
198 : }
199 40 : if (nStartIdx > 0 && bLastWasReversed != bReversed)
200 : {
201 0 : CPLError(CE_Failure, CPLE_AppDefined,
202 0 : "Variable %s is non monotonic", var->GetName().c_str());
203 0 : bEmpty = true;
204 0 : return;
205 : }
206 40 : bLastWasReversed = bReversed;
207 :
208 40 : if (!bFoundMinIdx)
209 : {
210 40 : if (bReversed && nStartIdx == 0 && dfMin > pdfTmp[nCount - 1])
211 : {
212 2 : bEmpty = true;
213 2 : return;
214 : }
215 38 : else if (!bReversed && dfMin < pdfTmp[0] - EPS)
216 : {
217 6 : if (bSlice)
218 : {
219 1 : bEmpty = true;
220 1 : return;
221 : }
222 5 : bFoundMinIdx = true;
223 5 : nMinIdx = nStartIdx;
224 : }
225 32 : else if (dfMin >= pdfTmp[0] - EPS &&
226 28 : dfMin <= pdfTmp[nCount - 1] + EPS)
227 : {
228 130 : for (size_t i = 0; i < nCount; i++)
229 : {
230 130 : if (dfMin <= pdfTmp[i] + EPS)
231 : {
232 26 : bFoundMinIdx = true;
233 26 : nMinIdx = nStartIdx + (bReversed ? nCount - 1 - i : i);
234 26 : break;
235 : }
236 : }
237 26 : CPLAssert(bFoundMinIdx);
238 : }
239 : }
240 37 : if (!bFoundMaxIdx)
241 : {
242 37 : if (bReversed && nStartIdx == 0 && dfMax > pdfTmp[nCount - 1])
243 : {
244 2 : if (bSlice)
245 : {
246 0 : bEmpty = true;
247 0 : return;
248 : }
249 2 : bFoundMaxIdx = true;
250 2 : nMaxIdx = 0;
251 : }
252 35 : else if (!bReversed && dfMax < pdfTmp[0] - EPS)
253 : {
254 1 : if (nStartIdx == 0)
255 : {
256 1 : bEmpty = true;
257 1 : return;
258 : }
259 0 : bFoundMaxIdx = true;
260 0 : nMaxIdx = nStartIdx - 1;
261 : }
262 34 : else if (dfMax > pdfTmp[0] - EPS &&
263 32 : dfMax <= pdfTmp[nCount - 1] + EPS)
264 : {
265 156 : for (size_t i = 1; i < nCount; i++)
266 : {
267 148 : if (dfMax <= pdfTmp[i] - EPS)
268 : {
269 18 : bFoundMaxIdx = true;
270 18 : nMaxIdx = nStartIdx +
271 18 : (bReversed ? nCount - 1 - (i - 1) : i - 1);
272 18 : break;
273 : }
274 : }
275 26 : if (!bFoundMaxIdx)
276 : {
277 8 : bFoundMaxIdx = true;
278 8 : nMaxIdx = nStartIdx + (bReversed ? 0 : nCount - 1);
279 : }
280 : }
281 : }
282 : }
283 : else
284 : {
285 0 : if (!bFoundMinIdx)
286 : {
287 0 : if (dfMin <= pdfTmp[0] + EPS)
288 : {
289 0 : bFoundMinIdx = true;
290 0 : nMinIdx = nStartIdx;
291 : }
292 0 : else if (bLastWasReversed && nStartIdx > 0)
293 : {
294 0 : bFoundMinIdx = true;
295 0 : nMinIdx = nStartIdx - 1;
296 : }
297 : }
298 0 : if (!bFoundMaxIdx)
299 : {
300 0 : if (dfMax >= pdfTmp[0] - EPS)
301 : {
302 0 : bFoundMaxIdx = true;
303 0 : nMaxIdx = nStartIdx;
304 : }
305 0 : else if (!bLastWasReversed && nStartIdx > 0)
306 : {
307 0 : bFoundMaxIdx = true;
308 0 : nMaxIdx = nStartIdx - 1;
309 : }
310 : }
311 : }
312 : }
313 :
314 : /************************************************************************/
315 : /* FindMinMaxIdxString() */
316 : /************************************************************************/
317 :
318 40 : static void FindMinMaxIdxString(const GDALMDArray *var, const char **ppszTmp,
319 : const size_t nCount, const GUInt64 nStartIdx,
320 : const std::string &osMin,
321 : const std::string &osMax, const bool bSlice,
322 : bool &bFoundMinIdx, GUInt64 &nMinIdx,
323 : bool &bFoundMaxIdx, GUInt64 &nMaxIdx,
324 : bool &bLastWasReversed, bool &bEmpty)
325 : {
326 40 : bool bFoundNull = false;
327 200 : for (size_t i = 0; i < nCount; i++)
328 : {
329 160 : if (ppszTmp[i] == nullptr)
330 : {
331 0 : bFoundNull = true;
332 0 : break;
333 : }
334 : }
335 40 : if (bFoundNull)
336 : {
337 0 : CPLError(CE_Failure, CPLE_AppDefined,
338 0 : "Variable %s contains null strings", var->GetName().c_str());
339 0 : bEmpty = true;
340 0 : return;
341 : }
342 40 : if (nCount >= 2)
343 : {
344 40 : bool bReversed = false;
345 40 : if (std::string(ppszTmp[0]) > std::string(ppszTmp[nCount - 1]))
346 : {
347 19 : bReversed = true;
348 19 : std::reverse(ppszTmp, ppszTmp + nCount);
349 : }
350 40 : if (nStartIdx > 0 && bLastWasReversed != bReversed)
351 : {
352 0 : CPLError(CE_Failure, CPLE_AppDefined,
353 0 : "Variable %s is non monotonic", var->GetName().c_str());
354 0 : bEmpty = true;
355 0 : return;
356 : }
357 40 : bLastWasReversed = bReversed;
358 :
359 40 : if (!bFoundMinIdx)
360 : {
361 59 : if (bReversed && nStartIdx == 0 &&
362 59 : osMin > std::string(ppszTmp[nCount - 1]))
363 : {
364 2 : bEmpty = true;
365 2 : return;
366 : }
367 38 : else if (!bReversed && osMin < std::string(ppszTmp[0]))
368 : {
369 5 : if (bSlice)
370 : {
371 1 : bEmpty = true;
372 1 : return;
373 : }
374 4 : bFoundMinIdx = true;
375 4 : nMinIdx = nStartIdx;
376 : }
377 94 : else if (osMin >= std::string(ppszTmp[0]) &&
378 61 : osMin <= std::string(ppszTmp[nCount - 1]))
379 : {
380 68 : for (size_t i = 0; i < nCount; i++)
381 : {
382 68 : if (osMin <= std::string(ppszTmp[i]))
383 : {
384 26 : bFoundMinIdx = true;
385 26 : nMinIdx = nStartIdx + (bReversed ? nCount - 1 - i : i);
386 26 : break;
387 : }
388 : }
389 26 : CPLAssert(bFoundMinIdx);
390 : }
391 : }
392 37 : if (!bFoundMaxIdx)
393 : {
394 54 : if (bReversed && nStartIdx == 0 &&
395 54 : osMax > std::string(ppszTmp[nCount - 1]))
396 : {
397 3 : if (bSlice)
398 : {
399 0 : bEmpty = true;
400 0 : return;
401 : }
402 3 : bFoundMaxIdx = true;
403 3 : nMaxIdx = 0;
404 : }
405 34 : else if (!bReversed && osMax < std::string(ppszTmp[0]))
406 : {
407 1 : if (nStartIdx == 0)
408 : {
409 1 : bEmpty = true;
410 1 : return;
411 : }
412 0 : bFoundMaxIdx = true;
413 0 : nMaxIdx = nStartIdx - 1;
414 : }
415 33 : else if (osMax == std::string(ppszTmp[0]))
416 : {
417 6 : bFoundMaxIdx = true;
418 6 : nMaxIdx = nStartIdx + (bReversed ? nCount - 1 : 0);
419 : }
420 79 : else if (osMax > std::string(ppszTmp[0]) &&
421 52 : osMax <= std::string(ppszTmp[nCount - 1]))
422 : {
423 42 : for (size_t i = 1; i < nCount; i++)
424 : {
425 42 : if (osMax <= std::string(ppszTmp[i]))
426 : {
427 20 : bFoundMaxIdx = true;
428 20 : if (osMax == std::string(ppszTmp[i]))
429 16 : nMaxIdx =
430 16 : nStartIdx + (bReversed ? nCount - 1 - i : i);
431 : else
432 4 : nMaxIdx =
433 4 : nStartIdx +
434 4 : (bReversed ? nCount - 1 - (i - 1) : i - 1);
435 20 : break;
436 : }
437 : }
438 20 : CPLAssert(bFoundMaxIdx);
439 : }
440 : }
441 : }
442 : else
443 : {
444 0 : if (!bFoundMinIdx)
445 : {
446 0 : if (osMin <= std::string(ppszTmp[0]))
447 : {
448 0 : bFoundMinIdx = true;
449 0 : nMinIdx = nStartIdx;
450 : }
451 0 : else if (bLastWasReversed && nStartIdx > 0)
452 : {
453 0 : bFoundMinIdx = true;
454 0 : nMinIdx = nStartIdx - 1;
455 : }
456 : }
457 0 : if (!bFoundMaxIdx)
458 : {
459 0 : if (osMax >= std::string(ppszTmp[0]))
460 : {
461 0 : bFoundMaxIdx = true;
462 0 : nMaxIdx = nStartIdx;
463 : }
464 0 : else if (!bLastWasReversed && nStartIdx > 0)
465 : {
466 0 : bFoundMaxIdx = true;
467 0 : nMaxIdx = nStartIdx - 1;
468 : }
469 : }
470 : }
471 : }
472 :
473 : /************************************************************************/
474 : /* GetDimensionDesc() */
475 : /************************************************************************/
476 :
477 : struct DimensionDesc
478 : {
479 : GUInt64 nStartIdx = 0;
480 : GUInt64 nStep = 1;
481 : GUInt64 nSize = 0;
482 : GUInt64 nOriSize = 0;
483 : bool bSlice = false;
484 : };
485 :
486 : struct DimensionRemapper
487 : {
488 : std::map<std::string, DimensionDesc> oMap{};
489 : };
490 :
491 : static const DimensionDesc *
492 207 : GetDimensionDesc(DimensionRemapper &oDimRemapper,
493 : const GDALMultiDimTranslateOptions *psOptions,
494 : const std::shared_ptr<GDALDimension> &poDim)
495 : {
496 414 : std::string osKey(poDim->GetFullName());
497 : osKey +=
498 207 : CPLSPrintf("_" CPL_FRMT_GUIB, static_cast<GUIntBig>(poDim->GetSize()));
499 207 : auto oIter = oDimRemapper.oMap.find(osKey);
500 317 : if (oIter != oDimRemapper.oMap.end() &&
501 110 : oIter->second.nOriSize == poDim->GetSize())
502 : {
503 110 : return &(oIter->second);
504 : }
505 97 : DimensionDesc desc;
506 97 : desc.nSize = poDim->GetSize();
507 97 : desc.nOriSize = desc.nSize;
508 :
509 194 : CPLString osRadix(poDim->GetName());
510 97 : osRadix += '(';
511 107 : for (const auto &subset : psOptions->aosSubset)
512 : {
513 93 : if (STARTS_WITH(subset.c_str(), osRadix.c_str()))
514 : {
515 83 : auto var = poDim->GetIndexingVariable();
516 166 : if (!var || var->GetDimensionCount() != 1 ||
517 83 : var->GetDimensions()[0]->GetSize() != poDim->GetSize())
518 : {
519 0 : CPLError(CE_Failure, CPLE_AppDefined,
520 : "Dimension %s has a subset specification, but lacks "
521 : "a single dimension indexing variable",
522 0 : poDim->GetName().c_str());
523 0 : return nullptr;
524 : }
525 83 : if (subset.back() != ')')
526 : {
527 2 : CPLError(CE_Failure, CPLE_AppDefined,
528 : "Missing ')' in subset specification.");
529 2 : return nullptr;
530 : }
531 : CPLStringList aosTokens(CSLTokenizeString2(
532 : subset
533 81 : .substr(osRadix.size(), subset.size() - 1 - osRadix.size())
534 : .c_str(),
535 81 : ",", CSLT_HONOURSTRINGS));
536 81 : if (aosTokens.size() == 1)
537 : {
538 26 : desc.bSlice = true;
539 : }
540 81 : if (aosTokens.size() != 1 && aosTokens.size() != 2)
541 : {
542 1 : CPLError(CE_Failure, CPLE_AppDefined,
543 : "Invalid number of valus in subset specification.");
544 1 : return nullptr;
545 : }
546 :
547 : const bool bIsNumeric =
548 80 : var->GetDataType().GetClass() == GEDTC_NUMERIC;
549 : const GDALExtendedDataType dt(
550 : bIsNumeric ? GDALExtendedDataType::Create(GDT_Float64)
551 80 : : GDALExtendedDataType::CreateString());
552 :
553 80 : double dfMin = 0;
554 80 : double dfMax = 0;
555 80 : std::string osMin;
556 80 : std::string osMax;
557 80 : if (bIsNumeric)
558 : {
559 80 : if (CPLGetValueType(aosTokens[0]) == CPL_VALUE_STRING ||
560 40 : (aosTokens.size() == 2 &&
561 28 : CPLGetValueType(aosTokens[1]) == CPL_VALUE_STRING))
562 : {
563 0 : CPLError(CE_Failure, CPLE_AppDefined,
564 : "Non numeric bound in subset specification.");
565 0 : return nullptr;
566 : }
567 40 : dfMin = CPLAtof(aosTokens[0]);
568 40 : dfMax = dfMin;
569 40 : if (aosTokens.size() == 2)
570 28 : dfMax = CPLAtof(aosTokens[1]);
571 40 : if (dfMin > dfMax)
572 0 : std::swap(dfMin, dfMax);
573 : }
574 : else
575 : {
576 40 : osMin = aosTokens[0];
577 40 : osMax = osMin;
578 40 : if (aosTokens.size() == 2)
579 26 : osMax = aosTokens[1];
580 40 : if (osMin > osMax)
581 0 : std::swap(osMin, osMax);
582 : }
583 :
584 80 : const size_t nDTSize(dt.GetSize());
585 : const size_t nMaxChunkSize = static_cast<size_t>(std::min(
586 80 : static_cast<GUInt64>(10 * 1000 * 1000), poDim->GetSize()));
587 80 : std::vector<GByte> abyTmp(nDTSize * nMaxChunkSize);
588 80 : double *pdfTmp = reinterpret_cast<double *>(&abyTmp[0]);
589 80 : const char **ppszTmp = reinterpret_cast<const char **>(&abyTmp[0]);
590 80 : GUInt64 nStartIdx = 0;
591 160 : const double EPS = std::max(std::max(1e-10, fabs(dfMin) / 1e10),
592 80 : fabs(dfMax) / 1e10);
593 80 : bool bFoundMinIdx = false;
594 80 : bool bFoundMaxIdx = false;
595 80 : GUInt64 nMinIdx = 0;
596 80 : GUInt64 nMaxIdx = 0;
597 80 : bool bLastWasReversed = false;
598 80 : bool bEmpty = false;
599 : while (true)
600 : {
601 : const size_t nCount = static_cast<size_t>(
602 200 : std::min(static_cast<GUInt64>(nMaxChunkSize),
603 100 : poDim->GetSize() - nStartIdx));
604 100 : if (nCount == 0)
605 20 : break;
606 80 : const GUInt64 anStartId[] = {nStartIdx};
607 80 : const size_t anCount[] = {nCount};
608 160 : if (!var->Read(anStartId, anCount, nullptr, nullptr, dt,
609 80 : &abyTmp[0], nullptr, 0))
610 : {
611 0 : return nullptr;
612 : }
613 80 : if (bIsNumeric)
614 : {
615 40 : FindMinMaxIdxNumeric(
616 40 : var.get(), pdfTmp, nCount, nStartIdx, dfMin, dfMax,
617 40 : desc.bSlice, bFoundMinIdx, nMinIdx, bFoundMaxIdx,
618 : nMaxIdx, bLastWasReversed, bEmpty, EPS);
619 : }
620 : else
621 : {
622 40 : FindMinMaxIdxString(var.get(), ppszTmp, nCount, nStartIdx,
623 40 : osMin, osMax, desc.bSlice, bFoundMinIdx,
624 : nMinIdx, bFoundMaxIdx, nMaxIdx,
625 : bLastWasReversed, bEmpty);
626 : }
627 80 : if (dt.NeedsFreeDynamicMemory())
628 : {
629 200 : for (size_t i = 0; i < nCount; i++)
630 : {
631 160 : dt.FreeDynamicMemory(&abyTmp[i * nDTSize]);
632 : }
633 : }
634 80 : if (bEmpty || (bFoundMinIdx && bFoundMaxIdx) ||
635 : nCount < nMaxChunkSize)
636 : {
637 : break;
638 : }
639 20 : nStartIdx += nMaxChunkSize;
640 20 : }
641 :
642 : // cppcheck-suppress knownConditionTrueFalse
643 80 : if (!bLastWasReversed)
644 : {
645 42 : if (!bFoundMinIdx)
646 6 : bEmpty = true;
647 36 : else if (!bFoundMaxIdx)
648 9 : nMaxIdx = poDim->GetSize() - 1;
649 : else
650 27 : bEmpty = nMaxIdx < nMinIdx;
651 : }
652 : else
653 : {
654 38 : if (!bFoundMaxIdx)
655 8 : bEmpty = true;
656 30 : else if (!bFoundMinIdx)
657 5 : nMinIdx = poDim->GetSize() - 1;
658 : else
659 25 : bEmpty = nMinIdx < nMaxIdx;
660 : }
661 80 : if (bEmpty)
662 : {
663 16 : CPLError(CE_Failure, CPLE_AppDefined,
664 : "Subset specification results in an empty set");
665 16 : return nullptr;
666 : }
667 :
668 : // cppcheck-suppress knownConditionTrueFalse
669 64 : if (!bLastWasReversed)
670 : {
671 34 : CPLAssert(nMaxIdx >= nMinIdx);
672 34 : desc.nStartIdx = nMinIdx;
673 34 : desc.nSize = nMaxIdx - nMinIdx + 1;
674 : }
675 : else
676 : {
677 30 : CPLAssert(nMaxIdx <= nMinIdx);
678 30 : desc.nStartIdx = nMaxIdx;
679 30 : desc.nSize = nMinIdx - nMaxIdx + 1;
680 : }
681 :
682 64 : break;
683 : }
684 : }
685 :
686 82 : for (const auto &scaleFactor : psOptions->aosScaleFactor)
687 : {
688 6 : if (STARTS_WITH(scaleFactor.c_str(), osRadix.c_str()))
689 : {
690 2 : if (scaleFactor.back() != ')')
691 : {
692 0 : CPLError(CE_Failure, CPLE_AppDefined,
693 : "Missing ')' in scalefactor specification.");
694 0 : return nullptr;
695 : }
696 : std::string osScaleFactor(scaleFactor.substr(
697 2 : osRadix.size(), scaleFactor.size() - 1 - osRadix.size()));
698 2 : int nScaleFactor = atoi(osScaleFactor.c_str());
699 2 : if (CPLGetValueType(osScaleFactor.c_str()) != CPL_VALUE_INTEGER ||
700 : nScaleFactor <= 0)
701 : {
702 0 : CPLError(CE_Failure, CPLE_NotSupported,
703 : "Only positive integer scale factor is supported");
704 0 : return nullptr;
705 : }
706 2 : desc.nSize /= nScaleFactor;
707 2 : if (desc.nSize == 0)
708 0 : desc.nSize = 1;
709 2 : desc.nStep *= nScaleFactor;
710 2 : break;
711 : }
712 : }
713 :
714 78 : oDimRemapper.oMap[osKey] = desc;
715 78 : return &oDimRemapper.oMap[osKey];
716 : }
717 :
718 : /************************************************************************/
719 : /* ParseArraySpec() */
720 : /************************************************************************/
721 :
722 : // foo
723 : // name=foo,transpose=[1,0],view=[0],dstname=bar,ot=Float32
724 147 : static bool ParseArraySpec(const std::string &arraySpec, std::string &srcName,
725 : std::string &dstName, int &band,
726 : std::vector<int> &anTransposedAxis,
727 : std::string &viewExpr,
728 : GDALExtendedDataType &outputType, bool &bResampled)
729 : {
730 281 : if (!STARTS_WITH(arraySpec.c_str(), "name=") &&
731 134 : !STARTS_WITH(arraySpec.c_str(), "band="))
732 : {
733 133 : srcName = arraySpec;
734 133 : dstName = arraySpec;
735 133 : auto pos = dstName.rfind('/');
736 133 : if (pos != std::string::npos)
737 22 : dstName = dstName.substr(pos + 1);
738 133 : return true;
739 : }
740 :
741 28 : std::vector<std::string> tokens;
742 28 : std::string curToken;
743 14 : bool bInArray = false;
744 588 : for (size_t i = 0; i < arraySpec.size(); ++i)
745 : {
746 574 : if (!bInArray && arraySpec[i] == ',')
747 : {
748 18 : tokens.emplace_back(std::move(curToken));
749 18 : curToken = std::string();
750 : }
751 : else
752 : {
753 556 : if (arraySpec[i] == '[')
754 : {
755 6 : bInArray = true;
756 : }
757 550 : else if (arraySpec[i] == ']')
758 : {
759 6 : bInArray = false;
760 : }
761 556 : curToken += arraySpec[i];
762 : }
763 : }
764 14 : if (!curToken.empty())
765 : {
766 14 : tokens.emplace_back(std::move(curToken));
767 : }
768 44 : for (const auto &token : tokens)
769 : {
770 32 : if (STARTS_WITH(token.c_str(), "name="))
771 : {
772 13 : srcName = token.substr(strlen("name="));
773 13 : if (dstName.empty())
774 13 : dstName = srcName;
775 : }
776 19 : else if (STARTS_WITH(token.c_str(), "band="))
777 : {
778 1 : band = atoi(token.substr(strlen("band=")).c_str());
779 1 : if (dstName.empty())
780 1 : dstName = CPLSPrintf("Band%d", band);
781 : }
782 18 : else if (STARTS_WITH(token.c_str(), "dstname="))
783 : {
784 10 : dstName = token.substr(strlen("dstname="));
785 : }
786 8 : else if (STARTS_WITH(token.c_str(), "transpose="))
787 : {
788 2 : auto transposeExpr = token.substr(strlen("transpose="));
789 4 : if (transposeExpr.size() < 3 || transposeExpr[0] != '[' ||
790 2 : transposeExpr.back() != ']')
791 : {
792 0 : CPLError(CE_Failure, CPLE_AppDefined,
793 : "Invalid value for transpose");
794 0 : return false;
795 : }
796 2 : transposeExpr = transposeExpr.substr(1, transposeExpr.size() - 2);
797 : CPLStringList aosAxis(
798 2 : CSLTokenizeString2(transposeExpr.c_str(), ",", 0));
799 5 : for (int i = 0; i < aosAxis.size(); ++i)
800 : {
801 4 : int iAxis = atoi(aosAxis[i]);
802 : // check for non-integer characters
803 4 : if (iAxis == 0)
804 : {
805 2 : if (!EQUAL(aosAxis[i], "0"))
806 : {
807 1 : CPLError(CE_Failure, CPLE_AppDefined,
808 : "Invalid value for axis in transpose: %s",
809 : aosAxis[i]);
810 1 : return false;
811 : }
812 : }
813 :
814 3 : anTransposedAxis.push_back(iAxis);
815 : }
816 : }
817 6 : else if (STARTS_WITH(token.c_str(), "view="))
818 : {
819 4 : viewExpr = token.substr(strlen("view="));
820 : }
821 2 : else if (STARTS_WITH(token.c_str(), "ot="))
822 : {
823 0 : auto outputTypeStr = token.substr(strlen("ot="));
824 0 : if (outputTypeStr == "String")
825 0 : outputType = GDALExtendedDataType::CreateString();
826 : else
827 : {
828 0 : auto eDT = GDALGetDataTypeByName(outputTypeStr.c_str());
829 0 : if (eDT == GDT_Unknown)
830 0 : return false;
831 0 : outputType = GDALExtendedDataType::Create(eDT);
832 : }
833 : }
834 2 : else if (STARTS_WITH(token.c_str(), "resample="))
835 : {
836 1 : bResampled = CPLTestBool(token.c_str() + strlen("resample="));
837 : }
838 : else
839 : {
840 1 : CPLError(CE_Failure, CPLE_AppDefined,
841 : "Unexpected array specification part: %s", token.c_str());
842 1 : return false;
843 : }
844 : }
845 12 : return true;
846 : }
847 :
848 : /************************************************************************/
849 : /* TranslateArray() */
850 : /************************************************************************/
851 :
852 144 : static bool TranslateArray(
853 : DimensionRemapper &oDimRemapper,
854 : const std::shared_ptr<GDALMDArray> &poSrcArrayIn,
855 : const std::string &arraySpec,
856 : const std::shared_ptr<GDALGroup> &poSrcRootGroup,
857 : const std::shared_ptr<GDALGroup> &poSrcGroup,
858 : const std::shared_ptr<GDALGroup> &poDstRootGroup,
859 : std::shared_ptr<GDALGroup> &poDstGroup, GDALDataset *poSrcDS,
860 : std::map<std::string, std::shared_ptr<GDALDimension>> &mapSrcToDstDims,
861 : std::map<std::string, std::shared_ptr<GDALDimension>> &mapDstDimFullNames,
862 : const GDALMultiDimTranslateOptions *psOptions)
863 : {
864 288 : std::string srcArrayName;
865 288 : std::string dstArrayName;
866 144 : int band = -1;
867 288 : std::vector<int> anTransposedAxis;
868 288 : std::string viewExpr;
869 144 : bool bResampled = false;
870 288 : GDALExtendedDataType outputType(GDALExtendedDataType::Create(GDT_Unknown));
871 144 : if (!ParseArraySpec(arraySpec, srcArrayName, dstArrayName, band,
872 : anTransposedAxis, viewExpr, outputType, bResampled))
873 : {
874 2 : return false;
875 : }
876 :
877 142 : std::shared_ptr<GDALMDArray> srcArray;
878 142 : bool bSrcArrayAccessibleThroughSrcGroup = true;
879 142 : if (poSrcRootGroup && poSrcGroup)
880 : {
881 141 : if (!srcArrayName.empty() && srcArrayName[0] == '/')
882 28 : srcArray = poSrcRootGroup->OpenMDArrayFromFullname(srcArrayName);
883 : else
884 113 : srcArray = poSrcGroup->OpenMDArray(srcArrayName);
885 141 : if (!srcArray)
886 : {
887 3 : if (poSrcArrayIn && poSrcArrayIn->GetFullName() == arraySpec)
888 : {
889 2 : bSrcArrayAccessibleThroughSrcGroup = false;
890 2 : srcArray = poSrcArrayIn;
891 : }
892 : else
893 : {
894 1 : CPLError(CE_Failure, CPLE_AppDefined, "Cannot find array %s",
895 : srcArrayName.c_str());
896 1 : return false;
897 : }
898 : }
899 : }
900 : else
901 : {
902 1 : auto poBand = poSrcDS->GetRasterBand(band);
903 1 : if (!poBand)
904 0 : return false;
905 1 : srcArray = poBand->AsMDArray();
906 : }
907 :
908 282 : auto tmpArray = srcArray;
909 :
910 141 : if (bResampled)
911 : {
912 : auto newTmpArray =
913 3 : tmpArray->GetResampled(std::vector<std::shared_ptr<GDALDimension>>(
914 1 : tmpArray->GetDimensionCount()),
915 2 : GRIORA_NearestNeighbour, nullptr, nullptr);
916 1 : if (!newTmpArray)
917 0 : return false;
918 1 : tmpArray = std::move(newTmpArray);
919 : }
920 :
921 141 : if (!anTransposedAxis.empty())
922 : {
923 1 : auto newTmpArray = tmpArray->Transpose(anTransposedAxis);
924 1 : if (!newTmpArray)
925 0 : return false;
926 1 : tmpArray = std::move(newTmpArray);
927 : }
928 141 : const auto &srcArrayDims(tmpArray->GetDimensions());
929 : std::map<std::shared_ptr<GDALDimension>, std::shared_ptr<GDALDimension>>
930 282 : oMapSubsetDimToSrcDim;
931 :
932 282 : std::vector<GDALMDArray::ViewSpec> viewSpecs;
933 141 : if (!viewExpr.empty())
934 : {
935 4 : if (!psOptions->aosSubset.empty() || !psOptions->aosScaleFactor.empty())
936 : {
937 0 : CPLError(CE_Failure, CPLE_NotSupported,
938 : "View specification not supported when used together "
939 : "with subset and/or scalefactor options");
940 0 : return false;
941 : }
942 4 : auto newTmpArray = tmpArray->GetView(viewExpr, true, viewSpecs);
943 4 : if (!newTmpArray)
944 0 : return false;
945 4 : tmpArray = std::move(newTmpArray);
946 : }
947 184 : else if (!psOptions->aosSubset.empty() ||
948 47 : !psOptions->aosScaleFactor.empty())
949 : {
950 98 : bool bHasModifiedDim = false;
951 98 : viewExpr = '[';
952 194 : for (size_t i = 0; i < srcArrayDims.size(); ++i)
953 : {
954 112 : const auto &srcDim(srcArrayDims[i]);
955 : const auto poDimDesc =
956 112 : GetDimensionDesc(oDimRemapper, psOptions, srcDim);
957 112 : if (poDimDesc == nullptr)
958 16 : return false;
959 96 : if (i > 0)
960 14 : viewExpr += ',';
961 76 : if (!poDimDesc->bSlice && poDimDesc->nStartIdx == 0 &&
962 172 : poDimDesc->nStep == 1 && poDimDesc->nSize == srcDim->GetSize())
963 : {
964 28 : viewExpr += ":";
965 : }
966 : else
967 : {
968 68 : bHasModifiedDim = true;
969 : viewExpr += CPLSPrintf(
970 68 : CPL_FRMT_GUIB, static_cast<GUInt64>(poDimDesc->nStartIdx));
971 68 : if (!poDimDesc->bSlice)
972 : {
973 48 : viewExpr += ':';
974 : viewExpr +=
975 : CPLSPrintf(CPL_FRMT_GUIB,
976 48 : static_cast<GUInt64>(poDimDesc->nStartIdx +
977 48 : poDimDesc->nSize *
978 48 : poDimDesc->nStep));
979 48 : viewExpr += ':';
980 : viewExpr += CPLSPrintf(
981 48 : CPL_FRMT_GUIB, static_cast<GUInt64>(poDimDesc->nStep));
982 : }
983 : }
984 : }
985 82 : viewExpr += ']';
986 82 : if (bHasModifiedDim)
987 : {
988 66 : auto tmpArrayNew = tmpArray->GetView(viewExpr, false, viewSpecs);
989 66 : if (!tmpArrayNew)
990 0 : return false;
991 66 : tmpArray = std::move(tmpArrayNew);
992 66 : size_t j = 0;
993 66 : const auto &tmpArrayDims(tmpArray->GetDimensions());
994 146 : for (size_t i = 0; i < srcArrayDims.size(); ++i)
995 : {
996 80 : const auto &srcDim(srcArrayDims[i]);
997 : const auto poDimDesc =
998 80 : GetDimensionDesc(oDimRemapper, psOptions, srcDim);
999 80 : if (poDimDesc == nullptr)
1000 0 : return false;
1001 80 : if (poDimDesc->bSlice)
1002 20 : continue;
1003 60 : CPLAssert(j < tmpArrayDims.size());
1004 60 : oMapSubsetDimToSrcDim[tmpArrayDims[j]] = srcDim;
1005 60 : j++;
1006 : }
1007 : }
1008 : else
1009 : {
1010 16 : viewExpr.clear();
1011 : }
1012 : }
1013 :
1014 125 : int idxSliceSpec = -1;
1015 195 : for (size_t i = 0; i < viewSpecs.size(); ++i)
1016 : {
1017 70 : if (viewSpecs[i].m_osFieldName.empty())
1018 : {
1019 70 : if (idxSliceSpec >= 0)
1020 : {
1021 0 : idxSliceSpec = -1;
1022 0 : break;
1023 : }
1024 : else
1025 : {
1026 70 : idxSliceSpec = static_cast<int>(i);
1027 : }
1028 : }
1029 : }
1030 :
1031 : // Map source dimensions to target dimensions
1032 250 : std::vector<std::shared_ptr<GDALDimension>> dstArrayDims;
1033 125 : const auto &tmpArrayDims(tmpArray->GetDimensions());
1034 265 : for (size_t i = 0; i < tmpArrayDims.size(); ++i)
1035 : {
1036 140 : const auto &srcDim(tmpArrayDims[i]);
1037 140 : std::string srcDimFullName(srcDim->GetFullName());
1038 :
1039 0 : std::shared_ptr<GDALDimension> dstDim;
1040 : {
1041 280 : CPLErrorStateBackuper oErrorStateBackuper(CPLQuietErrorHandler);
1042 140 : if (!srcDimFullName.empty() && srcDimFullName[0] == '/')
1043 : {
1044 : dstDim =
1045 81 : poDstRootGroup->OpenDimensionFromFullname(srcDimFullName);
1046 : }
1047 : }
1048 140 : if (dstDim)
1049 : {
1050 45 : dstArrayDims.emplace_back(dstDim);
1051 45 : continue;
1052 : }
1053 :
1054 95 : auto oIter = mapSrcToDstDims.find(srcDimFullName);
1055 95 : if (oIter != mapSrcToDstDims.end())
1056 : {
1057 2 : dstArrayDims.emplace_back(oIter->second);
1058 2 : continue;
1059 : }
1060 93 : auto oIterRealSrcDim = oMapSubsetDimToSrcDim.find(srcDim);
1061 93 : if (oIterRealSrcDim != oMapSubsetDimToSrcDim.end())
1062 : {
1063 52 : srcDimFullName = oIterRealSrcDim->second->GetFullName();
1064 52 : oIter = mapSrcToDstDims.find(srcDimFullName);
1065 52 : if (oIter != mapSrcToDstDims.end())
1066 : {
1067 10 : dstArrayDims.emplace_back(oIter->second);
1068 10 : continue;
1069 : }
1070 : }
1071 :
1072 83 : const auto nDimSize = srcDim->GetSize();
1073 83 : std::string newDimNameFullName(srcDimFullName);
1074 83 : std::string newDimName(srcDim->GetName());
1075 83 : int nIncr = 2;
1076 83 : std::string osDstGroupFullName(poDstGroup->GetFullName());
1077 83 : if (osDstGroupFullName == "/")
1078 81 : osDstGroupFullName.clear();
1079 166 : auto oIter2 = mapDstDimFullNames.find(osDstGroupFullName + '/' +
1080 166 : srcDim->GetName());
1081 88 : while (oIter2 != mapDstDimFullNames.end() &&
1082 4 : oIter2->second->GetSize() != nDimSize)
1083 : {
1084 1 : newDimName = srcDim->GetName() + CPLSPrintf("_%d", nIncr);
1085 2 : newDimNameFullName = osDstGroupFullName + '/' + srcDim->GetName() +
1086 1 : CPLSPrintf("_%d", nIncr);
1087 1 : nIncr++;
1088 1 : oIter2 = mapDstDimFullNames.find(newDimNameFullName);
1089 : }
1090 86 : if (oIter2 != mapDstDimFullNames.end() &&
1091 3 : oIter2->second->GetSize() == nDimSize)
1092 : {
1093 3 : dstArrayDims.emplace_back(oIter2->second);
1094 3 : continue;
1095 : }
1096 :
1097 240 : dstDim = poDstGroup->CreateDimension(newDimName, srcDim->GetType(),
1098 160 : srcDim->GetDirection(), nDimSize);
1099 80 : if (!dstDim)
1100 0 : return false;
1101 80 : if (!srcDimFullName.empty() && srcDimFullName[0] == '/')
1102 : {
1103 72 : mapSrcToDstDims[srcDimFullName] = dstDim;
1104 : }
1105 80 : mapDstDimFullNames[dstDim->GetFullName()] = dstDim;
1106 80 : dstArrayDims.emplace_back(dstDim);
1107 :
1108 0 : std::shared_ptr<GDALMDArray> srcIndexVar;
1109 80 : GDALMDArray::Range range;
1110 80 : range.m_nStartIdx = 0;
1111 80 : range.m_nIncr = 1;
1112 80 : std::string indexingVarSpec;
1113 80 : if (idxSliceSpec >= 0)
1114 : {
1115 49 : const auto &viewSpec(viewSpecs[idxSliceSpec]);
1116 49 : auto iParentDim = viewSpec.m_mapDimIdxToParentDimIdx[i];
1117 48 : if (iParentDim != static_cast<size_t>(-1) &&
1118 : (srcIndexVar =
1119 97 : srcArrayDims[iParentDim]->GetIndexingVariable()) !=
1120 46 : nullptr &&
1121 143 : srcIndexVar->GetDimensionCount() == 1 &&
1122 46 : srcIndexVar->GetFullName() != srcArray->GetFullName())
1123 : {
1124 10 : CPLAssert(iParentDim < viewSpec.m_parentRanges.size());
1125 10 : range = viewSpec.m_parentRanges[iParentDim];
1126 10 : indexingVarSpec = "name=" + srcIndexVar->GetFullName();
1127 10 : indexingVarSpec += ",dstname=" + newDimName;
1128 20 : if (psOptions->aosSubset.empty() &&
1129 10 : psOptions->aosScaleFactor.empty())
1130 : {
1131 7 : if (range.m_nStartIdx != 0 || range.m_nIncr != 1 ||
1132 3 : srcArrayDims[iParentDim]->GetSize() !=
1133 3 : srcDim->GetSize())
1134 : {
1135 1 : indexingVarSpec += ",view=[";
1136 2 : if (range.m_nIncr > 0 ||
1137 1 : range.m_nStartIdx != srcDim->GetSize() - 1)
1138 : {
1139 : indexingVarSpec +=
1140 0 : CPLSPrintf(CPL_FRMT_GUIB, range.m_nStartIdx);
1141 : }
1142 1 : indexingVarSpec += ':';
1143 1 : if (range.m_nIncr > 0)
1144 : {
1145 : const auto nEndIdx =
1146 0 : range.m_nStartIdx +
1147 0 : range.m_nIncr * srcDim->GetSize();
1148 : indexingVarSpec +=
1149 0 : CPLSPrintf(CPL_FRMT_GUIB, nEndIdx);
1150 : }
1151 2 : else if (range.m_nStartIdx >
1152 1 : -range.m_nIncr * srcDim->GetSize())
1153 : {
1154 : const auto nEndIdx =
1155 0 : range.m_nStartIdx +
1156 0 : range.m_nIncr * srcDim->GetSize();
1157 : indexingVarSpec +=
1158 0 : CPLSPrintf(CPL_FRMT_GUIB, nEndIdx - 1);
1159 : }
1160 1 : indexingVarSpec += ':';
1161 : indexingVarSpec +=
1162 1 : CPLSPrintf(CPL_FRMT_GIB, range.m_nIncr);
1163 1 : indexingVarSpec += ']';
1164 : }
1165 : }
1166 : }
1167 : }
1168 : else
1169 : {
1170 31 : srcIndexVar = srcDim->GetIndexingVariable();
1171 31 : if (srcIndexVar)
1172 : {
1173 29 : indexingVarSpec = srcIndexVar->GetFullName();
1174 : }
1175 : }
1176 119 : if (srcIndexVar && !indexingVarSpec.empty() &&
1177 39 : srcIndexVar->GetFullName() != srcArray->GetFullName())
1178 : {
1179 30 : if (poSrcRootGroup)
1180 : {
1181 28 : if (!TranslateArray(oDimRemapper, srcIndexVar, indexingVarSpec,
1182 : poSrcRootGroup, poSrcGroup, poDstRootGroup,
1183 : poDstGroup, poSrcDS, mapSrcToDstDims,
1184 : mapDstDimFullNames, psOptions))
1185 : {
1186 0 : return false;
1187 : }
1188 : }
1189 : else
1190 : {
1191 2 : GDALGeoTransform gt;
1192 4 : if (poSrcDS->GetGeoTransform(gt) == CE_None && gt[2] == 0.0 &&
1193 2 : gt[4] == 0.0)
1194 : {
1195 : auto var = std::dynamic_pointer_cast<VRTMDArray>(
1196 8 : poDstGroup->CreateMDArray(
1197 : newDimName, {dstDim},
1198 8 : GDALExtendedDataType::Create(GDT_Float64)));
1199 2 : if (var)
1200 : {
1201 : const double dfStart =
1202 2 : srcIndexVar->GetName() == "X"
1203 2 : ? gt[0] + (range.m_nStartIdx + 0.5) * gt[1]
1204 1 : : gt[3] + (range.m_nStartIdx + 0.5) * gt[5];
1205 : const double dfIncr =
1206 2 : (srcIndexVar->GetName() == "X" ? gt[1] : gt[5]) *
1207 2 : range.m_nIncr;
1208 : std::unique_ptr<VRTMDArraySourceRegularlySpaced>
1209 : poSource(new VRTMDArraySourceRegularlySpaced(
1210 2 : dfStart, dfIncr));
1211 2 : var->AddSource(std::move(poSource));
1212 : }
1213 : }
1214 : }
1215 :
1216 60 : CPLErrorStateBackuper oErrorStateBackuper(CPLQuietErrorHandler);
1217 60 : auto poDstIndexingVar(poDstGroup->OpenMDArray(newDimName));
1218 30 : if (poDstIndexingVar)
1219 29 : dstDim->SetIndexingVariable(std::move(poDstIndexingVar));
1220 : }
1221 : }
1222 250 : if (outputType.GetClass() == GEDTC_NUMERIC &&
1223 125 : outputType.GetNumericDataType() == GDT_Unknown)
1224 : {
1225 125 : outputType = GDALExtendedDataType(tmpArray->GetDataType());
1226 : }
1227 : auto dstArray =
1228 250 : poDstGroup->CreateMDArray(dstArrayName, dstArrayDims, outputType);
1229 250 : auto dstArrayVRT = std::dynamic_pointer_cast<VRTMDArray>(dstArray);
1230 125 : if (!dstArrayVRT)
1231 0 : return false;
1232 :
1233 125 : GUInt64 nCurCost = 0;
1234 125 : dstArray->CopyFromAllExceptValues(srcArray.get(), false, nCurCost, 0,
1235 : nullptr, nullptr);
1236 125 : if (bResampled)
1237 1 : dstArray->SetSpatialRef(tmpArray->GetSpatialRef().get());
1238 :
1239 125 : if (idxSliceSpec >= 0)
1240 : {
1241 140 : std::set<size_t> oSetParentDimIdxNotInArray;
1242 158 : for (size_t i = 0; i < srcArrayDims.size(); ++i)
1243 : {
1244 88 : oSetParentDimIdxNotInArray.insert(i);
1245 : }
1246 70 : const auto &viewSpec(viewSpecs[idxSliceSpec]);
1247 138 : for (size_t i = 0; i < tmpArrayDims.size(); ++i)
1248 : {
1249 68 : auto iParentDim = viewSpec.m_mapDimIdxToParentDimIdx[i];
1250 68 : if (iParentDim != static_cast<size_t>(-1))
1251 : {
1252 67 : oSetParentDimIdxNotInArray.erase(iParentDim);
1253 : }
1254 : }
1255 91 : for (const auto parentDimIdx : oSetParentDimIdxNotInArray)
1256 : {
1257 21 : const auto &srcDim(srcArrayDims[parentDimIdx]);
1258 : const auto nStartIdx =
1259 21 : viewSpec.m_parentRanges[parentDimIdx].m_nStartIdx;
1260 21 : if (nStartIdx < static_cast<GUInt64>(INT_MAX))
1261 : {
1262 21 : auto dstAttr = dstArray->CreateAttribute(
1263 42 : "DIM_" + srcDim->GetName() + "_INDEX", {},
1264 84 : GDALExtendedDataType::Create(GDT_Int32));
1265 21 : dstAttr->Write(static_cast<int>(nStartIdx));
1266 : }
1267 : else
1268 : {
1269 0 : auto dstAttr = dstArray->CreateAttribute(
1270 0 : "DIM_" + srcDim->GetName() + "_INDEX", {},
1271 0 : GDALExtendedDataType::CreateString());
1272 0 : dstAttr->Write(CPLSPrintf(CPL_FRMT_GUIB,
1273 : static_cast<GUIntBig>(nStartIdx)));
1274 : }
1275 :
1276 42 : auto srcIndexVar(srcDim->GetIndexingVariable());
1277 21 : if (srcIndexVar && srcIndexVar->GetDimensionCount() == 1)
1278 : {
1279 21 : const auto &dt(srcIndexVar->GetDataType());
1280 42 : std::vector<GByte> abyTmp(dt.GetSize());
1281 21 : const size_t nCount = 1;
1282 42 : if (srcIndexVar->Read(&nStartIdx, &nCount, nullptr, nullptr, dt,
1283 21 : &abyTmp[0], nullptr, 0))
1284 : {
1285 : {
1286 21 : auto dstAttr = dstArray->CreateAttribute(
1287 63 : "DIM_" + srcDim->GetName() + "_VALUE", {}, dt);
1288 21 : dstAttr->Write(abyTmp.data(), abyTmp.size());
1289 21 : dt.FreeDynamicMemory(&abyTmp[0]);
1290 : }
1291 :
1292 21 : const auto &unit(srcIndexVar->GetUnit());
1293 21 : if (!unit.empty())
1294 : {
1295 0 : auto dstAttr = dstArray->CreateAttribute(
1296 0 : "DIM_" + srcDim->GetName() + "_UNIT", {},
1297 0 : GDALExtendedDataType::CreateString());
1298 0 : dstAttr->Write(unit.c_str());
1299 : }
1300 : }
1301 : }
1302 : }
1303 : }
1304 :
1305 125 : double dfStart = 0.0;
1306 125 : double dfIncrement = 0.0;
1307 127 : if (!bSrcArrayAccessibleThroughSrcGroup &&
1308 2 : tmpArray->IsRegularlySpaced(dfStart, dfIncrement))
1309 : {
1310 : auto poSource = std::make_unique<VRTMDArraySourceRegularlySpaced>(
1311 2 : dfStart, dfIncrement);
1312 2 : dstArrayVRT->AddSource(std::move(poSource));
1313 : }
1314 : else
1315 : {
1316 123 : const auto dimCount(tmpArray->GetDimensionCount());
1317 246 : std::vector<GUInt64> anSrcOffset(dimCount);
1318 246 : std::vector<GUInt64> anCount(dimCount);
1319 261 : for (size_t i = 0; i < dimCount; ++i)
1320 : {
1321 138 : anCount[i] = tmpArrayDims[i]->GetSize();
1322 : }
1323 246 : std::vector<GUInt64> anStep(dimCount, 1);
1324 246 : std::vector<GUInt64> anDstOffset(dimCount);
1325 : std::unique_ptr<VRTMDArraySourceFromArray> poSource(
1326 : new VRTMDArraySourceFromArray(
1327 123 : dstArrayVRT.get(), false, false, poSrcDS->GetDescription(),
1328 246 : band < 0 ? srcArray->GetFullName() : std::string(),
1329 247 : band >= 1 ? CPLSPrintf("%d", band) : std::string(),
1330 123 : std::move(anTransposedAxis),
1331 : bResampled
1332 368 : ? (viewExpr.empty()
1333 : ? std::string("resample=true")
1334 123 : : std::string("resample=true,").append(viewExpr))
1335 122 : : std::move(viewExpr),
1336 123 : std::move(anSrcOffset), std::move(anCount), std::move(anStep),
1337 369 : std::move(anDstOffset)));
1338 123 : dstArrayVRT->AddSource(std::move(poSource));
1339 : }
1340 :
1341 125 : return true;
1342 : }
1343 :
1344 : /************************************************************************/
1345 : /* GetGroup() */
1346 : /************************************************************************/
1347 :
1348 : static std::shared_ptr<GDALGroup>
1349 6 : GetGroup(const std::shared_ptr<GDALGroup> &poRootGroup,
1350 : const std::string &fullName)
1351 : {
1352 12 : auto poCurGroup = poRootGroup;
1353 12 : CPLStringList aosTokens(CSLTokenizeString2(fullName.c_str(), "/", 0));
1354 10 : for (int i = 0; i < aosTokens.size(); i++)
1355 : {
1356 10 : auto poCurGroupNew = poCurGroup->OpenGroup(aosTokens[i], nullptr);
1357 5 : if (!poCurGroupNew)
1358 : {
1359 1 : CPLError(CE_Failure, CPLE_AppDefined, "Cannot find group %s",
1360 : aosTokens[i]);
1361 1 : return nullptr;
1362 : }
1363 4 : poCurGroup = std::move(poCurGroupNew);
1364 : }
1365 5 : return poCurGroup;
1366 : }
1367 :
1368 : /************************************************************************/
1369 : /* CopyGroup() */
1370 : /************************************************************************/
1371 :
1372 17 : static bool CopyGroup(
1373 : DimensionRemapper &oDimRemapper,
1374 : const std::shared_ptr<GDALGroup> &poDstRootGroup,
1375 : std::shared_ptr<GDALGroup> &poDstGroup,
1376 : const std::shared_ptr<GDALGroup> &poSrcRootGroup,
1377 : const std::shared_ptr<GDALGroup> &poSrcGroup, GDALDataset *poSrcDS,
1378 : std::map<std::string, std::shared_ptr<GDALDimension>> &mapSrcToDstDims,
1379 : std::map<std::string, std::shared_ptr<GDALDimension>> &mapDstDimFullNames,
1380 : const GDALMultiDimTranslateOptions *psOptions, bool bRecursive)
1381 : {
1382 34 : const auto srcDims = poSrcGroup->GetDimensions();
1383 34 : std::map<std::string, std::string> mapSrcVariableNameToIndexedDimName;
1384 29 : for (const auto &dim : srcDims)
1385 : {
1386 15 : const auto poDimDesc = GetDimensionDesc(oDimRemapper, psOptions, dim);
1387 15 : if (poDimDesc == nullptr)
1388 3 : return false;
1389 12 : if (poDimDesc->bSlice)
1390 2 : continue;
1391 : auto dstDim =
1392 10 : poDstGroup->CreateDimension(dim->GetName(), dim->GetType(),
1393 10 : dim->GetDirection(), poDimDesc->nSize);
1394 10 : if (!dstDim)
1395 0 : return false;
1396 10 : mapSrcToDstDims[dim->GetFullName()] = dstDim;
1397 10 : mapDstDimFullNames[dstDim->GetFullName()] = dstDim;
1398 20 : auto poIndexingVarSrc(dim->GetIndexingVariable());
1399 10 : if (poIndexingVarSrc)
1400 : {
1401 10 : mapSrcVariableNameToIndexedDimName[poIndexingVarSrc->GetName()] =
1402 20 : dim->GetFullName();
1403 : }
1404 : }
1405 :
1406 14 : if (!(poSrcGroup == poSrcRootGroup && psOptions->aosGroup.empty()))
1407 : {
1408 11 : auto attrs = poSrcGroup->GetAttributes();
1409 15 : for (const auto &attr : attrs)
1410 : {
1411 4 : auto dstAttr = poDstGroup->CreateAttribute(
1412 4 : attr->GetName(), attr->GetDimensionsSize(),
1413 8 : attr->GetDataType());
1414 4 : if (!dstAttr)
1415 : {
1416 0 : if (!psOptions->bStrict)
1417 0 : continue;
1418 0 : return false;
1419 : }
1420 4 : auto raw(attr->ReadAsRaw());
1421 4 : if (!dstAttr->Write(raw.data(), raw.size()) && !psOptions->bStrict)
1422 0 : return false;
1423 : }
1424 : }
1425 :
1426 : auto arrayNames =
1427 28 : poSrcGroup->GetMDArrayNames(psOptions->aosArrayOptions.List());
1428 40 : for (const auto &name : arrayNames)
1429 : {
1430 26 : if (!TranslateArray(oDimRemapper, nullptr, name, poSrcRootGroup,
1431 : poSrcGroup, poDstRootGroup, poDstGroup, poSrcDS,
1432 : mapSrcToDstDims, mapDstDimFullNames, psOptions))
1433 : {
1434 0 : return false;
1435 : }
1436 :
1437 : // If this array is the indexing variable of a dimension, link them
1438 : // together.
1439 52 : auto srcArray = poSrcGroup->OpenMDArray(name);
1440 26 : CPLAssert(srcArray);
1441 52 : auto dstArray = poDstGroup->OpenMDArray(name);
1442 26 : CPLAssert(dstArray);
1443 : auto oIterDimName =
1444 26 : mapSrcVariableNameToIndexedDimName.find(srcArray->GetName());
1445 26 : if (oIterDimName != mapSrcVariableNameToIndexedDimName.end())
1446 : {
1447 : auto oCorrespondingDimIter =
1448 10 : mapSrcToDstDims.find(oIterDimName->second);
1449 10 : if (oCorrespondingDimIter != mapSrcToDstDims.end())
1450 : {
1451 10 : CPLErrorStateBackuper oErrorStateBackuper(CPLQuietErrorHandler);
1452 20 : oCorrespondingDimIter->second->SetIndexingVariable(
1453 10 : std::move(dstArray));
1454 : }
1455 : }
1456 : }
1457 :
1458 14 : if (bRecursive)
1459 : {
1460 14 : auto groupNames = poSrcGroup->GetGroupNames();
1461 20 : for (const auto &name : groupNames)
1462 : {
1463 6 : auto srcSubGroup = poSrcGroup->OpenGroup(name);
1464 6 : if (!srcSubGroup)
1465 : {
1466 0 : return false;
1467 : }
1468 6 : auto dstSubGroup = poDstGroup->CreateGroup(name);
1469 6 : if (!dstSubGroup)
1470 : {
1471 0 : return false;
1472 : }
1473 6 : if (!CopyGroup(oDimRemapper, poDstRootGroup, dstSubGroup,
1474 : poSrcRootGroup, srcSubGroup, poSrcDS,
1475 : mapSrcToDstDims, mapDstDimFullNames, psOptions,
1476 : true))
1477 : {
1478 0 : return false;
1479 : }
1480 : }
1481 : }
1482 14 : return true;
1483 : }
1484 :
1485 : /************************************************************************/
1486 : /* ParseGroupSpec() */
1487 : /************************************************************************/
1488 :
1489 : // foo
1490 : // name=foo,dstname=bar,recursive=no
1491 7 : static bool ParseGroupSpec(const std::string &groupSpec, std::string &srcName,
1492 : std::string &dstName, bool &bRecursive)
1493 : {
1494 7 : bRecursive = true;
1495 7 : if (!STARTS_WITH(groupSpec.c_str(), "name="))
1496 : {
1497 5 : srcName = groupSpec;
1498 5 : return true;
1499 : }
1500 :
1501 4 : CPLStringList aosTokens(CSLTokenizeString2(groupSpec.c_str(), ",", 0));
1502 5 : for (int i = 0; i < aosTokens.size(); i++)
1503 : {
1504 4 : const std::string token(aosTokens[i]);
1505 4 : if (STARTS_WITH(token.c_str(), "name="))
1506 : {
1507 2 : srcName = token.substr(strlen("name="));
1508 : }
1509 2 : else if (STARTS_WITH(token.c_str(), "dstname="))
1510 : {
1511 1 : dstName = token.substr(strlen("dstname="));
1512 : }
1513 1 : else if (token == "recursive=no")
1514 : {
1515 0 : bRecursive = false;
1516 : }
1517 : else
1518 : {
1519 1 : CPLError(CE_Failure, CPLE_AppDefined,
1520 : "Unexpected group specification part: %s", token.c_str());
1521 1 : return false;
1522 : }
1523 : }
1524 1 : return true;
1525 : }
1526 :
1527 : /************************************************************************/
1528 : /* TranslateInternal() */
1529 : /************************************************************************/
1530 :
1531 102 : static bool TranslateInternal(std::shared_ptr<GDALGroup> &poDstRootGroup,
1532 : GDALDataset *poSrcDS,
1533 : const GDALMultiDimTranslateOptions *psOptions)
1534 : {
1535 :
1536 204 : auto poSrcRootGroup = poSrcDS->GetRootGroup();
1537 102 : if (poSrcRootGroup)
1538 : {
1539 101 : if (psOptions->aosGroup.empty())
1540 : {
1541 190 : auto attrs = poSrcRootGroup->GetAttributes();
1542 99 : for (const auto &attr : attrs)
1543 : {
1544 4 : if (attr->GetName() == "Conventions")
1545 1 : continue;
1546 3 : auto dstAttr = poDstRootGroup->CreateAttribute(
1547 3 : attr->GetName(), attr->GetDimensionsSize(),
1548 9 : attr->GetDataType());
1549 3 : if (dstAttr)
1550 : {
1551 6 : auto raw(attr->ReadAsRaw());
1552 3 : dstAttr->Write(raw.data(), raw.size());
1553 : }
1554 : }
1555 : }
1556 : }
1557 :
1558 204 : DimensionRemapper oDimRemapper;
1559 204 : std::map<std::string, std::shared_ptr<GDALDimension>> mapSrcToDstDims;
1560 204 : std::map<std::string, std::shared_ptr<GDALDimension>> mapDstDimFullNames;
1561 102 : if (!psOptions->aosGroup.empty())
1562 : {
1563 6 : if (poSrcRootGroup == nullptr)
1564 : {
1565 0 : CPLError(
1566 : CE_Failure, CPLE_AppDefined,
1567 : "No multidimensional source dataset: -group cannot be used");
1568 0 : return false;
1569 : }
1570 6 : if (psOptions->aosGroup.size() == 1)
1571 : {
1572 10 : std::string srcName;
1573 10 : std::string dstName;
1574 : bool bRecursive;
1575 5 : if (!ParseGroupSpec(psOptions->aosGroup[0], srcName, dstName,
1576 : bRecursive))
1577 1 : return false;
1578 8 : auto poSrcGroup = GetGroup(poSrcRootGroup, srcName);
1579 4 : if (!poSrcGroup)
1580 1 : return false;
1581 3 : return CopyGroup(oDimRemapper, poDstRootGroup, poDstRootGroup,
1582 : poSrcRootGroup, poSrcGroup, poSrcDS,
1583 : mapSrcToDstDims, mapDstDimFullNames, psOptions,
1584 3 : bRecursive);
1585 : }
1586 : else
1587 : {
1588 3 : for (const auto &osGroupSpec : psOptions->aosGroup)
1589 : {
1590 2 : std::string srcName;
1591 2 : std::string dstName;
1592 : bool bRecursive;
1593 2 : if (!ParseGroupSpec(osGroupSpec, srcName, dstName, bRecursive))
1594 0 : return false;
1595 2 : auto poSrcGroup = GetGroup(poSrcRootGroup, srcName);
1596 2 : if (!poSrcGroup)
1597 0 : return false;
1598 2 : if (dstName.empty())
1599 1 : dstName = poSrcGroup->GetName();
1600 2 : auto dstSubGroup = poDstRootGroup->CreateGroup(dstName);
1601 4 : if (!dstSubGroup ||
1602 2 : !CopyGroup(oDimRemapper, poDstRootGroup, dstSubGroup,
1603 : poSrcRootGroup, poSrcGroup, poSrcDS,
1604 : mapSrcToDstDims, mapDstDimFullNames, psOptions,
1605 : bRecursive))
1606 : {
1607 0 : return false;
1608 : }
1609 : }
1610 : }
1611 : }
1612 96 : else if (!psOptions->aosArraySpec.empty())
1613 : {
1614 161 : for (const auto &arraySpec : psOptions->aosArraySpec)
1615 : {
1616 90 : if (!TranslateArray(oDimRemapper, nullptr, arraySpec,
1617 : poSrcRootGroup, poSrcRootGroup, poDstRootGroup,
1618 : poDstRootGroup, poSrcDS, mapSrcToDstDims,
1619 : mapDstDimFullNames, psOptions))
1620 : {
1621 19 : return false;
1622 : }
1623 : }
1624 : }
1625 : else
1626 : {
1627 6 : if (poSrcRootGroup == nullptr)
1628 : {
1629 0 : CPLError(CE_Failure, CPLE_AppDefined,
1630 : "No multidimensional source dataset");
1631 0 : return false;
1632 : }
1633 6 : return CopyGroup(oDimRemapper, poDstRootGroup, poDstRootGroup,
1634 : poSrcRootGroup, poSrcRootGroup, poSrcDS,
1635 6 : mapSrcToDstDims, mapDstDimFullNames, psOptions, true);
1636 : }
1637 :
1638 72 : return true;
1639 : }
1640 :
1641 : /************************************************************************/
1642 : /* CopyToNonMultiDimensionalDriver() */
1643 : /************************************************************************/
1644 :
1645 : static GDALDatasetH
1646 4 : CopyToNonMultiDimensionalDriver(GDALDriver *poDriver, const char *pszDest,
1647 : const std::shared_ptr<GDALGroup> &poRG,
1648 : const GDALMultiDimTranslateOptions *psOptions)
1649 : {
1650 4 : std::shared_ptr<GDALMDArray> srcArray;
1651 4 : if (psOptions && !psOptions->aosArraySpec.empty())
1652 : {
1653 3 : if (psOptions->aosArraySpec.size() != 1)
1654 : {
1655 0 : CPLError(CE_Failure, CPLE_NotSupported,
1656 : "For output to a non-multidimensional driver, only "
1657 : "one array should be specified");
1658 0 : return nullptr;
1659 : }
1660 6 : std::string srcArrayName;
1661 6 : std::string dstArrayName;
1662 3 : int band = -1;
1663 6 : std::vector<int> anTransposedAxis;
1664 6 : std::string viewExpr;
1665 : GDALExtendedDataType outputType(
1666 3 : GDALExtendedDataType::Create(GDT_Unknown));
1667 3 : bool bResampled = false;
1668 3 : ParseArraySpec(psOptions->aosArraySpec[0], srcArrayName, dstArrayName,
1669 : band, anTransposedAxis, viewExpr, outputType,
1670 : bResampled);
1671 3 : srcArray = poRG->OpenMDArray(dstArrayName);
1672 : }
1673 : else
1674 : {
1675 1 : auto srcArrayNames = poRG->GetMDArrayNames(
1676 1 : psOptions ? psOptions->aosArrayOptions.List() : nullptr);
1677 4 : for (const auto &srcArrayName : srcArrayNames)
1678 : {
1679 4 : auto tmpArray = poRG->OpenMDArray(srcArrayName);
1680 4 : if (tmpArray)
1681 : {
1682 4 : const auto &dims(tmpArray->GetDimensions());
1683 10 : if (!(dims.size() == 1 && dims[0]->GetIndexingVariable() &&
1684 6 : dims[0]->GetIndexingVariable()->GetName() ==
1685 : srcArrayName))
1686 : {
1687 2 : if (srcArray)
1688 : {
1689 1 : CPLError(CE_Failure, CPLE_AppDefined,
1690 : "Several arrays exist. Select one for "
1691 : "output to non-multidimensional driver");
1692 1 : return nullptr;
1693 : }
1694 1 : srcArray = std::move(tmpArray);
1695 : }
1696 : }
1697 : }
1698 : }
1699 3 : if (!srcArray)
1700 : {
1701 0 : CPLError(CE_Failure, CPLE_AppDefined, "Cannot find source array");
1702 0 : return nullptr;
1703 : }
1704 3 : size_t iXDim = static_cast<size_t>(-1);
1705 3 : size_t iYDim = static_cast<size_t>(-1);
1706 3 : const auto &dims(srcArray->GetDimensions());
1707 8 : for (size_t i = 0; i < dims.size(); ++i)
1708 : {
1709 5 : if (dims[i]->GetType() == GDAL_DIM_TYPE_HORIZONTAL_X)
1710 : {
1711 2 : iXDim = i;
1712 : }
1713 3 : else if (dims[i]->GetType() == GDAL_DIM_TYPE_HORIZONTAL_Y)
1714 : {
1715 3 : iYDim = i;
1716 : }
1717 : }
1718 3 : if (dims.size() == 1)
1719 : {
1720 1 : iXDim = 0;
1721 : }
1722 2 : else if (dims.size() >= 2 && (iXDim == static_cast<size_t>(-1) ||
1723 : iYDim == static_cast<size_t>(-1)))
1724 : {
1725 0 : iXDim = dims.size() - 1;
1726 0 : iYDim = dims.size() - 2;
1727 : }
1728 : std::unique_ptr<GDALDataset> poTmpSrcDS(
1729 6 : srcArray->AsClassicDataset(iXDim, iYDim));
1730 3 : if (!poTmpSrcDS)
1731 0 : return nullptr;
1732 6 : return GDALDataset::ToHandle(poDriver->CreateCopy(
1733 : pszDest, poTmpSrcDS.get(), false,
1734 3 : psOptions ? const_cast<char **>(psOptions->aosCreateOptions.List())
1735 : : nullptr,
1736 : psOptions ? psOptions->pfnProgress : nullptr,
1737 3 : psOptions ? psOptions->pProgressData : nullptr));
1738 : }
1739 :
1740 : /************************************************************************/
1741 : /* GDALMultiDimTranslate() */
1742 : /************************************************************************/
1743 :
1744 : /* clang-format off */
1745 : /**
1746 : * Converts raster data between different formats.
1747 : *
1748 : * This is the equivalent of the
1749 : * <a href="/programs/gdalmdimtranslate.html">gdalmdimtranslate</a> utility.
1750 : *
1751 : * GDALMultiDimTranslateOptions* must be allocated and freed with
1752 : * GDALMultiDimTranslateOptionsNew() and GDALMultiDimTranslateOptionsFree()
1753 : * respectively. pszDest and hDstDS cannot be used at the same time.
1754 : *
1755 : * @param pszDest the destination dataset path or NULL.
1756 : * @param hDstDS the destination dataset or NULL.
1757 : * @param nSrcCount the number of input datasets.
1758 : * @param pahSrcDS the list of input datasets.
1759 : * @param psOptions the options struct returned by
1760 : * GDALMultiDimTranslateOptionsNew() or NULL.
1761 : * @param pbUsageError pointer to a integer output variable to store if any
1762 : * usage error has occurred or NULL.
1763 : * @return the output dataset (new dataset that must be closed using
1764 : * GDALClose(), or hDstDS is not NULL) or NULL in case of error.
1765 : *
1766 : * @since GDAL 3.1
1767 : */
1768 : /* clang-format on */
1769 :
1770 : GDALDatasetH
1771 116 : GDALMultiDimTranslate(const char *pszDest, GDALDatasetH hDstDS, int nSrcCount,
1772 : GDALDatasetH *pahSrcDS,
1773 : const GDALMultiDimTranslateOptions *psOptions,
1774 : int *pbUsageError)
1775 : {
1776 116 : if (pbUsageError)
1777 106 : *pbUsageError = false;
1778 116 : if (nSrcCount != 1 || pahSrcDS[0] == nullptr)
1779 : {
1780 0 : CPLError(CE_Failure, CPLE_NotSupported,
1781 : "Only one source dataset is supported");
1782 0 : if (pbUsageError)
1783 0 : *pbUsageError = true;
1784 0 : return nullptr;
1785 : }
1786 :
1787 116 : if (hDstDS)
1788 : {
1789 0 : CPLError(CE_Failure, CPLE_NotSupported,
1790 : "Update of existing file not supported yet");
1791 0 : GDALClose(hDstDS);
1792 0 : return nullptr;
1793 : }
1794 :
1795 348 : CPLString osFormat(psOptions ? psOptions->osFormat : "");
1796 116 : if (pszDest == nullptr /* && hDstDS == nullptr */)
1797 : {
1798 0 : CPLError(CE_Failure, CPLE_NotSupported,
1799 : "Both pszDest and hDstDS are NULL.");
1800 0 : if (pbUsageError)
1801 0 : *pbUsageError = true;
1802 0 : return nullptr;
1803 : }
1804 :
1805 116 : GDALDriver *poDriver = nullptr;
1806 :
1807 : #ifdef this_is_dead_code_for_now
1808 : const bool bCloseOutDSOnError = hDstDS == nullptr;
1809 : if (pszDest == nullptr)
1810 : pszDest = GDALGetDescription(hDstDS);
1811 : #endif
1812 :
1813 116 : if (psOptions && psOptions->bOverwrite && !EQUAL(pszDest, ""))
1814 : {
1815 1 : VSIRmdirRecursive(pszDest);
1816 : }
1817 115 : else if (psOptions && psOptions->bNoOverwrite && !EQUAL(pszDest, ""))
1818 : {
1819 : VSIStatBufL sStat;
1820 8 : if (VSIStatL(pszDest, &sStat) == 0)
1821 : {
1822 0 : CPLError(CE_Failure, CPLE_AppDefined,
1823 : "File '%s' already exists. Specify the --overwrite "
1824 : "option to overwrite it.",
1825 : pszDest);
1826 0 : return nullptr;
1827 : }
1828 8 : else if (std::unique_ptr<GDALDataset>(GDALDataset::Open(pszDest)))
1829 : {
1830 0 : CPLError(CE_Failure, CPLE_AppDefined,
1831 : "Dataset '%s' already exists. Specify the --overwrite "
1832 : "option to overwrite it.",
1833 : pszDest);
1834 0 : return nullptr;
1835 : }
1836 : }
1837 :
1838 : #ifdef this_is_dead_code_for_now
1839 : if (hDstDS == nullptr)
1840 : #endif
1841 : {
1842 116 : if (osFormat.empty())
1843 : {
1844 107 : if (EQUAL(CPLGetExtensionSafe(pszDest).c_str(), "nc"))
1845 2 : osFormat = "netCDF";
1846 : else
1847 105 : osFormat = GetOutputDriverForRaster(pszDest);
1848 107 : if (osFormat.empty())
1849 : {
1850 1 : CPLError(CE_Failure, CPLE_AppDefined,
1851 : "Cannot determine output driver for dataset name '%s'",
1852 : pszDest);
1853 1 : return nullptr;
1854 : }
1855 : }
1856 115 : poDriver = GDALDriver::FromHandle(GDALGetDriverByName(osFormat));
1857 115 : char **papszDriverMD = poDriver ? poDriver->GetMetadata() : nullptr;
1858 230 : if (poDriver == nullptr ||
1859 115 : (!CPLTestBool(CSLFetchNameValueDef(papszDriverMD, GDAL_DCAP_RASTER,
1860 0 : "FALSE")) &&
1861 0 : !CPLTestBool(CSLFetchNameValueDef(
1862 230 : papszDriverMD, GDAL_DCAP_MULTIDIM_RASTER, "FALSE"))) ||
1863 115 : (!CPLTestBool(CSLFetchNameValueDef(papszDriverMD, GDAL_DCAP_CREATE,
1864 0 : "FALSE")) &&
1865 0 : !CPLTestBool(CSLFetchNameValueDef(
1866 0 : papszDriverMD, GDAL_DCAP_CREATECOPY, "FALSE")) &&
1867 0 : !CPLTestBool(CSLFetchNameValueDef(
1868 0 : papszDriverMD, GDAL_DCAP_CREATE_MULTIDIMENSIONAL, "FALSE")) &&
1869 0 : !CPLTestBool(CSLFetchNameValueDef(
1870 : papszDriverMD, GDAL_DCAP_CREATECOPY_MULTIDIMENSIONAL,
1871 : "FALSE"))))
1872 : {
1873 0 : CPLError(CE_Failure, CPLE_NotSupported,
1874 : "Output driver `%s' not recognised or does not support "
1875 : "output file creation.",
1876 : osFormat.c_str());
1877 0 : return nullptr;
1878 : }
1879 : }
1880 :
1881 115 : GDALDataset *poSrcDS = GDALDataset::FromHandle(pahSrcDS[0]);
1882 :
1883 115 : std::unique_ptr<GDALDataset> poTmpDS;
1884 115 : GDALDataset *poTmpSrcDS = poSrcDS;
1885 230 : if (psOptions &&
1886 115 : (!psOptions->aosArraySpec.empty() || !psOptions->aosGroup.empty() ||
1887 19 : !psOptions->aosSubset.empty() || !psOptions->aosScaleFactor.empty() ||
1888 14 : !psOptions->aosArrayOptions.empty()))
1889 : {
1890 102 : poTmpDS.reset(VRTDataset::CreateMultiDimensional("", nullptr, nullptr));
1891 102 : CPLAssert(poTmpDS);
1892 102 : poTmpSrcDS = poTmpDS.get();
1893 :
1894 102 : auto poDstRootGroup = poTmpDS->GetRootGroup();
1895 102 : CPLAssert(poDstRootGroup);
1896 :
1897 102 : if (!TranslateInternal(poDstRootGroup, poSrcDS, psOptions))
1898 : {
1899 : #ifdef this_is_dead_code_for_now
1900 : if (bCloseOutDSOnError)
1901 : #endif
1902 : {
1903 24 : GDALClose(hDstDS);
1904 24 : hDstDS = nullptr;
1905 : }
1906 24 : return nullptr;
1907 : }
1908 : }
1909 :
1910 91 : auto poRG(poTmpSrcDS->GetRootGroup());
1911 180 : if (poRG &&
1912 89 : poDriver->GetMetadataItem(GDAL_DCAP_CREATE_MULTIDIMENSIONAL) ==
1913 180 : nullptr &&
1914 4 : poDriver->GetMetadataItem(GDAL_DCAP_CREATECOPY_MULTIDIMENSIONAL) ==
1915 : nullptr)
1916 : {
1917 : #ifdef this_is_dead_code_for_now
1918 : if (hDstDS)
1919 : {
1920 : CPLError(CE_Failure, CPLE_NotSupported,
1921 : "Appending to non-multidimensional driver not supported.");
1922 : GDALClose(hDstDS);
1923 : hDstDS = nullptr;
1924 : return nullptr;
1925 : }
1926 : #endif
1927 : hDstDS =
1928 4 : CopyToNonMultiDimensionalDriver(poDriver, pszDest, poRG, psOptions);
1929 : }
1930 : else
1931 : {
1932 174 : hDstDS = GDALDataset::ToHandle(poDriver->CreateCopy(
1933 : pszDest, poTmpSrcDS, false,
1934 87 : psOptions ? const_cast<char **>(psOptions->aosCreateOptions.List())
1935 : : nullptr,
1936 : psOptions ? psOptions->pfnProgress : nullptr,
1937 : psOptions ? psOptions->pProgressData : nullptr));
1938 : }
1939 :
1940 91 : return hDstDS;
1941 : }
1942 :
1943 : /************************************************************************/
1944 : /* GDALMultiDimTranslateOptionsNew() */
1945 : /************************************************************************/
1946 :
1947 : /**
1948 : * Allocates a GDALMultiDimTranslateOptions struct.
1949 : *
1950 : * @param papszArgv NULL terminated list of options (potentially including
1951 : * filename and open options too), or NULL. The accepted options are the ones of
1952 : * the <a href="/programs/gdalmdimtranslate.html">gdalmdimtranslate</a> utility.
1953 : * @param psOptionsForBinary should be nullptr, unless called from
1954 : * gdalmdimtranslate_bin.cpp
1955 : * @return pointer to the allocated GDALMultiDimTranslateOptions struct. Must be
1956 : * freed with GDALMultiDimTranslateOptionsFree().
1957 : *
1958 : * @since GDAL 3.1
1959 : */
1960 :
1961 117 : GDALMultiDimTranslateOptions *GDALMultiDimTranslateOptionsNew(
1962 : char **papszArgv, GDALMultiDimTranslateOptionsForBinary *psOptionsForBinary)
1963 : {
1964 :
1965 234 : auto psOptions = std::make_unique<GDALMultiDimTranslateOptions>();
1966 :
1967 : /* -------------------------------------------------------------------- */
1968 : /* Parse arguments. */
1969 : /* -------------------------------------------------------------------- */
1970 : try
1971 : {
1972 : auto argParser = GDALMultiDimTranslateAppOptionsGetParser(
1973 117 : psOptions.get(), psOptionsForBinary);
1974 :
1975 117 : argParser->parse_args_without_binary_name(papszArgv);
1976 :
1977 : // Check for invalid options:
1978 : // -scaleaxes is not compatible with -array = "view"
1979 : // -subset is not compatible with -array = "view"
1980 117 : if (std::find(psOptions->aosArraySpec.cbegin(),
1981 117 : psOptions->aosArraySpec.cend(),
1982 351 : "view") != psOptions->aosArraySpec.cend())
1983 : {
1984 0 : if (!psOptions->aosScaleFactor.empty())
1985 : {
1986 0 : CPLError(CE_Failure, CPLE_NotSupported,
1987 : "The -scaleaxes option is not compatible with the "
1988 : "-array \"view\" option.");
1989 0 : return nullptr;
1990 : }
1991 :
1992 0 : if (!psOptions->aosSubset.empty())
1993 : {
1994 0 : CPLError(CE_Failure, CPLE_NotSupported,
1995 : "The -subset option is not compatible with the -array "
1996 : "\"view\" option.");
1997 0 : return nullptr;
1998 : }
1999 : }
2000 : }
2001 0 : catch (const std::exception &error)
2002 : {
2003 0 : CPLError(CE_Failure, CPLE_AppDefined, "%s", error.what());
2004 0 : return nullptr;
2005 : }
2006 :
2007 117 : if (psOptionsForBinary)
2008 : {
2009 : // Note: bUpdate is apparently never changed by the command line options
2010 3 : psOptionsForBinary->bUpdate = psOptions->bUpdate;
2011 3 : if (!psOptions->osFormat.empty())
2012 0 : psOptionsForBinary->osFormat = psOptions->osFormat;
2013 : }
2014 :
2015 117 : return psOptions.release();
2016 : }
2017 :
2018 : /************************************************************************/
2019 : /* GDALMultiDimTranslateOptionsFree() */
2020 : /************************************************************************/
2021 :
2022 : /**
2023 : * Frees the GDALMultiDimTranslateOptions struct.
2024 : *
2025 : * @param psOptions the options struct for GDALMultiDimTranslate().
2026 : *
2027 : * @since GDAL 3.1
2028 : */
2029 :
2030 116 : void GDALMultiDimTranslateOptionsFree(GDALMultiDimTranslateOptions *psOptions)
2031 : {
2032 116 : delete psOptions;
2033 116 : }
2034 :
2035 : /************************************************************************/
2036 : /* GDALMultiDimTranslateOptionsSetProgress() */
2037 : /************************************************************************/
2038 :
2039 : /**
2040 : * Set a progress function.
2041 : *
2042 : * @param psOptions the options struct for GDALMultiDimTranslate().
2043 : * @param pfnProgress the progress callback.
2044 : * @param pProgressData the user data for the progress callback.
2045 : *
2046 : * @since GDAL 3.1
2047 : */
2048 :
2049 13 : void GDALMultiDimTranslateOptionsSetProgress(
2050 : GDALMultiDimTranslateOptions *psOptions, GDALProgressFunc pfnProgress,
2051 : void *pProgressData)
2052 : {
2053 13 : psOptions->pfnProgress = pfnProgress;
2054 13 : psOptions->pProgressData = pProgressData;
2055 13 : }
|
