get_cone_rotations#

get_cone_rotations(cone_angle, cone_sampling, axis=(1, 0, 0), axis_angle=360.0, axis_sampling=None, reference=(1, 0, 0), n_symmetry=1, seq=None)[source]#

Generate rotations describing the possible placements of a vector in a cone.

Parameters:
cone_anglefloat

The half-angle of the cone in degrees.

cone_samplingfloat

Angular increment used for sampling points on the cone in degrees.

axisTuple[float], optional

Base-vector of the cone.

axis_anglefloat, optional

The total angle of rotation around the cone axis in degrees (default is 360.0).

axis_samplingfloat, optional

Angular increment used for sampling points around the cone axis in degrees. If None, it takes the value of cone_sampling.

referenceTuple[float], optional

Returned rotations will map this point onto the cone. In practice, this is the principal axis of the template.

n_symmetryint, optional

Number of symmetry axis around the vector axis.

seqstr, optional

Convention for angles. By default returns rotation matrices.

Returns:
NDArray

An arary of rotations represented as stack of rotation matrices when convention None (n, 3, 3) or an array of Euler angles (n, 3) for available conventions.