out3Plot.outCom7Regional.createReportPlot

createReportPlot(dirListGrouped, inputDEM, outputDir, groupExtents, groupFeatures, reportType)[source]

Create a visual report showing the DEM extent with either basic or optional inputs.

Parameters

  • dirListGrouped (list) – List of dictionaries containing dirName and list of geometries

  • inputDEM (pathlib.Path) – Path to input DEM file

  • outputDir (pathlib.Path) – Path to output directory where the report will be saved

  • groupExtents (dict) – Dictionary with dirName as key and (xMin, xMax, yMin, yMax) as value, containing the DEM clipping extents for each group

  • groupFeatures (dict) – Dictionary containing clipped features for each group and type

  • reportType (str) – Type of report to create, either ‘basic’ or ‘optional’ - ‘basic’: Shows DEM extent and release areas only - ‘optional’: Shows DEM extent with entrainment and resistance areas

Returns

reportPath – Path to the generated report image

Return type

pathlib.Path