plot_over_line#
- DataSetFilters.plot_over_line(pointa, pointb, resolution=None, scalars=None, title=None, ylabel=None, figsize=None, figure=True, show=True, tolerance=None, fname=None, progress_bar=False)[source]#
Sample a dataset along a high resolution line and plot.
Plot the variables of interest in 2D using matplotlib where the X-axis is distance from Point A and the Y-axis is the variable of interest. Note that this filter returns
None.- Parameters
- pointasequence
Location in
[x, y, z].- pointbsequence
Location in
[x, y, z].- resolution
int,optional Number of pieces to divide line into. Defaults to number of cells in the input mesh. Must be a positive integer.
- scalars
str,optional The string name of the variable in the input dataset to probe. The active scalar is used by default.
- title
str,optional The string title of the matplotlib figure.
- ylabel
str,optional The string label of the Y-axis. Defaults to variable name.
- figsize
tuple(int),optional The size of the new figure.
- figurebool,
optional Flag on whether or not to create a new figure.
- showbool,
optional Shows the matplotlib figure.
- tolerance
float,optional Tolerance used to compute whether a point in the source is in a cell of the input. If not given, tolerance is automatically generated.
- fname
str,optional Save the figure this file name when set.
- progress_barbool,
optional Display a progress bar to indicate progress.
Examples
See the Plot Over Line example.