ProbeFunction

class diffsims.utils.probe_utils.ProbeFunction(func=None)

Bases: object

Object representing a probe function.

Parameters:

func (function) – Function which takes in an array, r, of shape [nx, ny, nz, 3] and returns an array of shape [nx, ny, nz]. r[…,0] corresponds to the x coordinate, r[…, 1] to y etc. If not provided (or None) then the __call__ and FT methods must be overrided.

Methods

ProbeFunction.FT(y[, out])

Returns the Fourier transform of func on the mesh y.