rasterio/docs/index.rst
Sean Gillies 8bff8a70b4
Merge _crs with crs (#2335)
* Merge _crs into crs

CRS is an extension class now, with improved documentation. The
test__crs.py file is obsolete and has been deleted.

I piggy-backed some API doc changes onto this. We now generate
API docs from scratch every time and have removed the .rst files
from the repo. The crs module now uses the embedsignature Cython
directive, which we should do for other extension modules.

* Include private modules

* Restore API docs

We'll remove them in a different branch.

* Update docs/index.rst

* Handle OverflowError from <int>code

Also repair chunks missed in rebase
2022-03-31 19:19:21 -06:00

64 lines
1.6 KiB
ReStructuredText

==========================================
Rasterio: access to geospatial raster data
==========================================
Geographic information systems use GeoTIFF and other formats to organize and
store gridded raster datasets such as satellite imagery and terrain models.
Rasterio reads and writes these formats and provides a Python API based on
Numpy N-dimensional arrays and GeoJSON.
Here's an example program that extracts the GeoJSON shapes of a raster's valid
data footprint.
.. code:: python
import rasterio
import rasterio.features
import rasterio.warp
with rasterio.open('example.tif') as dataset:
# Read the dataset's valid data mask as a ndarray.
mask = dataset.dataset_mask()
# Extract feature shapes and values from the array.
for geom, val in rasterio.features.shapes(
mask, transform=dataset.transform):
# Transform shapes from the dataset's own coordinate
# reference system to CRS84 (EPSG:4326).
geom = rasterio.warp.transform_geom(
dataset.crs, 'EPSG:4326', geom, precision=6)
# Print GeoJSON shapes to stdout.
print(geom)
The output of the program:
.. code:: python
{'type': 'Polygon', 'coordinates': [[(-77.730817, 25.282335), ...]]}
Rasterio supports Python versions 3.6 or higher.
.. toctree::
:maxdepth: 2
intro
installation
quickstart
cli
topics/index
Rasterio API Reference <api/index>
contributing
faq
Indices and Tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. _GDAL: http://gdal.org/