skbot.transform.HexagonAxisRound¶
- class skbot.transform.HexagonAxisRound(*, axis=- 1)[source]¶
Round Hexagon Axis Coordinates in 2D.
This link rounds hexagon coordinates given in axis coordinates (r, q) to their closest hexagon.
- Parameters
- axisint
The axis along which rounding takes place.
Notes
This link is _not_ invertible.
Method Summary
__call__(parent[, child, add_inverse])Add this link to the parent frame.
invert()Returns a new link that is the inverse of this link.
transform(x)Expresses the vector x (assumed to be given in the parent's frame) in the child's frame.
Transform x (given in the child frame) into the parent frame.
Methods
- __call__(parent, child=None, *, add_inverse=True)¶
Add this link to the parent frame.
- Parameters
- parentFrame
The Frame from which vectors originate.
- childFrame
The Frame in which vectors are expressed after they were mapped by this link’s transform. If None, a new child will be created.
- add_inversebool
Also add the inverse link to the child if this Link is invertible. Defaults to
True.
- Returns
- childFrame
The Frame in which vectors are expressed after they were mapped by this link’s transform.
- Return type
- invert()¶
Returns a new link that is the inverse of this link.
The links share parameters, i.e., if the transform of a link changes, the transform of its inverse does also.
- Return type
- transform(x)[source]¶
Expresses the vector x (assumed to be given in the parent’s frame) in the child’s frame.
- Parameters
- xArrayLike
The vector expressed in the parent’s frame
- Returns
- yArrayLike
The vector expressed in the child’s frame
- Return type
ndarray
- __inverse_transform__(x)¶
Transform x (given in the child frame) into the parent frame.
- Parameters
- xArrayLike
The vector expressed in the childs’s frame
- Returns
- yArrayLike
The vector expressed in the parents’s frame
- Return type
ndarray