Simple Swath
This module is designed to extract a swath profile from a raster using a line shapefile.
Install
- To install it :
- pip install simple_swath
Dependencies
- numpy
- gdal
- shapely
- rasterstats
- alive_progress
- matplotlib
- matplotlib_scalebar
Usage
Inside a (i)python environnement:
- To import the module:
-
>>> from simple_swath import swath
- To
-
>>> swath(raster_file = 'Rastername', shapefile_file = 'shapename', outfile = 'prefixname', increment_value = 10, window_size = 100, bins = 40, meanmedian = 'mean', minmax = True, frequencyplot = True, TEMP = False, ylim = None, subplots = True)
Options/inputs
To use options or inputs, you need to set them as
swath(option_name = option_value, [...])
Options/inputs are (option_names):
- raster_path (str) : Path of the Raster to use. The raster needs to be projected; units should be meters
- shapefile_path (str) : Path of the shapefile to use to extract the profile. The shapefile should be in the same projection than the input raster
- outfile (str) : Prefix to add to the outputs' names.
- spl_incrt (float) : Increment along the profile (in m).
- spl_wndw (float) : Width of the box to build (in m).
- bins (integer, optional) : Number of categories to compute the histogram.
- minmax (bool, optional) : True to plot the min/max. Defaults to False.
- frequencyplot (bool, optional) : True to plot the frequency. Defaults to False.
- TEMP (bool, optional) : True to keep the temporary shapefiles, False to delete the folder TEMP/. Defaults to False.
- ylim (tuple, optional) : Tuple of y limits for the graph profile. Defaults to None
- subplots (bool, optional) : True to plot the raster and the swath on the same plot, False to plot the raste and the swath as two separate plots. Default = False
Help files
- To get help in your (i)python environnement:
-
>>> help(swath)
Outputs
The module outputs pdfs of graphs, csv files, and pickle binary files.
- pdfs are the plot of the raster with the line use for the swath, and the swath profile
- csv files are a record of the data use to plot the swath (max, min, mean, median, 1s)
- pickle binary files record the data used plot the frequency plot. There are two files. The file "rater_freqs.pickle" contains the frequency data, and the file "bin_edges.pickle" contains the bins extend of the frequency.
How to cite
Licence
Copyright (c) 2024 Xavier Robert <xavier.robert@ird.fr> and Benjamin Lehmann <lehmann.benj@gmail.com> SPDX-License-Identifier: GPL-3.0-or-later