Source code for in3Utils.geoTrans

""" Opperations and transformations of rasters and lines
"""

import logging
import math
import pathlib
import numpy as np
import scipy as sp
import scipy.interpolate
import copy
import matplotlib.pyplot as plt

# Local imports
import avaframe.in2Trans.ascUtils as IOf
import avaframe.in3Utils.fileHandlerUtils as fU


# create local logger
log = logging.getLogger(__name__)


[docs]def projectOnRaster(dem, Points, interp='bilinear', inData='rasterData', outData='z'): """Projects Points on raster using a bilinear or nearest interpolation and returns the z coord (no for loop) Parameters ------------- dem: dict dem dictionary Points: dict Points dictionary (x,y) interp: str interpolation option, between nearest or bilinear inData: str key in the dem dict of the 2D field to use for the interpolation. outData: str key in the Points dict toe updat with the interpolated data. Returns ------- Points: dict Points dictionary with z coordinate added or updated ioob: int number of out of bounds indexes """ header = dem['header'] rasterdata = dem[inData] xllc = header['xllcenter'] yllc = header['yllcenter'] cellsize = header['cellsize'] xcoor = Points['x'] ycoor = Points['y'] zcoor, ioob = projectOnGrid(xcoor, ycoor, rasterdata, csz=cellsize, xllc=xllc, yllc=yllc, interp=interp) Points[outData] = zcoor return Points, ioob
[docs]def projectOnGrid(x, y, Z, csz=1, xllc=0, yllc=0, interp='bilinear'): """Projects Z onto points (x,y) using a bilinear or nearest interpolation and returns the z coord Parameters ------------- x: array x coord of the points to project y: array y coord of the points to project Z : 2D numpy array raster data csz: float cellsize corresponding to the raster data xllc: float x coord of the lower left center of the raster yllc: float y coord of the lower left center of the raster interp: str interpolation option, between nearest or bilinear Returns ------- z : 2D numpy array projected data on the raster data ioob: int number of out of bounds indexes """ nrow, ncol = np.shape(Z) # initialize outputs z = np.ones((np.shape(x)))*np.NaN dx = np.ones((np.shape(x)))*np.NaN dy = np.ones((np.shape(x)))*np.NaN f11 = np.ones((np.shape(x)))*np.NaN f12 = np.ones((np.shape(x)))*np.NaN f21 = np.ones((np.shape(x)))*np.NaN f22 = np.ones((np.shape(x)))*np.NaN # find coordinates in normalized ref (origin (0,0) and cellsize 1) Lxx = (x - xllc) / csz Lyy = (y - yllc) / csz Lx = copy.deepcopy(Lxx) Ly = copy.deepcopy(Lyy) # find out of bound indexes if interp == 'nearest': Lx[np.where((Lxx <= -0.5))] = np.NaN Ly[np.where((Lxx <= -0.5))] = np.NaN Lx[np.where(Lxx >= (ncol-0.5))] = np.NaN Ly[np.where(Lxx >= (ncol-0.5))] = np.NaN Lx[np.where(Lyy <= -0.5)] = np.NaN Ly[np.where(Lyy <= -0.5)] = np.NaN Lx[np.where(Lyy >= (nrow-0.5))] = np.NaN Ly[np.where(Lyy >= (nrow-0.5))] = np.NaN elif interp == 'bilinear': Lx[np.where((Lxx < 0))] = np.NaN Ly[np.where((Lxx < 0))] = np.NaN Lx[np.where(Lxx >= (ncol-1))] = np.NaN Ly[np.where(Lxx >= (ncol-1))] = np.NaN Lx[np.where(Lyy < 0)] = np.NaN Ly[np.where(Lyy < 0)] = np.NaN Lx[np.where(Lyy >= (nrow-1))] = np.NaN Ly[np.where(Lyy >= (nrow-1))] = np.NaN # find index of index of not nan value mask = ~np.isnan(Lx+Ly) maskInd = np.argwhere(~np.isnan(Lx+Ly))[:, 0] itot = len(Lx) iinb = len(maskInd) ioob = itot - iinb # find coordinates of the 4 nearest cornes on the raster Lx0 = np.floor(Lx).astype('int') Ly0 = np.floor(Ly).astype('int') Lx1 = Lx0 + 1 Ly1 = Ly0 + 1 # prepare for bilinear interpolation(do not take out of bound into account) if interp == 'nearest': dx[mask] = np.round(Lx[mask]) dy[mask] = np.round(Ly[mask]) z[mask] = Z[dy[mask].astype('int'), dx[mask].astype('int')] elif interp == 'bilinear': dx[mask] = Lx[mask] - Lx0[mask] dy[mask] = Ly[mask] - Ly0[mask] f11[mask] = Z[Ly0[mask], Lx0[mask]] f12[mask] = Z[Ly1[mask], Lx0[mask]] f21[mask] = Z[Ly0[mask], Lx1[mask]] f22[mask] = Z[Ly1[mask], Lx1[mask]] # using bilinear interpolation on the cell z = f11*(1-dx)*(1-dy) + f21*dx*(1-dy) + f12*(1-dx)*dy + f22*dx*dy return z, ioob
[docs]def resizeData(raster, rasterRef): """ Reproject raster on a grid of shape rasterRef Parameters ---------- raster : dict raster dictionary rasterRef : dict reference raster dictionary Returns ------- data : 2D numpy array reprojected data dataRef : 2D numpy array reference data """ if IOf.isEqualASCheader(raster['header'], rasterRef['header']): return raster['rasterData'], rasterRef['rasterData'] else: headerRef = rasterRef['header'] ncols = headerRef['ncols'] nrows = headerRef['nrows'] csz = headerRef['cellsize'] xllc = headerRef['xllcenter'] yllc = headerRef['yllcenter'] xgrid = np.linspace(xllc, xllc+(ncols-1)*csz, ncols) ygrid = np.linspace(yllc, yllc+(nrows-1)*csz, nrows) X, Y = np.meshgrid(xgrid, ygrid) Points = {'x': X, 'y': Y} Points, _ = projectOnRaster(raster, Points, interp='bilinear') raster['rasterData'] = Points['z'] return raster['rasterData'], rasterRef['rasterData']
[docs]def remeshData(rasterDict, cellSizeNew, remeshOption='griddata', interpMethod='cubic', larger=True): """ compute raster data on a new mesh with cellSize using the specified remeshOption. remeshOption are to choose between 'griddata', 'interp2d' or 'RectBivariateSpline' Only the 'griddata' works properly if the input data contains noData points, 'interp2d' or 'RectBivariateSpline' are faster but fail if input data contains noData points. The new mesh is as big or smaller as the original mesh if larger is False and bigger if larger is True Parameters ---------- rasterDict : dict raster dictionary (with header and rasterData) cellSize : float mesh size of new mesh remeshOption: str method used to remesh ('griddata', 'interp2d' or 'RectBivariateSpline') Check the scipy documentation for more details default is 'griddata' interpMethod: str interpolation order to use for the interpolation ('linear', 'cubic' or 'quintic') larger: Boolean if true (default) output grid is at least as big as the input Returns ------- data : dict remeshed data dict with data as numpy array and header info """ header = rasterDict['header'] # fetch shape info and get new mesh info xGrid, yGrid, _, _ = makeCoordGridFromHeader(header) xGridNew, yGridNew, ncolsNew, nrowsNew = makeCoordGridFromHeader(header, cellSizeNew=cellSizeNew, larger=larger) z = rasterDict['rasterData'] log.info('Remeshed data extent difference x: %f and y %f' % (xGrid[-1, -1]-xGridNew[-1, -1], yGrid[-1, -1]-yGridNew[-1, -1])) if remeshOption == 'griddata': xGrid = xGrid.flatten() yGrid = yGrid.flatten() zCopy = np.copy(z).flatten() # make sure to remove the nans (no data points) from the input mask = np.where(~np.isnan(zCopy)) xGrid = xGrid[mask] yGrid = yGrid[mask] z = zCopy[mask] zNew = sp.interpolate.griddata((xGrid, yGrid), z, (xGridNew, yGridNew), method=interpMethod, fill_value=header['noDataValue']) elif remeshOption == 'interp2d': if np.isnan(z).any(): message = 'Data to remesh contains NaNs. Can not interpole with "interp2d".' log.error(message) raise ValueError(message) I2D = sp.interpolate.interp2d(xGrid[0, :], yGrid[:, 0], z, kind=interpMethod, fill_value=header['noDataValue']) zNew = I2D(xGridNew[0, :], yGridNew[:, 0]) elif remeshOption == 'RectBivariateSpline': if np.isnan(z).any(): message = 'Data to remesh contains NaNs. Can not interpole with "RectBivariateSpline".' log.error(message) raise ValueError(message) if interpMethod == 'linear': k = 1 elif interpMethod == 'cubic': k = 3 elif interpMethod == 'quintic': k = 5 else: message = 'There is no %s interpolation method available for RectBivariateSpline' % interpMethod log.error(message) raise NameError(message) zNew = sp.interpolate.RectBivariateSpline(yGrid[:, 0], xGrid[0, :], z, ky=k, kx=k)(yGridNew[:, 0], xGridNew[0, :], grid=True) # zNew = zNew.reshape(np.shape(xGrid)) # create header of remeshed DEM # set new header headerRemeshed = {} headerRemeshed['xllcenter'] = header['xllcenter'] headerRemeshed['yllcenter'] = header['yllcenter'] headerRemeshed['noDataValue'] = header['noDataValue'] headerRemeshed['cellsize'] = cellSizeNew headerRemeshed['ncols'] = ncolsNew headerRemeshed['nrows'] = nrowsNew # create remeshed raster dictionary remeshedRaster = {'rasterData': zNew, 'header': headerRemeshed} return remeshedRaster
[docs]def remeshDEM(demFile, cfgSim): """ change DEM cell size by reprojecting on a new grid - first check if remeshed DEM available the new DEM is as big or smaller as the original DEM and saved to Inputs/DEMremshed as remeshedDEMcellSize Interpolation is based on griddata with a cubic method. Here would be the place to change the order of the interpolation or to switch to another interpolation method. Parameters ---------- demFile: str or pathlib path path to DEM in Inputs/ cfgSim : configParser meshCellSizeThreshold : threshold under which no remeshing is done meshCellSize : desired cell size Returns ------- pathDem : str path of DEM with desired cell size relative to Inputs/ """ # first check if remeshed DEM is available pathDem, DEMFound, allDEMNames = searchRemeshedDEM(demFile.stem, cfgSim) if DEMFound: return pathDem # -------- if no remeshed DEM found - remesh # fetch info on dem file dem = IOf.readRaster(demFile) headerDEM = dem['header'] # read dem header info cszDEM = headerDEM['cellsize'] # fetch info on desired meshCellSize cszDEMNew = float(cfgSim['GENERAL']['meshCellSize']) # start remesh log.info('Remeshing the input DEM (of cell size %.2g m) to a cell size of %.2g m' % (cszDEM, cszDEMNew)) remeshedDEM = remeshData(dem, cszDEMNew, remeshOption='griddata', interpMethod='cubic', larger=False) # save remeshed DEM pathToDem = pathlib.Path(cfgSim['GENERAL']['avalancheDir'], 'Inputs', 'DEMremeshed') fU.makeADir(pathToDem) outFile = pathToDem / ('%s_remeshedDEM%.2f.asc' % (demFile.stem, remeshedDEM['header']['cellsize'])) if outFile.name in allDEMNames: message = 'Name for saving remeshedDEM already used: %s' % outFile.name log.error(message) raise FileExistsError(message) IOf.writeResultToAsc(remeshedDEM['header'], remeshedDEM['rasterData'], outFile, flip=True) log.info('Saved remeshed DEM to %s' % outFile) pathDem = str(pathlib.Path('DEMremeshed', outFile.name)) return pathDem
[docs]def searchRemeshedDEM(demName, cfgSim): """ search if remeshed DEM with correct name and cell size already available Parameters ----------- demName: str name of DEM file in Inputs/ cfgSim: configparser object configuration settings: avaDir, meshCellSize, meshCellSizeThreshold Returns -------- remshedDEM: dict dictionary of remeshed DEM if not found empty dict DEMFound: bool flag if dem is found allDEMNames: list list of all names of dems found in Inputs/DEMremeshed """ # path to remeshed DEM folder pathToDems = pathlib.Path(cfgSim['GENERAL']['avalancheDir'], 'Inputs', 'DEMremeshed') DEMFound = False pathDem = '' allDEMNames = [] # fetch info on desired meshCellSize meshCellSize = float(cfgSim['GENERAL']['meshCellSize']) meshCellSizeThreshold = float(cfgSim['GENERAL']['meshCellSizeThreshold']) # check if DEM is available if pathToDems.is_dir(): # look for dems and check if cellSize within tolerance and origin matches demFiles = list(pathToDems.glob('*.asc')) allDEMNames = [d.name for d in demFiles] for demF in demFiles: headerDEM = IOf.readASCheader(demF) if abs(meshCellSize - headerDEM['cellsize']) < meshCellSizeThreshold and demName in demF.stem: log.info('Remeshed DEM found: %s cellSize: %.5f' % (demF.name, headerDEM['cellsize'])) DEMFound = True pathDem = str(pathlib.Path('DEMremeshed', demF.name)) continue else: log.debug('Remeshed dem found %s with cellSize %.2f - not used' % (demF, headerDEM['cellsize'])) else: log.debug('Directory %s does not exist' % pathToDems) return pathDem, DEMFound, allDEMNames
[docs]def computeS(avaPath): """ compute s coordinate given a path (x, y) Parameters ----------- avaPath: dict path dictionary with x and y coordinates as 1D numpy arrays Returns -------- avaPath: dict path dictionary updated with s coordinate """ xcoord = avaPath['x'] ycoord = avaPath['y'] n = np.size((xcoord)) # compute s dxs = xcoord[1:n]-xcoord[0:n-1] dys = ycoord[1:n]-ycoord[0:n-1] # deduce the distance in s direction ds2 = (dxs*dxs + dys*dys) ds = np.sqrt(ds2) scoord = np.cumsum(ds) avaPath['s'] = np.insert(scoord, 0, 0) return avaPath
[docs]def prepareLine(dem, avapath, distance=10, Point=None): """Resample and project line on dem 1- Resample the avapath line with a max intervall of distance=10m between points (projected distance on the horizontal plane). 2- Make avalanche profile out of the path (affect a z value using the dem) 3- Get projection of points on the profil (closest point) Parameters ----------- dem: dict dem dictionary avapath: dict line dictionary distance: float resampling distance Point: dict a point dictionary (optional, can contain several point) Returns ------- avaProfile: dict the resampled avapath with the z coordinate projPoint: dict point dictionary projected on the profile (if several points were give in input, only the closest point to the profile is projected) """ xcoor = avapath['x'] ycoor = avapath['y'] xcoornew = np.array([xcoor[0]]) ycoornew = np.array([ycoor[0]]) s = np.array([0]) # curvilinear coordinate allong the path # loop on the points of the avapath for i in range(np.shape(xcoor)[0] - 1): Vx = xcoor[i + 1] - xcoor[i] Vy = ycoor[i + 1] - ycoor[i] D = np.sqrt(Vx**2 + Vy**2) nd = int(np.floor(D / distance) + 1) # Resample each segment S0 = s[-1] for j in range(1, nd + 1): xn = j / (nd) * Vx + xcoor[i] yn = j / (nd) * Vy + ycoor[i] xcoornew = np.append(xcoornew, xn) ycoornew = np.append(ycoornew, yn) s = np.append(s, S0 + D * j / nd) resampAvaPath = avapath resampAvaPath['x'] = xcoornew resampAvaPath['y'] = ycoornew resampAvaPath, _ = projectOnRaster(dem, resampAvaPath) resampAvaPath['s'] = s avaProfile = resampAvaPath # find split point by computing the distance to the line if Point: projPoint = findSplitPoint(avaProfile, Point) else: projPoint = None return avaProfile, projPoint
[docs]def findPointOnDEM(dem, vDirX, vDirY, vDirZ, zHighest, xFirst, yFirst, zFirst): """ find point on dem given a direction and a z value to reach Parameters ----------- dem: dict dem dict vDirX, vDirY, vDirZ: floats x, y and z components of the direction in which to extend zHighest: float z value to reach xFirst, yFirst, zFirst: floats x, y and z coordinates of the starting point Returns -------- xExtTop, yExtTop, zExtTop:floats x, y and z coordinates of the point found """ header = dem['header'] xllc = header['xllcenter'] yllc = header['yllcenter'] csz = header['cellsize'] zRaster = dem['rasterData'] gamma = (zHighest - zFirst) / vDirZ * np.linspace(0.25, 2, 100) xArray = xFirst + gamma * vDirX yArray = yFirst + gamma * vDirY zArray, _ = projectOnGrid(xArray, yArray, zRaster, csz=csz, xllc=xllc, yllc=yllc, interp='bilinear') idx = np.nanargmin(np.abs(zArray - np.array([zHighest]))) xExtTop = np.array([xFirst + gamma[idx] * vDirX]) yExtTop = np.array([yFirst + gamma[idx] * vDirY]) zExtTop = np.array([zArray[idx]]) return xExtTop, yExtTop, zExtTop
[docs]def findSplitPoint(avaProfile, Points): """ Finds the closest point in Points to the avaProfile and returns its projection on avaProfile. Parameters ----------- avaProfile: dict line dictionary with x and y coordinates Point: dict a point dictionary Returns ------- projPoint: dict point dictionary projected on the profile (if several points were give in input, only the closest point to the profile is projected) """ xcoor = avaProfile['x'] ycoor = avaProfile['y'] Dist = np.empty((0)) IndSplit = np.empty((0)) for i in range(len(Points['x'])): dist = np.sqrt((xcoor - Points['x'][i]) ** 2 + (ycoor - Points['y'][i])**2) indSplit = np.argmin(dist) IndSplit = np.append(IndSplit, indSplit) Dist = np.append(Dist, dist[indSplit]) ind = np.argmin(Dist) indSplit = int(IndSplit[ind]) projPoint = {} projPoint['x'] = avaProfile['x'][indSplit] projPoint['y'] = avaProfile['y'][indSplit] projPoint['z'] = avaProfile['z'][indSplit] projPoint['s'] = avaProfile['s'][indSplit] projPoint['indSplit'] = indSplit return projPoint
[docs]def checkProfile(avaProfile, projSplitPoint=None): """ check that the avalanche profiles goes from top to bottom flip it if not and adjust the splitpoint in consequence Parameters ----------- avaProfile: dict line dictionary with x and y coordinates projSplitPoint: dict a point dictionary already projected on the avaProfile Returns ------- avaProfile: dict avaProfile, fliped if needed projSplitPoint: dict point dictionary """ if projSplitPoint: indSplit = projSplitPoint['indSplit'] if avaProfile['z'][-1] > avaProfile['z'][0]: log.info('Profile reversed') avaProfile['x'] = np.flip(avaProfile['x']) avaProfile['y'] = np.flip(avaProfile['y']) avaProfile['z'] = np.flip(avaProfile['z']) try: L = avaProfile['s'][-1] avaProfile['s'] = L - np.flip(avaProfile['s']) except KeyError: pass if projSplitPoint: indSplit = len(avaProfile['x']) - indSplit - 1 projSplitPoint['indSplit'] = indSplit avaProfile['indSplit'] = indSplit else: projSplitPoint = None avaProfile['indSplit'] = None return projSplitPoint, avaProfile
[docs]def findAngleProfile(tmp, ds, dsMin): """ Find the beta point: first point under the beta value given in prepareAngleProfile. Make sure that at least dsMin meters behind the point are also under the beta value otherwise keep searching Parameters ---------- tmp: 1D numpy array index array of point in profile with slope bellow the given beta angle and bellow the splitPoint ds: 1D numpy array distance between points discribed in tmp dsMin: float threshold distance [m] for looking for the beta point (at least dsMin meters below beta degres) Returns ------- idsAnglePoint: int index of beta point """ noPointFoundMessage = 'No point found. Check the angle and threshold distance.' i = 0 condition = True if np.size(tmp) == 0: raise IndexError(noPointFoundMessage) while (i <= np.size(tmp) and condition): ind = tmp[i] j = 0 dist = 0 while dist < dsMin: try: condition = condition and (tmp[i+j+1] == ind+j+1) dist = dist + ds[i + j] except IndexError: raise IndexError(noPointFoundMessage) if not condition: i = i + j + 1 break j = j + 1 if condition: idsAnglePoint = ind break condition = True return idsAnglePoint
[docs]def prepareAngleProfile(beta, avaProfile, raiseWarning=True): """Prepare inputs for findAngleProfile function Read profile (s, z), compute the slope Angle look for points for which the slope is under the given Beta value and that are located downstream of the splitPoint Parameters ---------- beta: float beta angle in degrees avaProfile: dict profile dictionary, s, z and a split point(optional) raiseWarning: bool True to raise eventual warnings Returns ------- angle: 1D numpy array profile angle tmp: 1D numpy array index array of point in profile with slope bellow the given beta angle and bellow the splitPoint ds: 1D numpy array distance between points discribed in tmp """ s = avaProfile['s'] z = avaProfile['z'] try: indSplit = avaProfile['indSplit'] sSplit = s[indSplit] except KeyError: if raiseWarning: log.warning('No split Point given!') sSplit = 0 ds = np.abs(s - np.roll(s, 1)) dz = np.roll(z, 1) - z ds[0] = ds[1] dz[0] = dz[1] angle = np.rad2deg(np.arctan2(dz, ds)) # get all values where Angle < beta but >0 # get index of first occurance and go one back to get previous value # (i.e. last value above beta) # tmp = x[(angle < beta) & (angle > 0.0) & (x > 450)] tmp = np.where((angle <= beta) & (s > sSplit)) tmp = np.asarray(tmp).flatten() ds = ds[tmp] return angle, tmp, ds
[docs]def isCounterClockWise(path): """ Determines if a polygon path is mostly clockwise or counter clockwise https://stackoverflow.com/a/45986805/15887086 Parameters ---------- path: matplotlib.path polygon path Returns ------- isCounterCloc1: int 1 if the path is counter clockwise, 0 otherwise """ v = path.vertices-path.vertices[0, :] a = np.arctan2(v[1:, 1], v[1:, 0]) isCounterClock = (a[1:] >= a[:-1]).astype(int).mean() >= 0.5 return isCounterClock
[docs]def getCellsAlongLine(header, lineDict, addBuffer=True): """ Find all raster cells crossed by the line line has to be entierly contained on the raster extend. If addBuffer is True, add neighbour cells to the result based on https://stackoverflow.com/a/35808540/15887086 Parameters ---------- header: dict raster header lineDict: dict line dictionary addBuffer: boolean True to add a 1 cell buffer around the line Returns ------- lineDict: dict line dictionary updated with the "cellsCrossed" 1D array (boolean array of 0 and 1 if the cell is crossed by the line or in its neigborhood) """ ncols = header['ncols'] nrows = header['nrows'] xllc = header['xllcenter'] yllc = header['yllcenter'] csz = header['cellsize'] # normalize line coordinates xArray = (lineDict['x'] - xllc)/csz yArray = (lineDict['y'] - yllc)/csz # loop on line points cellsCrossed = np.zeros((ncols * nrows)) for i in range(np.size(xArray)-1): xA = xArray[i] xB = xArray[i+1] yA = yArray[i] yB = yArray[i+1] dx = xB - xA dy = yB - yA sx = np.sign(dx) sy = np.sign(dy) # add starting point cell to cell list indX = round(xA) indY = round(yA) indCell = indX + ncols * indY cellsCrossed[indCell] = 1 if addBuffer: cellsCrossed, _, _ = getNeighborCells(indX, indY, ncols, nrows, cellsCrossed) # find next intersection with vertical and horizontal axis tIx = dy * (indX + sx/2 - xA) if dx != 0 else float("+inf") tIy = dx * (indY + sy/2 - yA) if dy != 0 else float("+inf") indXB = round(xB) indYB = round(yB) while (indX, indY) != (indXB, indYB): # NB if tIx == tIy we increment both x and y (movx, movy) = (abs(tIx) <= abs(tIy), abs(tIy) <= abs(tIx)) if movx: # intersection is at (indX + sx, yA + tIx / dx^2) indX += sx tIx = dy * (indX + sx/2 - xA) if movy: # intersection is at (xA + tIy / dy^2, indY + sy) indY += sy tIy = dx * (indY + sy/2 - yA) indX = round(indX) indY = round(indY) indCell = indX + ncols * indY cellsCrossed[indCell] = 1 if addBuffer: cellsCrossed, _, _ = getNeighborCells(indX, indY, ncols, nrows, cellsCrossed) lineDict['cellsCrossed'] = cellsCrossed.astype(int) return lineDict
[docs]def getNeighborCells(indX, indY, ncols, nrows, cellsArray): """ Find the neighbour cells to a given cell Parameters ---------- indX: int x index of the cell for which you want to find the direct neighbors indY: int y index of the cell for which you want to find the direct neighbors ncols: int number of cols in the raster nrows: int number of rows in the raster cellsArray: 1D int array boolean array of 0 and 1 if the cell is crossed by the line or in its neigborhood Returns ------- cellsArray: 1D int array updated boolean array of 0 and 1 if the cell is crossed by the line or in its neigborhood """ indXList = [] indYList = [] for i in [-1, 0, 1]: if (indX + i < ncols) & (indX + i >= 0): for j in [-1, 0, 1]: if (indY + j < nrows) & (indY + j >= 0): indCell = (indX + i) + ncols * (indY + j) cellsArray[indCell] = 1 indXList.append(indX + i) indYList.append(indY + j) return cellsArray, indXList, indYList
[docs]def path2domain(xyPath, rasterTransfo): """Creates a domain (irregular raster) along a path, given the path xyPath, a domain width and a raster cellsize Parameters: ------------- xyPath: dict line dictionary with coordinates x and y rasterTransfo: dict rasterTransfo['w']: float Domain width rasterTransfo['cellSizeSL']: float cellsize expected for the new raster Returns: --------- rasterTransfo: dict rasterTransfo updated with xp, yp Arrays determining a path of width w along a line rasterTransfo['DBXl']: x coord of the left boundary rasterTransfo['DBXr']: x coord of the right boundary rasterTransfo['DBYl']: y coord of the left boundary rasterTransfo['DBYr']: y coord of the right boundary [Fischer2013] Fischer, Jan-Thomas. (2013). A novel approach to evaluate and compare computational snow avalanche simulation. Natural Hazards and Earth System Sciences. 13. 1655-. 10.5194/nhess-13-1655-2013. Uwe Schlifkowitz/ BFW, June 2011 """ csz = rasterTransfo['cellSizeSL'] x = xyPath['x'] y = xyPath['y'] # compute the non dimensional width w = rasterTransfo['domainWidth']/2/csz # remove scaling due to cellsize x = x/csz y = y/csz # Difference between x- bzw. y-Coordinates of Polyline # first and last Vertex: Difference between this and the next # other vertices: Difference between previous and next dx = np.array((x[1]-x[0])) dy = np.array((y[1]-y[0])) n = len(x) for i in range(2, n): dx = np.append(dx, (x[i]-x[i-2])/2.) dy = np.append(dy, (y[i]-y[i-2])/2.) dx = np.append(dx, x[-1]-x[-2]) dy = np.append(dy, y[-1]-y[-2]) # Direction of normal vector of difference, # a.k.a. bisecting line of angle d = np.arctan2(dy, dx) + math.pi/2 # x- and y-Coordinates (left and right) of path edges, # total width w # x-KOO[left right] DBXl = np.array((x + w * np.cos(d))) DBXr = np.array((x + w * np.cos(d + math.pi))) # y-KOO[left right] DBYl = np.array((y + w * np.sin(d))) DBYr = np.array((y + w * np.sin(d + math.pi))) rasterTransfo['DBXl'] = DBXl rasterTransfo['DBXr'] = DBXr rasterTransfo['DBYl'] = DBYl rasterTransfo['DBYr'] = DBYr return rasterTransfo
[docs]def areaPoly(X, Y): """Gauss's area formula to calculate polygon area Parameters ---------- X: 1D numpy array x coord of the vertices Y: 1D numpy array y coord of the vertices (Without repeating the first vertex!!!) Returns ------- area: float Area of the polygon """ X = np.append(X, X[0]) Y = np.append(Y, Y[0]) area = 0 for i in range(np.size(X)-1): area = area + (X[i]*Y[i+1]-Y[i]*X[i+1])/2 return area
[docs]def checkOverlap(toCheckRaster, refRaster, nameToCheck, nameRef, crop=False): """Check if two rasters overlap Parameters ---------- toCheckRaster : 2D numpy array Raster to check refRaster : 2D numpy array reference Raster nameToCheck: str name of raster that might overlap nameRef: str name of reference raster crop : boolean if True, remove overlaping part and send a warning Returns ------- toCheckRaster: 2D numpy array if crop is True, return toCheckRaster without the overlaping part and send a warning if needed if crop is False, return error if Rasters overlap otherwise return toCheckRaster """ mask = (toCheckRaster > 0) & (refRaster > 0) if mask.any(): if crop: toCheckRaster[mask] = 0 message = '%s area feature overlapping with %s area - removing the overlapping part' % (nameToCheck, nameRef) log.warning(message) else: message = '%s area features overlapping with %s area - this is not allowed' % (nameToCheck, nameRef) log.error(message) raise AssertionError(message) return toCheckRaster
[docs]def cartToSpherical(X, Y, Z): """ convert from cartesian to spherical coordinates Parameters ----------- X: float x coordinate Y: float y coordinate Z: float z coordinate Returns --------- r: float radius phi: float azimuth angle [degrees] theta: float for elevation angle defined from Z-axis down [degrees] """ xy = X**2 + Y**2 r = np.sqrt(xy + Z**2) # for elevation angle defined from Z-axis down theta = np.arctan2(np.sqrt(xy), Z) theta = np.degrees(theta) # azimuth: 0 degree is south phi = np.arctan2(X, Y) phi = np.degrees(phi) return r, phi, theta
[docs]def rotateRaster(rasterDict, theta, deg=True): """ rotate clockwise a raster arround (0, 0) with theta angle Parameters ----------- rasterDict: dict raster dictionary theta: float rotation angle of the vector from start point to end point - degree default deg: bool if true theta is converted to rad from degree Returns -------- rotatedRaster: dict rotated raster dictionary """ # convert to rad if provided as degree if deg: theta = np.radians(theta) # create raster grid with origin 0,0 header = rasterDict['header'] xllc = header['xllcenter'] yllc = header['yllcenter'] ncols = header['ncols'] nrows = header['nrows'] csz = header['cellsize'] X, Y = makeCoordinateGrid(xllc, yllc, csz, ncols, nrows) # rotate Grid xTheta = np.cos(theta) * X + np.sin(theta) * Y yTheta = -np.sin(theta) * X + np.cos(theta) * Y # project data on this new grid rotatedZ, _ = projectOnGrid(xTheta, yTheta, rasterDict['rasterData'], csz=csz, xllc=xllc, yllc=yllc, interp='bilinear') rotatedRaster = {'header': header, 'rasterData': rotatedZ} return rotatedRaster
[docs]def rotate(locationPoints, theta, deg=True): """ rotate a vector provided as start and end point with theta angle rotation counter-clockwise Parameters ----------- locationPoints: list list of lists with x,y coordinate of start and end point of a line theta: float rotation angle of the vector from start point to end point - degree default deg: bool if true theta is converted to rad from degree Returns -------- rotatedLine: list list of lists of x,y coordinates of start and end point of rotated vector """ # convert to rad if provided as degree if deg: theta = np.radians(theta) # create vector with origin 0,0 vector = np.diff(locationPoints) # create rotation matrix # counterclockwise rotation rotationMatrix = np.array([ [np.cos(theta), -np.sin(theta)], [np.sin(theta), np.cos(theta)], ]) # rotate vector vectorRot = np.dot(rotationMatrix, vector) # create rotated line as list of start and end point rotatedLine = [[locationPoints[0][0], float(locationPoints[0][0]+vectorRot[0])], # x [locationPoints[1][0], float(locationPoints[1][0]+vectorRot[1])] # y ] return rotatedLine
[docs]def makeCoordGridFromHeader(rasterHeader, cellSizeNew=None, larger=False): """ Get x and y (2D) grid description vectors for a mesh with a given number of rows and columns, lower left center and cellSize. If 'cellSizeNew' is not None use cellSizeNew instead of rasterHeader['cellsize'] Make sure the new grid is at least as big as the old one if larger=True (can happen if 'cellSizeNew' is not None) Parameters ----------- rasterHeader: dict ratser header with info on ncols, nrows, csz, xllcenter, yllcenter, noDataValue cellSizeNew: float If not None, use cellSizeNew as cell size larger: boolean If True, make sure the extend of the (xGrid, yGrid) is larger or equal than the header one Returns -------- xGrid, yGrid: 2D numpy arrays 2D vector of x and y values for mesh center coordinates (produced using meshgrid) ncols, nrows: int number of columns and rows """ ncols = rasterHeader['ncols'] nrows = rasterHeader['nrows'] xllc = rasterHeader['xllcenter'] yllc = rasterHeader['yllcenter'] csz = rasterHeader['cellsize'] # if a new cell size is provided, compute the new ncols and nrows if cellSizeNew is not None: xExtent = (ncols-1) * csz yExtent = (nrows-1) * csz ncolsNew = int(xExtent/cellSizeNew + 1) nrowsNew = int(yExtent/cellSizeNew + 1) # get rid of the case cellSizeNew = csz (which would lead to a too large grid) if larger and ((ncolsNew-1) * cellSizeNew < xExtent): ncols = ncolsNew + 1 nrows = nrowsNew + 1 else: ncols = ncolsNew nrows = nrowsNew csz = cellSizeNew # create the grid xGrid, yGrid = makeCoordinateGrid(xllc, yllc, csz, ncols, nrows) return xGrid, yGrid, ncols, nrows
[docs]def makeCoordinateGrid(xllc, yllc, csz, ncols, nrows): """Create grid Parameters ----------- xllc, yllc: float x and y coordinate of the lower left center csz: float cell size ncols, nrows: int number of columns and rows Returns -------- xGrid, yGrid: 2D numpy arrays 2D vector of x and y values for mesh center coordinates (produced using meshgrid) """ xEnd = (ncols-1) * csz yEnd = (nrows-1) * csz xp = np.linspace(0, xEnd, ncols) + xllc yp = np.linspace(0, yEnd, nrows) + yllc xGrid, yGrid = np.meshgrid(xp, yp) return xGrid, yGrid