ktk.geometry.create_frames#

create_frames(origin, x=None, y=None, z=None, xy=None, xz=None, yz=None)[source]#

Create an Nx4x4 series of frames based on series of points and vectors.

Parameters
  • origin (ArrayLike) – A series of N points (Nx4) that corresponds to the origin of the series of frames to be created.

  • x (Optional[ArrayLike]) – Define either x, y or z. A series of N vectors (Nx4) that are aligned toward the {x|y|z} series of frames to be created.

  • y (Optional[ArrayLike]) – Define either x, y or z. A series of N vectors (Nx4) that are aligned toward the {x|y|z} series of frames to be created.

  • z (Optional[ArrayLike]) – Define either x, y or z. A series of N vectors (Nx4) that are aligned toward the {x|y|z} series of frames to be created.

  • xy (Optional[ArrayLike]) – Only if x is specified. A series of N vectors (Nx4) in the {xy|xz} plane of the series of frames to be created. As a rule of thumb, use a series of N vectors that correspond roughly to the {z|-y} axis.

  • xz (Optional[ArrayLike]) – Only if x is specified. A series of N vectors (Nx4) in the {xy|xz} plane of the series of frames to be created. As a rule of thumb, use a series of N vectors that correspond roughly to the {z|-y} axis.

  • xy – Only if y is specified. A series of N vectors (Nx4) in the {xy|yz} plane of the series of frames to be created. As a rule of thumb, use a series of N vectors that correspond roughly to the {z|x} axis.

  • yz (Optional[ArrayLike]) – Only if y is specified. A series of N vectors (Nx4) in the {xy|yz} plane of the series of frames to be created. As a rule of thumb, use a series of N vectors that correspond roughly to the {z|x} axis.

  • xz – Only if z is specified. A series of N vectors (Nx4) in the {xz|yz} plane of the series of frames to be created. As a rule of thumb, use a series of N vectors that correspond roughly to the {-y|x} axis.

  • yz – Only if z is specified. A series of N vectors (Nx4) in the {xz|yz} plane of the series of frames to be created. As a rule of thumb, use a series of N vectors that correspond roughly to the {-y|x} axis.

Returns

Series of frames (Nx4x4).

Return type

np.ndarray