Image.streamplot#

StreamplotManager.streamplot(var1: ndarray[tuple[Any, ...], dtype[generic]], var2: ndarray[tuple[Any, ...], dtype[generic]], check: bool = True, **kwargs: Any) → LineCollection[source]#

Plot a streamplot of a vector field.

The function uses the streamplot function from matplotlib.pyplot.

Parameters:

- alpha: float, default 1.0: Sets the opacity of the plot, where 1.0 means total opaque and 0.0 means total transparent.
- arrowsize: float, default 1.0: Sets the size of the arrows of the streamline.
- arrowstyle: str, default ‘-|>’: Sets the style of the arrows of the streamline.
- aspect: {‘auto’, ‘equal’, float}, default ‘auto’: Sets the aspect ratio of the plot. The ‘auto’ keyword is the default option (most likely the plot will be squared). The ‘equal’ keyword will set the same scaling for x and y. A float will fix the ratio between the y-scale and the x-scale (1.0 is the same as ‘equal’).
- ax: axis object: The axis where to plot the streamlines. If not given, the last considered axis will be used.
- brokenlines: bool, default True: Splits the streamlines in shorter segments.
- c: str, default self.color: Determines the streamplot color. If not defined, the program will loop over an array of 6 color which are different for the most common vision deficiencies.
- cmap: str, default ‘hot’: Selects the colormap. If not defined, the colormap ‘hot’ will be adopted. Some useful colormaps are: plasma, magma, seismic. Please avoid using colorbars like jjet or rainbow, which are not perceptively uniform and not suited for people with vision deficiencies. All the colormap available are listed in the following link: https://matplotlib.org/stable/tutorials/colors/colormaps.html
- cpos: {‘top’,’bottom’,’left’,’right’}, default None: Enables the colorbar (if defined), default position on the right.
- cscale: {‘linear’,’log’,’symlog’,’twoslope’}, default ‘linear’: Sets the colorbar scale. Default is the linear (‘norm’) scale.
- density: float, default 1.0: Sets the density and closeness of the streamlines. The domain is divided in a 30x30 grid. When set as default, each cell contains at most a number of crossing streamplot line equal to this keyword.
- extend: {‘neither’,’both’,’min’,’max’}, default ‘neither’: Sets the extension of the triangular colorbar extension.
- extendrect: bool, default False: If True, the colorbar extension will be rectangular.
- fontsize: float, default 17.0: Sets the fontsize for all the axis components (only for the current axis).
- grid: bool, default False: Enables/disables the grid on the plot.
- integration_direction: {‘forward’, ‘backward’, ‘both’}, default:’both’: Sets the streamlines integration in the forward direction, backward direction, or both.
- labelsize: float, default fontsize: Sets the labels fontsize (which is the same for both labels). The default value corresponds to the value of the keyword ‘fontsize’.
- lw: float, default 1.0: Sets the width of the streamlines.
- maxlength: float, default 5.0: Sets the maximum length of a streamline in coordinates units.
- minlength: float, default 0.1: Sets the minimum length of a streamline in coordinates units.
- minorticks: str, default None: If not None enables the minor ticks on the plot (for both grid axes).
- start_points: np.ndarray, default None: Sets the starting points of the streamlines, if a more controlled plot is wanted.
- ticksdir: {‘in’, ‘out’}, default ‘in’: Sets the ticks direction. The default option is ‘in’.
- tickssize: float | bool, default True: Sets the ticks fontsize (which is the same for both grid axes). The default value corresponds to the value of the keyword ‘fontsize’.
- title: str, default None: Places the title of the plot on top of it.
- titlepad: float, default 8.0: Sets the distance between the title and the top of the plot
- titlesize: float, default fontsize: Sets the title fontsize. The default value corresponds to the value of the keyword ‘fontsize’.
- transpose: True/False, default False: Transposes the variable matrix. Use is not recommended if not really necessary (e.g. in case of highly customized variables and plots)
- tresh: float, default max(abs(vmin),vmax)*0.01: Sets the threshold for the colormap. If not defined, the threshold will be set to 1% of the maximum absolute value of the variable. The default cases are the following: - twoslope colorscale: sets the limit between the two linear regimes. - symlog: sets the limit between the logaitrhmic and the linear regime.
- var1 (not optional): np.ndarray: The x1-component of the vector field.
- var2 (not optional): np.ndarray: The x2-component of the vector field.
- vmax: float: The maximum value of the vector field norm.
- vmin: float: The minimum value of the vector field norm.
- x1: np.ndarray: The x-axis variable.
- x2: np.ndarray: The y-axis variable.
- xrange: [float, float], default [0,1]: Sets the range in the x-direction. If not defined the code will compute the range while plotting the data.
- xscale: {‘linear’,’log’}, default ‘linear’: If enabled (and different from True), sets automatically the scale on the x-axis. Data in log scale should be used with the keyword ‘log’, while data in linear scale should be used with the keyword ‘linear’.
- xticks: {[float], None, True}, default True: If enabled (and different from True), sets manually ticks on x-axis. In order to completely remove the ticks the keyword should be used with None.
- xtickslabels: {[str], None, True}, default True: If enabled (and different from True), sets manually the ticks labels on the x-axis. In order to completely remove the ticks the keyword should be used with None. Note that fixed tickslabels should always correspond to fixed ticks.
- xtitle: str, default None: Sets and places the label of the x-axis.
- yrange: [float, float], default [0,1]: Sets the range in the y-direction. If not defined the code will compute the range while plotting the data.
- yscale: {‘linear’,’log’}, default ‘linear’: If enabled (and different from True), sets automatically the scale on the y-axis. Data in log scale should be used with the keyword ‘log’, while data in linear scale should be used with the keyword ‘linear’.
- yticks: {[float], None, True}, default True: If enabled (and different from True), sets manually ticks on y-axis. In order to completely remove the ticks the keyword should be used with None.
- ytickslabels: {[str], None, True}, default True: If enabled (and different from True), sets manually the ticks labels on the y-axis. In order to completely remove the ticks the keyword should be used with None. Note that fixed tickslabels should always correspond to fixed ticks.
- ytitle: str, default None: Sets and places the label of the y-axis.
—-

Returns:

strm: LineCollection
The streamplot of the given vector field.

Examples

Example #1: Plot a streamplot of a vector field
```
>>> I.streamplot(D.Bx1, D.Bx2)
```