Object descriptions

These tutorials describe the main objects of the library.

• Check wolfhece version package
  • Current version
  • Version available on Pypi
  • Test if the current version is sufficient
  • Change the logging level (default is INFO)
• Model / GUI architecture in wolfhece
  • Why this separation?
  • Class hierarchy overview
  • 1. WolfArrayModel vs WolfArray
  • 2. vectorModel / zoneModel / ZonesModel
  • 3. cloud_vertices — graceful fallback
  • 4. TriangulationModel
  • 5. Element_To_Draw — the integration mixin
  • 6. When to use what?
  • 7. Import summary
• Element_To_Draw & WolfMapViewer — Drawing architecture
  • Inheritance tree
  • Element_To_Draw — base interface
  • Key methods to override in subclasses
  • WolfMapViewer — the GUI viewer
  • Model / GUI pattern
• Factory methods — quick object creation
  • 1. header_wolf factories
  • 2. WolfArray / WolfArrayModel factories
  • 3. vector / vectorModel factories
  • 4. zone / zoneModel factories
  • 5. Zones / ZonesModel factories
  • Summary
• Spatial header for WOLF arrays
  • Creating a header from scratch
  • Factory methods — make, make_from_xybounds_grid, from_slices
  • Spatial extent and bounds
  • Coordinate ↔ Index conversions
  • Comparing and combining headers
  • Reading and writing header files
  • Extracting a header from a WolfArray
  • Summary
• WolfArray, what is it?
  • Basics
  • Numpy Considerations
  • Viewer Compatibility
  • Plotting
  • Python/Fortran
  • Data types
  • How to create a WolfArray?
  • Type order - C or F ?
  • NoData/NullValue, bounds, plot…
  • Saving and Loading
  • Accessing Values by Coordinates
• WolfArray - Data type
  • Using “whichtype” during WolfArray creation
  • Get equivalent Numpy type
  • Modifying Values in a WolfArray
  • Type conversion
  • Representation Space
  • Memory consumption
• WolfArray — File I/O
  • Creating a Sample Array
  • Saving as Wolf Binary (.bin)
  • Saving as GeoTIFF (.tif)
  • Saving as NumPy (.npy)
  • Importing GeoTIFF with import_geotif
  • Exporting with export_geotif
  • Clean Up
• Basic math operations on WolfArray
  • Examples of math operations
  • Working with Masked Arrays
  • Is a masked value equivalent to NoData/NullValue ?
  • Statistics
• Resizing a WolfArray
  • Loading a digital elevation model
  • Changing the resolution to 10 m × 10 m
  • Increasing the resolution (zoom in)
  • Anticipating the result without performing the rebin
  • When rebin is not possible
• Multiblock Arrays
  • Creating a Multiblock Array from scratch
  • By Reference or By Value?
  • Accessing the Blocks
  • Convert to WolfArray “single” block
  • And More…
  • Iterating Over Blocks
  • Overlapping Blocks
• WolfArray — Spatial Analysis
  • Setup: Synthetic DEM
  • Raster Algebra
  • Masking Chains
  • Rebinning with Different Operators
  • Gradient / Slope
  • Spatial Statistics by Region
  • Cropping and Edge Trimming
• 2D cell indices
  • Creation of a 2D grid
  • Viewing the Grid as Coordinates/Georeferenced item
  • Cell/Mesh Numbering
  • Edge Numbering
  • Shape
  • Fortran/Python Numbering
  • Exploring a More Complex Grid Configuration
• Memory Organization of NumPy Arrays
  • Fortran or C Numpy array - Why is it important?
  • Multiple conventions
  • Contiguous memory
  • Axis, what is it?
  • Is One Axis Faster?
  • Observation
• Memory/Matrice view
  • Matrice View - Fortran Numbering (1-Based)
  • Matrice view - Python numbering (0-based)
  • Coordinates equivalence
  • WolfArray is F_CONTIGUOUS
  • Shape (nbx, nby) or (nby, nbx)?
  • Memory organization of a NumPy array in C_CONTIGUOUS order
  • Difference Between C_CONTIGUOUS and F_CONTIGUOUS
  • Test on a small example
• Raster–Vector Operations
  • Setup: a DEM-like Raster and a Polygon
  • Masking Outside a Polygon
  • Masking Inside a Polygon
  • Extracting Values Inside a Polygon
  • Extracting Values along a Polyline
  • Interpolating on a Polygon
  • Cropping to a Bounding Box
  • Zonal Statistics
• Zones, zone, vector, vertex, What is it ?
  • Basics
  • Formats
  • Interaction with Shapely
  • Create a wolfvertex
  • Create a vector
  • Plot a vector
  • Create a zone
  • Plot a zone
  • Create a Zones
  • Plot a Zones
  • Save a Zones to file
  • Closed Vectors (Polygons vs. Polylines)
  • Shapely Interoperability
  • Save / Load Round-Trip
• Cloud vertices, What is it ?
  • Basics
  • Storage
  • Properties
  • KD-tree
  • Create a new cloud_vertices instance
  • Storage modes and automatic switch
  • Plot by matplotlib
  • Get coordinates of the vertices
  • Add a value
  • Get coordinates but value as z
  • Find the nearest vertex
  • Find the nearest vertices
  • Find the nearest vertex for multiple points
  • Performance guidelines (quick recap)
• Managing collections of point clouds
  • What is a cloud_of_clouds?
  • Prerequisites
  • Creating a cloud_of_clouds
  • Accessing clouds
  • Removing a cloud
  • Global bounds
  • Adding values to clouds
  • Getting all coordinates
  • Iterating over all vertices
  • Nearest neighbor query
  • Merging all clouds into one
  • Display properties
  • Saving and loading (JSON)
  • Duplicating a collection
  • Summary
• Triangulation
  • Basics example
  • Plot with Pyvista
  • Interpolate on array
  • Creation from vectors/zone
  • Constrained Delaunay Triangulation
  • Saving and Loading
  • create_multibin Parameters
• Profile, what is it?
  • Basics
  • Import
  • How to create a profile?
  • Exemple 1 : a large section
  • Exemple 2 : a small section
  • Example 3 : a rectangular one
  • How to access the geometry ?
  • Area, Wetted Perimeter, Top-Width, Uniform Manning-Strickler relations, critical depth and discharges
  • Plotting the relations
  • Add “banks” position
  • Add more positions - “bed”, “left_down”, “right_down”
  • Uniform Manning-Strickler Discharge / Water Depth
  • A more complex cross-section
  • Compare the section with the tables and LAZ data.
• Crosssections, What is it ?
  • Basics
  • Import
  • How to initialize?
  • Stored information
  • Dependencies
  • Sorting along a vector
  • Example
  • How to plot ?
  • Sort along
  • Upstream/Downstream profile
  • Iterate from profile to up/down
  • Select profile
  • And more…
• Cross-Sections
  • Creating a Profile from Scratch
  • Plotting a Profile
  • Reference Points
  • Working with Multiple Cross-Sections
  • Hydraulic Calculations
  • Loading Cross-Sections from Files
• Colors & Palettes
  • RGB class — color manipulation
  • wolfpaletteModel — creating a palette
  • Visualizing a palette with matplotlib
  • Reading / saving .pal files
  • Built-in default palettes
  • Summary
• Coordinates_operations — CRS transformations
  • Transforming point coordinates
  • Raster reprojection
  • Summary
• Hydraulic utilities
  • Part 1 — compare_series: model evaluation metrics
  • Part 2 — friction_law: hydraulic friction coefficients
• Wolf_Param & Project — Parameter management
  • Internal structure
  • Creating parameters from scratch (headless)
  • Reading and modifying parameters
  • Iterating over all groups and parameters
  • Saving and loading parameter files
  • Active vs Default values
  • Incrementable groups
  • Building from a raw string
  • Copying and comparing
  • Checking existence and using Enum parameters
  • Wolf2D_Project — linking simulations, vectors, and palettes
  • Summary
• ImagesTiles & PictureCollection — Managing images
  • ImagesTiles — tiled raster images
  • PictureCollection — georeferenced photos
  • Summary
• toys_dataset — Downloading example data
  • Imports and cache directory
  • Downloading a WolfArray
  • Downloading vectors and shapefiles
  • Available example directories
  • DownloadFiles — companion file handling
  • Downloading a GPU simulation
  • Generic download_file
  • Force re-download
  • Summary
• Wolfresults_2D & wolfres2DGPU — 2D simulation results
  • Architecture
  • GPU-optimized tiled danger maps
• Shields parameter
  • The Shields diagram
  • Python implementation
  • References
  • Importing modules
  • Critical Shields parameter
  • Diagrams
  • Determining the critical parameter from the sediment diameter
  • Determining the critical sediment diameter from the shear stress
  • Example with Manning-Strickler
  • Example with Colebrook-White
  • Suspension and transport mode
• Création d’une digue synthétique
  • Import des modules
  • Création d’une digue sur base d’une trace, de pentes et d’altitudes min et max
  • Création d’un digue sur base d’une forme de section
  • Même approche mais avec une largeur non-nulle en tête de digue
  • Interpolation sur une matrice de topographie