timflow.transient.plots.PlotTransient.head_along_line#

timflow.transient.plots.PlotTransient.head_along_line(x1=0, x2=1, y1=0, y2=0, npoints=100, t=1.0, layers=0, sstart=0, color=None, lw=1, figsize=None, ax=None, legend=True, grid=True)#

Plot head along line.

Parameters:
  • x1 (float) – start and end coordinates of line

  • x2 (float) – start and end coordinates of line

  • y1 (float) – start and end coordinates of line

  • y2 (float) – start and end coordinates of line

  • npoints (int) – number of points along line

  • t (scalar or array) – times at which to plot heads

  • layers – layers for which to plot heads

  • sstart (float) – starting distance for cross-section

  • color (str) – color of line

  • lw (float) – line width

  • figsize (tuple of 2 values) – size of figure

  • ax (matplotlib.Axes) – axes to plot on, default is None which creates a new figure

  • legend (bool) – add legend to plot

  • grid (bool) – add grid to plot

Returns:

ax – axes with plot

Return type:

matplotlib.Axes