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

xradio/measurement_set/_utils/_msv2/conversion.py

@@ -1029,7 +1029,7 @@ def convert_and_write_partition(
                         datetime.timezone.utc
                     ).isoformat(),
                     "xradio_version": importlib.metadata.version("xradio"),
-                    "schema_version": "4.0.-9994",
+                    "schema_version": "4.0.-9991",
                     "type": "visibility",
                 }
             )
@@ -1399,58 +1399,58 @@ def antenna_ids_to_names(
     return xds
 
 
+def add_group_to_data_groups(
+    data_groups: dict, what_group: str, correlated_data_name: str, uvw: bool = True
+):
+    """
+    Adds one correlated_data variable to the data_groups dict.
+    A utility function to use when creating/updating data_groups from MSv2 data columns
+    / data variables.
+
+    Parameters
+    ----------
+    data_groups: str
+        The data_groups dict of an MSv4 xds. It is updated in-place
+    what_group: str
+        Name of the data group: "base", "corrected", "model", etc.
+    correlated_data_name: str
+        Name of the correlated_data var: "VISIBILITY", "VISIBILITY_CORRECTED", "SPECTRUM", etc.
+    uvw: bool
+        Whether to add a uvw field to the data group (assume True = interferometric data).
+    """
+    data_groups[what_group] = {
+        "correlated_data": correlated_data_name,
+        "flag": "FLAG",
+        "weight": "WEIGHT",
+    }
+    if uvw:
+        data_groups[what_group]["uvw"] = "UVW"
+
+
 def add_data_groups(xds):
     xds.attrs["data_groups"] = {}
+
+    data_groups = xds.attrs["data_groups"]
     if "VISIBILITY" in xds:
-        xds.attrs["data_groups"]["base"] = {
-            "correlated_data": "VISIBILITY",
-            "flag": "FLAG",
-            "weight": "WEIGHT",
-            "uvw": "UVW",
-        }
+        add_group_to_data_groups(data_groups, "base", "VISIBILITY")
 
     if "VISIBILITY_CORRECTED" in xds:
-        xds.attrs["data_groups"]["corrected"] = {
-            "correlated_data": "VISIBILITY_CORRECTED",
-            "flag": "FLAG",
-            "weight": "WEIGHT",
-            "uvw": "UVW",
-        }
+        add_group_to_data_groups(data_groups, "corrected", "VISIBILITY_CORRECTED")
 
     if "VISIBILITY_MODEL" in xds:
-        xds.attrs["data_groups"]["model"] = {
-            "correlated_data": "VISIBILITY_MODEL",
-            "flag": "FLAG",
-            "weight": "WEIGHT",
-            "uvw": "UVW",
-        }
+        add_group_to_data_groups(data_groups, "model", "VISIBILITY_MODEL")
 
     is_single_dish = False
     if "SPECTRUM" in xds:
-        xds.attrs["data_groups"]["base"] = {
-            "correlated_data": "SPECTRUM",
-            "flag": "FLAG",
-            "weight": "WEIGHT",
-            "uvw": "UVW",
-        }
+        add_group_to_data_groups(data_groups, "base", "SPECTRUM", False)
         is_single_dish = True
 
     if "SPECTRUM_MODEL" in xds:
-        xds.attrs["data_groups"]["model"] = {
-            "correlated_data": "SPECTRUM_MODEL",
-            "flag": "FLAG",
-            "weight": "WEIGHT",
-            "uvw": "UVW",
-        }
+        add_group_to_data_groups(data_groups, "model", "SPECTRUM_MODEL", False)
         is_single_dish = True
 
     if "SPECTRUM_CORRECTED" in xds:
-        xds.attrs["data_groups"]["corrected"] = {
-            "correlated_data": "SPECTRUM_CORRECTED",
-            "flag": "FLAG",
-            "weight": "WEIGHT",
-            "uvw": "UVW",
-        }
+        add_group_to_data_groups(data_groups, "corrected", "SPECTRUM_CORRECTED", False)
         is_single_dish = True
 
     return xds, is_single_dish

xradio/measurement_set/convert_msv2_to_processing_set.py

@@ -76,8 +76,9 @@ def convert_msv2_to_processing_set(
     partition_scheme : list, optional
         A MS v4 can only contain a single data description (spectral window and polarization setup), and observation mode. Consequently, the MS v2 is partitioned when converting to MS v4.
         In addition to data description and polarization setup a finer partitioning is possible by specifying a list of partitioning keys. Any combination of the following keys are possible:
-        "FIELD_ID", "SCAN_NUMBER", "STATE_ID", "SOURCE_ID", "SUB_SCAN_NUMBER". For mosaics where the phase center is rapidly changing (such as VLA on the fly mosaics)
-        partition_scheme should be set to an empty list []. By default, ["FIELD_ID"].
+        "FIELD_ID", "SCAN_NUMBER", "STATE_ID", "SOURCE_ID", "SUB_SCAN_NUMBER", "ANTENNA1".
+        "ANTENNA1" is intended as a single-dish specific partitioning option.
+        For mosaics where the phase center is rapidly changing (such as VLA on the fly mosaics) partition_scheme should be set to an empty list []. By default, ["FIELD_ID"].
     main_chunksize : Union[Dict, float, None], optional
         Defines the chunk size of the main dataset. If given as a dictionary, defines the sizes of several dimensions, and acceptable keys are "time", "baseline_id", "antenna_id", "frequency", "polarization". If given as a float, gives the size of a chunk in GiB. By default, None.
     with_pointing : bool, optional

xradio/measurement_set/schema.py

@@ -125,7 +125,7 @@ class QuantityInHertzArray:
 @xarray_dataarray_schema
 class QuantityInMetersArray:
     """
-    Quantity with units of Hertz
+    Quantity with units of meters
     """
 
     data: Data[ZD, float]
@@ -137,7 +137,7 @@ class QuantityInMetersArray:
 @xarray_dataarray_schema
 class QuantityInMetersPerSecondArray:
     """
-    Quantity with units of Hertz
+    Quantity with units of meters per second
     """
 
     data: Data[ZD, float]
@@ -149,7 +149,7 @@ class QuantityInMetersPerSecondArray:
 @xarray_dataarray_schema
 class QuantityInRadiansArray:
     """
-    Quantity with units of Hertz
+    Quantity with units of radians
     """
 
     data: Data[ZD, float]
@@ -304,6 +304,31 @@ class SkyCoordArray:
     """
 
 
+@xarray_dataarray_schema
+class PointingBeamArray:
+    """Pointing beam data array in :py:class:`PointingXds`."""
+
+    data: Data[
+        Union[
+            tuple[Time, AntennaName, LocalSkyDirLabel],
+            tuple[TimePointing, AntennaName, LocalSkyDirLabel],
+            tuple[Time, AntennaName, LocalSkyDirLabel, nPolynomial],
+            tuple[TimePointing, AntennaName, LocalSkyDirLabel, nPolynomial],
+        ],
+        numpy.float64,
+    ]
+
+    type: Attr[SkyCoord] = "sky_coord"
+    units: Attr[UnitsOfSkyCoordInRadians] = ("rad", "rad")
+    frame: Attr[AllowedSkyCoordFrames] = "fk5"
+    """
+    From fixvis docs: clean and the im tool ignore the reference frame claimed by the UVW column (it is often mislabelled
+    as ITRF when it is really FK5 (J2000)) and instead assume the (u, v, w)s are in the same frame as the phase tracking
+    center. calcuvw does not yet force the UVW column and field centers to use the same reference frame! Blank = use the
+    phase tracking frame of vis.
+    """
+
+
 @xarray_dataarray_schema
 class LocalSkyCoordArray:
     """Measures array for the arrays that have coordinate local_sky_dir_label in :py:class:`PointingXds`"""
@@ -660,7 +685,7 @@ class FrequencyArray:
     """Frequency coordinate in the main dataset."""
 
     data: Data[Frequency, float]
-    """ Time, expressed in SI seconds since the epoch. """
+    """ Center frequencies for each channel. """
     spectral_window_name: Attr[str]
     """ Name associated with spectral window. """
     frequency_group_name: Optional[Attr[str]]
@@ -698,7 +723,7 @@ class FrequencyCalArray:
     only measures data, as opposed to the frequency array of the main dataset."""
 
     data: Data[FrequencyCal, float]
-    """ Time, expressed in SI seconds since the epoch. """
+    """ Center frequencies for each channel. """
 
     type: Attr[SpectralCoord] = "spectral_coord"
     units: Attr[UnitsHertz] = ("Hz",)
@@ -1188,7 +1213,10 @@ class PartitionInfoDict:
     """ List of source names. """
     # source_id: mising / remove for good?
     intents: list[str]
-    """ Infromation in obs_mode column of MSv2 State table. """
+    """ An intent string identifies one intention of the scan, such as to calibrate or observe a
+    target. See :ref:`scan intents` for possible values. When converting from MSv2, the list of
+    intents is derived from the OBS_MODE column of MSv2 state table (every comma separated value
+    is taken as an intent). """
     taql: Optional[str]
     """ The taql query used if converted from MSv2. """
     line_name: list[str]
@@ -1469,7 +1497,7 @@ class WeatherXds:
     time: Optional[Coordof[TimeInterpolatedCoordArray]]
     """ Mid-point of the time interval. Labeled 'time' when interpolated to main time axis """
     time_weather: Optional[Coordof[TimeWeatherCoordArray]]
-    """ Mid-point of the time interval. Labeled 'time_cal' when not interpolated to main time axis """
+    """ Mid-point of the time interval. Labeled 'time_weather' when not interpolated to main time axis """
     antenna_name: Optional[Coordof[AntennaNameArray]]
     """ Antenna identifier """
     ellipsoid_pos_label: Optional[Coord[EllipsoidPosLabel, str]] = (
@@ -1574,7 +1602,7 @@ class PointingXds:
     """
     Pointing dataset: antenna pointing information.
 
-    In the past the relationship and definition of the pointing infromation has not been clear. Here we attempt to clarify it by explaining the relationship between the ASDM, MSv2 and MSv4 pointing information.
+    In the past the relationship and definition of the pointing information has not been clear. Here we attempt to clarify it by explaining the relationship between the ASDM, MSv2 and MSv4 pointing information.
 
     The following abreviations are used:
 
@@ -1615,29 +1643,31 @@ class PointingXds:
     Direction labels.
     """
 
-    POINTING_BEAM: Data[
-        Union[
-            tuple[Time, AntennaName],
-            tuple[TimePointing, AntennaName],
-            tuple[Time, AntennaName, nPolynomial],
-            tuple[TimePointing, AntennaName, nPolynomial],
-        ],
-        LocalSkyCoordArray,
-    ]
+    POINTING_BEAM: Dataof[PointingBeamArray]
     """
     The direction of the peak response of the beam and is equavalent to the MSv2 DIRECTION (M2_direction) with_pointing_correction=True, optionally expressed as polynomial coefficients.
     """
 
+    # Optional coords:
+
     time: Optional[Coordof[TimeInterpolatedCoordArray]] = None
     """
     Mid-point of the time interval for which the information in this row is
     valid. Required to use the same time measure reference as in visibility dataset.
     Labeled 'time' when interpolating to main time axis.
     """
+
     time_pointing: Optional[Coordof[TimePointingCoordArray]] = None
     """ Midpoint of time for which this set of parameters is accurate. Labeled
     'time_pointing' when not interpolating to main time axis """
 
+    n_polynomial: Optional[Coord[nPolynomial, numpy.int64]] = None
+    """
+    Polynomial index, when using polynomial coefficients to specify POINTING_BEAM
+    """
+
+    # Optional data vars:
+
     POINTING_DISH_MEASURED: Optional[
         Data[
             Union[
@@ -1901,15 +1931,6 @@ class VisibilityXds:
     xradio_version: Optional[Attr[str]] = None
     """ Version of XRADIO used if converted from MSv2. """
 
-    intent: Optional[Attr[str]] = None
-    """Identifies the intention of the scan, such as to calibrate or observe a
-    target. See :ref:`scan intents` for possible values.
-    """
-    data_description_id: Optional[Attr[str]] = None
-    """
-    The id assigned to this combination of spectral window and polarization setup.
-    """
-
 
 @xarray_dataset_schema
 class SpectrumXds:
@@ -2001,12 +2022,3 @@ class SpectrumXds:
 
     xradio_version: Optional[Attr[str]] = None
     """ Version of XRADIO used if converted from MSv2. """
-
-    intent: Optional[Attr[str]] = None
-    """Identifies the intention of the scan, such as to calibrate or observe a
-    target. See :ref:`scan intents` for possible values.
-    """
-    data_description_id: Optional[Attr[str]] = None
-    """
-    The id assigned to this combination of spectral window and polarization setup.
-    """

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xradio
-Version: 0.0.45
+Version: 0.0.46
 Summary:  Xarray Radio Astronomy Data IO
 Author-email: Jan-Willem Steeb <jsteeb@nrao.edu>
 License: BSD 3-Clause License

{xradio-0.0.45.dist-info → xradio-0.0.46.dist-info}/RECORD

@@ -25,17 +25,17 @@ xradio/image/_util/_zarr/xds_from_zarr.py,sha256=4b6KHmAcnrhBbCi-Z7e3Lm6l6wziJL1
 xradio/image/_util/_zarr/xds_to_zarr.py,sha256=wogXbwX8n3Sl9PHoc3_Y_LBowQsQ-94HZQFZ5NcxUZA,1624
 xradio/image/_util/_zarr/zarr_low_level.py,sha256=fVaPnxYazz6UDLBZuyUOekZKQ945OwhfBHeNeDgnW0w,13338
 xradio/measurement_set/__init__.py,sha256=dTrX1Rki43UGz0srfGh07lm-zcUXJdSdSPbS3QPaMpg,662
-xradio/measurement_set/convert_msv2_to_processing_set.py,sha256=AoYZBrFyy8kaPg_2GuIr8yc_ht9vSNkUPPY7VO5Nsn8,8083
+xradio/measurement_set/convert_msv2_to_processing_set.py,sha256=KQomjZtfrahMZFHH9XV0xfw4jlNvEuveUgLSEmeBo80,8173
 xradio/measurement_set/load_processing_set.py,sha256=RedC4i4dOHzgYiz_C0P-3F0PwvEGUomvq_ilpcfUCco,5540
 xradio/measurement_set/measurement_set_xds.py,sha256=slZ4Nj3io3WkspjUqY4E-JO3LR2X7g9w2e88yjxcDQ8,4621
 xradio/measurement_set/open_processing_set.py,sha256=533fwEP4pJIBB-NdwFttbobVb8zEXsblvDTjF4ptTDU,3831
 xradio/measurement_set/processing_set.py,sha256=uVc8PpG_7ivGYqTZpDCLCfuXBOwTLMFj3TebbEpKMRI,29904
-xradio/measurement_set/schema.py,sha256=OPAliKAdZt9oblyGW-CHnEzl-1hMj3-9I8G220XArXM,76439
+xradio/measurement_set/schema.py,sha256=oETmqrBoaVE0xS36yQIXe9Yo3YjOBkIndWB76v8wlc0,77022
 xradio/measurement_set/_utils/__init__.py,sha256=XE-h1yMfr6tVD6gdUwXO1CVq5SQ6kD_oj-e5TFwslds,97
 xradio/measurement_set/_utils/msv2.py,sha256=7hnZMFoQ-s1g0ATjEupLvtdqQCdroPv-Rl5OwjqXjh8,4430
 xradio/measurement_set/_utils/zarr.py,sha256=ehXlu0Xh_UZ5Xm2RnHCxESsRZ26c3DQAO5rqMK5MwTk,3947
 xradio/measurement_set/_utils/_msv2/chunks.py,sha256=JTPk3il6fk570BjWZMoOAtsbvnLmqPcBv9EPY6A2yOs,2964
-xradio/measurement_set/_utils/_msv2/conversion.py,sha256=bWySUtoOl9IAWJG6pncPZtmE6gV11B8jEu3QNpEvY1k,51914
+xradio/measurement_set/_utils/_msv2/conversion.py,sha256=9At2ytmBWp1tKuGPYD6ONcnl1ymW8QpdpouwQDFUs8k,52215
 xradio/measurement_set/_utils/_msv2/create_antenna_xds.py,sha256=qLUDxbkJBOaD7EaVx7ufiU0CL5f8VVxK-923-j4XpXc,17758
 xradio/measurement_set/_utils/_msv2/create_field_and_source_xds.py,sha256=MNO1M6o8i-_L9I26mx20jkMRNKU4ymxLCohbSTpZwLo,34167
 xradio/measurement_set/_utils/_msv2/descr.py,sha256=dYK8mhXxODIh-dfqaOm-YZb7kmoN1N2golX_RFncO94,5215
@@ -70,8 +70,8 @@ xradio/schema/metamodel.py,sha256=WjtW7pAVzcjLRWifRH3sQoOiN6TV810hARpOIz1M_gw,38
 xradio/schema/typing.py,sha256=8-o6fZd99kJ4FVdgBYRTIRJ-wDqpcUNXzCTfJvl3TIw,10439
 xradio/sphinx/__init__.py,sha256=VGY-7Ty3q67qpnBee0-znbiJ-Iy0F93UO--IpjEdHXc,380
 xradio/sphinx/schema_table.py,sha256=YTQvK-VOBIpFtcx7sjcaMod4OSbl0uowelYIcdP3oVg,11878
-xradio-0.0.45.dist-info/LICENSE.txt,sha256=9CYIJt7riOXo9AD0eXBZviLxo_HebD-2JJI8oiWtzfg,1807
-xradio-0.0.45.dist-info/METADATA,sha256=S4j62JPPIt_1dTmA5rHGPiwmVARgKvouth0LrQkJy4w,4470
-xradio-0.0.45.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-xradio-0.0.45.dist-info/top_level.txt,sha256=dQu27fGBZJ2Yk-gW5XeD-dZ76Xa4Xcvk60Vz-dwXp7k,7
-xradio-0.0.45.dist-info/RECORD,,
+xradio-0.0.46.dist-info/LICENSE.txt,sha256=9CYIJt7riOXo9AD0eXBZviLxo_HebD-2JJI8oiWtzfg,1807
+xradio-0.0.46.dist-info/METADATA,sha256=QhT0pxXnEf8i6uNKQucBr0g0Yk2kpsSYSCzszasLyVo,4470
+xradio-0.0.46.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+xradio-0.0.46.dist-info/top_level.txt,sha256=dQu27fGBZJ2Yk-gW5XeD-dZ76Xa4Xcvk60Vz-dwXp7k,7
+xradio-0.0.46.dist-info/RECORD,,