feat: Updated rainflow cycle binning to use separate binning parameters for range, mean, and dwell. (#630)

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: ansys-pwalters

doc/changelog.d/630.miscellaneous.md

@@ -0,0 +1 @@
+Feat: Updated rainflow cycle binning to use separate binning parameters for range, mean, and dwell.

src/ansys/sherlock/core/lifecycle.py

@@ -2151,7 +2151,9 @@ def import_thermal_signal(
         >>>         phase_name=phaseName,
         >>>         time_removal= False,
         >>>         load_range_percentage=0.25,
-        >>>         number_of_bins=0,
+        >>>         number_of_range_bins=0,
+        >>>         number_of_mean_bins=0,
+        >>>         number_of_dwell_bins=0,
         >>>         temperature_range_filtering_limit=0.0,
         >>>         time_filtering_limit=72.0,
         >>>         time_filtering_limit_units="hr",

src/ansys/sherlock/core/types/lifecycle_types.py

@@ -74,8 +74,12 @@ class ImportThermalSignalRequest(BaseModel):
     """Option to indicate that time results with shorter half-cycle durations are removed."""
     load_range_percentage: float
     """Defines the fraction of the range near peaks and valleys considered as a dwell region."""
-    number_of_bins: int
-    """Number of bins for binning cycles, 0 for no binning."""
+    number_of_range_bins: int
+    """Number of range bins for binning cycles, 0 for no range binning."""
+    number_of_mean_bins: int
+    """Number of mean bins for binning cycles, 0 for no mean binning."""
+    number_of_dwell_bins: int
+    """Number of dwell bins for binning cycles, 0 for no dwell binning."""
     temperature_range_filtering_limit: float
     """Minimum cycle range to include in results, 0 for not filtering."""
     time_filtering_limit: float
@@ -93,7 +97,7 @@ def str_validation(cls, value: str, info: ValidationInfo):
         """Validate string fields listed."""
         return basic_str_validator(value, info.field_name)
 
-    @field_validator("number_of_bins")
+    @field_validator("number_of_range_bins", "number_of_mean_bins", "number_of_dwell_bins")
     @classmethod
     def non_negative_int_validation(cls, value: int, info: ValidationInfo):
         """Validate integer fields listed contain non-negative values."""
@@ -110,7 +114,9 @@ def _convert_to_grpc(self) -> SherlockLifeCycleService_pb2.ImportThermalSignalRe
             fileProperties=self.thermal_signal_file_properties._convert_to_grpc(),
             timeRemoval=self.time_removal,
             loadRangePercentage=self.load_range_percentage,
-            numberOfBins=self.number_of_bins,
+            numberOfRangeBins=self.number_of_range_bins,
+            numberOfMeanBins=self.number_of_mean_bins,
+            numberOfDwellBins=self.number_of_dwell_bins,
             temperatureRangeFilteringLimit=self.temperature_range_filtering_limit,
             timeFilteringLimit=self.time_filtering_limit,
             timeFilteringLimitUnits=self.time_filtering_limit_units,

tests/test_lifecycle.py

@@ -2072,7 +2072,9 @@ def helper_test_import_thermal_signal(lifecycle: Lifecycle):
                 phase_name="Environmental",
                 time_removal=False,
                 load_range_percentage=0.25,
-                number_of_bins=0,
+                number_of_range_bins=0,
+                number_of_mean_bins=0,
+                number_of_dwell_bins=0,
                 temperature_range_filtering_limit=0.0,
                 time_filtering_limit=72.0,
                 time_filtering_limit_units="hr",
@@ -2104,7 +2106,9 @@ def helper_test_import_thermal_signal(lifecycle: Lifecycle):
                 phase_name="Environmental",
                 time_removal=False,
                 load_range_percentage=0.25,
-                number_of_bins=0,
+                number_of_range_bins=0,
+                number_of_mean_bins=0,
+                number_of_dwell_bins=0,
                 temperature_range_filtering_limit=0.0,
                 time_filtering_limit=72.0,
                 time_filtering_limit_units="hr",
@@ -2136,7 +2140,9 @@ def helper_test_import_thermal_signal(lifecycle: Lifecycle):
                 phase_name="",
                 time_removal=False,
                 load_range_percentage=0.25,
-                number_of_bins=0,
+                number_of_range_bins=0,
+                number_of_mean_bins=0,
+                number_of_dwell_bins=0,
                 temperature_range_filtering_limit=0.0,
                 time_filtering_limit=72.0,
                 time_filtering_limit_units="hr",
@@ -2168,19 +2174,89 @@ def helper_test_import_thermal_signal(lifecycle: Lifecycle):
                 phase_name="Environmental",
                 time_removal=False,
                 load_range_percentage=0.25,
-                number_of_bins=-1,
+                number_of_range_bins=-1,
+                number_of_mean_bins=0,
+                number_of_dwell_bins=0,
                 temperature_range_filtering_limit=0.0,
                 time_filtering_limit=72.0,
                 time_filtering_limit_units="hr",
                 generated_cycles_label="Generated Cycles from pySherlock",
             )
         )
-        pytest.fail("No exception raised when using a missing generated_cycles_label parameter")
+        pytest.fail("No exception raised when using invalid number_of_range_bins parameter")
+    except Exception as e:
+        assert isinstance(e, pydantic.ValidationError)
+        assert (
+            str(e.errors()[0]["msg"])
+            == "Value error, number_of_range_bins must be greater than or equal to 0."
+        )
+
+    try:
+        lifecycle.import_thermal_signal(
+            ImportThermalSignalRequest(
+                file_name="C:/Temp/ThermalSignalMissing.csv",
+                project="Tutorial Project",
+                thermal_signal_file_properties=ThermalSignalFileProperties(
+                    header_row_count=0,
+                    numeric_format="English",
+                    column_delimiter=",",
+                    time_column="Time",
+                    time_units="sec",
+                    temperature_column="Temperature",
+                    temperature_units="C",
+                ),
+                phase_name="Environmental",
+                time_removal=False,
+                load_range_percentage=0.25,
+                number_of_range_bins=0,
+                number_of_mean_bins=-1,
+                number_of_dwell_bins=0,
+                temperature_range_filtering_limit=0.0,
+                time_filtering_limit=72.0,
+                time_filtering_limit_units="hr",
+                generated_cycles_label="Generated Cycles from pySherlock",
+            )
+        )
+        pytest.fail("No exception raised when using invalid number_of_mean_bins parameter")
+    except Exception as e:
+        assert isinstance(e, pydantic.ValidationError)
+        assert (
+            str(e.errors()[0]["msg"])
+            == "Value error, number_of_mean_bins must be greater than or equal to 0."
+        )
+
+    try:
+        lifecycle.import_thermal_signal(
+            ImportThermalSignalRequest(
+                file_name="C:/Temp/ThermalSignalMissing.csv",
+                project="Tutorial Project",
+                thermal_signal_file_properties=ThermalSignalFileProperties(
+                    header_row_count=0,
+                    numeric_format="English",
+                    column_delimiter=",",
+                    time_column="Time",
+                    time_units="sec",
+                    temperature_column="Temperature",
+                    temperature_units="C",
+                ),
+                phase_name="Environmental",
+                time_removal=False,
+                load_range_percentage=0.25,
+                number_of_range_bins=0,
+                number_of_mean_bins=0,
+                number_of_dwell_bins=-1,
+                temperature_range_filtering_limit=0.0,
+                time_filtering_limit=72.0,
+                time_filtering_limit_units="hr",
+                generated_cycles_label="Generated Cycles from pySherlock",
+            )
+        )
+        pytest.fail("No exception raised when using invalid number_of_dwell_bins parameter")
     except Exception as e:
         assert isinstance(e, pydantic.ValidationError)
         assert (
             str(e.errors()[0]["msg"])
-            == "Value error, number_of_bins must be greater than or equal to 0."
+            == "Value error, number_of_dwell_bins must be greater than or equal to 0."
         )
 
     try:
@@ -2200,7 +2276,9 @@ def helper_test_import_thermal_signal(lifecycle: Lifecycle):
                 phase_name="Environmental",
                 time_removal=False,
                 load_range_percentage=0.25,
-                number_of_bins=0,
+                number_of_range_bins=0,
+                number_of_mean_bins=0,
+                number_of_dwell_bins=0,
                 temperature_range_filtering_limit=0.0,
                 time_filtering_limit=72.0,
                 time_filtering_limit_units="",
@@ -2232,7 +2310,9 @@ def helper_test_import_thermal_signal(lifecycle: Lifecycle):
                 phase_name="Environmental",
                 time_removal=False,
                 load_range_percentage=0.25,
-                number_of_bins=0,
+                number_of_range_bins=0,
+                number_of_mean_bins=0,
+                number_of_dwell_bins=0,
                 temperature_range_filtering_limit=0.0,
                 time_filtering_limit=72.0,
                 time_filtering_limit_units="hr",