def test_elev_or_mask(x, y, offset, expected):
if expected is None:
with utils.raises(ValueError):
validate.elev_or_mask(x, y, failNone=True)
else:
result = validate.elev_or_mask(x, y, offset=offset)
nptest.assert_array_equal(result, expected)
def write_cells(X,
Y,
mask,
crs,
outputfile,
river=None,
reach=0,
elev=None,
triangles=False):
""" Saves a GIS file of quadrilaterals representing grid cells.
Parameters
----------
X, Y : numpy (masked) arrays, same dimensions
Attributes of the gridgen object representing the x- and y-coords.
mask : numpy array or None
Array describing which cells to mask (exclude) from the output.
Shape should be N-1 by M-1, where N and M are the dimensions of
`X` and `Y`.
crs : string
A geopandas/proj/fiona-compatible string describing the coordinate
reference system of the x/y values.
outputfile : string
Path to the point GIS file to which the data will be written.
river : optional string (default = None)
The river to be listed in the GIS file's attribute table.
reach : optional int (default = 0)
The reach of the river to be listed in the GIS file's attribute
table.
elev : optional array or None (defauly)
The elevation of the grid cells. Shape should be N-1 by M-1,
where N and M are the dimensions of `X` and `Y` (like `mask`).
triangles : optional bool (default = False)
If True, triangles can be included
Returns
-------
geopandas.GeoDataFrame
"""
# check X, Y shapes
Y = validate.elev_or_mask(X, Y, 'Y', offset=0)
# check elev shape
elev = validate.elev_or_mask(X, elev, 'elev', offset=0)
# check the mask shape
mask = validate.elev_or_mask(X, mask, 'mask', offset=1)
X = numpy.ma.masked_invalid(X)
Y = numpy.ma.masked_invalid(Y)
ny, nx = X.shape
row = 0
geodata = []
for ii in range(nx - 1):
for jj in range(ny - 1):
if not (numpy.any(X.mask[jj:jj + 2, ii:ii + 2]) or mask[jj, ii]):
row += 1
Z = elev[jj, ii]
# build the array or coordinates
coords = misc.make_poly_coords(xarr=X[jj:jj + 2, ii:ii + 2],
yarr=Y[jj:jj + 2, ii:ii + 2],
zpnt=Z,
triangles=triangles)
# build the attributes
record = OrderedDict(id=row,
river=river,
reach=reach,
ii=ii + 2,
jj=jj + 2,
elev=Z,
ii_jj='{:02d}_{:02d}'.format(
ii + 2, jj + 2),
geometry=Polygon(shell=coords))
# append to file is coordinates are not masked
# (masked = beyond the river boundary)
if coords is not None:
geodata.append(record)
gdf = geopandas.GeoDataFrame(geodata, crs=crs, geometry='geometry')
gdf.to_file(outputfile)
return gdf
def write_points(X, Y, crs, outputfile, river=None, reach=0, elev=None):
""" Saves grid-related attributes of a pygridgen.Gridgen object to a
GIS file with geomtype = 'Point'.
Parameters
----------
X, Y : numpy (masked) arrays, same dimensions
Attributes of the gridgen object representing the x- and y-coords.
crs : string
A geopandas/proj/fiona-compatible string describing the coordinate
reference system of the x/y values.
outputfile : string
Path to the point-geometry GIS file to which the data will be written.
river : optional string (default = None)
The river to be listed in the GIS files's attribute table.
reach : optional int (default = 0)
The reach of the river to be listed in the GIS file's attribute
table.
elev : optional array or None (defauly)
The elevation of the grid cells. Array dimensions must be 1 less than
X and Y.
Returns
-------
geopandas.GeoDataFrame
"""
# check that X and Y are have the same shape, NaN cells
X, Y = validate.equivalent_masks(X, Y)
# check elev shape
elev = validate.elev_or_mask(X, elev, 'elev', offset=0)
# start writting or appending to the output
row = 0
geodata = []
for ii in range(X.shape[1]):
for jj in range(X.shape[0]):
# check that nothing is masked (outside of the river)
if not (X.mask[jj, ii]):
row += 1
# build the coords
coords = (X[jj, ii], Y[jj, ii])
# build the attributes
record = OrderedDict(id=int(row),
river=river,
reach=reach,
ii=int(ii + 2),
jj=int(jj + 2),
elev=float(elev[jj, ii]),
ii_jj='{:02d}_{:02d}'.format(
ii + 2, jj + 2),
geometry=Point(coords))
geodata.append(record)
gdf = geopandas.GeoDataFrame(geodata, crs=crs, geometry='geometry')
gdf.to_file(outputfile)
return gdf
def test_nooffset(self):
other = validate.elev_or_mask(self.X, self.Y, offset=0)
nptest.assert_array_equal(other, self.Y)
def test_offset(self):
other = validate.elev_or_mask(self.X, self.Yoffset,
offset=self.offset)
nptest.assert_array_equal(other, self.Yoffset)
def test_bad_shape(self):
validate.elev_or_mask(self.X, self.Yoffset)
def test_failNone(self):
validate.elev_or_mask(self.X, None, failNone=True)
def saveGridShapefile(X, Y, mask, template, outputfile, mode, river=None, reach=0, elev=None, triangles=False):
""" Saves a shapefile of quadrilaterals representing grid cells.
Parameters
----------
X, Y : numpy (masked) arrays, same dimensions
Attributes of the gridgen object representing the x- and y-coords.
mask : numpy array or None
Array describing which cells to mask (exclude) from the output.
Shape should be N-1 by M-1, where N and M are the dimensions of
`X` and `Y`.
template : string
Path to a template shapfiles with the desired schema.
outputfile : string
Path to the point shapefile to which the data will be written.
mode : string
The mode with which `outputfile` will be written.
(i.e., 'a' for append and 'w' for write)
river : optional string (default = None)
The river to be listed in the shapefile's attribute table.
reach : optional int (default = 0)
The reach of the river to be listed in the shapefile's attribute
table.
elev : optional array or None (defauly)
The elevation of the grid cells. Shape should be N-1 by M-1,
where N and M are the dimensions of `X` and `Y` (like `mask`).
triangles : optional bool (default = False)
If True, triangles can be included
Returns
-------
None
"""
# check that `mode` is valid
mode = validate.file_mode(mode)
# check X, Y shapes
Y = validate.elev_or_mask(X, Y, "Y", offset=0)
# check elev shape
elev = validate.elev_or_mask(X, elev, "elev", offset=0)
# check the mask shape
mask = validate.elev_or_mask(X, mask, "mask", offset=1)
X = np.ma.masked_invalid(X)
Y = np.ma.masked_invalid(Y)
ny, nx = X.shape
# load the template
with fiona.open(template, "r") as src:
src_driver = src.driver
src_crs = src.crs
src_schema = src.schema
src_schema["geometry"] = "Polygon"
# start writting or appending to the output
with fiona.open(outputfile, mode, driver=src_driver, crs=src_crs, schema=src_schema) as out:
row = 0
for ii in range(nx - 1):
for jj in range(ny - 1):
if not (np.any(X.mask[jj : jj + 2, ii : ii + 2]) or mask[jj, ii]):
row += 1
Z = elev[jj, ii]
# build the array or coordinates
coords = misc.make_poly_coords(
xarr=X[jj : jj + 2, ii : ii + 2], yarr=Y[jj : jj + 2, ii : ii + 2], zpnt=Z, triangles=triangles
)
# build the attributes
props = OrderedDict(
id=row,
river=river,
reach=reach,
ii=ii + 2,
jj=jj + 2,
elev=Z,
ii_jj="{:02d}_{:02d}".format(ii + 2, jj + 2),
)
# append to file is coordinates are not masked
# (masked = beyond the river boundary)
if coords is not None:
record = misc.make_record(row, coords, "Polygon", props)
out.write(record)
def savePointShapefile(X, Y, template, outputfile, mode="w", river=None, reach=0, elev=None):
""" Saves grid-related attributes of a pygridgen.Gridgen object to a
shapefile with geomtype = 'Point'.
Parameters
----------
X, Y : numpy (masked) arrays, same dimensions
Attributes of the gridgen object representing the x- and y-coords.
template : string
Path to a template shapfiles with the desired schema.
outputfile : string
Path to the point shapefile to which the data will be written.
mode : optional string (default = 'w')
The mode with which `outputfile` will be written.
(i.e., 'a' for append and 'w' for write)
river : optional string (default = None)
The river to be listed in the shapefile's attribute table.
reach : optional int (default = 0)
The reach of the river to be listed in the shapefile's attribute
table.
elev : optional array or None (defauly)
The elevation of the grid cells. Array dimensions must be 1 less than
X and Y.
Returns
-------
None
"""
# check that the `mode` is a valid value
mode = validate.file_mode(mode)
# check that X and Y are have the same shape, NaN cells
X, Y = validate.equivalent_masks(X, Y)
# check elev shape
elev = validate.elev_or_mask(X, elev, "elev", offset=0)
# load the template
with fiona.open(template, "r") as src:
src_driver = src.driver
src_crs = src.crs
src_schema = src.schema
src_schema["geometry"] = "Point"
# start writting or appending to the output
with fiona.open(outputfile, mode, driver=src_driver, crs=src_crs, schema=src_schema) as out:
row = 0
for ii in range(X.shape[1]):
for jj in range(X.shape[0]):
# check that nothing is masked (outside of the river)
if not (X.mask[jj, ii]):
row += 1
# build the coords
coords = (X[jj, ii], Y[jj, ii])
# build the attributes
props = OrderedDict(
id=int(row),
river=river,
reach=reach,
ii=int(ii + 2),
jj=int(jj + 2),
elev=float(elev[jj, ii]),
ii_jj="{:02d}_{:02d}".format(ii + 2, jj + 2),
)
# append to the output file
record = misc.make_record(row, coords, "Point", props)
out.write(record)
