Add FlowObject #61
Add FlowObject #61
Conversation
Add linting and type checks (TopoToolbox#59)
| def show(self, cmap: str = 'terrain'): | ||
| """ | ||
| Display the FlowObject instance as an image using Matplotlib. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| cmap : str, optional | ||
| Matplotlib colormap that will be used in the plot. | ||
| """ | ||
|
|
||
| fig, axs = plt.subplots(1, 3, figsize=(15, 5)) | ||
|
|
||
| axs[0].imshow(self.z, cmap=cmap) | ||
| axs[0].set_title('dem') | ||
|
|
||
| axs[1].imshow(self.target, cmap=cmap) | ||
| axs[1].set_title('target') | ||
|
|
||
| axs[2].imshow(self.source, cmap=cmap) | ||
| axs[2].set_title('source') | ||
|
|
||
| plt.tight_layout() | ||
| plt.show() |
There was a problem hiding this comment.
This is fine for now. TopoToolbox v3 doesn't really have a default plot method for FLOWobj. I think typically you create a STREAMobj, which is more interesting to visualize.
| # raster metadata | ||
| self.z = dem | ||
| self.target = target | ||
| self.source = source | ||
| self.shape = grid.shape | ||
|
|
||
| # georeference | ||
| self.bounds = grid.bounds | ||
| self.transform = grid.transform | ||
| self.crs = grid.crs |
There was a problem hiding this comment.
I think it is fine to copy the GridObject metadata into the FlowObject. Maybe there is some application where it would be better to have a reference to the original GridObject, but we can change this easily enough if we figure that out.
I am also pretty sure that self.z = dem just copies a reference to the array and doesn't copy the array data, which I think is what we want. This does make things a little weird if you modify fd.z, since that modification will be applied to dem.z, but users generally shouldn't be modifying the DEM through the FlowObject, not least because it invalidates the flow directions.
This pull request contains the following:
dims[2]instead of nrows, ncols when using libtopotoolbox functions. Closes Pass dimensions as an array #53gwdt_computecosts,gwdt,flow_routing_d8_carveandflow_routing_targets. Closes Add gwdt function #45Limitations:
At the moment,(Fixed with the new release)GIT_TAG mainis used in theCMakeLists.txtsinceflow_routing_targetswill only be added to libtopotoolbox next Monday.del var_namewhich could be beneficial when working with big DEMs.Regarding the new FlowObject #60 :
self.z = demwill result in the array being only stored once, and both variables (z in GridObject and FlowObject) will point to the same data.showfunction will print the DEM, target and source array. That's probably not how we want it to work, but for now it's sort of a proof that something is actually being computed.I have also added the new class to the documentation and added a basic example notebook which will be expanded later on. The private functions are not listed in the documentation, but still have doc strings.