Line data Source code
1 : /******************************************************************************
2 : *
3 : * Project: GDAL
4 : * Purpose: "gdal raster calc" subcommand
5 : * Author: Daniel Baston
6 : *
7 : ******************************************************************************
8 : * Copyright (c) 2025, ISciences LLC
9 : *
10 : * SPDX-License-Identifier: MIT
11 : ****************************************************************************/
12 :
13 : #include "gdalalg_raster_calc.h"
14 :
15 : #include "../frmts/vrt/gdal_vrt.h"
16 : #include "../frmts/vrt/vrtdataset.h"
17 :
18 : #include "cpl_float.h"
19 : #include "cpl_vsi_virtual.h"
20 : #include "gdal_priv.h"
21 : #include "gdal_utils.h"
22 : #include "vrtdataset.h"
23 :
24 : #include <algorithm>
25 : #include <optional>
26 :
27 : //! @cond Doxygen_Suppress
28 :
29 : #ifndef _
30 : #define _(x) (x)
31 : #endif
32 :
33 : struct GDALCalcOptions
34 : {
35 : GDALDataType dstType{GDT_Unknown};
36 : bool checkCRS{true};
37 : bool checkExtent{true};
38 : };
39 :
40 242 : static bool MatchIsCompleteVariableNameWithNoIndex(const std::string &str,
41 : size_t from, size_t to)
42 : {
43 242 : if (to < str.size())
44 : {
45 : // If the character after the end of the match is:
46 : // * alphanumeric or _ : we've matched only part of a variable name
47 : // * [ : we've matched a variable that already has an index
48 : // * ( : we've matched a function name
49 308 : if (std::isalnum(str[to]) || str[to] == '_' || str[to] == '[' ||
50 108 : str[to] == '(')
51 : {
52 93 : return false;
53 : }
54 : }
55 149 : if (from > 0)
56 : {
57 : // If the character before the start of the match is alphanumeric or _,
58 : // we've matched only part of a variable name.
59 91 : if (std::isalnum(str[from - 1]) || str[from - 1] == '_')
60 : {
61 3 : return false;
62 : }
63 : }
64 :
65 146 : return true;
66 : }
67 :
68 : /**
69 : * Add a band subscript to all instances of a specified variable that
70 : * do not already have such a subscript. For example, "X" would be
71 : * replaced with "X[3]" but "X[1]" would be left untouched.
72 : */
73 146 : static std::string SetBandIndices(const std::string &origExpression,
74 : const std::string &variable, int band,
75 : bool &expressionChanged)
76 : {
77 146 : std::string expression = origExpression;
78 146 : expressionChanged = false;
79 :
80 146 : std::string::size_type seekPos = 0;
81 146 : auto pos = expression.find(variable, seekPos);
82 352 : while (pos != std::string::npos)
83 : {
84 206 : auto end = pos + variable.size();
85 :
86 206 : if (MatchIsCompleteVariableNameWithNoIndex(expression, pos, end))
87 : {
88 : // No index specified for variable
89 220 : expression = expression.substr(0, pos + variable.size()) + '[' +
90 330 : std::to_string(band) + ']' + expression.substr(end);
91 110 : expressionChanged = true;
92 : }
93 :
94 206 : seekPos = end;
95 206 : pos = expression.find(variable, seekPos);
96 : }
97 :
98 146 : return expression;
99 : }
100 :
101 72 : static bool PosIsAggregateFunctionArgument(const std::string &expression,
102 : size_t pos)
103 : {
104 : // If this position is a function argument, we should be able to
105 : // scan backwards for a ( and find only variable names, literals or commas.
106 72 : while (pos != 0)
107 : {
108 64 : const char c = expression[pos];
109 64 : if (c == '(')
110 : {
111 24 : pos--;
112 24 : break;
113 : }
114 40 : if (!(isspace(c) || isalnum(c) || c == ',' || c == '.' || c == '[' ||
115 : c == ']' || c == '_'))
116 : {
117 4 : return false;
118 : }
119 36 : pos--;
120 : }
121 :
122 : // Now what we've found the (, the preceding characters should be an
123 : // aggregate function name
124 32 : if (pos < 2)
125 : {
126 8 : return false;
127 : }
128 :
129 24 : if (STARTS_WITH_CI(expression.c_str() + (pos - 2), "avg") ||
130 20 : STARTS_WITH_CI(expression.c_str() + (pos - 2), "sum") ||
131 52 : STARTS_WITH_CI(expression.c_str() + (pos - 2), "min") ||
132 8 : STARTS_WITH_CI(expression.c_str() + (pos - 2), "max"))
133 : {
134 20 : return true;
135 : }
136 :
137 4 : return false;
138 : }
139 :
140 : /**
141 : * Replace X by X[1],X[2],...X[n]
142 : */
143 : static std::string
144 32 : SetBandIndicesFlattenedExpression(const std::string &origExpression,
145 : const std::string &variable, int nBands)
146 : {
147 32 : std::string expression = origExpression;
148 :
149 32 : std::string::size_type seekPos = 0;
150 32 : auto pos = expression.find(variable, seekPos);
151 68 : while (pos != std::string::npos)
152 : {
153 36 : auto end = pos + variable.size();
154 :
155 72 : if (MatchIsCompleteVariableNameWithNoIndex(expression, pos, end) &&
156 36 : PosIsAggregateFunctionArgument(expression, pos))
157 : {
158 20 : std::string newExpr = expression.substr(0, pos);
159 68 : for (int i = 1; i <= nBands; ++i)
160 : {
161 48 : if (i > 1)
162 28 : newExpr += ',';
163 48 : newExpr += variable;
164 48 : newExpr += '[';
165 48 : newExpr += std::to_string(i);
166 48 : newExpr += ']';
167 : }
168 20 : const size_t oldExprSize = expression.size();
169 20 : newExpr += expression.substr(end);
170 20 : expression = std::move(newExpr);
171 20 : end += expression.size() - oldExprSize;
172 : }
173 :
174 36 : seekPos = end;
175 36 : pos = expression.find(variable, seekPos);
176 : }
177 :
178 32 : return expression;
179 : }
180 :
181 : struct SourceProperties
182 : {
183 : int nBands{0};
184 : int nX{0};
185 : int nY{0};
186 : bool hasGT{false};
187 : GDALGeoTransform gt{};
188 : OGRSpatialReferenceRefCountedPtr srs{};
189 : std::vector<std::optional<double>> noData{};
190 : GDALDataType eDT{GDT_Unknown};
191 : };
192 :
193 : static std::optional<SourceProperties>
194 156 : UpdateSourceProperties(SourceProperties &out, const std::string &dsn,
195 : const GDALCalcOptions &options)
196 : {
197 312 : SourceProperties source;
198 156 : bool srsMismatch = false;
199 156 : bool extentMismatch = false;
200 156 : bool dimensionMismatch = false;
201 :
202 : {
203 : std::unique_ptr<GDALDataset> ds(
204 156 : GDALDataset::Open(dsn.c_str(), GDAL_OF_RASTER));
205 :
206 156 : if (!ds)
207 : {
208 0 : CPLError(CE_Failure, CPLE_AppDefined, "Failed to open %s",
209 : dsn.c_str());
210 0 : return std::nullopt;
211 : }
212 :
213 156 : source.nBands = ds->GetRasterCount();
214 156 : source.nX = ds->GetRasterXSize();
215 156 : source.nY = ds->GetRasterYSize();
216 156 : source.noData.resize(source.nBands);
217 :
218 156 : if (options.checkExtent)
219 : {
220 150 : ds->GetGeoTransform(source.gt);
221 : }
222 :
223 156 : if (options.checkCRS && out.srs)
224 : {
225 57 : const OGRSpatialReference *srs = ds->GetSpatialRef();
226 57 : srsMismatch = srs && !srs->IsSame(out.srs.get());
227 : }
228 :
229 : // Store the source data type if it is the same for all bands in the source
230 156 : bool bandsHaveSameType = true;
231 412 : for (int i = 1; i <= source.nBands; ++i)
232 : {
233 256 : GDALRasterBand *band = ds->GetRasterBand(i);
234 :
235 256 : if (i == 1)
236 : {
237 156 : source.eDT = band->GetRasterDataType();
238 : }
239 200 : else if (bandsHaveSameType &&
240 100 : source.eDT != band->GetRasterDataType())
241 : {
242 0 : source.eDT = GDT_Unknown;
243 0 : bandsHaveSameType = false;
244 : }
245 :
246 : int success;
247 256 : double noData = band->GetNoDataValue(&success);
248 256 : if (success)
249 : {
250 17 : source.noData[i - 1] = noData;
251 : }
252 : }
253 : }
254 :
255 156 : if (source.nX != out.nX || source.nY != out.nY)
256 : {
257 3 : dimensionMismatch = true;
258 : }
259 :
260 156 : if (source.gt.xorig != out.gt.xorig || source.gt.xrot != out.gt.xrot ||
261 156 : source.gt.yorig != out.gt.yorig || source.gt.yrot != out.gt.yrot)
262 : {
263 6 : extentMismatch = true;
264 : }
265 156 : if (source.gt.xscale != out.gt.xscale || source.gt.yscale != out.gt.yscale)
266 : {
267 : // Resolutions are different. Are the extents the same?
268 9 : double xmaxOut =
269 9 : out.gt.xorig + out.nX * out.gt.xscale + out.nY * out.gt.xrot;
270 9 : double yminOut =
271 9 : out.gt.yorig + out.nX * out.gt.yrot + out.nY * out.gt.yscale;
272 :
273 9 : double xmax = source.gt.xorig + source.nX * source.gt.xscale +
274 9 : source.nY * source.gt.xrot;
275 9 : double ymin = source.gt.yorig + source.nX * source.gt.yrot +
276 9 : source.nY * source.gt.yscale;
277 :
278 : // Max allowable extent misalignment, expressed as fraction of a pixel
279 9 : constexpr double EXTENT_RTOL = 1e-3;
280 :
281 9 : if (std::abs(xmax - xmaxOut) >
282 15 : EXTENT_RTOL * std::abs(source.gt.xscale) ||
283 6 : std::abs(ymin - yminOut) > EXTENT_RTOL * std::abs(source.gt.yscale))
284 : {
285 6 : extentMismatch = true;
286 : }
287 : }
288 :
289 156 : if (options.checkExtent && extentMismatch)
290 : {
291 2 : CPLError(CE_Failure, CPLE_AppDefined,
292 : "Input extents are inconsistent.");
293 2 : return std::nullopt;
294 : }
295 :
296 154 : if (!options.checkExtent && dimensionMismatch)
297 : {
298 1 : CPLError(CE_Failure, CPLE_AppDefined,
299 : "Inputs do not have the same dimensions.");
300 1 : return std::nullopt;
301 : }
302 :
303 : // Find a common resolution
304 153 : if (source.nX > out.nX)
305 : {
306 1 : auto dx = CPLGreatestCommonDivisor(out.gt.xscale, source.gt.xscale);
307 1 : if (dx == 0)
308 : {
309 0 : CPLError(CE_Failure, CPLE_AppDefined,
310 : "Failed to find common resolution for inputs.");
311 0 : return std::nullopt;
312 : }
313 1 : out.nX = static_cast<int>(
314 1 : std::round(static_cast<double>(out.nX) * out.gt.xscale / dx));
315 1 : out.gt.xscale = dx;
316 : }
317 153 : if (source.nY > out.nY)
318 : {
319 1 : auto dy = CPLGreatestCommonDivisor(out.gt.yscale, source.gt.yscale);
320 1 : if (dy == 0)
321 : {
322 0 : CPLError(CE_Failure, CPLE_AppDefined,
323 : "Failed to find common resolution for inputs.");
324 0 : return std::nullopt;
325 : }
326 1 : out.nY = static_cast<int>(
327 1 : std::round(static_cast<double>(out.nY) * out.gt.yscale / dy));
328 1 : out.gt.yscale = dy;
329 : }
330 :
331 153 : if (srsMismatch)
332 : {
333 1 : CPLError(CE_Failure, CPLE_AppDefined,
334 : "Input spatial reference systems are inconsistent.");
335 1 : return std::nullopt;
336 : }
337 :
338 152 : return source;
339 : }
340 :
341 : /** Create XML nodes for one or more derived bands resulting from the evaluation
342 : * of a single expression
343 : *
344 : * @param pszVRTFilename VRT filename
345 : * @param root VRTDataset node to which the band nodes should be added
346 : * @param bandType the type of the band(s) to create
347 : * @param nXOut Number of columns in VRT dataset
348 : * @param nYOut Number of rows in VRT dataset
349 : * @param expression Expression for which band(s) should be added
350 : * @param dialect Expression dialect
351 : * @param flatten Generate a single band output raster per expression, even if
352 : * input datasets are multiband.
353 : * @param noDataText nodata value to use for the created band, or "none", or ""
354 : * @param pixelFunctionArguments Pixel function arguments.
355 : * @param sources Mapping of source names to DSNs
356 : * @param sourceProps Mapping of source names to properties
357 : * @param fakeSourceFilename If not empty, used instead of real input filenames.
358 : * @return true if the band(s) were added, false otherwise
359 : */
360 : static bool
361 116 : CreateDerivedBandXML(const char *pszVRTFilename, CPLXMLNode *root, int nXOut,
362 : int nYOut, GDALDataType bandType,
363 : const std::string &expression, const std::string &dialect,
364 : bool flatten, const std::string &noDataText,
365 : const std::vector<std::string> &pixelFunctionArguments,
366 : const std::map<std::string, std::string> &sources,
367 : const std::map<std::string, SourceProperties> &sourceProps,
368 : const std::string &fakeSourceFilename)
369 : {
370 116 : int nOutBands = 1; // By default, each expression produces a single output
371 : // band. When processing the expression below, we may
372 : // discover that the expression produces multiple bands,
373 : // in which case this will be updated.
374 :
375 255 : for (int nOutBand = 1; nOutBand <= nOutBands; nOutBand++)
376 : {
377 : // Copy the expression for each output band, because we may modify it
378 : // when adding band indices (e.g., X -> X[1]) to the variables in the
379 : // expression.
380 143 : std::string bandExpression = expression;
381 :
382 143 : CPLXMLNode *band = CPLCreateXMLNode(root, CXT_Element, "VRTRasterBand");
383 143 : CPLAddXMLAttributeAndValue(band, "subClass", "VRTDerivedRasterBand");
384 143 : if (bandType == GDT_Unknown)
385 : {
386 103 : bandType = GDT_Float64;
387 : }
388 143 : CPLAddXMLAttributeAndValue(band, "dataType",
389 : GDALGetDataTypeName(bandType));
390 :
391 143 : std::optional<double> dstNoData;
392 143 : bool autoSelectNoDataValue = false;
393 143 : if (noDataText.empty())
394 : {
395 138 : autoSelectNoDataValue = true;
396 : }
397 5 : else if (noDataText != "none")
398 : {
399 : char *end;
400 5 : dstNoData = CPLStrtod(noDataText.c_str(), &end);
401 5 : if (end != noDataText.c_str() + noDataText.size())
402 : {
403 0 : CPLError(CE_Failure, CPLE_AppDefined,
404 : "Invalid NoData value: %s", noDataText.c_str());
405 0 : return false;
406 : }
407 : }
408 :
409 327 : for (const auto &[source_name, dsn] : sources)
410 : {
411 188 : auto it = sourceProps.find(source_name);
412 188 : CPLAssert(it != sourceProps.end());
413 188 : const auto &props = it->second;
414 :
415 188 : bool expressionAppliedPerBand = false;
416 188 : if (dialect == "builtin")
417 : {
418 42 : expressionAppliedPerBand = !flatten;
419 : }
420 : else
421 : {
422 146 : const int nDefaultInBand = std::min(props.nBands, nOutBand);
423 :
424 146 : if (flatten)
425 : {
426 32 : bandExpression = SetBandIndicesFlattenedExpression(
427 32 : bandExpression, source_name, props.nBands);
428 : }
429 :
430 : bandExpression =
431 292 : SetBandIndices(bandExpression, source_name, nDefaultInBand,
432 146 : expressionAppliedPerBand);
433 : }
434 :
435 188 : if (expressionAppliedPerBand)
436 : {
437 134 : if (nOutBands <= 1)
438 : {
439 93 : nOutBands = props.nBands;
440 : }
441 41 : else if (props.nBands != 1 && props.nBands != nOutBands)
442 : {
443 3 : CPLError(CE_Failure, CPLE_AppDefined,
444 : "Expression cannot operate on all bands of "
445 : "rasters with incompatible numbers of bands "
446 : "(source %s has %d bands but expected to have "
447 : "1 or %d bands).",
448 3 : source_name.c_str(), props.nBands, nOutBands);
449 4 : return false;
450 : }
451 : }
452 :
453 : // Create a source for each input band that is used in
454 : // the expression.
455 513 : for (int nInBand = 1; nInBand <= props.nBands; nInBand++)
456 : {
457 328 : CPLString inBandVariable;
458 328 : if (dialect == "builtin")
459 : {
460 72 : if (!flatten && props.nBands >= 2 && nInBand != nOutBand)
461 11 : continue;
462 : }
463 : else
464 : {
465 : inBandVariable.Printf("%s[%d]", source_name.c_str(),
466 256 : nInBand);
467 256 : if (bandExpression.find(inBandVariable) ==
468 : std::string::npos)
469 : {
470 79 : continue;
471 : }
472 : }
473 :
474 : const std::optional<double> &srcNoData =
475 238 : props.noData[nInBand - 1];
476 :
477 238 : CPLXMLNode *source = CPLCreateXMLNode(
478 : band, CXT_Element,
479 238 : srcNoData.has_value() ? "ComplexSource" : "SimpleSource");
480 238 : if (!inBandVariable.empty())
481 : {
482 177 : CPLAddXMLAttributeAndValue(source, "name",
483 : inBandVariable.c_str());
484 : }
485 :
486 : CPLXMLNode *sourceFilename =
487 238 : CPLCreateXMLNode(source, CXT_Element, "SourceFilename");
488 238 : if (fakeSourceFilename.empty())
489 : {
490 330 : std::string osSourceFilename = dsn;
491 165 : bool bRelativeToVRT = false;
492 165 : if (pszVRTFilename[0])
493 : {
494 16 : std::tie(osSourceFilename, bRelativeToVRT) =
495 32 : VRTSimpleSource::ComputeSourceNameAndRelativeFlag(
496 48 : CPLGetPathSafe(pszVRTFilename).c_str(), dsn);
497 : }
498 165 : CPLAddXMLAttributeAndValue(sourceFilename, "relativeToVRT",
499 : bRelativeToVRT ? "1" : "0");
500 165 : CPLCreateXMLNode(sourceFilename, CXT_Text,
501 : osSourceFilename.c_str());
502 : }
503 : else
504 : {
505 73 : CPLCreateXMLNode(sourceFilename, CXT_Text,
506 : fakeSourceFilename.c_str());
507 : }
508 :
509 : CPLXMLNode *sourceBand =
510 238 : CPLCreateXMLNode(source, CXT_Element, "SourceBand");
511 238 : CPLCreateXMLNode(sourceBand, CXT_Text,
512 476 : std::to_string(nInBand).c_str());
513 :
514 238 : if (srcNoData.has_value())
515 : {
516 : CPLXMLNode *srcNoDataNode =
517 17 : CPLCreateXMLNode(source, CXT_Element, "NODATA");
518 : std::string srcNoDataText =
519 34 : CPLSPrintf("%.17g", srcNoData.value());
520 17 : CPLCreateXMLNode(srcNoDataNode, CXT_Text,
521 : srcNoDataText.c_str());
522 :
523 17 : if (autoSelectNoDataValue && !dstNoData.has_value())
524 : {
525 8 : dstNoData = srcNoData;
526 : }
527 : }
528 :
529 238 : if (fakeSourceFilename.empty())
530 : {
531 : CPLXMLNode *srcRect =
532 165 : CPLCreateXMLNode(source, CXT_Element, "SrcRect");
533 165 : CPLAddXMLAttributeAndValue(srcRect, "xOff", "0");
534 165 : CPLAddXMLAttributeAndValue(srcRect, "yOff", "0");
535 165 : CPLAddXMLAttributeAndValue(
536 330 : srcRect, "xSize", std::to_string(props.nX).c_str());
537 165 : CPLAddXMLAttributeAndValue(
538 330 : srcRect, "ySize", std::to_string(props.nY).c_str());
539 :
540 : CPLXMLNode *dstRect =
541 165 : CPLCreateXMLNode(source, CXT_Element, "DstRect");
542 165 : CPLAddXMLAttributeAndValue(dstRect, "xOff", "0");
543 165 : CPLAddXMLAttributeAndValue(dstRect, "yOff", "0");
544 165 : CPLAddXMLAttributeAndValue(dstRect, "xSize",
545 330 : std::to_string(nXOut).c_str());
546 165 : CPLAddXMLAttributeAndValue(dstRect, "ySize",
547 330 : std::to_string(nYOut).c_str());
548 : }
549 : }
550 :
551 185 : if (dstNoData.has_value())
552 : {
553 17 : if (!GDALIsValueExactAs(dstNoData.value(), bandType))
554 : {
555 1 : CPLError(
556 : CE_Failure, CPLE_AppDefined,
557 : "Band output type %s cannot represent NoData value %g",
558 1 : GDALGetDataTypeName(bandType), dstNoData.value());
559 1 : return false;
560 : }
561 :
562 : CPLXMLNode *noDataNode =
563 16 : CPLCreateXMLNode(band, CXT_Element, "NoDataValue");
564 : CPLString dstNoDataText =
565 32 : CPLSPrintf("%.17g", dstNoData.value());
566 16 : CPLCreateXMLNode(noDataNode, CXT_Text, dstNoDataText.c_str());
567 : }
568 : }
569 :
570 : CPLXMLNode *pixelFunctionType =
571 139 : CPLCreateXMLNode(band, CXT_Element, "PixelFunctionType");
572 : CPLXMLNode *arguments =
573 139 : CPLCreateXMLNode(band, CXT_Element, "PixelFunctionArguments");
574 :
575 139 : if (dialect == "builtin")
576 : {
577 28 : CPLCreateXMLNode(pixelFunctionType, CXT_Text, expression.c_str());
578 : }
579 : else
580 : {
581 111 : CPLCreateXMLNode(pixelFunctionType, CXT_Text, "expression");
582 111 : CPLAddXMLAttributeAndValue(arguments, "dialect", "muparser");
583 : // Add the expression as a last step, because we may modify the
584 : // expression as we iterate through the bands.
585 111 : CPLAddXMLAttributeAndValue(arguments, "expression",
586 : bandExpression.c_str());
587 : }
588 :
589 139 : if (!pixelFunctionArguments.empty())
590 : {
591 16 : const CPLStringList args(pixelFunctionArguments);
592 16 : for (const auto &[key, value] : cpl::IterateNameValue(args))
593 : {
594 8 : CPLAddXMLAttributeAndValue(arguments, key, value);
595 : }
596 : }
597 : }
598 :
599 112 : return true;
600 : }
601 :
602 122 : static bool ParseSourceDescriptors(const std::vector<std::string> &inputs,
603 : std::map<std::string, std::string> &datasets,
604 : std::string &firstSourceName,
605 : bool requireSourceNames)
606 : {
607 281 : for (size_t iInput = 0; iInput < inputs.size(); iInput++)
608 : {
609 164 : const std::string &input = inputs[iInput];
610 164 : std::string name;
611 :
612 164 : const auto pos = input.find('=');
613 164 : if (pos == std::string::npos)
614 : {
615 61 : if (requireSourceNames && inputs.size() > 1)
616 : {
617 1 : CPLError(CE_Failure, CPLE_AppDefined,
618 : "Inputs must be named when more than one input is "
619 : "provided.");
620 1 : return false;
621 : }
622 60 : name = "X";
623 60 : if (iInput > 0)
624 : {
625 2 : name += std::to_string(iInput);
626 : }
627 : }
628 : else
629 : {
630 103 : name = input.substr(0, pos);
631 : }
632 :
633 : // Check input name is legal
634 347 : for (size_t i = 0; i < name.size(); ++i)
635 : {
636 187 : const char c = name[i];
637 187 : if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z'))
638 : {
639 : // ok
640 : }
641 20 : else if (c == '_' || (c >= '0' && c <= '9'))
642 : {
643 19 : if (i == 0)
644 : {
645 : // Reserved constants in MuParser start with an underscore
646 2 : CPLError(
647 : CE_Failure, CPLE_AppDefined,
648 : "Name '%s' is illegal because it starts with a '%c'",
649 : name.c_str(), c);
650 2 : return false;
651 : }
652 : }
653 : else
654 : {
655 1 : CPLError(CE_Failure, CPLE_AppDefined,
656 : "Name '%s' is illegal because character '%c' is not "
657 : "allowed",
658 : name.c_str(), c);
659 1 : return false;
660 : }
661 : }
662 :
663 : std::string dsn =
664 160 : (pos == std::string::npos) ? input : input.substr(pos + 1);
665 :
666 160 : if (!dsn.empty() && dsn.front() == '[' && dsn.back() == ']')
667 : {
668 : dsn = "{\"type\":\"gdal_streamed_alg\", \"command_line\":\"gdal "
669 0 : "raster pipeline " +
670 2 : CPLString(dsn.substr(1, dsn.size() - 2))
671 2 : .replaceAll('\\', "\\\\")
672 2 : .replaceAll('"', "\\\"") +
673 1 : "\"}";
674 : }
675 :
676 160 : if (datasets.find(name) != datasets.end())
677 : {
678 1 : CPLError(CE_Failure, CPLE_AppDefined,
679 : "An input with name '%s' has already been provided",
680 : name.c_str());
681 1 : return false;
682 : }
683 159 : datasets[name] = std::move(dsn);
684 :
685 159 : if (iInput == 0)
686 : {
687 118 : firstSourceName = std::move(name);
688 : }
689 : }
690 :
691 117 : return true;
692 : }
693 :
694 90 : static bool ReadFileLists(const std::vector<GDALArgDatasetValue> &inputDS,
695 : std::vector<std::string> &inputFilenames)
696 : {
697 212 : for (const auto &dsVal : inputDS)
698 : {
699 122 : const auto &input = dsVal.GetName();
700 122 : if (!input.empty() && input[0] == '@')
701 : {
702 : auto f =
703 2 : VSIVirtualHandleUniquePtr(VSIFOpenL(input.c_str() + 1, "r"));
704 2 : if (!f)
705 : {
706 0 : CPLError(CE_Failure, CPLE_FileIO, "Cannot open %s",
707 0 : input.c_str() + 1);
708 0 : return false;
709 : }
710 6 : while (const char *filename = CPLReadLineL(f.get()))
711 : {
712 4 : inputFilenames.push_back(filename);
713 4 : }
714 : }
715 : else
716 : {
717 120 : inputFilenames.push_back(input);
718 : }
719 : }
720 :
721 90 : return true;
722 : }
723 :
724 : /** Creates a VRT datasource with one or more derived raster bands containing
725 : * results of an expression.
726 : *
727 : * To make this work with muparser (which does not support vector types), we
728 : * do a simple parsing of the expression internally, transforming it into
729 : * multiple expressions with explicit band indices. For example, for a two-band
730 : * raster "X", the expression "X + 3" will be transformed into "X[1] + 3" and
731 : * "X[2] + 3". The use of brackets is for readability only; as far as the
732 : * expression engine is concerned, the variables "X[1]" and "X[2]" have nothing
733 : * to do with each other.
734 : *
735 : * @param pszVRTFilename VRT filename
736 : * @param inputs A list of sources, expressed as NAME=DSN
737 : * @param expressions A list of expressions to be evaluated
738 : * @param dialect Expression dialect
739 : * @param flatten Generate a single band output raster per expression, even if
740 : * input datasets are multiband.
741 : * @param noData NoData values to use for output bands, or "none", or ""
742 : * @param pixelFunctionArguments Pixel function arguments.
743 : * @param options flags controlling which checks should be performed on the inputs
744 : * @param[out] maxSourceBands Maximum number of bands in source dataset(s)
745 : * @param fakeSourceFilename If not empty, used instead of real input filenames.
746 : *
747 : * @return a newly created VRTDataset, or nullptr on error
748 : */
749 122 : static std::unique_ptr<GDALDataset> GDALCalcCreateVRTDerived(
750 : const char *pszVRTFilename, const std::vector<std::string> &inputs,
751 : const std::vector<std::string> &expressions, const std::string &dialect,
752 : bool flatten, const std::string &noData,
753 : const std::vector<std::vector<std::string>> &pixelFunctionArguments,
754 : const GDALCalcOptions &options, int &maxSourceBands,
755 : const std::string &fakeSourceFilename = std::string())
756 : {
757 122 : if (inputs.empty())
758 : {
759 0 : return nullptr;
760 : }
761 :
762 244 : std::map<std::string, std::string> sources;
763 244 : std::string firstSource;
764 122 : bool requireSourceNames = dialect != "builtin";
765 122 : if (!ParseSourceDescriptors(inputs, sources, firstSource,
766 : requireSourceNames))
767 : {
768 5 : return nullptr;
769 : }
770 :
771 : // Use the first source provided to determine properties of the output
772 117 : const char *firstDSN = sources[firstSource].c_str();
773 :
774 117 : maxSourceBands = 0;
775 :
776 : // Read properties from the first source
777 234 : SourceProperties out;
778 : {
779 : std::unique_ptr<GDALDataset> ds(
780 117 : GDALDataset::Open(firstDSN, GDAL_OF_RASTER));
781 :
782 117 : if (!ds)
783 : {
784 0 : CPLError(CE_Failure, CPLE_AppDefined, "Failed to open %s",
785 : firstDSN);
786 0 : return nullptr;
787 : }
788 :
789 117 : out.nX = ds->GetRasterXSize();
790 117 : out.nY = ds->GetRasterYSize();
791 117 : out.nBands = 1;
792 : out.srs =
793 117 : OGRSpatialReferenceRefCountedPtr::makeClone(ds->GetSpatialRef());
794 117 : out.hasGT = ds->GetGeoTransform(out.gt) == CE_None;
795 : }
796 :
797 234 : CPLXMLTreeCloser root(CPLCreateXMLNode(nullptr, CXT_Element, "VRTDataset"));
798 :
799 117 : maxSourceBands = 0;
800 :
801 : // Collect properties of the different sources, and verity them for
802 : // consistency.
803 234 : std::map<std::string, SourceProperties> sourceProps;
804 269 : for (const auto &[source_name, dsn] : sources)
805 : {
806 : // TODO avoid opening the first source twice.
807 156 : auto props = UpdateSourceProperties(out, dsn, options);
808 156 : if (props.has_value())
809 : {
810 152 : maxSourceBands = std::max(maxSourceBands, props->nBands);
811 152 : sourceProps[source_name] = std::move(props.value());
812 : }
813 : else
814 : {
815 4 : return nullptr;
816 : }
817 : }
818 :
819 113 : size_t iExpr = 0;
820 225 : for (const auto &origExpression : expressions)
821 : {
822 116 : GDALDataType bandType = options.dstType;
823 :
824 : // If output band type has not been specified, set it equal to the
825 : // input band type for certain pixel functions, if the inputs have
826 : // a consistent band type.
827 166 : if (bandType == GDT_Unknown && dialect == "builtin" &&
828 72 : (origExpression == "min" || origExpression == "max" ||
829 22 : origExpression == "mode"))
830 : {
831 12 : for (const auto &[_, props] : sourceProps)
832 : {
833 6 : if (bandType == GDT_Unknown)
834 : {
835 6 : bandType = props.eDT;
836 : }
837 0 : else if (props.eDT == GDT_Unknown || props.eDT != bandType)
838 : {
839 0 : bandType = GDT_Unknown;
840 0 : break;
841 : }
842 : }
843 : }
844 :
845 116 : if (!CreateDerivedBandXML(pszVRTFilename, root.get(), out.nX, out.nY,
846 : bandType, origExpression, dialect, flatten,
847 116 : noData, pixelFunctionArguments[iExpr],
848 : sources, sourceProps, fakeSourceFilename))
849 : {
850 4 : return nullptr;
851 : }
852 112 : ++iExpr;
853 : }
854 :
855 : // CPLDebug("VRT", "%s", CPLSerializeXMLTree(root.get()));
856 :
857 109 : auto ds = fakeSourceFilename.empty()
858 : ? std::make_unique<VRTDataset>(out.nX, out.nY)
859 218 : : std::make_unique<VRTDataset>(1, 1);
860 218 : if (ds->XMLInit(root.get(), pszVRTFilename[0]
861 126 : ? CPLGetPathSafe(pszVRTFilename).c_str()
862 218 : : "") != CE_None)
863 : {
864 0 : return nullptr;
865 : };
866 109 : if (out.hasGT)
867 : {
868 57 : ds->SetGeoTransform(out.gt);
869 : }
870 109 : if (out.srs)
871 : {
872 55 : ds->SetSpatialRef(out.srs.get());
873 : }
874 :
875 109 : return ds;
876 : }
877 :
878 : /************************************************************************/
879 : /* GDALRasterCalcAlgorithm::GDALRasterCalcAlgorithm() */
880 : /************************************************************************/
881 :
882 175 : GDALRasterCalcAlgorithm::GDALRasterCalcAlgorithm(bool standaloneStep) noexcept
883 : : GDALRasterPipelineStepAlgorithm(NAME, DESCRIPTION, HELP_URL,
884 525 : ConstructorOptions()
885 175 : .SetStandaloneStep(standaloneStep)
886 175 : .SetAddDefaultArguments(false)
887 175 : .SetAutoOpenInputDatasets(false)
888 175 : .SetInputDatasetInputFlags(GADV_NAME)
889 350 : .SetInputDatasetMetaVar("INPUTS")
890 525 : .SetInputDatasetMaxCount(INT_MAX))
891 : {
892 175 : AddRasterInputArgs(false, false);
893 175 : if (standaloneStep)
894 : {
895 137 : AddProgressArg();
896 137 : AddRasterOutputArgs(false);
897 : }
898 :
899 175 : AddOutputDataTypeArg(&m_type);
900 :
901 : AddArg("no-check-crs", 0,
902 : _("Do not check consistency of input coordinate reference systems"),
903 350 : &m_noCheckCRS)
904 175 : .AddHiddenAlias("no-check-srs");
905 : AddArg("no-check-extent", 0, _("Do not check consistency of input extents"),
906 175 : &m_noCheckExtent);
907 :
908 : AddArg("propagate-nodata", 0,
909 : _("Whether to set pixels to the output NoData value if any of the "
910 : "input pixels is NoData"),
911 175 : &m_propagateNoData);
912 :
913 350 : AddArg("calc", 0, _("Expression(s) to evaluate"), &m_expr)
914 175 : .SetRequired()
915 175 : .SetPackedValuesAllowed(false)
916 175 : .SetMinCount(1)
917 : .SetAutoCompleteFunction(
918 4 : [this](const std::string ¤tValue)
919 : {
920 4 : std::vector<std::string> ret;
921 2 : if (m_dialect == "builtin")
922 : {
923 1 : if (currentValue.find('(') == std::string::npos)
924 1 : return VRTDerivedRasterBand::GetPixelFunctionNames();
925 : }
926 1 : return ret;
927 175 : });
928 :
929 350 : AddArg("dialect", 0, _("Expression dialect"), &m_dialect)
930 175 : .SetDefault(m_dialect)
931 175 : .SetChoices("muparser", "builtin");
932 :
933 : AddArg("flatten", 0,
934 : _("Generate a single band output raster per expression, even if "
935 : "input datasets are multiband"),
936 175 : &m_flatten);
937 :
938 175 : AddNodataArg(&m_nodata, true);
939 :
940 : // This is a hidden option only used by test_gdalalg_raster_calc_expression_rewriting()
941 : // for now
942 : AddArg("no-check-expression", 0,
943 : _("Whether to skip expression validity checks for virtual format "
944 : "output"),
945 350 : &m_noCheckExpression)
946 175 : .SetHidden();
947 :
948 175 : AddValidationAction(
949 178 : [this]()
950 : {
951 94 : GDALPipelineStepRunContext ctxt;
952 94 : return m_noCheckExpression || !IsGDALGOutput() || RunStep(ctxt);
953 : });
954 175 : }
955 :
956 : /************************************************************************/
957 : /* GDALRasterCalcAlgorithm::RunImpl() */
958 : /************************************************************************/
959 :
960 85 : bool GDALRasterCalcAlgorithm::RunImpl(GDALProgressFunc pfnProgress,
961 : void *pProgressData)
962 : {
963 85 : GDALPipelineStepRunContext stepCtxt;
964 85 : stepCtxt.m_pfnProgress = pfnProgress;
965 85 : stepCtxt.m_pProgressData = pProgressData;
966 85 : return RunPreStepPipelineValidations() && RunStep(stepCtxt);
967 : }
968 :
969 : /************************************************************************/
970 : /* GDALRasterCalcAlgorithm::RunStep() */
971 : /************************************************************************/
972 :
973 90 : bool GDALRasterCalcAlgorithm::RunStep(GDALPipelineStepRunContext &ctxt)
974 : {
975 90 : CPLAssert(!m_outputDataset.GetDatasetRef());
976 :
977 90 : GDALCalcOptions options;
978 90 : options.checkExtent = !m_noCheckExtent;
979 90 : options.checkCRS = !m_noCheckCRS;
980 90 : if (!m_type.empty())
981 : {
982 5 : options.dstType = GDALGetDataTypeByName(m_type.c_str());
983 : }
984 :
985 180 : std::vector<std::string> inputFilenames;
986 90 : if (!ReadFileLists(m_inputDataset, inputFilenames))
987 : {
988 0 : return false;
989 : }
990 :
991 180 : std::vector<std::vector<std::string>> pixelFunctionArgs;
992 90 : if (m_dialect == "builtin")
993 : {
994 27 : for (std::string &expr : m_expr)
995 : {
996 : const CPLStringList aosTokens(
997 : CSLTokenizeString2(expr.c_str(), "()",
998 14 : CSLT_STRIPLEADSPACES | CSLT_STRIPENDSPACES));
999 14 : const char *pszFunction = aosTokens[0];
1000 : const auto *pair =
1001 14 : VRTDerivedRasterBand::GetPixelFunction(pszFunction);
1002 14 : if (!pair)
1003 : {
1004 0 : ReportError(CE_Failure, CPLE_NotSupported,
1005 : "'%s' is a unknown builtin function", pszFunction);
1006 0 : return false;
1007 : }
1008 14 : if (aosTokens.size() == 2)
1009 : {
1010 2 : std::vector<std::string> validArguments;
1011 2 : AddOptionsSuggestions(pair->second.c_str(), 0, std::string(),
1012 : validArguments);
1013 6 : for (std::string &s : validArguments)
1014 : {
1015 4 : if (!s.empty() && s.back() == '=')
1016 4 : s.pop_back();
1017 : }
1018 :
1019 : const CPLStringList aosTokensArgs(CSLTokenizeString2(
1020 : aosTokens[1], ",",
1021 2 : CSLT_STRIPLEADSPACES | CSLT_STRIPENDSPACES));
1022 4 : for (const auto &[key, value] :
1023 6 : cpl::IterateNameValue(aosTokensArgs))
1024 : {
1025 2 : if (std::find(validArguments.begin(), validArguments.end(),
1026 2 : key) == validArguments.end())
1027 : {
1028 0 : if (validArguments.empty())
1029 : {
1030 0 : ReportError(
1031 : CE_Failure, CPLE_IllegalArg,
1032 : "'%s' is a unrecognized argument for builtin "
1033 : "function '%s'. It does not accept any "
1034 : "argument",
1035 : key, pszFunction);
1036 : }
1037 : else
1038 : {
1039 0 : std::string validArgumentsStr;
1040 0 : for (const std::string &s : validArguments)
1041 : {
1042 0 : if (!validArgumentsStr.empty())
1043 0 : validArgumentsStr += ", ";
1044 0 : validArgumentsStr += '\'';
1045 0 : validArgumentsStr += s;
1046 0 : validArgumentsStr += '\'';
1047 : }
1048 0 : ReportError(
1049 : CE_Failure, CPLE_IllegalArg,
1050 : "'%s' is a unrecognized argument for builtin "
1051 : "function '%s'. Only %s %s supported",
1052 : key, pszFunction,
1053 0 : validArguments.size() == 1 ? "is" : "are",
1054 : validArgumentsStr.c_str());
1055 : }
1056 0 : return false;
1057 : }
1058 2 : CPL_IGNORE_RET_VAL(value);
1059 : }
1060 2 : pixelFunctionArgs.emplace_back(aosTokensArgs);
1061 : }
1062 : else
1063 : {
1064 12 : pixelFunctionArgs.push_back(std::vector<std::string>());
1065 : }
1066 14 : expr = pszFunction;
1067 : }
1068 : }
1069 : else
1070 : {
1071 77 : pixelFunctionArgs.resize(m_expr.size());
1072 : }
1073 :
1074 90 : if (m_propagateNoData)
1075 : {
1076 2 : if (m_nodata == "none")
1077 : {
1078 0 : ReportError(CE_Failure, CPLE_AppDefined,
1079 : "Output NoData value must be specified to use "
1080 : "--propagate-nodata");
1081 0 : return false;
1082 : }
1083 4 : for (auto &args : pixelFunctionArgs)
1084 : {
1085 2 : args.push_back("propagateNoData=1");
1086 : }
1087 : }
1088 :
1089 90 : int maxSourceBands = 0;
1090 : const bool bIsVRT =
1091 230 : m_format == "VRT" ||
1092 89 : (m_format.empty() &&
1093 102 : EQUAL(CPLGetExtensionSafe(m_outputDataset.GetName().c_str()).c_str(),
1094 90 : "VRT"));
1095 :
1096 : auto vrt = GDALCalcCreateVRTDerived(
1097 19 : bIsVRT ? m_outputDataset.GetName().c_str() : "", inputFilenames, m_expr,
1098 90 : m_dialect, m_flatten, m_nodata, pixelFunctionArgs, options,
1099 199 : maxSourceBands);
1100 90 : if (vrt == nullptr)
1101 : {
1102 13 : return false;
1103 : }
1104 :
1105 77 : if (!m_noCheckExpression)
1106 : {
1107 : const bool bIsGDALG =
1108 157 : m_format == "GDALG" ||
1109 63 : (m_format.empty() &&
1110 30 : cpl::ends_with(m_outputDataset.GetName(), ".gdalg.json"));
1111 64 : if (!m_standaloneStep || m_format == "stream" || bIsVRT || bIsGDALG)
1112 : {
1113 : // Try reading a single pixel to check formulas are valid.
1114 32 : std::vector<GByte> dummyData(vrt->GetRasterCount());
1115 :
1116 32 : auto poGTIFFDrv = GetGDALDriverManager()->GetDriverByName("GTiff");
1117 32 : std::string osTmpFilename;
1118 32 : if (poGTIFFDrv)
1119 : {
1120 : std::string osFilename =
1121 64 : VSIMemGenerateHiddenFilename("tmp.tif");
1122 : auto poDS = std::unique_ptr<GDALDataset>(
1123 : poGTIFFDrv->Create(osFilename.c_str(), 1, 1, maxSourceBands,
1124 64 : GDT_UInt8, nullptr));
1125 32 : if (poDS)
1126 32 : osTmpFilename = std::move(osFilename);
1127 : }
1128 32 : if (!osTmpFilename.empty())
1129 : {
1130 : auto fakeVRT = GDALCalcCreateVRTDerived(
1131 32 : "", inputFilenames, m_expr, m_dialect, m_flatten, m_nodata,
1132 32 : pixelFunctionArgs, options, maxSourceBands, osTmpFilename);
1133 64 : if (fakeVRT &&
1134 32 : fakeVRT->RasterIO(GF_Read, 0, 0, 1, 1, dummyData.data(), 1,
1135 : 1, GDT_UInt8, vrt->GetRasterCount(),
1136 32 : nullptr, 0, 0, 0, nullptr) != CE_None)
1137 : {
1138 5 : return false;
1139 : }
1140 : }
1141 27 : if (bIsGDALG)
1142 : {
1143 1 : return true;
1144 : }
1145 : }
1146 : }
1147 :
1148 71 : if (m_format == "stream" || !m_standaloneStep)
1149 : {
1150 24 : m_outputDataset.Set(std::move(vrt));
1151 24 : return true;
1152 : }
1153 :
1154 94 : CPLStringList translateArgs;
1155 47 : if (!m_format.empty())
1156 : {
1157 9 : translateArgs.AddString("-of");
1158 9 : translateArgs.AddString(m_format.c_str());
1159 : }
1160 48 : for (const auto &co : m_creationOptions)
1161 : {
1162 1 : translateArgs.AddString("-co");
1163 1 : translateArgs.AddString(co.c_str());
1164 : }
1165 :
1166 : GDALTranslateOptions *translateOptions =
1167 47 : GDALTranslateOptionsNew(translateArgs.List(), nullptr);
1168 47 : GDALTranslateOptionsSetProgress(translateOptions, ctxt.m_pfnProgress,
1169 : ctxt.m_pProgressData);
1170 :
1171 : auto poOutDS =
1172 : std::unique_ptr<GDALDataset>(GDALDataset::FromHandle(GDALTranslate(
1173 47 : m_outputDataset.GetName().c_str(), GDALDataset::ToHandle(vrt.get()),
1174 94 : translateOptions, nullptr)));
1175 47 : GDALTranslateOptionsFree(translateOptions);
1176 :
1177 47 : const bool bOK = poOutDS != nullptr;
1178 47 : m_outputDataset.Set(std::move(poOutDS));
1179 :
1180 47 : return bOK;
1181 : }
1182 :
1183 : GDALRasterCalcAlgorithmStandalone::~GDALRasterCalcAlgorithmStandalone() =
1184 : default;
1185 :
1186 : //! @endcond
|
