# from_align_vectors#

classmethod Orientation.from_align_vectors(other: Miller, initial: Vector3d, weights: = None, return_rmsd: bool = False, return_sensitivity: bool = False) [source]#

Create an estimated orientation to optimally align vectors in the crystal and sample reference frames.

This method wraps `align_vectors()`. See that method for further explanations of parameters and returns.

Parameters:
other

Crystal directions of shape `(n,)` in the crystal reference frame.

initial

Sample directions of shape `(n,)` in the sample reference frame.

weights

Relative importance of the different vectors.

return_rmsd

Whether to return the (weighted) root mean square distance between `other` and `initial` after alignment. Default is `False`.

return_sensitivity

Whether to return the sensitivity matrix. Default is `False`.

Returns:
`estimated_orientation`

Best estimate of the orientation that transforms `initial` to `other`. The symmetry of the orientation is inferred from the point group of the phase of `other`, if given.

`rmsd`

Returned when `return_rmsd=True`.

`sensitivity`

Returned when `return_sensitivity=True`.

Raises:
`ValueError`

If `other` is not a Miller instance.

Examples

```>>> from orix.quaternion import Orientation
>>> from orix.vector import Vector3d, Miller
>>> from orix.crystal_map import Phase
>>> t = Miller(uvw=[[0, 1, 0], [1, 0, 0]], phase=Phase(point_group="m-3m"))
>>> v_sample = Vector3d([[0, -1, 0], [0, 0, 1]])
>>> O = Orientation.from_align_vectors(t, v_sample)
>>> O * v_sample
Vector3d (2,)
[[0. 1. 0.]
[1. 0. 0.]]
```

## Examples using `Orientation.from_align_vectors`#

Orientation from aligning directions

Orientation from aligning directions