.. _python_samples:

================================================================================
Sample scripts
================================================================================

The following are sample scripts intended to give an idea how to use the
GDAL's Python interface. Please feel free to use them in your applications.

From GDAL 3.2, Python utility scripts :ref:`programs` are located inside the `osgeo_utils` module.
From GDAL 3.3, Python sample scripts are located inside the `osgeo_utils.samples` sub-module.

Python Raster Sample scripts
------------------------------

.. only:: html

    - assemblepoly: Script demonstrates how to assemble polygons from arcs. Demonstrates various aspects of OGR Python API.
    - fft: Script to perform forward and inverse two-dimensional fast Fourier transform.
    - gdal2grd: Script to write out ASCII GRD rasters (used in Golden Software Surfer). from any source supported by GDAL.
    - gdal_vrtmerge: Similar to gdal_merge, but produces a VRT file.
    - gdalcopyproj: Duplicate the geotransform, projection and/or GCPs from one raster dataset to another,
      which can be useful after performing image manipulations with other software that ignores or discards georeferencing metadata.
    - gdalfilter:  Example script for applying kernel based filters to an image using GDAL.
      Demonstrates use of virtual files as an intermediate representation.
    - get_soundg: Script to copy the SOUNDG layer from an S-57 file to a Shapefile,
      splitting up features with MULTIPOINT geometries into many POINT features,
      and appending the point elevations as an attribute.
    - histrep: Module to extract data from many rasters into one output.
    - load2odbc: Load ODBC table to an ODBC datastore. Uses direct SQL since the ODBC driver is read-only for OGR.
    - rel: Script to produce a shaded relief image from the elevation data. (similar functionality in gdaldem now)
    - tigerpoly:  Script demonstrating how to assemble polygons from arcs in TIGER/Line datasource,
      writing results to a newly created shapefile.
    - tolatlong: Script to read coordinate system and geotransformation matrix from input file and report
      latitude/longitude coordinates for the specified pixel.
    - val_repl: Script to replace specified values from the input raster file with the new ones.
      May be useful in cases when you don't like value, used for NoData indication and want replace it with other value.
      Input file remains unchanged, results stored in other file.
    - vec_tr: Example of applying some algorithm to all the geometries in the file, such as a fixed offset.
    - vec_tr_spat: Example of using Intersect() to filter based on only those features that truly intersect a given rectangle.
      Easily extended to general polygon!
    - classify: Demonstrates using numpy for simple range based classification of an image.
      This is only an example that has stuff hardcoded.
    - gdal_lut: Read a LUT from a text file, and apply it to an image.
      Sort of a '1 band' version of pct2rgb.
    - magphase: Example script computing magnitude and phase images from a complex image.
    - hsv_merge: Merge greyscale image into RGB image as intensity in HSV space.
    - gdal_ls: Display the list of files in a virtual directory, like /vsicurl or /vsizip
    - gdal_cp: Copy a virtual file
    - gdal_minmax_location: returns the location where min/max values of a raster are hit.

Python Vector Sample scripts
------------------------------

.. only:: html

    - ogrupdate: Update a target datasource with the features of a source datasource. Contrary to ogr2ogr,
      this script tries to match features between the datasources,
      to decide whether to create a new feature, or to update an existing one.
    - ogr_layer_algebra: Application for executing OGR layer algebra operations.
    - ogr_dispatch: Dispatch features into layers according to the value of some fields or the geometry type.
    - wcs_virtds_params: Generates MapServer WCS layer definition from a tileindex with mixed SRS
    - ogr_build_junction_table: Create junction tables for layers coming from GML datasources that
      reference other objects in _href fields
    - gcps2ogr: Outputs GDAL GCPs as OGR points


Python Coordinate Reference System Sample scripts
------------------------------------------------------

.. only:: html

    - crs2crs2grid: A script to produce PROJ.4 grid shift files from HTDP program.

Python direct ports of c++ programs
---------------------------------------

.. only:: html

    - :ref:`gdalinfo`: A direct port of apps/gdalinfo.c
    - :ref:`ogrinfo`: A direct port of apps/ogrinfo.cpp
    - :ref:`gdallocationinfo`: A direct port of apps/gdallocationinfo.cpp

Python sample scripts that are now programs
----------------------------------------------

Sample scripts might be upgraded to proper gdal utilities (programs) in next versions
with added functionality and documentation.
The following samples from previous versions are now programs.

.. only:: html

    - :ref:`gdal2xyz`: Translates a raster file into xyz format.
    - :ref:`gdal_retile`: Script for restructuring data in a tree of regular tiles.
    - val_at_coord: see :ref:`gdallocationinfo`
