refactor: step 1

Signed-off-by: nstarman <[email protected]>

Author: nstarman

docs/guides/operators.md

@@ -50,12 +50,12 @@ CartesianPos3D(
 )
 ```
 
-### GalileanRotation
+### Rotate
 
 Rotates vectors in space:
 
 ```{code-block} python
->>> rot = cxo.GalileanRotation.from_euler("z", u.Quantity(90, "deg"))
+>>> rot = cxo.Rotate.from_euler("z", u.Quantity(90, "deg"))
 >>> rot(q).round(2)
 CartesianPos3D(
     x=Quantity(-2., unit='kpc'),
@@ -73,7 +73,7 @@ Operators can be composed using the {class}`~coordinax.ops.Pipe` class or the
 
 ```{code-block} python
 >>> op1 = cxo.GalileanSpatialTranslation.from_([1, 0, 0], "kpc")
->>> op2 = cxo.GalileanRotation.from_euler("z", u.Quantity(90, "deg"))
+>>> op2 = cxo.Rotate.from_euler("z", u.Quantity(90, "deg"))
 >>> pipe = cxo.Pipe([op1, op2])
 >>> pipe(q).round(2)
 CartesianPos3D(
@@ -106,7 +106,7 @@ CartesianPos3D(
 
 - {class}`~coordinax.ops.simplify_op`: Simplifies composed operators when
   possible.
-- {class}`~coordinax.ops.convert_to_pipe_operators`: Utility to convert a list
+- {class}`~coordinax.ops.convert_to_operator_tuple`: Utility to convert a list
   of operators into a {class}`~coordinax.ops.Pipe`.
 
 ---

src/coordinax/_coordinax_space_frames/frame_transforms.py

@@ -1,7 +1,7 @@
 """Astronomy reference frames."""
 # ruff:noqa: N806
 
-__all__: list[str] = []
+__all__: tuple[str, ...] = ()
 
 
 from typing import TypeAlias
@@ -16,14 +16,7 @@
 from .galactocentric import Galactocentric
 from .icrs import ICRS
 from coordinax._src.distances import Distance
-from coordinax._src.operators import (
-    GalileanRotation,
-    GalileanSpatialTranslation,
-    Identity,
-    Pipe,
-    VelocityBoost,
-    simplify_op,
-)
+from coordinax._src.operators import Add, Identity, Pipe, Rotate, simplify_op
 
 ScalarAngle: TypeAlias = Shaped[u.Quantity["angle"] | u.Angle, ""]
 RotationMatrix: TypeAlias = Shaped[Array, "3 3"]
@@ -54,7 +47,7 @@ def frame_transform_op(
 
     >>> @dispatch
     ... def frame_transform_op(from_frame: MySpaceFrame, to_frame: ICRS, /) -> cx.ops.AbstractOperator:
-    ...     return cx.ops.GalileanRotation.from_euler("z", u.Quantity(10, "deg"))
+    ...     return cx.ops.Rotate.from_euler("z", u.Quantity(10, "deg"))
 
     We can transform from `MySpaceFrame` to a Galacocentric frame, even though
     we don't have a direct transformation defined:
@@ -65,7 +58,7 @@ def frame_transform_op(
     >>> op = cx.frames.frame_transform_op(my_frame, gcf_frame)
     >>> op
     Pipe((
-        GalileanRotation(rotation=f32[3,3]),
+        Rotate(rotation=f32[3,3]),
         ...
     ))
 
@@ -116,14 +109,14 @@ def frame_transform_op(from_frame: Galactocentric, to_frame: Galactocentric, /)
     >>> frame_op2 = cxf.frame_transform_op(gcf_frame, gcf_frame2)
     >>> frame_op2
     Pipe((
-        VelocityBoost(CartesianVel3D( ... )),
-        GalileanRotation(rotation=f32[3,3]),
-        GalileanSpatialTranslation(CartesianPos3D( ... )),
-        GalileanRotation(rotation=f32[3,3]),
-        GalileanRotation(rotation=f32[3,3]),
-        GalileanSpatialTranslation(CartesianPos3D( ... )),
-        GalileanRotation(rotation=f32[3,3]),
-        VelocityBoost(CartesianVel3D( ... ))
+        Add(CartesianVel3D( ... )),
+        Rotate(rotation=f32[3,3]),
+        Add(CartesianPos3D( ... )),
+        Rotate(rotation=f32[3,3]),
+        Rotate(rotation=f32[3,3]),
+        Add(CartesianPos3D( ... )),
+        Rotate(rotation=f32[3,3]),
+        Add(CartesianVel3D( ... ))
     ))
 
     """
@@ -193,10 +186,10 @@ def frame_transform_op(from_frame: ICRS, to_frame: Galactocentric, /) -> Pipe:
     >>> frame_op = cx.frames.frame_transform_op(icrs_frame, gcf_frame)
     >>> frame_op
     Pipe((
-        GalileanRotation(rotation=f32[3,3]),
-        GalileanSpatialTranslation(CartesianPos3D( ... )),
-        GalileanRotation(rotation=f32[3,3]),
-        VelocityBoost(CartesianVel3D( ... ))
+        Rotate(rotation=f32[3,3]),
+        Add(CartesianPos3D( ... )),
+        Rotate(rotation=f32[3,3]),
+        Add(CartesianVel3D( ... ))
     ))
 
     Apply the transformation:
@@ -238,25 +231,23 @@ def frame_transform_op(from_frame: ICRS, to_frame: Galactocentric, /) -> Pipe:
 
     """  # noqa: E501
     # rotation matrix to align x(ICRS) with the vector to the Galactic center
-    rot_lat = GalileanRotation.from_euler("y", to_frame.galcen.lat)
-    rot_lon = GalileanRotation.from_euler("z", -to_frame.galcen.lon)
+    rot_lat = Rotate.from_euler("y", to_frame.galcen.lat)
+    rot_lon = Rotate.from_euler("z", -to_frame.galcen.lon)
     # extra roll away from the Galactic x-z plane
-    roll = GalileanRotation.from_euler("x", to_frame.roll - to_frame.roll0)
+    roll = Rotate.from_euler("x", to_frame.roll - to_frame.roll0)
     # construct transformation matrix
     R = (roll @ rot_lat @ rot_lon).simplify()
 
     # Translation by Sun-Galactic center distance around x' and rotate about y'
     # to account for tilt due to Sun's height above the plane
     z_d = u.ustrip("", to_frame.z_sun / to_frame.galcen.distance)  # [radian]
-    H = GalileanRotation.from_euler("y", u.Quantity(jnp.asin(z_d), "rad"))
+    H = Rotate.from_euler("y", u.Quantity(jnp.asin(z_d), "rad"))
 
     # Post-rotation spatial offset to Galactic center.
-    offset_q = GalileanSpatialTranslation(
-        -to_frame.galcen.distance * jnp.asarray([1, 0, 0])
-    )
+    offset_q = Add(-to_frame.galcen.distance * jnp.asarray([1, 0, 0]))
 
     # Post-rotation velocity offset
-    offset_v = VelocityBoost(to_frame.galcen_v_sun)
+    offset_v = Add(to_frame.galcen_v_sun)
 
     # Total Operator
     return R | offset_q | H | offset_v

src/coordinax/_src/frames/example.py

@@ -11,13 +11,7 @@
 
 from .base import AbstractReferenceFrame
 from coordinax._src.frames import api
-from coordinax._src.operators import (
-    GalileanBoost,
-    GalileanRotation,
-    GalileanSpatialTranslation,
-    Identity,
-    Pipe,
-)
+from coordinax._src.operators import Add, Identity, Pipe, Rotate
 
 
 @final
@@ -34,9 +28,9 @@ class Alice(AbstractReferenceFrame):
     >>> op = cxf.frame_transform_op(alice, bob)
     >>> print(op)
     Pipe((
-      GalileanSpatialTranslation(<CartesianPos3D: (x, y, z) [km]
+      Add(<CartesianPos3D: (x, y, z) [km]
           [100000  10000      0]>),
-      GalileanBoost(<CartesianVel3D: (x, y, z) [m / s]
+      Add(<CartesianVel3D: (x, y, z) [m / s]
           [2.698e+08 0.000e+00 0.000e+00]>)
     ))
 
@@ -62,9 +56,9 @@ class Bob(AbstractReferenceFrame):
     >>> op = cxf.frame_transform_op(alice, bob)
     >>> print(op)
     Pipe((
-      GalileanSpatialTranslation(<CartesianPos3D: (x, y, z) [km]
+      Add(<CartesianPos3D: (x, y, z) [km]
           [100000  10000      0]>),
-      GalileanBoost(<CartesianVel3D: (x, y, z) [m / s]
+      Add(<CartesianVel3D: (x, y, z) [m / s]
           [2.698e+08 0.000e+00 0.000e+00]>)
     ))
 
@@ -117,9 +111,9 @@ def frame_transform_op(from_frame: Alice, to_frame: FriendOfAlice, /) -> Pipe:
     >>> op = cx.frames.frame_transform_op(alice, friend)
     >>> print(op)
     Pipe((
-      GalileanSpatialTranslation(<CartesianPos3D: (x, y, z) [m]
+      Add(<CartesianPos3D: (x, y, z) [m]
           [10  0  0]>),
-      GalileanRotation([[ 0.         -0.99999994  0.        ]
+      Rotate([[ 0.         -0.99999994  0.        ]
                         [ 0.99999994  0.          0.        ]
                         [ 0.          0.          0.99999994]])
     ))
@@ -133,8 +127,8 @@ def frame_transform_op(from_frame: Alice, to_frame: FriendOfAlice, /) -> Pipe:
      ))
 
     """
-    shift = GalileanSpatialTranslation.from_([10, 0, 0], "m")
-    rotation = GalileanRotation.from_euler("Z", u.Quantity(90, "deg"))
+    shift = Add.from_([10, 0, 0], "m")
+    rotation = Rotate.from_euler("Z", u.Quantity(90, "deg"))
     return shift | rotation
 
 
@@ -154,9 +148,9 @@ def frame_transform_op(from_frame: Alice, to_frame: Bob, /) -> Pipe:
     >>> op = cxf.frame_transform_op(alice, bob)
     >>> print(op)
     Pipe((
-      GalileanSpatialTranslation(<CartesianPos3D: (x, y, z) [km]
+      Add(<CartesianPos3D: (x, y, z) [km]
           [100000  10000      0]>),
-      GalileanBoost(<CartesianVel3D: (x, y, z) [m / s]
+      Add(<CartesianVel3D: (x, y, z) [m / s]
           [2.698e+08 0.000e+00 0.000e+00]>)
     ))
 
@@ -175,8 +169,8 @@ def frame_transform_op(from_frame: Alice, to_frame: Bob, /) -> Pipe:
     ))
 
     """
-    shift = GalileanSpatialTranslation.from_([100_000, 10_000, 0], "km")
-    boost = GalileanBoost.from_([269_813_212.2, 0, 0], "m/s")
+    shift = Add.from_([100_000, 10_000, 0], "km")
+    boost = Add.from_([269_813_212.2, 0, 0], "m/s")
     return shift | boost
 
 
@@ -200,10 +194,10 @@ def frame_transform_op(
     >>> op = cx.frames.frame_transform_op(friend, alice)
     >>> print(op)
     Pipe((
-      GalileanRotation([[ 0.          0.99999994  0.        ]
+      Rotate([[ 0.          0.99999994  0.        ]
                         [-0.99999994  0.          0.        ]
                         [ 0.          0.          0.99999994]]),
-      GalileanSpatialTranslation(<CartesianPos3D: (x, y, z) [m]
+      Add(<CartesianPos3D: (x, y, z) [m]
           [-10   0   0]>)
     ))
 

src/coordinax/_src/frames/register_ops.py

@@ -1,16 +1,18 @@
 """Register for `coordinax.ops`."""
 
-__all__: list[str] = []
+__all__: tuple[str, ...] = ()
 
 
+from plum import dispatch
+
 from dataclassish import replace
 
 from .coordinate import Coordinate
 from coordinax._src.operators import AbstractOperator
 
 
-@AbstractOperator.__call__.dispatch  # type: ignore[misc]
-def call(self: AbstractOperator, x: Coordinate, /) -> Coordinate:
+@dispatch
+def operate(self: AbstractOperator, obj: Coordinate, /) -> Coordinate:
     """Apply the operator to a coordinate.
 
     Examples
@@ -34,4 +36,4 @@ def call(self: AbstractOperator, x: Coordinate, /) -> Coordinate:
 
     """
     # TODO: take the frame into account
-    return replace(x, data=self(x.data))
+    return replace(obj, data=self(obj.data))

src/coordinax/_src/frames/xfm.py

@@ -36,11 +36,11 @@ class TransformedReferenceFrame(AbstractReferenceFrame, Generic[FrameT]):
     >>> import coordinax as cx
     >>> import coordinax.frames as cxf
 
-    >>> R = cx.ops.GalileanRotation([[0., -1, 0], [1, 0, 0], [0, 0, 1]])
+    >>> R = cx.ops.Rotate([[0., -1, 0], [1, 0, 0], [0, 0, 1]])
     >>> frame = cxf.TransformedReferenceFrame(cxf.ICRS(), R)
     >>> frame
     TransformedReferenceFrame(
-      base_frame=ICRS(), xop=GalileanRotation(rotation=f32[3,3])
+      base_frame=ICRS(), xop=Rotate(rotation=f32[3,3])
     )
 
     Let's transform a position from the base frame to the transformed frame:
@@ -93,11 +93,11 @@ def frame_transform_op(
     >>> import coordinax as cx
     >>> import coordinax.frames as cxf
 
-    >>> R = cx.ops.GalileanRotation([[0., -1, 0], [1, 0, 0], [0, 0, 1]])
+    >>> R = cx.ops.Rotate([[0., -1, 0], [1, 0, 0], [0, 0, 1]])
     >>> frame = cxf.TransformedReferenceFrame(cxf.ICRS(), R)
     >>> frame
     TransformedReferenceFrame(
-      base_frame=ICRS(), xop=GalileanRotation(rotation=f32[3,3])
+      base_frame=ICRS(), xop=Rotate(rotation=f32[3,3])
     )
 
     Let's transform a position from the base frame to the transformed frame:
@@ -126,11 +126,11 @@ def frame_transform_op(
     >>> import coordinax as cx
     >>> import coordinax.frames as cxf
 
-    >>> R = cx.ops.GalileanRotation([[0., -1, 0], [1, 0, 0], [0, 0, 1]])
+    >>> R = cx.ops.Rotate([[0., -1, 0], [1, 0, 0], [0, 0, 1]])
     >>> frame = cxf.TransformedReferenceFrame(cxf.ICRS(), R)
     >>> frame
     TransformedReferenceFrame(
-      base_frame=ICRS(), xop=GalileanRotation(rotation=f32[3,3])
+      base_frame=ICRS(), xop=Rotate(rotation=f32[3,3])
     )
 
     Let's transform a position from the base frame to the transformed frame:
@@ -159,7 +159,7 @@ def frame_transform_op(
     >>> import coordinax as cx
     >>> import coordinax.frames as cxf
 
-    >>> R = cx.ops.GalileanRotation([[0., -1, 0], [1, 0, 0], [0, 0, 1]])
+    >>> R = cx.ops.Rotate([[0., -1, 0], [1, 0, 0], [0, 0, 1]])
     >>> frame1 = cxf.TransformedReferenceFrame(cxf.ICRS(), R)
 
     >>> shift = cx.ops.GalileanSpatialTranslation.from_([1, 0, 0], "kpc")

src/coordinax/_src/operators/__init__.py

@@ -1,40 +1,29 @@
 """Coordinax Operator package."""
-# ruff: noqa: F401
 
 __all__ = [
+    # Functional API
+    "operate",
     "simplify_op",
     # Classes
     "AbstractOperator",
-    "Identity",
     "AbstractCompositeOperator",
     "Pipe",
-    # Galilean
-    "AbstractGalileanOperator",
-    "GalileanBoost",
-    "GalileanOperator",
-    "GalileanRotation",
-    "GalileanSpatialTranslation",
-    "GalileanTranslation",
-    # Misc
-    "VelocityBoost",
-    # Utils
-    "convert_to_pipe_operators",
+    "Identity",
+    "Rotate",
+    "Add",
+    "GalileanOp",
 ]
 
-from .api import simplify_op
+from .api import operate, simplify_op
 from .base import AbstractOperator
-from .boost import VelocityBoost
 from .composite import AbstractCompositeOperator
-from .galilean.base import AbstractGalileanOperator
-from .galilean.boost import GalileanBoost
-from .galilean.composite import GalileanOperator
-from .galilean.rotation import GalileanRotation
-from .galilean.spatial_translation import GalileanSpatialTranslation
-from .galilean.translation import GalileanTranslation
+from .galilean import GalileanOp
 from .identity import Identity
-from .pipe import Pipe, convert_to_pipe_operators
+from .pipe import Pipe
+from .rotate import Rotate
+from .translate import Add
 
-# isort: split
-from . import compat, register_simplify
+# # isort: split
+# from . import compat, register_simplify
 
-del register_simplify, compat
+# del register_simplify, compat