idstools.view.pf_active

This module provides view functions and classes for pf_active ids data

refer data dictionary.

Module Contents

class idstools.view.pf_active.PFActiveView(ids: object)[source]

This class provides view functions for pf_active ids

Initialization PFActiveView object.

Parameters:
ids: object

pf_active ids object

compute_obj
ids
view_active_pf_coils(ax: matplotlib.pyplot.axes, select=':', edgecolor='#ff0000', facecolor='#ff7400', alpha=0.7)[source]

This function plots and annotates the active PF coils on a existing plot.

Parameters:
ax: matplotlib.pyplot.axes

ax is a parameter of type plt.axes, It is used to add patches (such as rectangles) and annotations to the plot.

Example

import imas
from idstools.view.pf_active import PFActiveView
from idstools.view.common import PlotCanvas

connection = imas.DBEntry("imas:mdsplus?user=public;pulse=135005;run=4;database=ITER;version=3", "r")
connection.open()
idsObj = connection.get('pf_active')
connection.close()
canvas = PlotCanvas(1, 1) # create canvas
ax = canvas.add_axes(title="", xlabel="", row=0, col=0)

viewObj = PFActiveView(idsObj)
viewObj.viewActivePfCoils(ax, showLabels=True) # plot contour on the canvas axes

ax.plot()
canvas.show()
image not found
idstools.view.pf_active.logger