template.class_template.SymmetryOrbitEQN.transform

SymmetryOrbitEQN.transform(to=None)

Method that handles all basis transformations. Undefined/trivial for Orbits with only one basis.

Parameters:

tostr

The basis to transform into. If already in said basis, returns self (not a copy!)

Returns:

Orbit

either self or instance in new basis. Returning self and not copying may have unintended consequences but typically it would not matter as orbithunter operations typically require copying numpy arrays.

Notes

Has no purpose for classes with singular basis. Convention is to return self (not a copy) if ‘to’ keyword argument equals self.basis.