pywfm.IWFMModel.plot_elements

IWFMModel.plot_elements(axes, values=None, cmap='jet', scale_factor=10000, buffer_distance=10000, write_to_file=False, file_name=None)

plots model elements on predefined axes

Parameters:

• axes (plt.Axes) – axes object for matplotlib figure

• values (list, tuple, np.ndarray, or None, default=None) – values to display color

• cmap (str or ~matplotlib.colors.Colormap, default=’jet’) – colormap used to map normalized data values to RGBA colors

• scale_factor (int, default=10000) – used to scale the limits of the x and y axis of the plot e.g. scale_factor=1 rounds the x and y min and max values down and up, respectively to the nearest whole number

• buffer_distance (int, default=10000) – value used to buffer the min and max axis values by a number of units

• write_to_file (boolean, default=False) – save plot to file. if True, file_name is required

• file_name (str) – file path and name (with extension for valid matplotlib.pyplot savefig output type)

Returns:

matplotlib figure is generated

Return type:

None