pyg4ometry.visualisation.Plot

Functions

AddCutterDataToPlot(filename[, projection, ax, ...])

Add cutter data to a plot or draw in a new figure if no axis object given.

AddCutterDataToPlotNoConectivity(filename[, ...])

Module Contents

pyg4ometry.visualisation.Plot.AddCutterDataToPlot(filename, projection='zx', ax=None, unitsFactor=1.0, colour='k', linewidth=0.5, alpha=1.0)

Add cutter data to a plot or draw in a new figure if no axis object given.

Parameters:
  • filename (str) – file name of exported cutter data from visualiser.

  • projection (str) – which two axes to plot in a 2D plot from the 3D data. e.g. zx, zy.

  • ax (matplotlib.axes._axes.Axes) – matplotlib axes instance.

  • unitsFactor (float) – numerical scaling factor for coordinates (e.g. 0.001 for plotting in meters).

  • colour (str) – matplotlib.pyplot.plot colour argument

  • linewidth (float) – matplotlib.pyplot.plot linewidth argument

  • alpha (float) – matplotlib.pyplot.plot alpha argument for transparency

If used without an axes, a new figure and axes will be created.

The project specifies the order of plotting, so ‘zx’ would give z in the plot’s x axis and ‘x’ in plot’s y axis. Any combination of ‘x’, ‘y’ and ‘z’ are accepted and must be different. e.g. any of ‘xy’, ‘xz’, ‘yx’, ‘yz’, ‘zx’, ‘zy’.

pyg4ometry.visualisation.Plot.AddCutterDataToPlotNoConectivity(filename, projection='zx', ax=None, unitsFactor=1.0, colour='k', linewidth=0.5, alpha=1.0)