Types

superfish.types

Typed dictionary shapes for parsed Superfish data.

Classes

superfish.types.ExternalFieldData

Bases: TypedDict

openPMD external field data, ready to be written to an HDF5 file.

superfish.types.FishT7Data

Bases: T7Data

Parsed Fish T7 file. Field arrays have shape (nr, nz).

superfish.types.PoissonT7Data

Bases: T7Data

Parsed Poisson T7 file.

Has either Er/Ez (electric, V/cm) or Br/Bz (magnetic, G) arrays of shape (nr, nz).

superfish.types.SFOGroup

Bases: TypedDict

Raw group of lines from an SFO file, delimited by separator lines.

superfish.types.SFOHeader

Bases: TypedDict

Parsed SFO header table, keyed by variable name.

superfish.types.SFOOutput

Bases: _SFOOutputBase

Fully parsed SFO file, as returned by :func:superfish.parsers.parse_sfo.

superfish.types.SFOSummary

Bases: TypedDict

Parsed summary-style SFO group, with values and their units.

superfish.types.T7Data

Bases: TypedDict

Common grid data for a parsed T7 file. Extents are in cm.

superfish.types.UnparsedGroup

Bases: TypedDict

SFO group with no dedicated parser; type is the raw type line.

superfish.types.WallSegment

Bases: WallSegmentData

Wall segment group, as stored in :class:SFOOutput.

superfish.types.WallSegmentData

Bases: TypedDict

Parsed wall segment table, with per-column data and units.