Pipeline / pipeline / 44bf07329dc

Commits

Vincent Geers authored 44bf07329dc Merge 31 Jan 2025

Pull request #1411: PIPE-2160: update documentation and typing for context and domain

Merge in PIPE/pipeline from PIPE-2160_update_documentation_context_domain to main

* commit '7600bb45ddea7389408d0b11bd66b8d113d6bb1b': (32 commits)
  PIPE-2160: correction in ObservingRun docstring for 'org_directions'.
  PIPE-2160: correction in ObservingRun docstring.
  PIPE-2160: updates to address PR comments.
  PIPE-2160: update MeasurementSet to always define the "polarizations" attribute at init.
  PIPE-2160: update docstrings and type hints in callibrary.py.
  PIPE-2160: update minimum CASA version to 6.6.6-1.
  PIPE-2160: update pipeline.infrastructure.launcher.Pipeline.close method to use context save method for consistency.
  PIPE-2160: document removal of the dictionary-based implementation of the Pipeline calibration library.
  PIPE-2160: remove the unused dictionary-based implementation of the Pipeline calibration library (DictCalLibrary and DictCalState) from pipeline.infrastructure.callibrary.
  PIPE-2160: remove unused "sensitivities" attribute from pipeline.infrastructure.launcher.Context class.
  PIPE-2160: remove unused "logtype" attribute from pipeline.infrastructure.launcher.Context class.
  PIPE-2160: remove the "flagcmds" list attribute from the pipeline.domain.measurementset.MeasurementSet class. Unchanged since 2013, this attribute only had its value populated by hifa_fluxcalflag but never used in subsequent tasks.
  PIPE-2160: remove unused "reduction_intents" property from pipeline.domain.state.State class.
  PIPE-2160: remove unused "centre" property from pipeline.domain.antennaarray.AntennaArray class and removed last known import of casatasks.private.simutil. Likely originally added for concept of removing antenna(s) from MS entirely and re-computing the centre.
  PIPE-2160: remove unused "group_name" attribute from pipeline.domain.datadescription.DataDescription class. This was likely a remnant from an early implementation of a FrequencyGroup that got removed in 26e3bec6 for CAS-4813.
  PIPE-2160: remove unused "get_fields" method from pipeline.domain.observingrun.ObservingRun.
  PIPE-2160: remove unused "TemporalCollection" class from pipeline.domain.measures. This class was effectively unchanged since 2013 and originally introduced for the concept of a versioned dataset.
  PIPE-2160: update domain.observingrun.ObservingRun to always define "ms_datatable_name" and "ms_reduction_group" at init; replace/remove tests for existence of those attributes; consolidate two separate "contains-single-dish" tests.
  PIPE-2160: update callibrary.CalTo to update type hint and revert change in setters for 'spw' and 'antenna' to deal with case of single integer spw ID.
  PIPE-2160: fix type hints in callibrary after removing import.
  ...

pipeline/domain/antenna.py

Modified

--
+"""The antenna module defines the Antenna class.
--
+"""
-+
+"""The antenna module defines the Antenna class."""
-2
+import pprint
-3
-4
+from pipeline.infrastructure import casa_tools
-5
-6
+_pprinter = pprint.PrettyPrinter()
-7
-8
-9
+class Antenna(object):
-10
+    """
--
+    Antenna is a logical representation of an antenna.
--
--
+    An Antenna has the following properties:
--
--
+    .. py:attribute:: id
--
--
+        the numerical identifier of this antenna within the ANTENNA subtable
--
+        of the measurement set
--
--
+    .. py:attribute:: name
--
--
+        the (potentially empty) name of this antenna
--
--
+    .. py:attribute:: longitude
--
--
+        the longitude of this antenna
--
--
+    .. py:attribute:: latitude
--
--
+        the latitude of this antenna
--
--
+    .. py:attribute:: height
--
--
+        the radial distance of this antenna from the Earth's centre
--
--
+    .. py:attribute:: diameter
--
--
+        the physical diameter of this antenna
--
--
+    .. py:attribute:: direction
--
--
+        the J2000 position on the sky to which this antenna points
-+
+    Antenna is a logical representation of an antenna.
-+
-+
+    Attributes:
-+
+        id: The numerical identifier of this antenna within the ANTENNA subtable
-+
+            of the measurement set.
-+
+        name: The (potentially empty) name of the antenna.
-+
+        station: The station pad on which the antenna is situated.
-+
+        diameter: The physical diameter of the antenna in meters.
-+
+        position: Dictionary with longitude, latitude, and height of the antenna.
-+
+        offset: The offset position of the antenna relative to AntennaArray.position
-+
+            (the antenna array reference position).
-+
+        longitude: The longitude of the antenna.
-+
+        latitude: The latitude of the antenna.
-+
+        height: The radial distance of the antenna from the Earth's centre.
-+
+        direction: The J2000 position on the sky to which the antenna points.
-26
+    """
--
+    def __init__(self, antenna_id, name, station, position, offset, diameter):
-+
+    def __init__(self, antenna_id: int, name: str, station: str, position: dict, offset: dict, diameter: float) -> None:
-+
+        """
-+
+        Initialize an Antenna object.
-+
-+
+        Args:
-+
+            antenna_id: The numerical identifier of the antenna.
-+
+            name: The name of the antenna.
-+
+            station: The station pad on which the antenna is situated.
-+
+            position: Dictionary with longitude, latitude, and height of the antenna.
-+
+            offset: The offset position of the antenna relative to AntennaArray.position
-+
+                (the antenna array reference position).
-+
+            diameter: The physical diameter of the antenna in meters.
-+
+        """
-40
+        self.id = antenna_id
-41
-42
+        # work around NumPy bug with empty strings
-43
+        # http://projects.scipy.org/numpy/ticket/1239
-44
+        self.name = str(name)
-45
+        self.station = str(station)
-46
-47
+        self.diameter = diameter
-48
+        self.position = position
-49
+        self.offset = offset
-50
-51
+        # The longitude, latitude and height of a CASA position are given in
-52
+        # canonical units, so we don't need to perform any further conversion
-53
+        self.longitude = position['m0']
-54
+        self.latitude = position['m1']
-55
+        self.height = position['m2']
-56
-57
+        mt = casa_tools.measures
-58
+        self.direction = mt.direction(v0=self.longitude, v1=self.latitude)
-59
--
+    def __repr__(self):
-+
+    def __repr__(self) -> str:
-61
+        return '{0}({1}, {2!r}, {3!r}, {4}, {5}, {6})'.format(
-62
+            self.__class__.__name__,
-63
+            self.id,
-64
+            self.name,
-65
+            self.station,
-66
+            _pprinter.pformat(self.position),
-67
+            _pprinter.pformat(self.offset),
-68
+            self.diameter)
-69
--
+    def __str__(self):
-+
+    def __str__(self) -> str:
-71
+        qt = casa_tools.quanta
-72
+        lon = qt.tos(self.longitude)
-73
+        lat = qt.tos(self.latitude)
-74
+        return '<Antenna {id} (lon={lon}, lat={lat})>'.format(
-75
+            id=self.identifier, lon=lon, lat=lat)
-76
-77
+    @property
--
+    def identifier(self):
--
+        '''
--
+        A human-readable identifier for this Antenna.
--
+        '''
--
+        return self.name if self.name else '#{0}'.format(self.id)
--
-+
+    def identifier(self) -> str:
-+
+        """Return a human-readable identifier for this Antenna."""
-+
+        return self.name if self.name else f"#{self.id}"

pipeline

Commits

Jira Issues

Add shortcut