rasterio package
Subpackages
Submodules
- rasterio.control module
- rasterio.coords module
- rasterio.crs module
CRS
CRS.data
CRS.from_authority()
CRS.from_dict()
CRS.from_epsg()
CRS.from_proj4()
CRS.from_string()
CRS.from_user_input()
CRS.from_wkt()
CRS.get()
CRS.is_epsg_code
CRS.is_geographic
CRS.is_projected
CRS.is_valid
CRS.items()
CRS.linear_units
CRS.linear_units_factor
CRS.to_authority()
CRS.to_dict()
CRS.to_epsg()
CRS.to_proj4()
CRS.to_string()
CRS.to_wkt()
CRS.units_factor
CRS.wkt
epsg_treats_as_latlong()
epsg_treats_as_northingeasting()
- rasterio.drivers module
- rasterio.dtypes module
- rasterio.enums module
ColorInterp
ColorInterp.Cb
ColorInterp.Cr
ColorInterp.Y
ColorInterp.alpha
ColorInterp.black
ColorInterp.blue
ColorInterp.cyan
ColorInterp.gray
ColorInterp.green
ColorInterp.grey
ColorInterp.hue
ColorInterp.lightness
ColorInterp.magenta
ColorInterp.palette
ColorInterp.red
ColorInterp.saturation
ColorInterp.undefined
ColorInterp.yellow
Compression
Interleaving
MaskFlags
MergeAlg
PhotometricInterp
Resampling
Resampling.nearest
Resampling.bilinear
Resampling.cubic
Resampling.cubic_spline
Resampling.lanczos
Resampling.average
Resampling.mode
Resampling.gauss
Resampling.max
Resampling.min
Resampling.med
Resampling.q1
Resampling.q3
Resampling.sum
Resampling.rms
Resampling.average
Resampling.bilinear
Resampling.cubic
Resampling.cubic_spline
Resampling.gauss
Resampling.lanczos
Resampling.max
Resampling.med
Resampling.min
Resampling.mode
Resampling.nearest
Resampling.q1
Resampling.q3
Resampling.rms
Resampling.sum
TransformDirection
TransformMethod
WktVersion
- rasterio.env module
- rasterio.errors module
BandOverviewError
CRSError
DatasetAttributeError
DatasetIOShapeError
DriverCapabilityError
DriverRegistrationError
EnvError
FileOverwriteError
GDALBehaviorChangeException
GDALOptionNotImplementedError
GDALVersionError
InvalidArrayError
NodataShadowWarning
NotGeoreferencedWarning
OverviewCreationError
PathError
RPCError
RasterBlockError
RasterioDeprecationWarning
RasterioError
RasterioIOError
ResamplingAlgorithmError
ShapeSkipWarning
StatisticsError
TransformError
TransformWarning
UnsupportedOperation
WarpOperationError
WarpOptionsError
WarpedVRTError
WindowError
WindowEvaluationError
- rasterio.features module
- rasterio.fill module
- rasterio.io module
BufferedDatasetWriter
BufferedDatasetWriter.block_shapes
BufferedDatasetWriter.block_size()
BufferedDatasetWriter.block_window()
BufferedDatasetWriter.block_windows()
BufferedDatasetWriter.bounds
BufferedDatasetWriter.build_overviews()
BufferedDatasetWriter.checksum()
BufferedDatasetWriter.close()
BufferedDatasetWriter.closed
BufferedDatasetWriter.colorinterp
BufferedDatasetWriter.colormap()
BufferedDatasetWriter.compression
BufferedDatasetWriter.count
BufferedDatasetWriter.crs
BufferedDatasetWriter.dataset_mask()
BufferedDatasetWriter.descriptions
BufferedDatasetWriter.driver
BufferedDatasetWriter.dtypes
BufferedDatasetWriter.files
BufferedDatasetWriter.gcps
BufferedDatasetWriter.get_gcps()
BufferedDatasetWriter.get_nodatavals()
BufferedDatasetWriter.get_tag_item()
BufferedDatasetWriter.get_transform()
BufferedDatasetWriter.height
BufferedDatasetWriter.index()
BufferedDatasetWriter.indexes
BufferedDatasetWriter.interleaving
BufferedDatasetWriter.is_tiled
BufferedDatasetWriter.lnglat()
BufferedDatasetWriter.mask_flag_enums
BufferedDatasetWriter.meta
BufferedDatasetWriter.mode
BufferedDatasetWriter.name
BufferedDatasetWriter.nodata
BufferedDatasetWriter.nodatavals
BufferedDatasetWriter.offsets
BufferedDatasetWriter.options
BufferedDatasetWriter.overviews()
BufferedDatasetWriter.photometric
BufferedDatasetWriter.profile
BufferedDatasetWriter.read()
BufferedDatasetWriter.read_crs()
BufferedDatasetWriter.read_masks()
BufferedDatasetWriter.read_transform()
BufferedDatasetWriter.res
BufferedDatasetWriter.rpcs
BufferedDatasetWriter.sample()
BufferedDatasetWriter.scales
BufferedDatasetWriter.set_band_description()
BufferedDatasetWriter.set_band_unit()
BufferedDatasetWriter.shape
BufferedDatasetWriter.start()
BufferedDatasetWriter.statistics()
BufferedDatasetWriter.stop()
BufferedDatasetWriter.subdatasets
BufferedDatasetWriter.tag_namespaces()
BufferedDatasetWriter.tags()
BufferedDatasetWriter.transform
BufferedDatasetWriter.units
BufferedDatasetWriter.update_tags()
BufferedDatasetWriter.width
BufferedDatasetWriter.window()
BufferedDatasetWriter.window_bounds()
BufferedDatasetWriter.window_transform()
BufferedDatasetWriter.write()
BufferedDatasetWriter.write_band()
BufferedDatasetWriter.write_colormap()
BufferedDatasetWriter.write_mask()
BufferedDatasetWriter.write_transform()
BufferedDatasetWriter.xy()
DatasetReader
DatasetReader.block_shapes
DatasetReader.block_size()
DatasetReader.block_window()
DatasetReader.block_windows()
DatasetReader.bounds
DatasetReader.checksum()
DatasetReader.close()
DatasetReader.closed
DatasetReader.colorinterp
DatasetReader.colormap()
DatasetReader.compression
DatasetReader.count
DatasetReader.crs
DatasetReader.dataset_mask()
DatasetReader.descriptions
DatasetReader.driver
DatasetReader.dtypes
DatasetReader.files
DatasetReader.gcps
DatasetReader.get_gcps()
DatasetReader.get_nodatavals()
DatasetReader.get_tag_item()
DatasetReader.get_transform()
DatasetReader.height
DatasetReader.index()
DatasetReader.indexes
DatasetReader.interleaving
DatasetReader.is_tiled
DatasetReader.lnglat()
DatasetReader.mask_flag_enums
DatasetReader.meta
DatasetReader.mode
DatasetReader.name
DatasetReader.nodata
DatasetReader.nodatavals
DatasetReader.offsets
DatasetReader.options
DatasetReader.overviews()
DatasetReader.photometric
DatasetReader.profile
DatasetReader.read()
DatasetReader.read_crs()
DatasetReader.read_masks()
DatasetReader.read_transform()
DatasetReader.res
DatasetReader.rpcs
DatasetReader.sample()
DatasetReader.scales
DatasetReader.shape
DatasetReader.start()
DatasetReader.statistics()
DatasetReader.stop()
DatasetReader.subdatasets
DatasetReader.tag_namespaces()
DatasetReader.tags()
DatasetReader.transform
DatasetReader.units
DatasetReader.width
DatasetReader.window()
DatasetReader.window_bounds()
DatasetReader.window_transform()
DatasetReader.write_transform()
DatasetReader.xy()
DatasetWriter
DatasetWriter.block_shapes
DatasetWriter.block_size()
DatasetWriter.block_window()
DatasetWriter.block_windows()
DatasetWriter.bounds
DatasetWriter.build_overviews()
DatasetWriter.checksum()
DatasetWriter.close()
DatasetWriter.closed
DatasetWriter.colorinterp
DatasetWriter.colormap()
DatasetWriter.compression
DatasetWriter.count
DatasetWriter.crs
DatasetWriter.dataset_mask()
DatasetWriter.descriptions
DatasetWriter.driver
DatasetWriter.dtypes
DatasetWriter.files
DatasetWriter.gcps
DatasetWriter.get_gcps()
DatasetWriter.get_nodatavals()
DatasetWriter.get_tag_item()
DatasetWriter.get_transform()
DatasetWriter.height
DatasetWriter.index()
DatasetWriter.indexes
DatasetWriter.interleaving
DatasetWriter.is_tiled
DatasetWriter.lnglat()
DatasetWriter.mask_flag_enums
DatasetWriter.meta
DatasetWriter.mode
DatasetWriter.name
DatasetWriter.nodata
DatasetWriter.nodatavals
DatasetWriter.offsets
DatasetWriter.options
DatasetWriter.overviews()
DatasetWriter.photometric
DatasetWriter.profile
DatasetWriter.read()
DatasetWriter.read_crs()
DatasetWriter.read_masks()
DatasetWriter.read_transform()
DatasetWriter.res
DatasetWriter.rpcs
DatasetWriter.sample()
DatasetWriter.scales
DatasetWriter.set_band_description()
DatasetWriter.set_band_unit()
DatasetWriter.shape
DatasetWriter.start()
DatasetWriter.statistics()
DatasetWriter.stop()
DatasetWriter.subdatasets
DatasetWriter.tag_namespaces()
DatasetWriter.tags()
DatasetWriter.transform
DatasetWriter.units
DatasetWriter.update_tags()
DatasetWriter.width
DatasetWriter.window()
DatasetWriter.window_bounds()
DatasetWriter.window_transform()
DatasetWriter.write()
DatasetWriter.write_band()
DatasetWriter.write_colormap()
DatasetWriter.write_mask()
DatasetWriter.write_transform()
DatasetWriter.xy()
FilePath
MemoryFile
ZipMemoryFile
get_writer_for_driver()
get_writer_for_path()
- rasterio.mask module
- rasterio.merge module
- rasterio.path module
- rasterio.plot module
- rasterio.profiles module
- rasterio.rpc module
- rasterio.sample module
- rasterio.session module
- rasterio.shutil module
- rasterio.tools module
- rasterio.transform module
- rasterio.vrt module
WarpedVRT
WarpedVRT.src_dataset
WarpedVRT.resampling
WarpedVRT.tolerance
WarpedVRT.src_nodata
WarpedVRT.dst_nodata
WarpedVRT.working_dtype
WarpedVRT.warp_extras
WarpedVRT.block_shapes
WarpedVRT.block_size()
WarpedVRT.block_window()
WarpedVRT.block_windows()
WarpedVRT.bounds
WarpedVRT.checksum()
WarpedVRT.close()
WarpedVRT.closed
WarpedVRT.colorinterp
WarpedVRT.colormap()
WarpedVRT.compression
WarpedVRT.count
WarpedVRT.crs
WarpedVRT.dataset_mask()
WarpedVRT.descriptions
WarpedVRT.driver
WarpedVRT.dtypes
WarpedVRT.files
WarpedVRT.gcps
WarpedVRT.get_gcps()
WarpedVRT.get_nodatavals()
WarpedVRT.get_tag_item()
WarpedVRT.get_transform()
WarpedVRT.height
WarpedVRT.index()
WarpedVRT.indexes
WarpedVRT.interleaving
WarpedVRT.is_tiled
WarpedVRT.lnglat()
WarpedVRT.mask_flag_enums
WarpedVRT.meta
WarpedVRT.mode
WarpedVRT.name
WarpedVRT.nodata
WarpedVRT.nodatavals
WarpedVRT.offsets
WarpedVRT.options
WarpedVRT.overviews()
WarpedVRT.photometric
WarpedVRT.profile
WarpedVRT.read()
WarpedVRT.read_crs()
WarpedVRT.read_masks()
WarpedVRT.read_transform()
WarpedVRT.res
WarpedVRT.rpcs
WarpedVRT.sample()
WarpedVRT.scales
WarpedVRT.shape
WarpedVRT.start()
WarpedVRT.statistics()
WarpedVRT.stop()
WarpedVRT.subdatasets
WarpedVRT.tag_namespaces()
WarpedVRT.tags()
WarpedVRT.transform
WarpedVRT.units
WarpedVRT.width
WarpedVRT.window()
WarpedVRT.window_bounds()
WarpedVRT.window_transform()
WarpedVRT.write_transform()
WarpedVRT.xy()
- rasterio.warp module
- rasterio.windows module
Module contents
Rasterio
- class rasterio.Band(ds, bidx, dtype, shape)
Bases:
tuple
Band of a Dataset.
- Parameters:
- bidx
Alias for field number 1
- ds
Alias for field number 0
- dtype
Alias for field number 2
- shape
Alias for field number 3
- rasterio.band(ds, bidx)
A dataset and one or more of its bands
- rasterio.open(fp, mode='r', driver=None, width=None, height=None, count=None, crs=None, transform=None, dtype=None, nodata=None, sharing=False, opener=None, **kwargs)
Open a dataset for reading or writing.
The dataset may be located in a local file, in a resource located by a URL, or contained within a stream of bytes. This function accepts different types of fp parameters. However, it is almost always best to pass a string that has a dataset name as its value. These are passed directly to GDAL protocol and format handlers. A path to a zipfile is more efficiently used by GDAL than a Python ZipFile object, for example.
In read (‘r’) or read/write (‘r+’) mode, no keyword arguments are required: these attributes are supplied by the opened dataset.
In write (‘w’ or ‘w+’) mode, the driver, width, height, count, and dtype keywords are strictly required.
- Parameters:
fp (str, os.PathLike, file-like, or rasterio.io.MemoryFile) – A filename or URL, a file object opened in binary (‘rb’) mode, a Path object, or one of the rasterio classes that provides the dataset-opening interface (has an open method that returns a dataset). Use a string when possible: GDAL can more efficiently access a dataset if it opens it natively.
mode (str, optional) – ‘r’ (read, the default), ‘r+’ (read/write), ‘w’ (write), or ‘w+’ (write/read).
driver (str, optional) – A short format driver name (e.g. “GTiff” or “JPEG”) or a list of such names (see GDAL docs at https://gdal.org/drivers/raster/index.html). In ‘w’ or ‘w+’ modes a single name is required. In ‘r’ or ‘r+’ modes the driver can usually be omitted. Registered drivers will be tried sequentially until a match is found. When multiple drivers are available for a format such as JPEG2000, one of them can be selected by using this keyword argument.
width (int, optional) – The number of columns of the raster dataset. Required in ‘w’ or ‘w+’ modes, it is ignored in ‘r’ or ‘r+’ modes.
height (int, optional) – The number of rows of the raster dataset. Required in ‘w’ or ‘w+’ modes, it is ignored in ‘r’ or ‘r+’ modes.
count (int, optional) – The count of dataset bands. Required in ‘w’ or ‘w+’ modes, it is ignored in ‘r’ or ‘r+’ modes.
crs (str, dict, or CRS, optional) – The coordinate reference system. Required in ‘w’ or ‘w+’ modes, it is ignored in ‘r’ or ‘r+’ modes.
transform (affine.Affine, optional) – Affine transformation mapping the pixel space to geographic space. Required in ‘w’ or ‘w+’ modes, it is ignored in ‘r’ or ‘r+’ modes.
dtype (str or numpy.dtype, optional) – The data type for bands. For example: ‘uint8’ or rasterio.uint16. Required in ‘w’ or ‘w+’ modes, it is ignored in ‘r’ or ‘r+’ modes.
nodata (int, float, or nan, optional) – Defines the pixel value to be interpreted as not valid data. Required in ‘w’ or ‘w+’ modes, it is ignored in ‘r’ or ‘r+’ modes.
sharing (bool, optional) – To reduce overhead and prevent programs from running out of file descriptors, rasterio maintains a pool of shared low level dataset handles. If True this function will use a shared handle if one is available. Multithreaded programs must avoid sharing and should set sharing to False.
opener (callable, optional) – A custom dataset opener which can serve GDAL’s virtual filesystem machinery via Python file-like objects. The underlying file-like object is obtained by calling opener with (fp, mode) or (fp, mode + “b”) depending on the format driver’s native mode. opener must return a Python file-like object that provides read, seek, tell, and close methods.
kwargs (optional) – These are passed to format drivers as directives for creating or interpreting datasets. For example: in ‘w’ or ‘w+’ modes a tiled=True keyword argument will direct the GeoTIFF format driver to create a tiled, rather than striped, TIFF.
- Returns:
rasterio.io.DatasetReader
– If mode is “r”.rasterio.io.DatasetWriter
– If mode is “r+”, “w”, or “w+”.
- Raises:
TypeError – If arguments are of the wrong Python type.
rasterio.errors.RasterioIOError – If the dataset can not be opened. Such as when there is no dataset with the given name.
rasterio.errors.DriverCapabilityError – If the detected format driver does not support the requested opening mode.
Examples
To open a local GeoTIFF dataset for reading using standard driver discovery and no directives:
>>> import rasterio >>> with rasterio.open('example.tif') as dataset: ... print(dataset.profile)
To open a local JPEG2000 dataset using only the JP2OpenJPEG driver:
>>> with rasterio.open( ... 'example.jp2', driver='JP2OpenJPEG') as dataset: ... print(dataset.profile)
To create a new 8-band, 16-bit unsigned, tiled, and LZW-compressed GeoTIFF with a global extent and 0.5 degree resolution:
>>> from rasterio.transform import from_origin >>> with rasterio.open( ... 'example.tif', 'w', driver='GTiff', dtype='uint16', ... width=720, height=360, count=8, crs='EPSG:4326', ... transform=from_origin(-180.0, 90.0, 0.5, 0.5), ... nodata=0, tiled=True, compress='lzw') as dataset: ... dataset.write(...)
- rasterio.pad(array, transform, pad_width, mode=None, **kwargs)
pad array and adjust affine transform matrix.
- Parameters:
array (numpy.ndarray) – Numpy ndarray, for best results a 2D array
transform (Affine transform) – transform object mapping pixel space to coordinates
pad_width (int) – number of pixels to pad array on all four
mode (str or function) – define the method for determining padded values
- Returns:
(array, transform) – Tuple of new array and affine transform
- Return type:
Notes
See
numpy.pad()
for details on mode and other kwargs.