.\" 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-VECTOR-CLIP" "1" "May 06, 2025" "" "GDAL" .SH NAME gdal-vector-clip \- Clip a vector dataset .sp Added in version 3.11. .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp .EX Usage: gdal vector clip [OPTIONS] Clip a vector dataset. Positional arguments: \-i, \-\-input Input vector datasets [required] \-o, \-\-output Output vector dataset [required] Common Options: \-h, \-\-help Display help message and exit \-\-json\-usage Display usage as JSON document and exit \-\-config = Configuration option [may be repeated] \-\-progress Display progress bar Options: \-l, \-\-layer, \-\-input\-layer Input layer name(s) [may be repeated] \-f, \-\-of, \-\-format, \-\-output\-format Output format (\(dqGDALG\(dq allowed) \-\-co, \-\-creation\-option = Creation option [may be repeated] \-\-lco, \-\-layer\-creation\-option = Layer creation option [may be repeated] \-\-overwrite Whether overwriting existing output is allowed \-\-update Whether to open existing dataset in update mode \-\-overwrite\-layer Whether overwriting existing layer is allowed \-\-append Whether appending to existing layer is allowed \-\-output\-layer Output layer name \-\-active\-layer Set active layer (if not specified, all) \-\-bbox Clipping bounding box as xmin,ymin,xmax,ymax Mutually exclusive with \-\-geometry, \-\-like \-\-bbox\-crs CRS of clipping bounding box \-\-geometry Clipping geometry (WKT or GeoJSON) Mutually exclusive with \-\-bbox, \-\-like \-\-geometry\-crs CRS of clipping geometry \-\-like Dataset to use as a template for bounds Mutually exclusive with \-\-bbox, \-\-geometry \-\-like\-sql SELECT statement to run on the \(aqlike\(aq dataset Mutually exclusive with \-\-like\-where \-\-like\-layer Name of the layer of the \(aqlike\(aq dataset \-\-like\-where WHERE SQL clause to run on the \(aqlike\(aq dataset Mutually exclusive with \-\-like\-sql Advanced Options: \-\-if, \-\-input\-format Input formats [may be repeated] \-\-oo, \-\-open\-option = Open options [may be repeated] .EE .UNINDENT .UNINDENT .SH DESCRIPTION .sp \fBgdal vector clip\fP can be used to clip a vector dataset using georeferenced coordinates. .sp Either \fI\%\-\-bbox\fP, \fI\%\-\-geometry\fP or \fI\%\-\-like\fP must be specified. .sp \fBclip\fP can also be used as a step of \fI\%gdal vector pipeline\fP\&. .sp Clipping sometimes results in geometries that are of a type not compatible with the geometry type. This program splits multi\-geometries or geometry collections into their parts for layers that are of a single geometry type (such as point, linestring, polygon) and only keeps the parts that are of that type. It also promotes single geometry types (e.g. polygons) to multi geometry types (e.g. multi\-polygons). If the user needs to preserve any type of intersection, the layer must use the \fBwkbUnknown\fP (any geometry) type. .SS Standard options .INDENT 0.0 .TP .B \-f, \-\-of, \-\-format, \-\-output\-format Which output vector format to use. Allowed values may be given by \fBgdal \-\-formats | grep vector | grep rw | sort\fP .UNINDENT .INDENT 0.0 .TP .B \-\-co = Many formats have one or more optional dataset creation options that can be used to control particulars about the file created. For instance, the GeoPackage driver supports creation options to control the version. .sp May be repeated. .sp The dataset creation options available vary by format driver, and some simple formats have no creation options at all. A list of options supported for a format can be listed with the \fI\%\-\-formats\fP command line option but the documentation for the format is the definitive source of information on driver creation options. See \fI\%Vector drivers\fP format specific documentation for legal creation options for each format. .sp Note that dataset creation options are different from layer creation options. .UNINDENT .INDENT 0.0 .TP .B \-\-overwrite Allow program to overwrite existing target file or dataset. Otherwise, by default, \fBgdal\fP errors out if the target file or dataset already exists. .UNINDENT .INDENT 0.0 .TP .B \-\-active\-layer Set the active layer. When it is specified, only the layer specified by its name will be subject to the processing. Other layers will be not modified. If this option is not specified, all layers will be subject to the processing. .UNINDENT .INDENT 0.0 .TP .B \-\-bbox ,,, Bounds to which to clip the dataset. They are assumed to be in the CRS of the input dataset, unless \fI\%\-\-bbox\-crs\fP is specified. The X and Y axis are the \(dqGIS friendly ones\(dq, that is X is longitude or easting, and Y is latitude or northing. Mutually exclusive with \fI\%\-\-like\fP and \fI\%\-\-geometry\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-bbox\-crs CRS in which the ,,, values of \fI\%\-\-bbox\fP are expressed. If not specified, it is assumed to be the CRS of the input dataset. Note that specifying \-\-bbox\-crs does not involve doing vector reprojection. Instead, the bounds are reprojected from the bbox\-crs to the CRS of the input dataset. .UNINDENT .INDENT 0.0 .TP .B \-\-geometry Geometry as a WKT or GeoJSON string to which to clip the dataset. If the input geometry is GeoJSON, its CRS is assumed to be WGS84, unless there is a CRS defined in the GeoJSON geometry or \fI\%\-\-geometry\-crs\fP is specified. If the input geometry is WKT, its CRS is assumed to be the one of the input dataset, unless \fI\%\-\-geometry\-crs\fP is specified. The X and Y axis are the \(dqGIS friendly ones\(dq, that is X is longitude or easting, and Y is latitude or northing. Mutually exclusive with \fI\%\-\-bbox\fP and \fI\%\-\-like\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-geometry\-crs CRS in which the coordinates values of \fI\%\-\-geometry\fP are expressed. If not specified, it is assumed to be the CRS of the input dataset. Note that specifying \-\-geometry\-crs does not involve doing vector reprojection. Instead, the bounds are reprojected from the geometry\-crs to the CRS of the input dataset. .UNINDENT .INDENT 0.0 .TP .B \-\-like Vector or raster dataset to use as a template for bounds. If the specified dataset is a raster, its rectangular bounds are used as the clipping geometry. If the specified dataset is a vector dataset, its polygonal geometries are unioned together to form the clipping geometry (beware that the result union might not be perfect if there are gaps between individual polygon features). If several layers are present, \fI\%\-\-like\-sql\fP or \fI\%\-\-like\-layer\fP must be specified. Mutually exclusive with \fI\%\-\-bbox\fP and \fI\%\-\-geometry\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-like\-sql Select desired geometries from the vector clip dataset using an SQL query. e.g \fBSELECT geom FROM my_layer WHERE country = \(aqFrance\(aq\fP\&. Mutually exclusive with \fI\%\-\-like\-layer\fP and \fI\%\-\-like\-where\fP .UNINDENT .INDENT 0.0 .TP .B \-\-like\-layer Select the named layer from the vector clip dataset. Mutually exclusive with \fI\%\-\-like\-sql\fP .UNINDENT .INDENT 0.0 .TP .B \-\-like\-where Restrict desired geometries from vector clip dataset layer based on an attribute query. e.g \fBcountry = \(aqFrance\(aq\fP\&. .UNINDENT .SS Advanced options .INDENT 0.0 .TP .B \-\-oo = Dataset open option (format specific). .sp May be repeated. .UNINDENT .INDENT 0.0 .TP .B \-\-if Format/driver name to be attempted to open the input file(s). It is generally not necessary to specify it, but it can be used to skip automatic driver detection, when it fails to select the appropriate driver. This option can be repeated several times to specify several candidate drivers. Note that it does not force those drivers to open the dataset. In particular, some drivers have requirements on file extensions. .sp May be repeated. .UNINDENT .SH EXAMPLES .SS Example 1: Clip a GeoPackage file to the bounding box from longitude 2, latitude 49, to longitude 3, latitude 50 in WGS 84 .INDENT 0.0 .INDENT 3.5 .sp .EX $ gdal vector clip \-\-bbox=2,49,3,50 \-\-bbox\-crs=EPSG:4326 in.gpkg out.gpkg \-\-overwrite .EE .UNINDENT .UNINDENT .SH AUTHOR Even Rouault .SH COPYRIGHT 1998-2025 .\" Generated by docutils manpage writer. .