rationalise cross-ref indexing in charts

Author: iboyd-ansys

src/ansys/systemcoupling/core/charts/chart_datatypes.py

@@ -45,10 +45,6 @@ class TransferSeriesInfo:
 
     Attributes
     ----------
-    data_index : int
-        This is used by the data source processor to associate this information (likely
-        obtained from heading or other metadata) with the correct data series.
-        It indexes into the full list of series associated with a given interface.
     series_type : SeriesType
         The type of line series.
     transfer_display_name : str
@@ -62,22 +58,20 @@ class TransferSeriesInfo:
     participant_display_name : str, optional
         The display name of the participant. This is required for transfer value series
         but not for convergence series.
-    line_suffixes: list[str]
-        This should always be empty for convergence series. For transfer value series,
-        it should contain the suffixes for any component series that exist. That is,
-        suffixes for complex components, "real" or "imag", and suffixes for vector
-        components, "x", "y", "z", or a combination of complex and vector component
-        types. The data indexes for individual components of the transfer are assumed
-        to be contiguous from ``data_index``.
+    component_suffix: str, optional
+        The suffix for this component series, if applicable. This is only needed for
+        transfer value series that have multiple components, such as complex or vector
+        values, and is otherwise None. Suffixes for complex components are "real" and
+        "imag", and suffixes for vector components are "x", "y", and "z". A combination
+        of complex and vector suffixes is possible, such as "y real" and "x imag".
     """
 
-    data_index: int
     series_type: SeriesType
     transfer_display_name: str
     disambiguation_index: int
     # Remainder for non-CONVERGENCE series only
     participant_display_name: Optional[str] = None
-    line_suffixes: list[str] = field(default_factory=list)
+    component_suffix: Optional[str] = None
 
 
 @dataclass
@@ -115,9 +109,6 @@ class SeriesData:
     transfer_index : int
         Index of the ``TransferSeriesInfo`` metadata for this series within the
         ``InterfaceInfo`` for the interface this series is associated with.
-    component_index : int, optional
-        The component index if this series is one of a set of complex and/or
-        vector components of the transfer. Otherwise is ``None``.
     start_index : int, optional
         The starting iteration of the ``data`` field. This defaults to 0 and
         only needs to be set to a different value if incremental data, such
@@ -128,10 +119,7 @@ class SeriesData:
     """
 
     transfer_index: int  # Index into transfer_info of associated InterfaceInfo
-    component_index: Optional[int] = None  # Component index if applicable
-
     start_index: int = 0  # Use when providing incremental data
-
     data: list[float] = field(default_factory=list)
 
 

src/ansys/systemcoupling/core/charts/csv_chartdata.py

@@ -157,14 +157,8 @@ def read_new_data(self):
 
     def _init_data(self):
         series_data_list: list[SeriesData] = []
-        for i, trans_info in enumerate(self._metadata.transfer_info):
-            if not trans_info.line_suffixes:
-                series_data_list.append(SeriesData(transfer_index=i))
-            else:
-                for j in range(len(trans_info.line_suffixes)):
-                    series_data_list.append(
-                        SeriesData(transfer_index=i, component_index=j)
-                    )
+        for i in range(len(self._metadata.transfer_info)):
+            series_data_list.append(SeriesData(transfer_index=i))
         self._data = InterfaceSeriesData(self._metadata, series=series_data_list)
 
     def _process_curr_data(self):
@@ -245,7 +239,6 @@ def parse_csv_metadata(interface_name: str, headers: list[str]) -> InterfaceInfo
         data_index = i - start_index
         series_type, intf_or_part_disp_name, trans_disp_name = _parse_header(header)
         if series_type == SeriesType.CONVERGENCE:
-            prev_part_name = ""
 
             # If there are no convergence headings, transfer_disambig will
             # remain unpopulated. In this case, assume for now that there
@@ -267,7 +260,6 @@ def parse_csv_metadata(interface_name: str, headers: list[str]) -> InterfaceInfo
                 assert_(intf_info.display_name == "", "display_name should be empty")
                 intf_info.display_name = intf_disp_name
             series_info = TransferSeriesInfo(
-                data_index=data_index,
                 series_type=series_type,
                 transfer_display_name=trans_disp_name,
                 # get(..., 0) for case where transfer_disambig empty (see note above)
@@ -276,39 +268,13 @@ def parse_csv_metadata(interface_name: str, headers: list[str]) -> InterfaceInfo
             intf_info.transfer_info.append(series_info)
         else:
             part_disp_name = intf_or_part_disp_name
-            suffix = _parse_suffix(header, part_disp_name)
-            if suffix:
-                if prev_part_name != part_disp_name:
-                    # Start a new series info for a group of components
-                    # Thus if there are 3 components, say, they will
-                    # implicitly have data indexes, data_index, data_index+1,
-                    # data_index+2, and the next TransferSeriesInfo will
-                    # have index data_index+3.
-                    intf_info.transfer_info.append(
-                        TransferSeriesInfo(
-                            data_index=data_index,
-                            series_type=series_type,
-                            transfer_display_name=trans_disp_name,
-                            disambiguation_index=transfer_disambig.get(
-                                trans_disp_name, 0
-                            ),
-                            participant_display_name=part_disp_name,
-                            line_suffixes=[suffix],
-                        )
-                    )
-                    prev_part_name = part_disp_name
-                else:
-                    # Append component info to current series info
-                    intf_info.transfer_info[-1].line_suffixes.append(suffix)
-            else:
-                prev_part_name = ""
-                intf_info.transfer_info.append(
-                    TransferSeriesInfo(
-                        data_index=data_index,
-                        series_type=series_type,
-                        transfer_display_name=trans_disp_name,
-                        disambiguation_index=transfer_disambig.get(trans_disp_name, 0),
-                        participant_display_name=part_disp_name,
-                    )
+            intf_info.transfer_info.append(
+                TransferSeriesInfo(
+                    series_type=series_type,
+                    transfer_display_name=trans_disp_name,
+                    disambiguation_index=transfer_disambig.get(trans_disp_name, 0),
+                    participant_display_name=part_disp_name,
+                    component_suffix=_parse_suffix(header, part_disp_name) or None,
                 )
+            )
     return intf_info

src/ansys/systemcoupling/core/charts/live_csv_datasource.py

@@ -70,7 +70,6 @@ def read_data(self):
 
                 line_series_incr = SeriesData(
                     line_series.transfer_index,
-                    line_series.component_index,
                     start_index=start_index,
                     data=line_series.data[start_index:],
                 )

src/ansys/systemcoupling/core/charts/plot_functions.py

@@ -54,10 +54,6 @@ def cancel(self) -> None: ...
     def read_data(self) -> None: ...
 
 
-def _make_csv_data_reader(interface_name: str) -> ChartDataReader:
-    return CsvChartDataReader(interface_name)
-
-
 def _create_and_show_impl(spec: PlotSpec, reader: ChartDataReader) -> Plotter:
     if len(spec.interfaces) != 1:
         raise ValueError("Plots currently only support one interface")
@@ -88,7 +84,7 @@ def create_and_show_plot_csv(spec: PlotSpec, csv_list: list[str]) -> Plotter:
         raise ValueError(
             "'csv_list' should have length equal to the number of interfaces"
         )
-    reader = _make_csv_data_reader(spec.interfaces[0].name)
+    reader = CsvChartDataReader(spec.interfaces[0].name, csv_list[0])
     return _create_and_show_impl(spec, reader)
 
 

src/ansys/systemcoupling/core/charts/plotdefinition_manager.py

@@ -240,7 +240,7 @@ def set_metadata(self, metadata: InterfaceInfo):
         # The integer is the "disambiguation_index" the transfer's TransferSeriesInfo.
         transfer_value_line_count: dict[tuple[str, int], int] = {}
 
-        for transfer in metadata.transfer_info:
+        for data_index, transfer in enumerate(metadata.transfer_info):
             transfer_key = (
                 transfer.transfer_display_name,
                 transfer.disambiguation_index,
@@ -257,7 +257,7 @@ def set_metadata(self, metadata: InterfaceInfo):
                 ] = ""
 
                 if conv_subplot := self._conv_subplots.get(interface_name):
-                    data_index_map[transfer.data_index] = (conv_subplot, iconv)
+                    data_index_map[data_index] = (conv_subplot, iconv)
                     # Add a new series list to y_data, and label to series_labels
                     # Both will be at position iconv of respective lists
                     # conv_subplot.y_data.append([])
@@ -277,28 +277,17 @@ def set_metadata(self, metadata: InterfaceInfo):
                         "<VALUETYPE>", value_type
                     )
                     itransval = transfer_value_line_count.get(transfer_key, 0)
-                    if not transfer.line_suffixes:
-                        data_index_map[transfer.data_index] = (
-                            transfer_value_subplot,
-                            itransval,
-                        )
-                        transfer_value_subplot.series_labels.append(
-                            transfer.participant_display_name
-                        )
-                        itransval += 1
-                        transfer_value_line_count[transfer_key] = itransval
-                    else:
-                        for i, suffix in enumerate(transfer.line_suffixes):
-                            data_index_map[transfer.data_index + i] = (
-                                transfer_value_subplot,
-                                itransval + i,
-                            )
-                            transfer_value_subplot.series_labels.append(
-                                transfer.participant_display_name + suffix
-                            )
-                        transfer_value_line_count[transfer_key] = itransval + len(
-                            transfer.line_suffixes
-                        )
+                    label = transfer.participant_display_name
+                    if transfer.component_suffix:
+                        label += transfer.component_suffix
+
+                    data_index_map[data_index] = (
+                        transfer_value_subplot,
+                        itransval,
+                    )
+                    transfer_value_subplot.series_labels.append(label)
+                    itransval += 1
+                    transfer_value_line_count[transfer_key] = itransval
 
         # This will be what allows us to update subplot data as new data received
         self._data_index_map[interface_name] = data_index_map

src/ansys/systemcoupling/core/charts/plotter.py

@@ -204,14 +204,8 @@ def update_line_series(self, series_data: SeriesData):
                 "Attempt to add series data to plot before metadata provided."
             )
 
-        trans = self._metadata.transfer_info[series_data.transfer_index]
-        offset = (
-            series_data.component_index
-            if series_data.component_index is not None
-            else 0
-        )
         subplot_defn, subplot_line_index = self._mgr.subplot_for_data_index(
-            self._metadata.name, trans.data_index + offset
+            self._metadata.name, series_data.transfer_index
         )
         if subplot_defn is None:
             # This can happen if the list of plots being show is filtered.

tests/charts/test_csv_chartdata.py

@@ -105,43 +105,37 @@ def test_parse_header():
     assert info0.transfer_display_name == "input"
     assert info0.series_type == SeriesType.CONVERGENCE
     assert info0.participant_display_name is None
-    assert info0.data_index == 0
-    assert info0.line_suffixes == []
+    assert info0.component_suffix is None
 
     info1 = info.transfer_info[1]
     assert info1.transfer_display_name == "input"
     assert info1.series_type == SeriesType.WEIGHTED_AVERAGE
     assert info1.participant_display_name == "rootFind"
-    assert info1.data_index == 1
-    assert info1.line_suffixes == []
+    assert info1.component_suffix is None
 
     info2 = info.transfer_info[2]
     assert info2.transfer_display_name == "input"
     assert info2.series_type == SeriesType.WEIGHTED_AVERAGE
     assert info2.participant_display_name == "rootFind 2"
-    assert info2.data_index == 2
-    assert info2.line_suffixes == []
+    assert info2.component_suffix is None
 
     info3 = info.transfer_info[3]
     assert info3.transfer_display_name == "input2"
     assert info3.series_type == SeriesType.CONVERGENCE
     assert info3.participant_display_name is None
-    assert info3.data_index == 3
-    assert info3.line_suffixes == []
+    assert info3.component_suffix is None
 
     info4 = info.transfer_info[4]
     assert info4.transfer_display_name == "input2"
     assert info4.series_type == SeriesType.WEIGHTED_AVERAGE
     assert info4.participant_display_name == "rootFind 2"
-    assert info4.data_index == 4
-    assert info4.line_suffixes == []
+    assert info4.component_suffix is None
 
     info5 = info.transfer_info[5]
     assert info5.transfer_display_name == "input2"
     assert info5.series_type == SeriesType.WEIGHTED_AVERAGE
     assert info5.participant_display_name == "rootFind"
-    assert info5.data_index == 5
-    assert info5.line_suffixes == []
+    assert info5.component_suffix is None
 
 
 def test_parse_header_components():
@@ -165,49 +159,67 @@ def test_parse_header_components():
 
     assert info.display_name == "Intf-1"
     assert info.is_transient
-    assert len(info.transfer_info) == 6
+    assert len(info.transfer_info) == 10
 
     info0 = info.transfer_info[0]
     assert info0.transfer_display_name == "input"
     assert info0.series_type == SeriesType.CONVERGENCE
     assert info0.participant_display_name is None
-    assert info0.data_index == 0
-    assert info0.line_suffixes == []
+    assert info0.component_suffix is None
 
     info1 = info.transfer_info[1]
     assert info1.transfer_display_name == "input"
     assert info1.series_type == SeriesType.SUM
     assert info1.participant_display_name == "part1"
-    assert info1.data_index == 1
-    assert info1.line_suffixes == ["x", "y", "z"]
+    assert info1.component_suffix == "x"
 
-    info2 = info.transfer_info[2]
+    info1 = info.transfer_info[2]
+    assert info1.transfer_display_name == "input"
+    assert info1.series_type == SeriesType.SUM
+    assert info1.participant_display_name == "part1"
+    assert info1.component_suffix == "y"
+
+    info1 = info.transfer_info[3]
+    assert info1.transfer_display_name == "input"
+    assert info1.series_type == SeriesType.SUM
+    assert info1.participant_display_name == "part1"
+    assert info1.component_suffix == "z"
+
+    info2 = info.transfer_info[4]
     assert info2.transfer_display_name == "input"
     assert info2.series_type == SeriesType.SUM
     assert info2.participant_display_name == "part2"
-    assert info2.data_index == 4
-    assert info2.line_suffixes == ["x", "y", "z"]
+    assert info2.component_suffix == "x"
 
-    info3 = info.transfer_info[3]
+    info2 = info.transfer_info[5]
+    assert info2.transfer_display_name == "input"
+    assert info2.series_type == SeriesType.SUM
+    assert info2.participant_display_name == "part2"
+    assert info2.component_suffix == "y"
+
+    info2 = info.transfer_info[6]
+    assert info2.transfer_display_name == "input"
+    assert info2.series_type == SeriesType.SUM
+    assert info2.participant_display_name == "part2"
+    assert info2.component_suffix == "z"
+
+    info3 = info.transfer_info[7]
     assert info3.transfer_display_name == "input2"
     assert info3.series_type == SeriesType.CONVERGENCE
     assert info3.participant_display_name is None
-    assert info3.data_index == 7
-    assert info3.line_suffixes == []
+    assert info3.component_suffix is None
 
-    info4 = info.transfer_info[4]
+    info4 = info.transfer_info[8]
     assert info4.transfer_display_name == "input2"
     assert info4.series_type == SeriesType.SUM
     assert info4.participant_display_name == "part2"
-    assert info4.data_index == 8
-    assert info4.line_suffixes == []
+    assert info4.component_suffix is None
 
-    info5 = info.transfer_info[5]
+    info5 = info.transfer_info[9]
     assert info5.transfer_display_name == "input2"
     assert info5.series_type == SeriesType.SUM
     assert info5.participant_display_name == "part1"
-    assert info5.data_index == 9
-    assert info5.line_suffixes == []
+    assert info5.component_suffix is None
 
 
 def test_timestep(data1):