fdfd_tools/meanas/vectorization.py

48 lines
1.4 KiB
Python
Raw Normal View History

2016-05-30 22:30:45 -07:00
"""
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,...].
2017-12-09 18:21:37 -08:00
Vectorized versions of the field use row-major (ie., C-style) ordering.
2016-05-30 22:30:45 -07:00
"""
from typing import List
import numpy
2019-08-04 13:48:41 -07:00
from .types import field_t, vfield_t
2016-05-30 22:30:45 -07:00
2019-08-04 13:48:41 -07:00
__author__ = 'Jan Petykiewicz'
2016-05-30 22:30:45 -07:00
def vec(f: field_t) -> vfield_t:
"""
Create a 1D ndarray from a 3D vector field which spans a 1-3D region.
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)
"""
if numpy.any(numpy.equal(f, None)):
return None
2019-08-04 13:48:41 -07:00
return numpy.ravel(f, order='C')
2016-05-30 22:30:45 -07:00
def unvec(v: vfield_t, shape: numpy.ndarray) -> field_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
ndarray.
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)
"""
if numpy.any(numpy.equal(v, None)):
return None
2019-07-21 22:05:40 -07:00
return v.reshape((3, *shape), order='C')
2016-05-30 22:30:45 -07:00