AxisymmetricKinematicData#

jeanspy.model.AxisymmetricKinematicData

See methods and properties for individual lookup pages, or the alphabetical API dictionary to search all classes. The full class contract and existing member anchors are retained below.

class jeanspy.model.AxisymmetricKinematicData(x_pc, y_pc, vlos_kms, e_vlos_kms)[source]#

Bases: object

Finite matching 1-D observations, in pc and km/s, copied on construction.

Sky x follows the line of nodes (the projected major axis for an oblate tracer); y is the perpendicular sky coordinate. Position-angle rotation and angular-to-physical conversion must be applied before constructing the data. Both signed coordinates and the projected center are supported.

Notes

Inputs and units. x_pc, y_pc, vlos_kms and e_vlos_kms are matching nonempty finite 1-D arrays; pc and km/s. from_data accepts the supported mapping/table or an existing data object.

Returns and shape. An immutable data container; as_kwargs returns the four arrays under their public names; len is N.

Validity. Signed sky coordinates include the center; velocity errors must be nonnegative.

Errors. Missing fields, mismatched shapes or invalid values raise.

Backend. NumPy host arrays.

Differentiation. No physical-parameter automatic differentiation on this API.

Examples. examples/axisymmetric_inference.py

Parameters:
x_pc: numpy.ndarray#
y_pc: numpy.ndarray#
vlos_kms: numpy.ndarray#
e_vlos_kms: numpy.ndarray#
classmethod from_data(data)[source]#

Copy a DataFrame, mapping, or another kinematic data object.

as_kwargs()[source]#

Return detached arrays for a NumPyro model or sampler call.