out3Plot.outParticlesAnalysis.addPeakFieldConstrained

addPeakFieldConstrained(avaDir, modName, simName, resType, demData, ax, alpha, oneColor='')[source]

use out1Peak functions to add plot of a peak field

Parameters
  • avaDir (pathlib path) – path to avalanche dir

  • modName (str) – name of computational module used to produce result peak fields

  • simName (str) – name of simulation

  • resType (str) – result variable name to look for peak field

  • demData (dict) – dict with info on dem used to run sim of peak field data

  • ax (matplotlib axes object) – axes where plot shall be added to

  • alpha (float) – value for transparency from 0-1

  • oneColor (empty str) – optional to add a color for a single color for field