tidy3d.RotationAroundAxis#

class RotationAroundAxis[source]#

Bases: AbstractRotation

Rotation of vectors and tensors around a given vector.

Parameters:
  • attrs (dict = {}) – Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, attrs are mutable. For example, the following is allowed for setting an attr obj.attrs['foo'] = bar. Also note that Tidy3D` will raise a TypeError if attrs contain objects that can not be serialized. One can check if attrs are serializable by calling obj.json().

  • axis (Union[Literal[0, 1, 2], Tuple[float, float, float]] = 0) – A vector that specifies the axis of rotation, or a single int: 0, 1, or 2, indicating x, y, or z.

  • angle (float = 0.0) – [units = rad]. Angle of rotation in radians.

Attributes

isidentity

Check whether rotation is identity.

matrix

Rotation matrix.

attrs

Methods

Inherited Common Usage

axis#
angle#
property isidentity#

Check whether rotation is identity.

property matrix#

Rotation matrix.

__hash__()#

Hash method.