jan/fdfd_tools
2
2
Fork 1
Code Issues Pull requests Releases Wiki Activity

Change comments to new format

Browse source
This commit is contained in:
Jan Petykiewicz 2020-01-07 21:31:16 -08:00
commit f69b8c9f11
4 changed files with 215 additions and 157 deletions
Download patch file Download diff file Expand all files Collapse all files

29
meanas/fdmath/vectorization.py
View file

@ -1,6 +1,6 @@
"""
Functions for moving between a vector field (list of 3 ndarrays, [f_x, f_y, f_z])
and a 1D array representation of that field [f_x0, f_x1, f_x2,... f_y0,... f_z0,...].
Functions for moving between a vector field (list of 3 ndarrays, `[f_x, f_y, f_z]`)
and a 1D array representation of that field `[f_x0, f_x1, f_x2,... f_y0,... f_z0,...]`.
Vectorized versions of the field use row-major (ie., C-style) ordering.
"""
@ -17,11 +17,14 @@ def vec(f: fdfield_t) -> vfdfield_t:
"""
Create a 1D ndarray from a 3D vector field which spans a 1-3D region.
Returns None if called with f=None.
Returns `None` if called with `f=None`.
:param f: A vector field, [f_x, f_y, f_z] where each f_ component is a 1 to
3D ndarray (f_* should all be the same size). Doesn't fail with f=None.
:return: A 1D ndarray containing the linearized field (or None)
Args:
f: A vector field, `[f_x, f_y, f_z]` where each `f_` component is a 1- to
3-D ndarray (`f_*` should all be the same size). Doesn't fail with `f=None`.
Returns:
1D ndarray containing the linearized field (or `None`)
"""
if numpy.any(numpy.equal(f, None)):
return None
@ -31,15 +34,17 @@ def vec(f: fdfield_t) -> vfdfield_t:
def unvec(v: vfdfield_t, shape: numpy.ndarray) -> fdfield_t:
"""
Perform the inverse of vec(): take a 1D ndarray and output a 3D field
of form [f_x, f_y, f_z] where each of f_* is a len(shape)-dimensional
of form `[f_x, f_y, f_z]` where each of `f_*` is a len(shape)-dimensional
ndarray.
Returns None if called with v=None.
Returns `None` if called with `v=None`.
:param v: 1D ndarray representing a 3D vector field of shape shape (or None)
:param shape: shape of the vector field
:return: [f_x, f_y, f_z] where each f_ is a len(shape) dimensional ndarray
(or None)
Args:
v: 1D ndarray representing a 3D vector field of shape shape (or None)
shape: shape of the vector field
Returns:
`[f_x, f_y, f_z]` where each `f_` is a `len(shape)` dimensional ndarray (or `None`)
"""
if numpy.any(numpy.equal(v, None)):
return None