Skip to main content

Reading and writing GeoTIFFs made easy. Proces satellite data directly from TAR files.

Project description


PyRSGIS is a powerful module to read, manipulate and export geo-rasters. The module is built on the GDAL library, and is very efficient for various geospatial analysis. Please do not use this package for commercial purpose without my explicit permission. Researchers/ academicians are welcomed for feedback and technical support.

Official Python repository

Cite : DOI

The module is capable of processing Landsat data from the downloaded TAR files itself.

Please find few example below:

Let's import the module by using the below code
import pyrsgis as rg

We will first start with reading raster and perform some basic operations. Make sure your current working directory is the same where the raster files are located, if not use the following command:
import os

Please skip the above two lines of code if the directory is already set to the files location.

To read bands of a stacked satellite image,
(1) For all bands:
dataSource, yourArray =, bands='all')
Which returns the data source containing projection information, and a NumPy array.

To read a list of bands from stacked images:
(2) For list of bands:
dataSource, yourArray =, bands=[2, 3, 4])
Which returns bands 2, 3 & 4 as three-dimensional NumPy array.

To read a specific band from stacked image:
(3) For a specific band:
dataSource, yourArray =, bands=2)
Which returns band number 2 as two-dimensional NumPy array.

To export the bands from the above read data,
(1) For all bands:
raster.export(yourArray, dataSource, "sample_extracted.tif", dtype='int', bands='all')
By default, dtype = 'int', to export float type array (eg. NDVI), use dtype = 'float'
Other options are: 'byte', 'cfloat32', 'cfloat64', 'cint16', 'cint32', 'float32', 'float64', 'int16', 'int32', 'uint8', 'uint16', 'uint32'

(2) For list of bands:
raster.export(yourArray, dataSource, "sample_extracted.tif", bands=[2, 3, 4])

(3) For a specific band:
raster.export(yourArray, dataSource, "sample_extracted.tif", bands=3)

To read the TAR file directly:
yourData = rg.readtar("yourFilename.tar.gz")

Similarly, stacked TIFF file can be read:
yourData = rg.readtif("yourFilename.tif")

After the above code, various properties of the raster can be assessed.
will give you the number of rows and columns.

The number of bands can be checked using:

The satellite sensor can also be determined.

If the above code shows the correct satellite sensor correctly, then this getting this should be easy:
This will show correctly the band number for available bands.

Any particular band can be extarcted using:
yourBand = yourData.getband(bandNumber)

The above code returns the band as array which can be visualised using:
or display(yourData.getband(bandNumber))
The map can directly be saved as an image.

Map title can also be assigned:
display(yourBand, maptitle='Your Map Title')

The extracted band can be exported using:
yourData.export(yourBand, "yourOutputFilename.tif")
This saves the extracted band to the same directory.
If exporting a float data type (raster with decimal values), please define the datatype explicitly, default is 'int':
yourData.export(yourBand, "yourOutputFilename.tif", datatype='float')

The NDVI (Normalised Difference Vegetaton Index) can be computed easily.
yourndvi = yourData.ndvi()
This returns the NDVI array,which can be exported using the same command used for the band above.

Any normalised difference indev can be computed using:
yourIndex = yourData.nordif(bandNumber2, bandNumber1)
Which performs (band2-band1)/(band2+band1) in the back end.

yourRaster.export(yourndvi, 'yourNDVI.tif', datatype='float')
Be careful that the NDVI is of float datatype, whereas the raw bands are integer datatype. Float data export uses more space on hard drive, so the default has been set to integer. Therefore, to export any float datatype, the argument should be passed explicitly.

Raster files can also be easily converted into CSV files which is mainly required for statistical analysis.
from pyrsgis.convert import rastertocsv

Assign the directory where raster files are located
yourDir = "D:\\yourRasterFolder"
rastertocsv(yourDir, filename='yourFilename.csv')

Generally the NoData or NULL values in the raster become random negative values, negatives can be removed using:
rastertocsv(yourDir, filename='yourFilename.csv', negative=False)

At times the NoData or NULL values in raster become '127' or '65536', they can also be removed by declaring explicitly
rastertocsv(yourDir, filename='yourFilename.csv', remove=[127, 65536])
This is a trial and check process, please check the generated CSV file for such issues

Bad rows in the CSV file represents the cell that has zero values in all the rasters and takes a lot of storage space, it can be eliminated using:
rastertocsv(yourDir, filename='yourFilename.csv', badrows=False)

pyrsgis also allows the user to quickly create the northing and easting coordinates using a reference raster
The flip option can be use to flip the resulting rasters.

from pyrsgis.raster import northing, easting

referenceRaster = 'E:/Example/landcover.tif'
northing(referenceFile, outFile='pyrsgis_northing.tif', flip=True)
easting(referenceFile, outFile='pyrsgis_easting.tif', flip=False)

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pyrsgis, version 0.3.1
Filename, size File type Python version Upload date Hashes
Filename, size pyrsgis-0.3.1-py3-none-any.whl (10.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pyrsgis-0.3.1.tar.gz (10.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page