simion.wb

SYNOPSIS

DESCRIPTION

Compatibility Warning: The features in this module are only available in the SIMION 8.1.0 and above.

The simion.wb object represents the currently loaded SIMION workbench (IOB file). This allows the SIMION workbench to be read and manipulated programmatically.

Tip: you can programmatically load a workbench via the simion.command() function: e.g. simion.command 'quad.iob'.

Note

This page is abridged from the full SIMION "Supplemental Documentation" (Help file). The following additional sections can be found in the full version of this page accessible via the "Help > Supplemental Documentation" menu in SIMION 8.1.1 or above:

• INTERFACE

• INTERFACE: PA Instance

Changes

• 8.2EA-20190205: - Add simion.wb:load_particles() function for loading any particles (ION, FLY, FLY2) from disk.

• 8.1.2.30 Add time t parameter to simion.wb:epotential(), simion.wb:bpotential(), simion.wb:efield(), simion.wb:bfield(), simion.wb instance:potential(), simion.wb instance:field(). These utilize fast_adjust, efield_adjust, and mfield_adjust segments.

• 8.1.2.30 Rename instance:potential_wc and instance:field_wc simion.wb instance:potential(), simion.wb instance:field() respectively. Old deprecated names kept for compatibility.

• 8.2EA-20130430(8.1.2.9) Add simion.wb.selected_instance_number - access currently selected PA instance number.

• 8.1.2.8 - PA instance rotation angles when set from the API (simion.wb instance.az, simion.wb instance.el, simion.wb instance.rt) or GUI (View > PAs > Positioning) are no longer automatically changed to standard form. For example, (az,el,rt)=(0,180,0) and (az,el,rt)=(180,0,180) represent the same rotation, and the former used to be automatically rewritten to the latter form. But this rewriting can cause confusion if the three angles are set one at a time. The rewritting also wasn’t properly updated in the GUI. r th1515.

• 8.2(8.1.2.5) - Add simion.wb:save() for saving IOB.

• 8.2(8.1.2.5) - Add simion.wb:load() for loading IOB.

• 8.1.2.5: If no workbench is currently loaded, simion.wb is now an empty workbench (no longer nil).

• 8.2(8.1.1.40-EA) - Add simion.wb:save_stl() for exporting IOB to STL.

• 8.1.1.18 - Add simion.wb.path and simion.wb.filename.

• 8.1.1.18 - Fix simion.wb:find_at(), simion.wb:bfield(), simion.wb:bpotential() may incorrectly return 0/nil for B-field prior to start of Fly’m.

• 8.1.1.0 - Add simion.wb:efield, simion.wb:bfield, simion.wb:epotential, simion.wb:bpotential, simion.wb:find_at.

• 8.1.1.0 - Add instance:potential_wc, instance:field_wc, and instance:inside_wc functions.

• 8.1.0-TEST14 - mm_per_gu was renamed to scale.