BugFix: Allow get_kwargs for setting kwargs on __mul__

CSSFrancis commented 6 months ago

Description of the change

This should fix (part) of the problems upstream with https://github.com/pyxem/diffsims/issues/211 by allowing the function get_kwargs to be overwritten in subclasses and change the order/what is passed to the init fuction.

Minimal example of the bug fix or new feature (This now works)

from orix.crystal_map import Phase
from orix.quaternion import Rotation
from diffsims.crystallography import ReciprocalLatticeVector

phase = Phase(point_group="m-3m")
g = ReciprocalLatticeVector(phase, [1, 1, 1])

R = Rotation.random()
g1 = R * g

# CHanges to RLV
# ---------------- 

    def get_kwargs(self, new_data, *args, **kwargs):
        return dict(phase=self.phase, xyz=new_data)

For reviewers

[ ] The PR title is short, concise, and will make sense 1 year later.
[ ] New functions are imported in corresponding __init__.py.
[ ] New features, API changes, and deprecations are mentioned in the unreleased section in CHANGELOG.rst.
[ ] Contributor(s) are listed correctly in __credits__ in orix/__init__.py and in .zenodo.json.

hakonanes commented 6 months ago

Thanks for suggesting a fix to the issue in diffsims. But, I've raised some doubts regarding our approach in the referenced issue https://github.com/pyxem/diffsims/issues/211#issuecomment-2099218511.

CSSFrancis commented 6 months ago

@hakonanes I think this should be possible. It works quite nicely with everything and makes the logic much simpler. Otherwise we end up having to struggle to track the rotation alongside the RLV from diffsims --> pyxem and it gets complicated.

pyxem / orix