geopyv.plots

Module Contents

Functions

contour_mesh(data, quantity, imshow, colorbar, ticks, ...)	Function to plot contours of mesh data.
convergence_mesh(data, quantity, show, block, save)	Function to plot Mesh convergence.
convergence_subset(data, show, block, save)	Function to plot Subset convergence.
inspect_mesh(data, show, block, save)	Function to inspect Mesh topology.
inspect_subset(data, mask, show, block, save)	Function to show the Subset and associated quality metrics.
quiver_mesh(data, scale, imshow, mesh, axis, xlim, ...)	Function to plot quiver plot of mesh data.

geopyv.plots.contour_mesh(data, quantity, imshow, colorbar, ticks, mesh, alpha, levels, axis, xlim, ylim, show, block, save)

Function to plot contours of mesh data.

geopyv.plots.convergence_mesh(data, quantity, show, block, save)

Function to plot Mesh convergence.

Parameters:

• data (dict) – Mesh data dict.

• quantity (str) – Quantity to plot. Options are “C_ZNCC”, “iterations”, or “norm”.

• show (bool) – Control whether the plot is displayed.

• block (bool) – Control whether the plot blocks execution until closed.

• save (str) – Name to use to save plot. Uses default extension of .png.

Returns:

• fig (matplotlib.pyplot.figure) – Figure object.

• ax (matplotlib.pyplot.axes) – Axes object.

Note

• The figure and axes objects can be returned allowing standard matplotlib functionality to be used to augment the plot generated. See the plots tutorial for guidance.

See also

convergence()

geopyv.plots.convergence_subset(data, show, block, save)

Function to plot Subset convergence.

Parameters:

• data (dict) – Subset data dict.

• show (bool) – Control whether the plot is displayed.

• block (bool) – Control whether the plot blocks execution until closed.

• save (str) – Name to use to save plot. Uses default extension of .png.

Returns:

• fig (matplotlib.pyplot.figure) – Figure object.

• ax (matplotlib.pyplot.axes) – Axes object.

Note

• The figure and axes objects can be returned allowing standard matplotlib functionality to be used to augment the plot generated. See the plots tutorial for guidance.

See also

convergence()

geopyv.plots.inspect_mesh(data, show, block, save)

Function to inspect Mesh topology.

Parameters:

• data (dict) – Mesh data dict.

• show (bool) – Control whether the plot is displayed.

• block (bool) – Control whether the plot blocks execution until closed.

• save (str) – Name to use to save plot. Uses default extension of .png.

Returns:

• fig (matplotlib.pyplot.figure) – Figure object.

• ax (matplotlib.pyplot.axes) – Axes object.

Note

• The figure and axes objects can be returned allowing standard matplotlib functionality to be used to augment the plot generated. See the plots tutorial for guidance.

See also

inspect()

geopyv.plots.inspect_subset(data, mask, show, block, save)

Function to show the Subset and associated quality metrics.

Parameters:

• data (dict) – Subset data dict.

• mask (numpy.ndarray) – Subset mask.

• show (bool) – Control whether the plot is displayed.

• block (bool) – Control whether the plot blocks execution until closed.

• save (str) – Name to use to save plot. Uses default extension of .png.

Returns:

• fig (matplotlib.pyplot.figure) – Figure object.

• ax (matplotlib.pyplot.axes) – Axes object.

Note

• The figure and axes objects can be returned allowing standard matplotlib functionality to be used to augment the plot generated. See the plots tutorial for guidance.

See also

inspect()

geopyv.plots.quiver_mesh(data, scale, imshow, mesh, axis, xlim, ylim, show, block, save)

Function to plot quiver plot of mesh data.