API Reference

Complete API documentation for coordinax.interop.astropy.

Coordinax interoperability with Astropy.

coordinax.interop.astropy.convert_cx_cdict_to_astropy_cartrep(p: dict[str, Any], /)

Convert a CDict to an astropy CartesianRepresentation.

>>> import astropy.coordinates as apyc
>>> import coordinax.charts as cxc
>>> import unxt as u
>>> import plum

>>> p = {"x": u.Q(1, "m"), "y": u.Q(2, "m"), "z": u.Q(3, "m")}
>>> plum.convert(p, apyc.CartesianRepresentation)
<CartesianRepresentation (x, y, z) in m
    (1., 2., 3.)>

Parameters:

p (dict[str, Any])

Return type:

CartesianRepresentation

coordinax.interop.astropy.convert_cx_cdict_to_astropy_cylrep(p: dict[str, Any], /)

Convert a CDict to an astropy CylindricalRepresentation.

>>> import astropy.coordinates as apyc
>>> import coordinax.charts as cxc
>>> import unxt as u
>>> import plum

>>> p = {"rho": u.Q(1, "m"), "phi": u.Q(45, "deg"), "z": u.Q(3, "m")}
>>> plum.convert(p, apyc.CylindricalRepresentation)
<CylindricalRepresentation (rho, phi, z) in (m, deg, m)
    (1., 45., 3.)>

Parameters:

p (dict[str, Any])

Return type:

CylindricalRepresentation

coordinax.interop.astropy.convert_cx_cdict_to_astropy_physsphrep(p: dict[str, Any], /)

Convert a CDict to an astropy PhysicsSphericalRepresentation.

>>> import astropy.coordinates as apyc
>>> import coordinax.charts as cxc
>>> import unxt as u
>>> import plum

>>> p = {"phi": u.Q(45, "deg"), "theta": u.Q(30, "deg"), "r": u.Q(1, "m")}
>>> plum.convert(p, apyc.PhysicsSphericalRepresentation)
<PhysicsSphericalRepresentation (phi, theta, r) in (deg, deg, m)
    (45., 30., 1.)>

Parameters:

p (dict[str, Any])

Return type:

PhysicsSphericalRepresentation

coordinax.interop.astropy.convert_cx_cdict_to_astropy_sphrep(p: dict[str, Any], /)

Convert a CDict to an astropy SphericalRepresentation.

>>> import astropy.coordinates as apyc
>>> import coordinax.charts as cxc
>>> import unxt as u
>>> import plum

>>> p = {"lon": u.Q(45, "deg"), "lat": u.Q(30, "deg"), "distance": u.Q(1, "m")}
>>> plum.convert(p, apyc.SphericalRepresentation)
<SphericalRepresentation (lon, lat, distance) in (deg, deg, m)
    (45., 30., 1.)>

Parameters:

p (dict[str, Any])

Return type:

SphericalRepresentation