idstools.view.tf

This module provides view functions and classes for tf ids data

refer data dictionary.

Module Contents

class idstools.view.tf.TFView(ids: object)[source]

This class provides view functions for tf ids

Initialization TFView object.

Parameters:
ids: object

tf ids object

compute_obj
ids
view_tf_coils(ax: matplotlib.pyplot.axes, select_coil=':', select_conductor=':', color='#57b6ed', edgecolor='#0000ff', facecolor='#57b6ed', alpha=0.7)[source]

Plots the Toroidal Field (TF) coils on the given matplotlib axis.

Parameters: ax (plt.axes): The matplotlib axis to plot on. select_coil (str, optional): The coil selection criteria. Defaults to “:”. select_conductor (str, optional): The conductor selection criteria. Defaults to “”. color (str, optional): The color to use for plotting the coils. Defaults to “#800000”.

Returns: Patch: A matplotlib Patch object for the TF legend.

Notes: - The function retrieves TF coil data using the compute_obj’s get_tf_coils method. - If no TF coil data is found, a warning is logged and the function returns without plotting. - The function plots the start and end points of the coil conductors and connects them with line segments. - The aspect ratio of the plot is set to be equal and the title is updated to include “tf”.

idstools.view.tf.logger