+.. _gdal2xyz:++================================================================================+gdal2xyz+================================================================================++.. only:: html++    Translates a raster file into `xyz` format.++.. Index:: gdal2xyz++Synopsis+--------++.. code-block::++    gdal2xyz [-help]+        [-skip factor]+        [-srcwin xoff yoff xsize ysize]+        [-b band]* [-allbands]+        [-csv]+        [-srcnodata value] [-dstnodata value]+        src_dataset [dst_dataset]++Description+-----------++The :program:`gdal2xyz` utility can be used to translate a raster file into xyz format.+`gdal2xyz` can be used as an alternative to `gdal_translate of=xyz`, but supporting other options,+for example:++    * Select more then one band+    * Skip or replace nodata value+    * Return the output as numpy arrays.++.. program:: gdal2xyz++.. option:: -skip++    How many rows/cols to skip in each iteration.++.. option:: -srcwin <xoff> <yoff> <xsize> <ysize>++    Selects a subwindow from the source image for copying based on pixel/line location.++.. option:: -b, -band <band>++    Select band *band* from the input spectral bands for output.+    Bands are numbered from 1 in the order spectral bands are specified.+    Multiple **-b** switches may be used.+    When no -b switch is used, the first band will be used.+    In order to use all input bands set `-allbands` or `-b 0`.++.. option:: -allbands++    Select all input bands.++.. option:: -csv++    Use comma instead of space as a delimiter.++.. option:: -skipnodata++    Exclude from the output lines with nodata value (as determinate by srcnodata)++.. option:: -srcnodata++    Determinants what is the nodata value of the dataset (for skipping or replacing)

+.. _gdal2xyz:++================================================================================+gdal2xyz+================================================================================++.. only:: html++    Translates a raster file into `xyz` format.++.. Index:: gdal2xyz++Synopsis+--------++.. code-block::++    gdal2xyz [-help]+        [-skip factor]+        [-srcwin xoff yoff xsize ysize]+        [-b band]* [-allbands]+        [-csv]+        [-srcnodata value] [-dstnodata value]+        src_dataset [dst_dataset]++Description+-----------++The :program:`gdal2xyz` utility can be used to translate a raster file into xyz format.+`gdal2xyz` can be used as an alternative to `gdal_translate of=xyz`, but supporting other options,+for example:++    * Select more then one band+    * Skip or replace nodata value+    * Return the output as numpy arrays.++.. program:: gdal2xyz++.. option:: -skip++    How many rows/cols to skip in each iteration.++.. option:: -srcwin <xoff> <yoff> <xsize> <ysize>++    Selects a subwindow from the source image for copying based on pixel/line location.++.. option:: -b, -band <band>++    Select band *band* from the input spectral bands for output.+    Bands are numbered from 1 in the order spectral bands are specified.+    Multiple **-b** switches may be used.+    When no -b switch is used, the first band will be used.+    In order to use all input bands set `-allbands` or `-b 0`.++.. option:: -allbands++    Select all input bands.++.. option:: -csv++    Use comma instead of space as a delimiter.++.. option:: -skipnodata++    Exclude from the output lines with nodata value (as determinate by srcnodata)

+.. _gdal2xyz:++================================================================================+gdal2xyz+================================================================================++.. only:: html++    Translates a raster file into `xyz` format.++.. Index:: gdal2xyz++Synopsis+--------++.. code-block::++    gdal2xyz [-help]+        [-skip factor]+        [-srcwin xoff yoff xsize ysize]+        [-b band]* [-allbands]+        [-csv]

 import numpy as np  from osgeo import gdal-from osgeo.utils.auxiliary.base import num+from osgeo.utils.auxiliary.base import num, PathLike+from osgeo.utils.auxiliary.util import PathOrDS from osgeo.utils.auxiliary.numpy_util import GDALTypeCodeAndNumericTypeCodeFromDataSet   def Usage():-    print('Usage: gdal2xyz.py [-skip factor] [-srcwin xoff yoff width height]')-    print('                   [-band b] [--allBands] [-csv]')-    print('                   [--skipNoData] [-noDataValue value]')-    print('                   srcfile [dstfile]')+    print('Usage: gdal2xyz.py [-help]'

 def main(argv):         band_nums = 1     return gdal2xyz(srcfile=srcfile, dstfile=dstfile, srcwin=srcwin, skip=skip,                     band_nums=band_nums, delim=delim,-                    skip_no_data=skip_no_data, no_data_value=no_data_value)+                    skip_nodata=skip_nodata, src_nodata=src_nodata, dst_nodata=dst_nodata)  -def gdal2xyz(srcfile: Union[str, Path, gdal.Dataset], dstfile: Union[str, Path] = None,+def gdal2xyz(srcfile: PathOrDS, dstfile: PathLike = None,              srcwin: Optional[Sequence[int]] = None,              skip: Union[int, Sequence[int]] = 1,              band_nums: Optional[Sequence[int]] = None, delim=' ',-             skip_no_data: bool = False, no_data_value: Optional[Union[Sequence, Number]] = None,+             skip_nodata: bool = False,+             src_nodata: Optional[Union[Sequence, Number]] = None, dst_nodata: Optional[Union[Sequence, Number]] = None,              return_np_arrays: bool = False):     """     translates a raster file (or dataset) into xyz format -    srcfile - source filename or dataset-    dstfile - destination filename-    srcwin - a sequence of 4 integers [x_off y_off x_size y_size]     skip - how many rows/cols to skip each iteration-    band_nums - number of the bands to include in the output. None to include all bands.-    delim - delimiter to use to separate columns-    skip_no_data - `True` will skip lines with uninteresting data values (NoDataValue or a given value)-    no_data_value - determinates which values to skip-        `None` - skip lines which have the dataset NoDataValue;-        Sequence/Number - skip lines with a given value (per band or per dataset)+    srcwin (xoff, yoff, xsize, ysize) - Selects a subwindow from the source image for copying based on pixel/line location.+    band_nums - selected input bands to process, None to process all.+    delim - the delimiter to use between balues in a line+    skip_nodata - Exclude from the output lines with nodata value (as determinate by srcnodata)+    src_nodata - Determinants what is the nodata value of the dataset (for skipping or replacing)

 def main(argv):         band_nums = 1     return gdal2xyz(srcfile=srcfile, dstfile=dstfile, srcwin=srcwin, skip=skip,                     band_nums=band_nums, delim=delim,-                    skip_no_data=skip_no_data, no_data_value=no_data_value)+                    skip_nodata=skip_nodata, src_nodata=src_nodata, dst_nodata=dst_nodata)  -def gdal2xyz(srcfile: Union[str, Path, gdal.Dataset], dstfile: Union[str, Path] = None,+def gdal2xyz(srcfile: PathOrDS, dstfile: PathLike = None,              srcwin: Optional[Sequence[int]] = None,              skip: Union[int, Sequence[int]] = 1,              band_nums: Optional[Sequence[int]] = None, delim=' ',-             skip_no_data: bool = False, no_data_value: Optional[Union[Sequence, Number]] = None,+             skip_nodata: bool = False,+             src_nodata: Optional[Union[Sequence, Number]] = None, dst_nodata: Optional[Union[Sequence, Number]] = None,              return_np_arrays: bool = False):     """     translates a raster file (or dataset) into xyz format -    srcfile - source filename or dataset-    dstfile - destination filename-    srcwin - a sequence of 4 integers [x_off y_off x_size y_size]     skip - how many rows/cols to skip each iteration-    band_nums - number of the bands to include in the output. None to include all bands.-    delim - delimiter to use to separate columns-    skip_no_data - `True` will skip lines with uninteresting data values (NoDataValue or a given value)-    no_data_value - determinates which values to skip-        `None` - skip lines which have the dataset NoDataValue;-        Sequence/Number - skip lines with a given value (per band or per dataset)+    srcwin (xoff, yoff, xsize, ysize) - Selects a subwindow from the source image for copying based on pixel/line location.+    band_nums - selected input bands to process, None to process all.+    delim - the delimiter to use between balues in a line+    skip_nodata - Exclude from the output lines with nodata value (as determinate by srcnodata)

 def main(argv):         band_nums = 1     return gdal2xyz(srcfile=srcfile, dstfile=dstfile, srcwin=srcwin, skip=skip,                     band_nums=band_nums, delim=delim,-                    skip_no_data=skip_no_data, no_data_value=no_data_value)+                    skip_nodata=skip_nodata, src_nodata=src_nodata, dst_nodata=dst_nodata)  -def gdal2xyz(srcfile: Union[str, Path, gdal.Dataset], dstfile: Union[str, Path] = None,+def gdal2xyz(srcfile: PathOrDS, dstfile: PathLike = None,              srcwin: Optional[Sequence[int]] = None,              skip: Union[int, Sequence[int]] = 1,              band_nums: Optional[Sequence[int]] = None, delim=' ',-             skip_no_data: bool = False, no_data_value: Optional[Union[Sequence, Number]] = None,+             skip_nodata: bool = False,+             src_nodata: Optional[Union[Sequence, Number]] = None, dst_nodata: Optional[Union[Sequence, Number]] = None,              return_np_arrays: bool = False):     """     translates a raster file (or dataset) into xyz format -    srcfile - source filename or dataset-    dstfile - destination filename-    srcwin - a sequence of 4 integers [x_off y_off x_size y_size]     skip - how many rows/cols to skip each iteration-    band_nums - number of the bands to include in the output. None to include all bands.-    delim - delimiter to use to separate columns-    skip_no_data - `True` will skip lines with uninteresting data values (NoDataValue or a given value)-    no_data_value - determinates which values to skip-        `None` - skip lines which have the dataset NoDataValue;-        Sequence/Number - skip lines with a given value (per band or per dataset)+    srcwin (xoff, yoff, xsize, ysize) - Selects a subwindow from the source image for copying based on pixel/line location.+    band_nums - selected input bands to process, None to process all.+    delim - the delimiter to use between balues in a line