fusionsc.magnetics.SurfaceArray

class fusionsc.magnetics.SurfaceArray(val=None, msgSize=1024, byReference=False)

A wrapper around service.FourierSurfaces.Builder that exposes array-like behavior

Methods

__init__([val, msgSize, byReference])	Creates a new instance by either: - Allocating a new message of size msgSize (if val is None) - Storing a reference to the target (if byReference is set) - Copying the message from the given target (accepts Cap'n'proto messages, YAML strings, lists, dicts, and NumPy arrays)
apply(op, *extraArgs)
asFourier()	Note Has asynchronous variant '.asnc(...)' that returns Promise[...]
asGeometry([nPhi, nTheta, radialShift])
cache(filename)	Note Has asynchronous variant '.asnc(...)' that returns Promise[...]
evaluate(phi, theta[, grid])	Note Has asynchronous variant '.asnc(...)' that returns Promise[...]
graph(**kwargs)	Visualizes the contents in a graph structure.
load()	Loads an instance of this class from a previously written archive file.
ptree()	Prints a tree version of this object.
save(filename)	Saves the object into an archive file (including all referenced data)
toYaml([flow])	Prints the contents as block-structured YAML
upload()	Note Has asynchronous variant '.asnc(...)' that returns Promise[...]

Attributes

data	Underlying Cap'n'proto struct (usually a builder type).
shape
type

Methods

SurfaceArray.__init__(val=None, msgSize=1024, byReference=False)

Creates a new instance by either: - Allocating a new message of size msgSize (if val is None) - Storing a reference to the target (if byReference is set) - Copying the message from the given target (accepts Cap’n’proto messages,

YAML strings, lists, dicts, and NumPy arrays)

SurfaceArray.apply(op, *extraArgs)

SurfaceArray.asFourier() → Any

Note Has asynchronous variant ‘.asnc(…)’ that returns Promise[…]

SurfaceArray.asGeometry(nPhi=100, nTheta=100, radialShift=0)

SurfaceArray.cache(filename) → Any

Note Has asynchronous variant ‘.asnc(…)’ that returns Promise[…]

SurfaceArray.evaluate(phi: numpy.typing.ArrayLike, theta: numpy.typing.ArrayLike, grid=True) → Any

Note Has asynchronous variant ‘.asnc(…)’ that returns Promise[…]

SurfaceArray.graph(**kwargs)

Visualizes the contents in a graph structure. Requires graphviz

SurfaceArray.load() → Any

Loads an instance of this class from a previously written archive file.

Note Has asynchronous variant ‘.asnc(…)’ that returns Promise[…]

SurfaceArray.ptree()

Prints a tree version of this object. Requires the printree library.

SurfaceArray.save(filename) → Any

Saves the object into an archive file (including all referenced data)

Note Has asynchronous variant ‘.asnc(…)’ that returns Promise[…]

SurfaceArray.toYaml(flow=False)

Prints the contents as block-structured YAML

SurfaceArray.upload() → Any

Note Has asynchronous variant ‘.asnc(…)’ that returns Promise[…]