skued.plane_mesh¶
- skued.plane_mesh(v1, v2, x1, x2=None, origin=(0, 0, 0))¶
Generate a spatial mesh for a plane defined by two vectors.
- Parameters
v1 (~numpy.ndarray, shape (3,)) – Basis vector of the plane. A warning is raised if
v1
andv2
are not orthogonal.v2 (~numpy.ndarray, shape (3,)) – Basis vector of the plane. A warning is raised if
v1
andv2
are not orthogonal.x1 (iterable, shape (N,)) – 1-D arrays representing the coordinates on the grid, along basis vectors
v1
andv2
respectively. Ifx2
is not specified,x1
andx2
are taken to be the samex2 (iterable, shape (N,)) – 1-D arrays representing the coordinates on the grid, along basis vectors
v1
andv2
respectively. Ifx2
is not specified,x1
andx2
are taken to be the sameorigin (iterable, shape (3,), optional) – Plane mesh will be generated with respect to this origin.
- Returns
x, y, z – Mesh arrays for the coordinate of the plane.
- Return type
~numpy.ndarray, ndim 2