SIMION.PA - PA Library in Python

SIMION.PA - Python (not Lua) module for reading/writing/manipulating SIMION potential arrays.

Contents

• SIMION.PA - PA Library in Python
  • DESCRIPTION
  • SYNOPSIS
  • INTERFACE
    • Class: PA
      • Constructor: PA
      • header_string
      • load
      • save
      • fast_adjustable
      • field_type
      • mode
      • max_voltage
      • mirror
      • mirror_x
      • mirror_y
      • mirror_z
      • ng
      • num_points
      • num_voxels
      • nx
      • ny
      • nz
      • pasharp
      • set
      • size
      • symmetry
      • dx_mm
      • dy_mm
      • dz_mm
      • inside
      • inside_real
      • voxel_inside
      • electrode
      • field
      • field_real
      • point
      • potential
      • potential_real
      • solid
      • raw
      • check
      • check_field_type
      • check_max_voltage
      • check_mirror
      • check_mode
      • check_ng
      • check_nx
      • check_ny
      • check_nz
      • check_size
      • check_symmetry
      • check_dx_mm
      • check_dy_mm
      • check_dz_mm
      • error
  • CHANGES
  • SOURCE

DESCRIPTION

This module is for manipulating SIMION potential array (PA/PA?) files (including creating, loading, modifying, and saving) in the Python language. See Appendix F.5 of the SIMION 8.0 manual (or Appendix p. D-5 of the SIMION 7.0 manual) for the PA file format specification.

This modules is intended to be very robust and has been put through an extensive test suite. It is also intended to be simple to use and very Pythonic. The module is, however, not as fast as the corresponding C++ implementation, even though speed has been considered, so use the C++ implementation if speed is critical.

SYNOPSIS

from SIMION.PA import *

#-- reading an existing array
pa = PA(file = 'buncher.pa#')
# print header parameters the simple way
print pa.header_string()

#-- creating an array from scratch
pa2 = PA(nx = 100, ny = 20, symmetry = 'cylindrical')

z = 0
for x in range(0, pa.nx()):
  ...    for y in range(0, pa.ny()):
  ...        inside = (x + y < 10)
  ...        if inside:
  ...            pa.point(x, y, z, 1, 5.0)  # electrode, 5V
pa2.save('cone.pa#')

#-- creating a magnetic field from scratch
pa3 = PA(nx = 50, ny = 50, field_type = 'magnetic')
z = 0
for x in range(0, pa.nx()):
    for y in range(0, pa.ny()):
        ex = x
        ey = y**2
        ez = 0
        pa3.field(x, y, z, ex, ey, ez)
pa3.save('mag1.pa')

Note

See these additional sections in this topic in the offline SIMION 8.1.0 help file:

• INTERFACE
• CHANGES

SOURCE

D.Manura (c) 2003-2011 Scientific Instrument Services, Inc. Licensed under the terms of SIMION 8 or the SIMION SL Toolkit. Created 2003-11.

version: 20110811