@crossbind/port-gdal-wasi 2.0.0-beta.50

package/dist/prebuilt/wasi-wasm32-st-release/share/man/man1/gdal_calc.1

@@ -0,0 +1,402 @@
+.\" Man page generated from reStructuredText.
+.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.TH "GDAL_CALC" "1" "Aug 18, 2026" "" "GDAL"
+.SH NAME
+gdal_calc \- Command line raster calculator with numpy syntax.
+.SH SYNOPSIS
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.EX
+gdal_calc [\-\-help] [\-\-help\-general]
+             \-\-calc=expression \-\-outfile=<out_filename> [\-A <filename>]
+             [\-\-A_band=<n>] [\-B...\-Z <filename>] [<other_options>]
+.EE
+.UNINDENT
+.UNINDENT
+.sp
+DESCRIPTION
+.sp
+Command line raster calculator with numpy syntax. Use any basic
+arithmetic supported by numpy arrays such as \fB+\fP, \fB\-\fP, \fB*\fP, and
+\fB/\fP along with logical operators such as \fB>\fP\&.
+Note that all files must have the same dimensions (unless the \fI\%\-\-extent\fP option is used),
+but no projection checking is performed (unless the \fI\%\-\-projectionCheck\fP option is used).
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+gdal_calc is a Python utility, and is only available if GDAL Python bindings are available.
+.UNINDENT
+.UNINDENT
+.sp
+\fBTIP:\fP
+.INDENT 0.0
+.INDENT 3.5
+Equivalent in new \(dqgdal\(dq command line interface:
+.sp
+See \fI\%gdal raster calc\fP\&.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-help
+Show this help message and exit
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-help\-general
+Gives a brief usage message for the generic GDAL commandline options and exit.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-calc=<expression>
+Calculation in numpy syntax using \fB+\fP, \fB\-\fP, \fB/\fP, \fB*\fP, or any numpy array functions (i.e. \fBlog10()\fP).
+Multiple \fI\%\-\-calc\fP options can be listed to produce a multiband file (GDAL >= 3.2).
+See \fI\%Example 10\fP\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-A <filename>
+Input GDAL raster file, you can use any letter (a\-z, A\-Z).  (lower case supported since GDAL 3.3)
+.sp
+A letter may be repeated, or several values (separated by space) can be provided (GDAL >= 3.3).
+The effect will be to create a 3D numpy array.
+Since GDAL 3.5, wildcard exceptions (using ?, *) are supported for all shells/platforms.
+In such a case, the calculation formula must use this input as a 3D array and must return a 2D array (see \fI\%Example 3\fP).
+If the calculation does not return a 2D array an error will be generated.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-A_band=<n>
+Number of raster band for file A (default 1).
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-outfile=<filename>
+Output file to generate or fill.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-NoDataValue=<value>
+Output NoDataValue (default datatype specific value).
+To indicate not setting a NoDataValue use \-\-NoDataValue=none (GDAL >= 3.3)
+.sp
+\fBNOTE:\fP
+.INDENT 7.0
+.INDENT 3.5
+Using the Python API:
+\fBNone\fP value will indicate default datatype specific value.
+\fB\(aqnone\(aq\fP value will indicate not setting a NoDataValue.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-hideNoData
+Added in version 3.3.
+
+.sp
+Ignores the input bands NoDataValue.
+By default, the input bands NoDataValue are not participating in the calculation.
+By setting this setting \- no special treatment will be performed on the input NoDataValue. and they will be participating in the calculation as any other value.
+The output will not have a set NoDataValue, unless you explicitly specified a specific value by setting \-\-NoDataValue=<value>.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-type=<datatype>
+Output datatype, must be one of [\fBByte\fP, \fBInt8\fP, \fBUInt16\fP, \fBInt16\fP, \fBUInt32\fP, \fBInt32\fP, \fBUInt64\fP, \fBInt64\fP, \fBFloat64\fP, \fBFloat32\fP, \fBCInt16\fP, \fBCInt32\fP, \fBCFloat64\fP, \fBCFloat32\fP].
+.sp
+\fBNOTE:\fP
+.INDENT 7.0
+.INDENT 3.5
+Despite the datatype set using \fB\-\-type\fP, when doing intermediate arithmetic operations using operands of the
+same type, the operation result will honor the original datatype. This may lead into unexpected results in the final result.
+.UNINDENT
+.UNINDENT
+.sp
+\fBNOTE:\fP
+.INDENT 7.0
+.INDENT 3.5
+UInt64, Int64, CInt16, CInt32, CFloat32, CFloat64 have been added in GDAL 3.5.3
+Int8 has been added in GDAL 3.7
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-format=<gdal_format>
+GDAL format for output file.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-color\-table=<filename>
+Allows specifying a filename of a color table (or a ColorTable object) (with Palette Index interpretation) to be used for the output raster.
+Supported formats: txt (i.e. like gdaldem, but color names are not supported), qlr, qml (i.e. exported from QGIS)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-extent=<option>
+Added in version 3.3.
+
+.sp
+This option determines how to handle rasters with different extents.
+This option is mutually exclusive with the \fIprojwin\fP option, which is used for providing a custom extent.
+.sp
+For all the options below the pixel size (resolution) and SRS (Spatial Reference System) of all the input rasters must be the same.
+.sp
+\fBignore\fP (default) \- only the dimensions of the rasters are compared. if the dimensions do not agree the operation will fail.
+.sp
+\fBfail\fP \- the dimensions and the extent (bounds) of the rasters must agree, otherwise the operation will fail.
+.sp
+\fBunion\fP \- the extent (bounds) of the output will be the minimal rectangle that contains all the input extents.
+.sp
+\fBintersect\fP \- the extent (bounds) of the output will be the maximal rectangle that is contained in all the input extents.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-projwin <ulx> <uly> <lrx> <lry>
+Added in version 3.3.
+
+.sp
+This option provides a custom extent for the output, it is mutually exclusive with the \fIextent\fP option.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-projectionCheck
+Added in version 3.3.
+
+.sp
+By default, no projection checking will be performed.
+By setting this option, if the projection is not the same for all bands then the operation will fail.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-creation\-option=<option>
+Passes a creation option to the output format driver.  Multiple
+options may be listed. See format specific documentation for legal
+creation options for each format.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-co=<option>
+The same as \fI\%creation\-option\fP\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-allBands=[a\-z, A\-Z]
+Apply the expression to all bands of a given raster. When
+\fI\%\-\-allBands\fP is used, \fI\%\-\-calc\fP may be specified only once.
+See \fI\%Example 11\fP and \fI\%Example 12\fP\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-overwrite
+Overwrite output file if it already exists. Overwriting must be understood
+here as deleting and recreating the file from scratch. Note that if this option
+is \fInot\fP specified and the output file already exists, it will be updated in
+place.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-debug
+Print debugging information.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-quiet
+Suppress progress messages.
+.UNINDENT
+.SH RETURN STATUS CODE
+.sp
+The program returns status code 0 in case of success, and non\-zero in case of
+error (non\-blocking errors emitted as warnings are considered as a successful
+execution).
+.SH PYTHON OPTIONS
+.sp
+Added in version 3.3.
+
+.sp
+The following options are available by using the Python interface of \fBgdal_calc\fP\&.
+They are not available using the command prompt.
+.INDENT 0.0
+.TP
+.B user_namespace
+A dictionary of custom functions or other names to be available for use in the Calc expression.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B return_ds
+If enabled, the output dataset will be returned from the function and not closed.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B color_table
+Allows specifying a ColorTable object (with Palette Index interpretation) to be used for the output raster.
+.UNINDENT
+.SH EXAMPLES
+.SS Example 1: Average of two files
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.EX
+gdal_calc \-A input1.tif \-B input2.tif \-\-outfile=result.tif \-\-calc=\(dq(A+B)/2\(dq
+.EE
+.UNINDENT
+.UNINDENT
+.sp
+\fBCAUTION:\fP
+.INDENT 0.0
+.INDENT 3.5
+If A and B inputs both have integer data types, integer division will be
+performed. To avoid this, you can convert one of the operands to a
+floating point type before the division operation.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.EX
+gdal_calc \-A input.tif \-B input2.tif \-\-outfile=result.tif \-\-calc=\(dq(A.astype(numpy.float64) + B) / 2\(dq
+.EE
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS Example 2: Summing three files
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.EX
+gdal_calc \-A input1.tif \-B input2.tif \-C input3.tif \-\-outfile=result.tif \-\-calc=\(dqA+B+C\(dq
+.EE
+.UNINDENT
+.UNINDENT
+.SS Example 3: Combining three files into a 3D array and summing
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.EX
+gdal_calc \-A input1.tif \-A input2.tif \-A input3.tif \-\-outfile=result.tif \-\-calc=\(dqnumpy.sum(A,axis=0)\(dq.
+.EE
+.UNINDENT
+.UNINDENT
+.SS Example 4: Average of three files
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.EX
+gdal_calc \-A input1.tif \-B input2.tif \-C input3.tif \-\-outfile=result.tif \-\-calc=\(dq(A+B+C)/3\(dq
+.EE
+.UNINDENT
+.UNINDENT
+.SS Example 5: Average of three files, using 3D array
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.EX
+gdal_calc \-A input1.tif input2.tif input3.tif \-\-outfile=result.tif \-\-calc=\(dqnumpy.average(a,axis=0)\(dq.
+.EE
+.UNINDENT
+.UNINDENT
+.SS Example 6: Maximum of three files
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.EX
+gdal_calc \-A input1.tif \-B input2.tif \-C input3.tif \-\-outfile=result.tif \-\-calc=\(dqnumpy.max((A,B,C),axis=0)\(dq
+.EE
+.UNINDENT
+.UNINDENT
+.SS Example 7: Maximum of three files, using a 3D array
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.EX
+gdal_calc \-A input1.tif input2.tif input3.tif \-\-outfile=result.tif \-\-calc=\(dqnumpy.max(A,axis=0)\(dq
+.EE
+.UNINDENT
+.UNINDENT
+.SS Example 8: Setting values of zero and below to NODATA
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.EX
+gdal_calc \-A input.tif \-\-outfile=result.tif \-\-calc=\(dqA*(A>0)\(dq \-\-NoDataValue=0
+.EE
+.UNINDENT
+.UNINDENT
+.SS Example 9: Using logical operator to keep a range of values from input
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.EX
+gdal_calc \-A input.tif \-\-outfile=result.tif \-\-calc=\(dqA*logical_and(A>100,A<150)\(dq
+.EE
+.UNINDENT
+.UNINDENT
+.SS Example 10: Performing two calculations and storing results in separate bands
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.EX
+gdal_calc \-A input.tif \-\-A_band=1 \-B input.tif \-\-B_band=2 \e
+  \-\-outfile=result.tif \-\-calc=\(dq(A+B)/2\(dq \-\-calc=\(dqB*logical_and(A>100,A<150)\(dq
+.EE
+.UNINDENT
+.UNINDENT
+.SS Example 11: Add a raster to each band in a 3\-band raster
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.EX
+gdal_calc \-A 3band.tif \-B 1band.tif \-\-outfile result.tif \-\-calc \(dqA+B\(dq \-\-allBands A
+.EE
+.UNINDENT
+.UNINDENT
+.sp
+The result will have three bands, where each band contains the values of \fB1band.tif\fP
+added to the corresponding band in \fB3band.tif\fP\&.
+.SS Example 12: Add two three\-band rasters
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.EX
+gdal_calc \-A 3band_a.tif \-B 3band_b.tif \-\-outfile result.tif \-\-calc \(dqA+B\(dq \-\-allBands A \-\-allBands B
+.EE
+.UNINDENT
+.UNINDENT
+.sp
+The result will have three bands, where each band contains the values of the corresponding
+band of \fB3band_a.tif\fP added to the corresponding band of \fB3band_b.tif\fP\&.
+.SH AUTHOR
+Chris Yesson <chris dot yesson at ioz dot ac dot uk>, Etienne Tourigny <etourigny dot dev at gmail dot com>
+.SH COPYRIGHT
+1998-2026
+.\" Generated by docutils manpage writer.
+.