pyampp.gxbox.box_view3d

Classes

MagFieldViewer

A class to visualize the magnetic field of a box using PyVista. It inherits from the BackgroundPlotter class.

Functions

minval(min_val)	Rounds the minimum value to the nearest hundredth.
maxval(max_val)	Rounds the maximum value to the nearest hundredth.
generate_streamlines_from_line_seeds(box, b3dtype, ...)

Module Contents

pyampp.gxbox.box_view3d.minval(min_val)

Rounds the minimum value to the nearest hundredth.

Parameters:

min_val – float The minimum value to round.

Returns:

float The rounded minimum value.

pyampp.gxbox.box_view3d.maxval(max_val)

Rounds the maximum value to the nearest hundredth.

Parameters:

max_val – float The maximum value to round.

Returns:

float The rounded maximum value.

pyampp.gxbox.box_view3d.generate_streamlines_from_line_seeds(box, b3dtype, line_seeds)

class pyampp.gxbox.box_view3d.MagFieldViewer(box, parent=None, box_norm_direction=None, box_view_up=None, time=None, b3dtype='nlfff', model_path=None, session_mode=None, *args, **kwargs)

Bases: pyvistaqt.BackgroundPlotter

A class to visualize the magnetic field of a box using PyVista. It inherits from the BackgroundPlotter class.

Parameters:

• box – object The box containing magnetic field data.

• parent – object, optional The parent object (default is None).

source_model_path

box

parent = None

model_path = None

session_mode = 'embedded'

box_norm_direction = None

box_view_up = None

updating_flag = False

spheres

current_sphere_id = None

next_sphere_id = 1

current_sphere = None

sphere_actor = None

sphere = None

axes_widget = None

plane_actor = None

bottom_slice_actor = None

base_map_actor = None

model_box_actor = None

fov_box_actor = None

streamlines_actor = None

streamlines = None

sphere_visible = True

slice_visible = True

base_map_visible = False

model_box_visible = True

fov_box_visible = True

plane_visible = True

use_interp = True

scalar = 'bz'

previous_params

previous_valid_values

scalar_selector = None

slice_checkbox = None

slice_axis_selector = None

slice_coord_label = None

scalar_selector_items = []

base_map_selector = None

model_box_checkbox = None

fov_box_checkbox = None

base_map_checkbox = None

base_map_items = []

center_x_input = None

center_y_input = None

center_z_input = None

radius_input = None

n_points_input = None

slice_z_input = None

vmin_input = None

vmax_input = None

slice_z_min = 0.0

slice_z_max = 0.0

scalar_min = 0.0

scalar_max = 0.0

base_scalar_min = 0.0

base_scalar_max = 0.0

update_button = None

send_button = None

save_model_button = None

save_close_button = None

cancel_button = None

save_as_button = None

parallel_proj_button = None

field_lines_control_group = None

sphere_control_group = None

base_vmin_input = None

base_vmax_input = None

timestr

grid_x

grid_y

grid_z

grid_zbase

slice_axis = 'z'

slice_axis_positions

slice_coord_min

slice_coord_max

default_sph_cen_x

default_sph_cen_y

default_sph_cen_z

print_camera_position(caller, event)

Prints the camera position whenever the camera is moved.

set_camera_to_LOS_direction()

Set the camera to the observer line-of-sight.

The authoritative orientation comes only from the observer WCS and the box frame. The optional FOV box is used only to choose the framing target (center/zoom), never to define the camera basis itself.

schedule_startup_los_view() → None

ensure_window_visible() → None

add_parallel_projection_button()

Adds a toggle button for parallel projection to the toolbar.

toggle_parallel_projection(state)

Toggles the parallel projection mode of the camera.

add_observer_cam_button()

Adds a button to the toolbar to set the camera to the normal direction.

add_menu_options()

save_state(default_filename='box_view3d_state.pkl')

Saves the current state of spheres to a file. Prompts the user to select a directory and input a filename.

Parameters:

default_filename – str The default name of the file to save the state data.

load_state(filename=None)

Loads the state of spheres from a file. Prompts the user to select a file.

add_widgets_to_window()

Adds the input widgets to the window.

select_sphere(sphere_id)

deselect_sphere()

Handles the deselection of a sphere. Clears the inputs and hides the current sphere and its streamlines.

delete_sphere_from_tb(sphere_id)

validate_input(widget, min_val, max_val, original_value, to_int=False, paired_widget=None, paired_type=None)

Validates the input of a QLineEdit widget and returns the value if it is valid. If the input is invalid, a warning message is displayed and the original value is restored.

Parameters:

• widget – QLineEdit The widget to validate.

• min_val – float The minimum valid value.

• max_val – float The maximum valid value.

• original_value – float The original value of the widget.

• to_int – bool Whether to convert the value to an integer.

• paired_widget – QLineEdit, optional The paired widget to compare the value with.

• paired_type – str, optional The type of comparison to perform with the paired widget.

Returns:

float The valid value.

init_grid()

init_plot()

Initializes and displays the plot with the magnetic field data.

update_plot(init=False)

Updates the plot based on the current input parameters.

update_slice(slice_axis, slice_z, scalar, vmin, vmax, use_interp=True, slice_visible=True)

Updates the slice plot based on the given parameters.

Parameters:

• slice_axis – str The axis normal to the slice plane.

• slice_z – float The slice coordinate along the selected axis.

• scalar – str The scalar field to use for the slice.

• vmin – float The minimum value for the color scale.

• vmax – float The maximum value for the color scale.

update_base_map(base_map, vmin, vmax, base_map_visible=True)

Render a fixed bottom-plane base map independently of the moving z-slice.

update_model_box(visible=True, do_render=True)

update_fov_box(visible=True, do_render=True)

create_streamlines(center_x, center_y, center_z, radius, n_points)

update_streamlines(center_x, center_y, center_z, radius, n_points)

Updates the streamline plot based on the given parameters.

Parameters:

• center_x – float The X coordinate of the center of the sphere.

• center_y – float The Y coordinate of the center of the sphere.

• center_z – float The Z coordinate of the center of the sphere.

• radius – float The radius of the sphere.

• n_points – int The number of seed points for the streamlines.

update_sphere()

Updates the sphere widget based on the current input parameters.

on_lock_z_changed(state)

update_sphere_visibility(sphere_visible)

Updates the visibility of the sphere widget.

Parameters:

sphere_visible – bool Whether the sphere widget is visible.

toggle_sphere_visibility(state)

Toggles the visibility of the sphere widget.

Parameters:

state – int The state of the checkbox (checked or unchecked).

update_plane()

Updates the plane widget based on the current input parameters.

update_plane_visibility(plane_visible)

Updates the visibility of the plane widget.

Parameters:

plane_visible – bool Whether the plane widget is visible.

toggle_plane_visibility(state)

Toggles the visibility of the plane widget.

Parameters:

state – int The state of the checkbox (checked or unchecked).

toggle_slice_visibility(state)

Toggles the visibility of the z-slice actor while preserving the selected scalar.

Parameters:

state – int The state of the checkbox (checked or unchecked).

toggle_base_map_visibility(state)

toggle_model_box_visibility(state)

toggle_fov_box_visibility(state)

send_streamlines()

Sends the streamline data of all spheres to the parent object (if any).

save_current_model()

accept_and_close()

cancel_and_close()

undo_and_restore()

save_box()

load_box()