`idstools.view.wall`¶

Module Contents¶

class idstools.view.wall.WallView(wall_ids)[source]¶

compute_object¶

wall_ids¶

add_wall_markings(ax, r, z, **kwargs)[source]¶

The function adds a path(Wall marking) to a given matplotlib axis object using the provided radial and vertical coordinates.

Parameters:¶

ax¶: The parameter “ax” is an instance of the Axes class in matplotlib. It represents the axes

on which the patch will be added.: r: The parameter “r” represents a list of x-coordinates for the vertices of the path. z: The parameter “z” represents the z-coordinates of the points in the path. It is a list or array containing the z-coordinates of the points.

view_inner_wall_line(ax)[source]¶

view_wall_limiter(ax, select_description2d=':', select_unit=':', wallcolor=None, **kwargs)[source]¶

view_wall_vessel(ax, select_description2d=':', select_unit=':', wallcolor=None, **kwargs)[source]¶

The function view_wall prints the values of r and z for each element in the wall_data dictionary and calls the addWallMarkings function to add a patch to the given ax object.

Parameters:¶

ax¶: ax is an instance of the matplotlib.axes.Axes class. It represents the axes on which

the wall will be plotted.: kwargs: This is useful to update properties of patch (Wall marking on the plot). You can find it here https://matplotlib.org/stable/api/_as_gen/matplotlib.patches.PathPatch.html.. most useful are linewidth, linestyle, visible, animated, edgecolor, fill or facecolor

idstools.view.wall.logger¶

idstools.view.wall¶

Module Contents¶

`idstools.view.wall`¶