# Bindings to 'GDAL'

## Documentation for package ‘gdalraster’ version 2.6.1

- DESCRIPTION file
- User guides, package vignettes and other documentation
- Package NEWS
- Package README

## Help Pages

A B C D E F G H I L M N O P R S T V W

gdalraster-package | Bindings to the GDAL API

## -- A --

addFilesInZip | Create/append to a potentially Seek-Optimized ZIP file (SOZip)
apply_geotransform | Apply geotransform (raster column/row to geospatial x/y)
autoCreateWarpedVRT | Create a virtual warped dataset automatically

## -- B --

bandCopyWholeRaster | Copy a whole raster band efficiently
bbox_from_dim_gt | Bounding box from dimensions and geotransform
bbox_from_wkt | Get the bounding box of a geometry specified in OGC WKT format
bbox_intersect | Bounding box intersection / union
bbox_to_wkt | Convert a bounding box to POLYGON in OGC WKT format
bbox_transform | Transform a bounding box to a different projection
bbox_union | Bounding box intersection / union
buildRAT | Build a GDAL Raster Attribute Table with VALUE, COUNT
buildVRT | Build a GDAL virtual raster from a list of datasets

## -- C --

calc | Raster calculation
CmbTable | Class for counting unique combinations of integers
CmbTable-class | Class for counting unique combinations of integers
combine | Raster overlay for unique combinations
copyDatasetFiles | Copy the files of a dataset
create | Create a new uninitialized raster
createColorRamp | Create a color ramp
createCopy | Create a copy of a raster

## -- D --

data_type_helpers | Helper functions for GDAL raster data types
DEFAULT_DEM_PROC | List of default DEM processing options
DEFAULT_NODATA | List of default nodata values by raster data type
deleteDataset | Delete named dataset
dem_derivatives | Convenience functions for simple DEM derivatives
dem_proc | GDAL DEM processing
displayRAT | Display a GDAL Raster Attribute Table
dt_find | Helper functions for GDAL raster data types
dt_find_for_value | Helper functions for GDAL raster data types
dt_is_complex | Helper functions for GDAL raster data types
dt_is_floating | Helper functions for GDAL raster data types
dt_is_integer | Helper functions for GDAL raster data types
dt_is_signed | Helper functions for GDAL raster data types
dt_size | Helper functions for GDAL raster data types
dt_union | Helper functions for GDAL raster data types
dt_union_with_value | Helper functions for GDAL raster data types
dump_open_datasets | Report open datasets

## -- E --

eastness | Convenience functions for simple DEM derivatives
epsg_to_wkt | Convert spatial reference definitions to OGC WKT or PROJJSON

## -- F --

fillNodata | Fill selected pixels by interpolation from surrounding areas
footprint | Compute footprint of a raster

## -- G --

GDALAlg | Class encapsulating a GDAL CLI algorithm
GDALAlg-class | Class encapsulating a GDAL CLI algorithm
GDALRaster | Class encapsulating a raster dataset and associated band objects
gdalraster | Bindings to the GDAL API
GDALRaster-class | Class encapsulating a raster dataset and associated band objects
GDALVector | Class encapsulating a vector layer in a GDAL dataset
GDALVector-class | Class encapsulating a vector layer in a GDAL dataset
gdal_alg | Functions for using GDAL CLI algorithms
gdal_cli | Functions for using GDAL CLI algorithms
gdal_commands | Functions for using GDAL CLI algorithms
gdal_compute_version | Compute a GDAL integer version number from major, minor, revision
gdal_formats | Retrieve information on GDAL format drivers for raster and vector
gdal_get_driver_md | Get metadata for a GDAL format driver
gdal_global_reg_names | Functions for using GDAL CLI algorithms
gdal_run | Functions for using GDAL CLI algorithms
gdal_run_piped | Functions for using GDAL CLI algorithms
gdal_usage | Functions for using GDAL CLI algorithms
gdal_version | Get GDAL version
gdal_version_num | Get GDAL version
geos_version | Get GEOS version
getCreationOptions | Return the list of creation options for a GDAL driver
get_cache_max | Get the maximum memory size available for the GDAL block cache
get_cache_used | Get the size of memory in use by the GDAL block cache
get_config_option | Get GDAL configuration option
get_num_cpus | Get the number of processors detected by GDAL
get_pixel_line | Raster pixel/line from geospatial x,y coordinates
get_usable_physical_ram | Get usable physical RAM reported by GDAL
gt_from_dim_bbox | Geotransform from dimensions and bounding box
g_add_geom | Geometry factory functions
g_area | Compute measurements for WKB/WKT geometries
g_binary_op | Binary operations on WKB or WKT geometries
g_binary_pred | Geometry binary predicates operating on WKB or WKT
g_boundary | Unary operations on WKB or WKT geometries
g_buffer | Unary operations on WKB or WKT geometries
g_build_collection | Geometry factory functions
g_build_polygon_from_edges | Geometry factory functions
g_centroid | Compute measurements for WKB/WKT geometries
g_concave_hull | Unary operations on WKB or WKT geometries
g_contains | Geometry binary predicates operating on WKB or WKT
g_convex_hull | Unary operations on WKB or WKT geometries
g_coords | Extract coordinate values from geometries
g_create | Geometry factory functions
g_crosses | Geometry binary predicates operating on WKB or WKT
g_delaunay_triangulation | Unary operations on WKB or WKT geometries
g_difference | Binary operations on WKB or WKT geometries
g_disjoint | Geometry binary predicates operating on WKB or WKT
g_distance | Compute measurements for WKB/WKT geometries
g_envelope | Obtain the 2D or 3D bounding envelope for input geometries
g_equals | Geometry binary predicates operating on WKB or WKT
g_factory | Geometry factory functions
g_geodesic_area | Compute measurements for WKB/WKT geometries
g_geodesic_length | Compute measurements for WKB/WKT geometries
g_geom_count | Obtain information about WKB/WKT geometries
g_get_geom | Geometry factory functions
g_intersection | Binary operations on WKB or WKT geometries
g_intersects | Geometry binary predicates operating on WKB or WKT
g_invalid_reason | Obtain information about WKB/WKT geometries
g_is_3D | Obtain information about WKB/WKT geometries
g_is_empty | Obtain information about WKB/WKT geometries
g_is_measured | Obtain information about WKB/WKT geometries
g_is_ring | Obtain information about WKB/WKT geometries
g_is_valid | Obtain information about WKB/WKT geometries
g_length | Compute measurements for WKB/WKT geometries
g_make_valid | Geometry utility functions operating on WKB or WKT
g_measures | Compute measurements for WKB/WKT geometries
g_name | Obtain information about WKB/WKT geometries
g_normalize | Geometry utility functions operating on WKB or WKT
g_overlaps | Geometry binary predicates operating on WKB or WKT
g_query | Obtain information about WKB/WKT geometries
g_segmentize | Unary operations on WKB or WKT geometries
g_set_3D | Geometry utility functions operating on WKB or WKT
g_set_measured | Geometry utility functions operating on WKB or WKT
g_simplify | Unary operations on WKB or WKT geometries
g_summary | Obtain information about WKB/WKT geometries
g_swap_xy | Geometry utility functions operating on WKB or WKT
g_sym_difference | Binary operations on WKB or WKT geometries
g_touches | Geometry binary predicates operating on WKB or WKT
g_transform | Apply a coordinate transformation to a WKB/WKT geometry
g_unary_op | Unary operations on WKB or WKT geometries
g_unary_union | Unary operations on WKB or WKT geometries
g_union | Binary operations on WKB or WKT geometries
g_util | Geometry utility functions operating on WKB or WKT
g_within | Geometry binary predicates operating on WKB or WKT
g_wk2wk | Geometry WKB/WKT conversion

## -- H --

has_geos | Is GEOS available?
has_spatialite | Is SpatiaLite available?
http_enabled | Check if GDAL CPLHTTP services can be useful (libcurl)

## -- I --

identifyDriver | Identify the GDAL driver that can open a dataset
inspectDataset | Obtain information about a GDAL raster or vector dataset
inv_geotransform | Invert geotransform
inv_project | Inverse project geospatial x/y coordinates to longitude/latitude
is_los_visible | Check line of sight between pairs of point locations

## -- L --

lib_versions | Return library version information for GDAL and its dependencies

## -- M --

make_chunk_index | Generate an index of chunk offsets and sizes for iterating a raster
mdim_as_classic | Return a view of an MDArray as a "classic" GDALDataset (i.e., 2D)
mdim_info | Report structure and content of a multidimensional dataset
mdim_translate | Convert multidimensional data between different formats, and subset

## -- N --

northness | Convenience functions for simple DEM derivatives

## -- O --

ogr2ogr | Convert vector data between different formats
ogrinfo | Retrieve information about a vector data source
ogr_define | OGR feature class definition for vector data
ogr_def_field | OGR feature class definition for vector data
ogr_def_field_domain | OGR feature class definition for vector data
ogr_def_geom_field | OGR feature class definition for vector data
ogr_def_layer | OGR feature class definition for vector data
ogr_ds_add_field_domain | Utility functions for managing vector data sources
ogr_ds_create | Utility functions for managing vector data sources
ogr_ds_delete_field_domain | Utility functions for managing vector data sources
ogr_ds_exists | Utility functions for managing vector data sources
ogr_ds_field_domain_names | Utility functions for managing vector data sources
ogr_ds_format | Utility functions for managing vector data sources
ogr_ds_layer_count | Utility functions for managing vector data sources
ogr_ds_layer_names | Utility functions for managing vector data sources
ogr_ds_test_cap | Utility functions for managing vector data sources
ogr_execute_sql | Utility functions for managing vector data sources
ogr_field_create | Utility functions for managing vector data sources
ogr_field_delete | Utility functions for managing vector data sources
ogr_field_index | Utility functions for managing vector data sources
ogr_field_rename | Utility functions for managing vector data sources
ogr_field_set_domain_name | Utility functions for managing vector data sources
ogr_geom_field_create | Utility functions for managing vector data sources
ogr_layer_create | Utility functions for managing vector data sources
ogr_layer_delete | Utility functions for managing vector data sources
ogr_layer_exists | Utility functions for managing vector data sources
ogr_layer_field_names | Utility functions for managing vector data sources
ogr_layer_rename | Utility functions for managing vector data sources
ogr_layer_test_cap | Utility functions for managing vector data sources
ogr_manage | Utility functions for managing vector data sources
ogr_proc | GDAL OGR facilities for vector geoprocessing
ogr_reproject | Reproject a vector layer

## -- P --

pixel_extract | Extract pixel values at geospatial point locations
plot.OGRFeature | Plot the geometry of an 'OGRFeature' object
plot.OGRFeatureSet | Plot the geometry column of an 'OGRFeatureSet'
plot_geom | Plot WKT or WKB geometries
plot_raster | Display raster data
polygonize | Create a polygon feature layer from raster data
pop_error_handler | Pop error handler off stack
print.OGRFeature | Print an 'OGRFeature' object
print.OGRFeatureSet | Print an 'OGRFeatureSet'
progress_bar_clear | Clear progress bar
proj_networking | Check, enable or disable PROJ networking capabilities
proj_search_paths | Get or set search path(s) for PROJ resource files
proj_version | Get PROJ version
push_error_handler | Push a new GDAL CPLError handler

## -- R --

rasterFromRaster | Create a raster from an existing raster as template
rasterize | Burn vector geometries into a raster
rasterToVRT | Create a GDAL virtual raster derived from one source dataset
Rcpp_CmbTable | Class for counting unique combinations of integers
Rcpp_CmbTable-class | Class for counting unique combinations of integers
Rcpp_GDALAlg | Class encapsulating a GDAL CLI algorithm
Rcpp_GDALAlg-class | Class encapsulating a GDAL CLI algorithm
Rcpp_GDALRaster | Class encapsulating a raster dataset and associated band objects
Rcpp_GDALRaster-class | Class encapsulating a raster dataset and associated band objects
Rcpp_GDALVector | Class encapsulating a vector layer in a GDAL dataset
Rcpp_GDALVector-class | Class encapsulating a vector layer in a GDAL dataset
Rcpp_RunningStats | Class to calculate mean and variance in one pass
Rcpp_RunningStats-class | Class to calculate mean and variance in one pass
Rcpp_VSIFile | Class wrapping the GDAL VSIVirtualHandle API for binary file I/O
Rcpp_VSIFile-class | Class wrapping the GDAL VSIVirtualHandle API for binary file I/O
read_ds | Convenience wrapper for 'GDALRaster$read()'
read_to_nativeRaster | Read raster data as nativeRaster
renameDataset | Rename a dataset
RunningStats | Class to calculate mean and variance in one pass
RunningStats-class | Class to calculate mean and variance in one pass
rvector_to_MEM | Create a GDAL in-memory dataset from R data without copying

## -- S --

SEEK_CUR | Constants for VSIFile$seek()
SEEK_END | Constants for VSIFile$seek()
SEEK_SET | Constants for VSIFile$seek()
set_cache_max | Set the maximum memory size for the GDAL block cache
set_config_option | Set GDAL configuration option
sieveFilter | Remove small raster polygons
srs_convert | Convert spatial reference definitions to OGC WKT or PROJJSON
srs_epsg_treats_as_lat_long | Obtain information about a spatial reference system
srs_epsg_treats_as_northing_easting | Obtain information about a spatial reference system
srs_find_epsg | Obtain information about a spatial reference system
srs_get_angular_units | Obtain information about a spatial reference system
srs_get_area_of_use | Obtain information about a spatial reference system
srs_get_axes | Obtain information about a spatial reference system
srs_get_axes_count | Obtain information about a spatial reference system
srs_get_axis_mapping_strategy | Obtain information about a spatial reference system
srs_get_celestial_body_name | Obtain information about a spatial reference system
srs_get_coord_epoch | Obtain information about a spatial reference system
srs_get_linear_units | Obtain information about a spatial reference system
srs_get_name | Obtain information about a spatial reference system
srs_get_utm_zone | Obtain information about a spatial reference system
srs_info_from_db | Obtain information about coordinate reference systems in the PROJ DB
srs_is_compound | Obtain information about a spatial reference system
srs_is_derived_gcs | Obtain information about a spatial reference system
srs_is_dynamic | Obtain information about a spatial reference system
srs_is_geocentric | Obtain information about a spatial reference system
srs_is_geographic | Obtain information about a spatial reference system
srs_is_local | Obtain information about a spatial reference system
srs_is_projected | Obtain information about a spatial reference system
srs_is_same | Obtain information about a spatial reference system
srs_is_vertical | Obtain information about a spatial reference system
srs_query | Obtain information about a spatial reference system
srs_to_projjson | Convert spatial reference definitions to OGC WKT or PROJJSON
srs_to_wkt | Convert spatial reference definitions to OGC WKT or PROJJSON

## -- T --

transform_bounds | Transform boundary
transform_xy | Transform geospatial x/y coordinates
translate | Convert raster data between different formats

## -- V --

validateCreationOptions | Validate the list of creation options that are handled by a driver
vector_to_MEM | Create a GDAL in-memory dataset from R data without copying
VSIFile | Class wrapping the GDAL VSIVirtualHandle API for binary file I/O
VSIFile-class | Class wrapping the GDAL VSIVirtualHandle API for binary file I/O
vsi_clear_path_options | Clear path specific configuration options
vsi_constants | Constants for VSIFile$seek()
vsi_copy_file | Copy a source file to a target filename
vsi_curl_clear_cache | Clean cache associated with /vsicurl/ and related file systems
vsi_get_actual_url | Returns the actual URL of a supplied VSI filename
vsi_get_disk_free_space | Return free disk space available on the filesystem
vsi_get_file_metadata | Get metadata on files
vsi_get_fs_options | Return the list of options associated with a virtual file system handler
vsi_get_fs_prefixes | Return the list of virtual file system handlers currently registered
vsi_get_signed_url | Returns a signed URL for a supplied VSI filename
vsi_glob | Get file and directory names matching a pattern that may contain wildcards
vsi_is_local | Returns if the file/filesystem is "local".
vsi_mkdir | Create a directory
vsi_read_dir | Read names in a directory
vsi_rename | Rename a file
vsi_rmdir | Delete a directory
vsi_set_path_option | Set a path specific option for a given path prefix
vsi_stat | Get filesystem object info
vsi_stat_exists | Get filesystem object info
vsi_stat_size | Get filesystem object info
vsi_stat_type | Get filesystem object info
vsi_supports_rnd_write | Return whether the filesystem supports random write
vsi_supports_seq_write | Return whether the filesystem supports sequential write
vsi_sync | Synchronize a source file/directory with a target file/directory
vsi_unlink | Delete a file
vsi_unlink_batch | Delete several files in a batch
vsi_uri_to_vsi_path | Return VSI compatible paths from URIs / URLs

## -- W --

warp | Raster reprojection and mosaicing