Commit 7bc387a9 authored by Daniel Scheffler's avatar Daniel Scheffler
Browse files

updated some docstrings

parent ac91043a
......@@ -929,7 +929,8 @@ class GeoArray(object):
:param vmax:
:param cmap:
:param nodataVal:
:param res_factor:
:param res_factor: <float> resolution factor for downsampling of the image to be plotted in order to save
plotting time and memory (default=None -> downsampling is performed to 1000x1000)
:param interactive: <bool> activates interactive plotting based on 'holoviews' library.
NOTE: this deactivates the magic '% matplotlib inline' in Jupyter Notebook
:return:
......@@ -939,9 +940,9 @@ class GeoArray(object):
# get image to plot
nodataVal = nodataVal if nodataVal is not None else self.nodata
image2plot, gt, prj = self._get_plottable_image(xlim, ylim, band, boundsMap=boundsMap,
boundsMapPrj=boundsMapPrj, res_factor=res_factor,
nodataVal=nodataVal)
image2plot, gt, prj = \
self._get_plottable_image(xlim, ylim, band, boundsMap=boundsMap, boundsMapPrj=boundsMapPrj,
res_factor=res_factor, nodataVal=nodataVal)
# set color palette
palette = cmap if cmap else plt.cm.gray
......@@ -1006,7 +1007,8 @@ class GeoArray(object):
:param vmax:
:param cmap:
:param nodataVal:
:param res_factor:
:param res_factor: <float> resolution factor for downsampling of the image to be plotted in order to save
plotting time and memory (default=None -> downsampling is performed to 1000x1000)
:param return_map:
:param zoomable: <bool> enable or disable zooming via mpld3
:return:
......@@ -1225,12 +1227,12 @@ class GeoArray(object):
def get_subset(self, xslice=None, yslice=None, zslice=None, return_GeoArray=True):
# type: (slice, slice, slice, bool) -> GeoArray
"""Returns a new instatnce of GeoArray representing a subset of the initial one wit respect to given array position.
:param xslice: a slice providing the X-position for the subset in the form slice(xstart, xend, xstep)
:param yslice: a slice providing the Y-position for the subset in the form slice(ystart, yend, ystep)
:param zslice: a slice providing the Z-position for the subset in the form slice(zstart, zend, zstep)
:param return_GeoArray: whether to return an instance of GeoArray (default) or a tuple(np.ndarray, gt, prj)
:return:
:return:
"""
sub_arr = self[xslice if xslice else slice(None),
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment