xradio 0.0.46__py3-none-any.whl → 0.0.48__py3-none-any.whl

xradio/measurement_set/schema.py

@@ -12,7 +12,7 @@ import numpy
 # Dimensions
 Time = Literal["time"]
 """ Observation time dimension """
-TimeCal = Literal["time_cal"]
+TimeSystemCal = Literal["time_system_cal"]
 """ time dimension of system calibration (when not interpolated to main time)"""
 TimeEphemeris = Literal["time_ephemeris"]
 """ time dimension of ephemeris data (when not interpolated to main time) """
@@ -34,7 +34,7 @@ BaselineId = Literal["baseline_id"]
 """ Baseline ID dimension """
 Frequency = Literal["frequency"]
 """ Frequency dimension """
-FrequencyCal = Literal["frequency_cal"]
+FrequencySystemCal = Literal["frequency_system_cal"]
 """ Frequency dimension in the system calibration dataset """
 Polarization = Literal["polarization"]
 """ Polarization dimension """
@@ -60,6 +60,8 @@ PolyTerm = Literal["poly_term"]
 """ Polynomial term used in VLBI GAIN_CURVE """
 LineLabel = Literal["line_label"]
 """ Line labels (for line names and variables). """
+FieldName = Literal["field_name"]
+""" Field names dimension. """
 
 # Represents "no dimension", i.e. used for coordinates and data variables with
 # zero dimensions.
@@ -379,7 +381,7 @@ class TimeInterpolatedCoordArray:
     Data model of a time axis when it is interpolated to match the time
     axis of the main dataset. This can be used in the system_calibration_xds,
     pointing_xds, weather_xds, field_and_source_info_xds, and phase_cal_xds
-    when their respective time_cal, time_pointing, time_weather,
+    when their respective time_system_cal, time_pointing, time_weather,
     time_ephemeris or time_phase_cal are interpolated to the main dataset
     time. See also :py:class:`TimeArray`.
 
@@ -407,19 +409,19 @@ class TimeInterpolatedCoordArray:
 
 
 @xarray_dataarray_schema
-class TimeCalCoordArray:
-    """Data model of 'time_cal' axis (time axis in system_calibration_xds
+class TimeSystemCalCoordArray:
+    """Data model of 'time_system_cal' axis (time axis in system_calibration_xds
     subdataset when not interpolated to the main time axis. See also
     :py:class:`TimeCoordArray`."""
 
-    data: Data[TimeCal, float]
+    data: Data[TimeSystemCal, float]
     """
     Time, expressed in seconds since the epoch (see ``scale`` &
     ``format``).
     """
 
-    type: Attr[Time] = "time_cal"
-    """ Coordinate type. Should be ``"time_cal"``. """
+    type: Attr[Time] = "time_system_cal"
+    """ Coordinate type. Should be ``"time_system_cal"``. """
 
     units: Attr[UnitsSeconds] = ("s",)
     """ Units to associate with axis"""
@@ -627,7 +629,7 @@ class EllipsoidPosLocationArray:
 
 @xarray_dataarray_schema
 class BaselineArray:
-    """Model of the baseline_id coordinate in the main dataset (interferometric data, :py:class:`VisibiiltyXds`)"""
+    """Model of the baseline_id coordinate in the main dataset (interferometric data, :py:class:`VisibilityXds`)"""
 
     data: Data[BaselineId, Union[numpy.int64, numpy.int32]]
     """Unique id for each baseline."""
@@ -718,11 +720,11 @@ class FrequencyArray:
 
 
 @xarray_dataarray_schema
-class FrequencyCalArray:
-    """The frequency_cal coordinate of the system calibration dataset. It has
+class FrequencySystemCalArray:
+    """The frequency_system_cal coordinate of the system calibration dataset. It has
     only measures data, as opposed to the frequency array of the main dataset."""
 
-    data: Data[FrequencyCal, float]
+    data: Data[FrequencySystemCal, float]
     """ Center frequencies for each channel. """
 
     type: Attr[SpectralCoord] = "spectral_coord"
@@ -961,7 +963,7 @@ class FreqSamplingArray:
     """
 
 
-# Define FieldAndSourceXds dataset already here, as it is needed in the
+# Define FieldAndSourceXds and FieldSourceEphemerisXds already here, as they are needed in the
 # definition of VisibilityArray
 @xarray_dataset_schema
 class FieldSourceXds:
@@ -972,34 +974,16 @@ class FieldSourceXds:
     For single dishes, this is the nominal pointing direction.
     """
 
-    source_name: Optional[Coord[Union[ZD, Time], str]]
+    source_name: Coord[FieldName, str]
     """ Source name. """
-    field_name: Optional[Coord[Union[ZD, Time], str]]
-    """Field name."""
-
-    time: Optional[Coordof[TimeInterpolatedCoordArray]]
-    """Midpoint of time for which this set of parameters is accurate. Labeled 'time' when interpolated to main time """
-    time_ephemeris: Optional[Coordof[TimeEphemerisCoordArray]]
-    """Midpoint of time for which this set of parameters is accurate. Labeled 'time_ephemeris' when not interpolating to main time """
 
-    line_label: Optional[Coord[LineLabel, str]]
-    """ Line labels (for line names and variables). """
+    field_name: Coord[FieldName, str]
+    """Field name."""
 
-    line_names: Optional[
-        Coord[
-            Union[
-                tuple[LineLabel],
-                tuple[Time, LineLabel],
-                tuple[TimeEphemeris, LineLabel],
-            ],
-            str,
-        ]
-    ]
-    """ Line names (e.g. v=1, J=1-0, SiO). """
+    sky_dir_label: Coord[SkyDirLabel, str]
+    """ Coordinate labels of sky directions (typically shape 2 and 'ra', 'dec') """
 
-    FIELD_PHASE_CENTER: Optional[
-        Data[Union[ZD, tuple[Time], tuple[TimeEphemeris]], SkyCoordArray]
-    ]
+    FIELD_PHASE_CENTER: Optional[Data[FieldName, SkyCoordArray]]
     """
     Offset from the SOURCE_DIRECTION that gives the direction of phase
     center for which the fringes have been stopped-that is a point source in
@@ -1009,25 +993,14 @@ class FieldSourceXds:
     varies with field, it refers DelayDir_Ref column instead.
     """
 
-    FIELD_REFERENCE_CENTER: Optional[
-        Data[Union[ZD, tuple[Time], tuple[TimeEphemeris]], SkyCoordArray]
-    ]
+    FIELD_REFERENCE_CENTER: Optional[Data[FieldName, SkyCoordArray]]
     """
     Used in single-dish to record the associated reference direction if positionswitching
     been applied. For conversion from MSv2, frame refers column keywords by default. If
     frame varies with field, it refers DelayDir_Ref column instead.
     """
 
-    SOURCE_LOCATION: Optional[
-        Data[
-            Union[
-                ZD,
-                tuple[Time],
-                tuple[TimeEphemeris],
-            ],
-            SkyCoordArray,
-        ]
-    ]
+    SOURCE_LOCATION: Optional[Data[FieldName, SkyCoordArray]]
     """
     CASA Table Cols: RA,DEC,Rho."Astrometric RA and Dec and Geocentric
     distance with respect to the observer’s location (Geocentric). "Adjusted
@@ -1040,11 +1013,7 @@ class FieldSourceXds:
 
     LINE_REST_FREQUENCY: Optional[
         Data[
-            Union[
-                tuple[LineLabel],
-                tuple[Time, LineLabel],
-                tuple[TimeEphemeris, LineLabel],
-            ],
+            tuple[FieldName, LineLabel],
             SpectralCoordArray,
         ]
     ]
@@ -1052,37 +1021,118 @@ class FieldSourceXds:
 
     LINE_SYSTEMIC_VELOCITY: Optional[
         Data[
-            Union[
-                tuple[LineLabel],
-                tuple[Time, LineLabel],
-                tuple[TimeEphemeris, LineLabel],
-            ],
+            tuple[FieldName, LineLabel],
             QuantityInMetersPerSecondArray,
         ]
     ]
     """ Systemic velocity at reference """
 
-    SOURCE_RADIAL_VELOCITY: Optional[
+    OBSERVER_POSITION: Optional[Data[ZD, LocationArray]]
+    """ Observer location. """
+
+    # --- Attributes ---
+    doppler_shift_velocity: Optional[Attr[UnitsOfDopplerShift]]
+    """ Velocity definition of the Doppler shift, e.g., RADIO or OPTICAL velocity in m/s """
+
+    source_model_url: Optional[Attr[str]]
+    """URL to access source model"""
+
+    type: Attr[Literal["field_and_source"]] = "field_and_source"
+    """
+    Type of dataset.
+    """
+
+    # --- Optional coordinates ---
+    cartesian_pos_label: Optional[Coord[CartesianPosLabel, str]] = ("x", "y", "z")
+    """ Coordinate labels of geocentric earth location data (typically shape 3 and 'x', 'y', 'z')"""
+
+    line_label: Optional[Coord[LineLabel, str]] = ()
+    """ Line labels (for line names and variables). """
+
+    line_names: Optional[Coord[tuple[FieldName, LineLabel], str]] = ()
+    """ Line names (e.g. v=1, J=1-0, SiO). """
+
+
+@xarray_dataset_schema
+class FieldSourceEphemerisXds:
+    """
+    Field positions for each source, when the source have ephemeris information.
+
+    Defines a field position on the sky. For interferometers, this is the correlated field position.
+    For single dishes, this is the nominal pointing direction.
+    """
+
+    source_name: Coord[Time, str]
+    """ Source name. """
+
+    field_name: Coord[Time, str]
+    """Field name."""
+
+    time: Coordof[TimeInterpolatedCoordArray]
+    """Midpoint of time for which this set of parameters is accurate. Labeled 'time' when interpolated to main time """
+
+    FIELD_PHASE_CENTER: Optional[Data[tuple[Time], SkyCoordArray]]
+    """
+    Offset from the SOURCE_DIRECTION that gives the direction of phase
+    center for which the fringes have been stopped-that is a point source in
+    this direction will produce a constant measured phase (page 2 of
+    https://articles.adsabs.harvard.edu/pdf/1999ASPC..180...79F). For
+    conversion from MSv2, frame refers column keywords by default. If frame
+    varies with field, it refers DelayDir_Ref column instead.
+    """
+
+    FIELD_REFERENCE_CENTER: Optional[Data[tuple[Time], SkyCoordArray]]
+    """
+    Used in single-dish to record the associated reference direction if positionswitching
+    been applied. For conversion from MSv2, frame refers column keywords by default. If
+    frame varies with field, it refers DelayDir_Ref column instead.
+    """
+
+    LINE_REST_FREQUENCY: Optional[Data[tuple[Time, LineLabel], SpectralCoordArray]]
+    """ Rest frequencies for the transitions. """
+
+    LINE_SYSTEMIC_VELOCITY: Optional[
+        Data[tuple[Time, LineLabel], QuantityInMetersPerSecondArray]
+    ]
+    """ Systemic velocity at reference """
+
+    SOURCE_LOCATION: Optional[
         Data[
-            Union[ZD, tuple[Time], tuple[TimeEphemeris]], QuantityInMetersPerSecondArray
+            Union[
+                tuple[Time],
+                tuple[TimeEphemeris],
+            ],
+            SkyCoordArray,
         ]
     ]
+    """
+    CASA Table Cols: RA,DEC,Rho."Astrometric RA and Dec and Geocentric
+    distance with respect to the observer’s location (Geocentric). "Adjusted
+    for light-time aberration only. With respect to the reference plane and
+    equinox of the chosen system (ICRF or FK4/B1950). If the FK4/B1950 frame
+    output is selected, elliptic aberration terms are added. Astrometric RA/DEC
+    is generally used when comparing or reducing data against a star catalog."
+    https://ssd.jpl.nasa.gov/horizons/manual.html : 1. Astrometric RA & DEC
+    """
+
+    SOURCE_RADIAL_VELOCITY: Optional[
+        Data[Union[tuple[Time], tuple[TimeEphemeris]], QuantityInMetersPerSecondArray]
+    ]
     """ CASA Table Cols: RadVel. Geocentric distance rate """
 
     NORTH_POLE_POSITION_ANGLE: Optional[
-        Data[Union[ZD, tuple[Time], tuple[TimeEphemeris]], QuantityInRadiansArray]
+        Data[Union[tuple[Time], tuple[TimeEphemeris]], QuantityInRadiansArray]
     ]
     """ CASA Table cols: NP_ang, "Targets' apparent north-pole position angle (counter-clockwise with respect to direction of true-of-date reference-frame north pole) and angular distance from the sub-observer point (center of disc) at print time. A negative distance indicates the north-pole is on the hidden hemisphere." https://ssd.jpl.nasa.gov/horizons/manual.html : 17. North pole position angle & distance from disc center. """
 
     NORTH_POLE_ANGULAR_DISTANCE: Optional[
-        Data[Union[ZD, tuple[Time], tuple[TimeEphemeris]], QuantityInRadiansArray]
+        Data[Union[tuple[Time], tuple[TimeEphemeris]], QuantityInRadiansArray]
     ]
     """ CASA Table cols: NP_dist, "Targets' apparent north-pole position angle (counter-clockwise with respect to direction of true-of date reference-frame north pole) and angular distance from the sub-observer point (center of disc) at print time. A negative distance indicates the north-pole is on the hidden hemisphere."https://ssd.jpl.nasa.gov/horizons/manual.html : 17. North pole position angle & distance from disc center. """
 
     SUB_OBSERVER_DIRECTION: Optional[
         Data[
             Union[
-                ZD,
                 tuple[Time],
                 tuple[TimeEphemeris],
             ],
@@ -1094,7 +1144,6 @@ class FieldSourceXds:
     SUB_SOLAR_POSITION: Optional[
         Data[
             Union[
-                ZD,
                 tuple[Time],
                 tuple[TimeEphemeris],
             ],
@@ -1104,14 +1153,12 @@ class FieldSourceXds:
     """ CASA Table cols: Sl_lon, Sl_lat, r. "Heliocentric distance along with "Apparent sub-solar longitude and latitude of the Sun on the target. The apparent planetodetic longitude and latitude of the center of the target disc as seen from the Sun, as seen by the observer at print-time.  This is _NOT_ exactly the same as the "sub-solar" (nearest) point for a non-spherical target shape (since the center of the disc seen from the Sun might not be the closest point to the Sun), but is very close if not a highly irregular body shape.  Light travel-time from Sun to target and from target to observer is taken into account.  Latitude is the angle between the equatorial plane and the line perpendicular to the reference ellipsoid of the body. The reference ellipsoid is an oblate spheroid with a single flatness coefficient in which the y-axis body radius is taken to be the same value as the x-axis radius. Uses IAU2009 rotation models except for Earth and Moon, which uses a higher precision models. Values for Jupiter, Saturn, Uranus and Neptune are Set III, referring to rotation of their magnetic fields.  Whether longitude is positive to the east or west for the target will be indicated at the end of the output ephemeris." https://ssd.jpl.nasa.gov/horizons/manual.html : 15. Solar sub-longitude & sub-latitude  """
 
     HELIOCENTRIC_RADIAL_VELOCITY: Optional[
-        Data[
-            Union[ZD, tuple[Time], tuple[TimeEphemeris]], QuantityInMetersPerSecondArray
-        ]
+        Data[Union[tuple[Time], tuple[TimeEphemeris]], QuantityInMetersPerSecondArray]
     ]
     """ CASA Table cols: rdot."The Sun's apparent range-rate relative to the target, as seen by the observer. A positive "rdot" means the target was moving away from the Sun, negative indicates movement toward the Sun." https://ssd.jpl.nasa.gov/horizons/manual.html : 19. Solar range & range-rate (relative to target) """
 
     OBSERVER_PHASE_ANGLE: Optional[
-        Data[Union[ZD, tuple[Time], tuple[TimeEphemeris]], QuantityInRadiansArray]
+        Data[Union[tuple[Time], tuple[TimeEphemeris]], QuantityInRadiansArray]
     ]
     """ CASA Table cols: phang.""phi" is the true PHASE ANGLE at the observers' location at print time. "PAB-LON" and "PAB-LAT" are the FK4/B1950 or ICRF/J2000 ecliptic longitude and latitude of the phase angle bisector direction; the outward directed angle bisecting the arc created by the apparent vector from Sun to target center and the astrometric vector from observer to target center. For an otherwise uniform ellipsoid, the time when its long-axis is perpendicular to the PAB direction approximately corresponds to lightcurve maximum (or maximum brightness) of the body. PAB is discussed in Harris et al., Icarus 57, 251-258 (1984)." https://ssd.jpl.nasa.gov/horizons/manual.html : Phase angle and bisector """
 
@@ -1124,15 +1171,15 @@ class FieldSourceXds:
 
     source_model_url: Optional[Attr[str]]
     """URL to access source model"""
+
     ephemeris_name: Optional[Attr[str]]
     """The name of the ephemeris. For example DE430.
 
     This can be used with Astropy solar_system_ephemeris.set('DE430'), see
     https://docs.astropy.org/en/stable/coordinates/solarsystem.html.
     """
-    is_ephemeris: Attr[bool] = False
 
-    type: Attr[Literal["field_and_source"]] = "field_and_source"
+    type: Attr[Literal["field_and_source_ephemeris"]] = "field_and_source_ephemeris"
     """
     Type of dataset.
     """
@@ -1151,6 +1198,15 @@ class FieldSourceXds:
     cartesian_pos_label: Optional[Coord[CartesianPosLabel, str]] = ("x", "y", "z")
     """ Coordinate labels of geocentric earth location data (typically shape 3 and 'x', 'y', 'z')"""
 
+    line_label: Optional[Coord[LineLabel, str]] = ()
+    """ Line labels (for line names and variables). """
+
+    line_names: Optional[Coord[tuple[FieldName, LineLabel], str]] = ()
+    """ Line names (e.g. v=1, J=1-0, SiO). """
+
+    time_ephemeris: Optional[Coordof[TimeEphemerisCoordArray]] = ()
+    """Midpoint of time for which this set of parameters is accurate. Labeled 'time_ephemeris' when not interpolating to main time """
+
 
 @xarray_dataarray_schema
 class SpectrumArray:
@@ -1166,7 +1222,9 @@ class SpectrumArray:
     frequency: Coordof[FrequencyArray]
     polarization: Coordof[PolarizationArray]
 
-    field_and_source_xds: Attr[FieldSourceXds]
+    field_and_source_xds: Attr[Union[FieldSourceXds, FieldSourceEphemerisXds]]
+    """ Field and source information. Also alows for variant where ephemeris information is included. """
+
     long_name: Optional[Attr[str]] = "Spectrum values"
     """ Long-form name to use for axis. Should be ``"Spectrum values"``"""
     units: Attr[list[str]] = ("Jy",)
@@ -1186,7 +1244,9 @@ class VisibilityArray:
     polarization: Coordof[PolarizationArray]
     frequency: Coordof[FrequencyArray]
 
-    field_and_source_xds: Attr[FieldSourceXds]
+    field_and_source_xds: Attr[Union[FieldSourceXds, FieldSourceEphemerisXds]]
+    """ Field and source information. Also alows for variant where ephemeris information is included. """
+
     long_name: Optional[Attr[str]] = "Visibility values"
     """ Long-form name to use for axis. Should be ``"Visibility values"``"""
     units: Attr[list[str]] = ("Jy",)
@@ -1207,8 +1267,8 @@ class PartitionInfoDict:
     """ List of all field names """
     polarization_setup: list[str]
     """ List of polrization bases. """
-    scan_number: list[int]
-    """ List of scan numbers. """
+    scan_name: list[str]
+    """ List of scan names. """
     source_name: list[str]
     """ List of source names. """
     # source_id: mising / remove for good?
@@ -1221,6 +1281,8 @@ class PartitionInfoDict:
     """ The taql query used if converted from MSv2. """
     line_name: list[str]
     """ Spectral line names """
+    antenna_name: Optional[str]
+    """ Name of antenna when partitioning also by antenna (single-dish). """
 
 
 @dict_schema
@@ -1368,7 +1430,7 @@ class GainCurveXds:
     """ Useful when data is combined from mutiple arrays for example ACA + ALMA. """
     receptor_label: Coord[ReceptorLabel, str]
     """ Names of receptors """
-    polarization_type: Optional[Coord[tuple[AntennaName, ReceptorLabel], str]]
+    polarization_type: Coord[tuple[AntennaName, ReceptorLabel], str]
     """ Polarization type to which each receptor responds (e.g. ”R”,”L”,”X” or ”Y”).
     This is the receptor polarization type as recorded in the final correlated data (e.g. ”RR”); i.e.
     as measured after all polarization combiners. ['X','Y'], ['R','L'] """
@@ -1425,7 +1487,7 @@ class PhaseCalibrationXds:
     """ Useful when data is combined from mutiple arrays for example ACA + ALMA. """
     receptor_label: Coord[ReceptorLabel, str]
     """ Names of receptors """
-    polarization_type: Optional[Coord[tuple[AntennaName, ReceptorLabel], str]]
+    polarization_type: Coord[tuple[AntennaName, ReceptorLabel], str]
     """ Polarization type to which each receptor responds (e.g. ”R”,”L”,”X” or ”Y”).
     This is the receptor polarization type as recorded in the final correlated data (e.g. ”RR”); i.e.
     as measured after all polarization combiners. ['X','Y'], ['R','L'] """
@@ -1516,7 +1578,7 @@ class WeatherXds:
             QuantityInPerSquareMetersArray,
         ]
     ] = None
-    """ Average column density of water """
+    """ Average column density of water, in zenith direction (rather than line of sight) """
     IONOS_ELECTRON: Optional[
         Data[
             Union[
@@ -1526,7 +1588,7 @@ class WeatherXds:
             QuantityInPerSquareMetersArray,
         ]
     ] = None
-    """ Average column density of electrons """
+    """ Average column density of electrons, in zenith direction (rather than line of sight) """
     PRESSURE: Optional[
         Data[
             Union[
@@ -1705,21 +1767,26 @@ class SystemCalibrationXds:
     # Coordinates
     antenna_name: Coordof[AntennaNameArray]
     """ Antenna identifier """
-    receptor_label: Coord[ReceptorLabel, numpy.int64]
+    receptor_label: Coord[ReceptorLabel, str]
+    """ Names of receptors """
+    polarization_type: Coord[tuple[AntennaName, ReceptorLabel], str]
+    """ Polarization type to which each receptor responds (e.g. ”R”,”L”,”X” or ”Y”).
+    This is the receptor polarization type as recorded in the final correlated data (e.g. ”RR”); i.e.
+    as measured after all polarization combiners. ['X','Y'], ['R','L'] """
     """  """
     time: Optional[Coordof[TimeInterpolatedCoordArray]] = None
     """ Midpoint of time for which this set of parameters is accurate. Labeled 'time' when interpolating to main time axis """
-    time_cal: Optional[Coordof[TimeCalCoordArray]] = None
-    """ Midpoint of time for which this set of parameters is accurate. Labeled 'time_cal' when not interpolating to main time axis """
-    frequency: Optional[Coordof[FrequencyCalArray]] = None
+    time_system_cal: Optional[Coordof[TimeSystemCalCoordArray]] = None
+    """ Midpoint of time for which this set of parameters is accurate. Labeled 'time_system_cal' when not interpolating to main time axis """
+    frequency: Optional[Coordof[FrequencySystemCalArray]] = None
     """  """
-    frequency_cal: Optional[Coord[FrequencyCal, int]] = None
+    frequency_system_cal: Optional[Coord[FrequencySystemCal, int]] = None
     """TODO: What is this?"""
 
     # Data variables (all optional)
     PHASE_DIFFERENCE: Optional[
         Data[
-            Union[tuple[AntennaName, TimeCal], tuple[AntennaName, Time]],
+            Union[tuple[AntennaName, TimeSystemCal], tuple[AntennaName, Time]],
             QuantityInRadiansArray,
         ]
     ] = None
@@ -1727,10 +1794,10 @@ class SystemCalibrationXds:
     TCAL: Optional[
         Data[
             Union[
-                tuple[AntennaName, TimeCal, ReceptorLabel, FrequencyCal],
-                tuple[AntennaName, TimeCal, ReceptorLabel, Frequency],
-                tuple[AntennaName, TimeCal, ReceptorLabel],
-                tuple[AntennaName, Time, ReceptorLabel, FrequencyCal],
+                tuple[AntennaName, TimeSystemCal, ReceptorLabel, FrequencySystemCal],
+                tuple[AntennaName, TimeSystemCal, ReceptorLabel, Frequency],
+                tuple[AntennaName, TimeSystemCal, ReceptorLabel],
+                tuple[AntennaName, Time, ReceptorLabel, FrequencySystemCal],
                 tuple[AntennaName, Time, ReceptorLabel, Frequency],
                 tuple[AntennaName, Time, ReceptorLabel],
             ],
@@ -1741,10 +1808,10 @@ class SystemCalibrationXds:
     TRX: Optional[
         Data[
             Union[
-                tuple[AntennaName, TimeCal, ReceptorLabel, FrequencyCal],
-                tuple[AntennaName, TimeCal, ReceptorLabel, Frequency],
-                tuple[AntennaName, TimeCal, ReceptorLabel],
-                tuple[AntennaName, Time, ReceptorLabel, FrequencyCal],
+                tuple[AntennaName, TimeSystemCal, ReceptorLabel, FrequencySystemCal],
+                tuple[AntennaName, TimeSystemCal, ReceptorLabel, Frequency],
+                tuple[AntennaName, TimeSystemCal, ReceptorLabel],
+                tuple[AntennaName, Time, ReceptorLabel, FrequencySystemCal],
                 tuple[AntennaName, Time, ReceptorLabel, Frequency],
                 tuple[AntennaName, Time, ReceptorLabel],
             ],
@@ -1755,10 +1822,10 @@ class SystemCalibrationXds:
     TSKY: Optional[
         Data[
             Union[
-                tuple[AntennaName, TimeCal, ReceptorLabel, FrequencyCal],
-                tuple[AntennaName, TimeCal, ReceptorLabel, Frequency],
-                tuple[AntennaName, TimeCal, ReceptorLabel],
-                tuple[AntennaName, Time, ReceptorLabel, FrequencyCal],
+                tuple[AntennaName, TimeSystemCal, ReceptorLabel, FrequencySystemCal],
+                tuple[AntennaName, TimeSystemCal, ReceptorLabel, Frequency],
+                tuple[AntennaName, TimeSystemCal, ReceptorLabel],
+                tuple[AntennaName, Time, ReceptorLabel, FrequencySystemCal],
                 tuple[AntennaName, Time, ReceptorLabel, Frequency],
                 tuple[AntennaName, Time, ReceptorLabel],
             ],
@@ -1769,10 +1836,10 @@ class SystemCalibrationXds:
     TSYS: Optional[
         Data[
             Union[
-                tuple[AntennaName, TimeCal, ReceptorLabel, FrequencyCal],
-                tuple[AntennaName, TimeCal, ReceptorLabel, Frequency],
-                tuple[AntennaName, TimeCal, ReceptorLabel],
-                tuple[AntennaName, Time, ReceptorLabel, FrequencyCal],
+                tuple[AntennaName, TimeSystemCal, ReceptorLabel, FrequencySystemCal],
+                tuple[AntennaName, TimeSystemCal, ReceptorLabel, Frequency],
+                tuple[AntennaName, TimeSystemCal, ReceptorLabel],
+                tuple[AntennaName, Time, ReceptorLabel, FrequencySystemCal],
                 tuple[AntennaName, Time, ReceptorLabel, Frequency],
                 tuple[AntennaName, Time, ReceptorLabel],
             ],
@@ -1783,10 +1850,10 @@ class SystemCalibrationXds:
     TANT: Optional[
         Data[
             Union[
-                tuple[AntennaName, TimeCal, ReceptorLabel, FrequencyCal],
-                tuple[AntennaName, TimeCal, ReceptorLabel, Frequency],
-                tuple[AntennaName, TimeCal, ReceptorLabel],
-                tuple[AntennaName, Time, ReceptorLabel, FrequencyCal],
+                tuple[AntennaName, TimeSystemCal, ReceptorLabel, FrequencySystemCal],
+                tuple[AntennaName, TimeSystemCal, ReceptorLabel, Frequency],
+                tuple[AntennaName, TimeSystemCal, ReceptorLabel],
+                tuple[AntennaName, Time, ReceptorLabel, FrequencySystemCal],
                 tuple[AntennaName, Time, ReceptorLabel, Frequency],
                 tuple[AntennaName, Time, ReceptorLabel],
             ],
@@ -1797,10 +1864,10 @@ class SystemCalibrationXds:
     TANT_SYS: Optional[
         Data[
             Union[
-                tuple[AntennaName, TimeCal, ReceptorLabel, FrequencyCal],
-                tuple[AntennaName, TimeCal, ReceptorLabel, Frequency],
-                tuple[AntennaName, TimeCal, ReceptorLabel],
-                tuple[AntennaName, Time, ReceptorLabel, FrequencyCal],
+                tuple[AntennaName, TimeSystemCal, ReceptorLabel, FrequencySystemCal],
+                tuple[AntennaName, TimeSystemCal, ReceptorLabel, Frequency],
+                tuple[AntennaName, TimeSystemCal, ReceptorLabel],
+                tuple[AntennaName, Time, ReceptorLabel, FrequencySystemCal],
                 tuple[AntennaName, Time, ReceptorLabel, Frequency],
                 tuple[AntennaName, Time, ReceptorLabel],
             ],
@@ -1878,12 +1945,15 @@ class VisibilityXds:
     # --- Optional Coordinates ---
     polarization_mixed: Optional[Coord[tuple[BaselineId, Polarization], str]] = None
     """
-    If the polarizations are not constant over baseline
+    If the polarizations are not constant over baseline. For mixed polarizations one would
+    use ['PP', 'PQ', 'QP', 'QQ'] as the polarization labels and then specify here the
+    actual polarization basis for each baseline using labels from the set of all
+    combinations of 'X', 'Y', 'R' and 'L'.
     """
     uvw_label: Optional[Coordof[UvwLabelArray]] = None
     """ u,v,w """
-    scan_number: Optional[Coord[Time, Union[numpy.int64, numpy.int32]]] = None
-    """Arbitary scan number to identify data taken in the same logical scan."""
+    scan_name: Optional[Coord[Time, str]] = None
+    """Arbitary scan name to identify data taken in the same logical scan."""
 
     # --- Optional data variables / arrays ---
 
@@ -1974,10 +2044,13 @@ class SpectrumXds:
     # --- Optional Coordinates ---
     polarization_mixed: Optional[Coord[tuple[AntennaName, Polarization], str]] = None
     """
-    If the polarizations are not constant over baseline
+    If the polarizations are not constant over antennas. For mixed polarizations one would
+    use ['PP', 'PQ', 'QP', 'QQ'] as the polarization labels and then specify here the
+    actual polarization basis for each antenna using labels from the set of
+    combinations of 'X', 'Y', 'R' and 'L'.
     """
-    scan_number: Optional[Coord[Time, Union[numpy.int64, numpy.int32]]] = None
-    """Arbitary scan number to identify data taken in the same logical scan."""
+    scan_name: Optional[Coord[Time, str]] = None
+    """Arbitary scan name to identify data taken in the same logical scan."""
 
     # SPECTRUM_CORRECTED: Optional[Dataof[SpectrumArray]] = None
 

xradio/sphinx/schema_table.py

@@ -212,6 +212,18 @@ def format_attr_model_text(state, attr) -> StringList:
                 state.nested_parse(vl, 0, line)
             return line
 
+        if typing.get_origin(attr.typ) == typing.Union:
+            vl = StringList()
+            type_args = typing.get_args(attr.typ)
+            options = []
+            for i, arg in enumerate(type_args):
+                vl.append(f":py:class:`~{arg.__module__}.{arg.__name__}`", "")
+                if i + 1 < len(type_args):
+                    vl.append(" or ", "")
+            with switch_source_input(state, vl):
+                state.nested_parse(vl, 0, line)
+            return line
+
         # Derived type, e.g. list of types?
         if typing.get_origin(attr.typ) == list and all(
             [isinstance(arg, type) for arg in type_args]

{xradio-0.0.46.dist-info → xradio-0.0.48.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: xradio
-Version: 0.0.46
+Version: 0.0.48
 Summary:  Xarray Radio Astronomy Data IO
 Author-email: Jan-Willem Steeb <jsteeb@nrao.edu>
 License: BSD 3-Clause License
@@ -37,7 +37,7 @@ License: BSD 3-Clause License
         OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
         OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
         
-Requires-Python: <3.13,>=3.9
+Requires-Python: <3.14,>=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: astropy
@@ -52,7 +52,7 @@ Requires-Dist: pytest-html
 Requires-Dist: s3fs
 Requires-Dist: scipy
 Requires-Dist: xarray
-Requires-Dist: zarr
+Requires-Dist: zarr<3,>=2
 Requires-Dist: pyarrow
 Requires-Dist: python_casacore>=3.6.1; sys_platform != "darwin"
 Requires-Dist: typing_extensions; python_version < "3.10"