rename argument is_polarized_dataset as enable_instrument_settings (#39191)

* rename argument `is_polarized_dataset` as `enable_instrument_settings`

The new name describes what the code does more accurately

Signed-off-by: Jose Borreguero <borreguero@gmail.com>

* Trigger CI build

---------

Signed-off-by: Jose Borreguero <borreguero@gmail.com>

Author: jmborr

Framework/PythonInterface/mantid/utils/reflectometry/orso_helper.py

@@ -62,12 +62,12 @@ def __init__(
         reduction_timestamp: datetime,
         creator_name: str,
         creator_affiliation: str,
-        is_polarized_dataset: bool,
+        enable_instrument_settings: bool,
     ) -> None:
         self._data_columns = data_columns
         self._header = None
 
-        self._create_mandatory_header(ws, dataset_name, reduction_timestamp, creator_name, creator_affiliation, is_polarized_dataset)
+        self._create_mandatory_header(ws, dataset_name, reduction_timestamp, creator_name, creator_affiliation, enable_instrument_settings)
 
     @property
     def dataset(self) -> OrsoDataset:
@@ -108,7 +108,7 @@ def _create_mandatory_header(
         reduction_timestamp: datetime,
         creator_name: str,
         creator_affiliation: str,
-        is_polarized_dataset: Optional[bool] = None,
+        enable_instrument_settings: Optional[bool] = None,
     ) -> None:
         owner = Person(name=None, affiliation=None)
 
@@ -123,7 +123,7 @@ def _create_mandatory_header(
         sample = Sample(name=ws.getTitle())
 
         # This will initially only consider polarization
-        instrument_settings = InstrumentSettings(None, None) if is_polarized_dataset else None
+        instrument_settings = InstrumentSettings(None, None) if enable_instrument_settings else None
         measurement = Measurement(instrument_settings=instrument_settings, data_files=[])
 
         data_source = DataSource(owner=owner, experiment=experiment, sample=sample, measurement=measurement)

Framework/PythonInterface/plugins/algorithms/SaveISISReflectometryORSO.py

@@ -413,7 +413,7 @@ def _create_dataset_with_mandatory_header(
             reduction_timestamp=self._get_reduction_timestamp(refl_dataset.reduction_history),
             creator_name=self.name(),
             creator_affiliation=MantidORSODataset.SOFTWARE_NAME,
-            is_polarized_dataset=refl_dataset.is_polarized,
+            enable_instrument_settings=refl_dataset.is_polarized,  # instrument settings only for polarization data
         )
 
     def _add_optional_header_info(self, dataset: MantidORSODataset, refl_dataset: ReflectometryDataset) -> None:

Framework/PythonInterface/test/python/mantid/utils/reflectometry/orso_helper_test.py

@@ -227,7 +227,13 @@ def test_create_mantid_orso_dataset(self):
         creator_name = "Creator Name"
         creator_affiliation = "Creator Affiliation"
         dataset = MantidORSODataset(
-            dataset_name, self._data_columns, self._ws, reduction_timestamp, creator_name, creator_affiliation, is_polarized_dataset=False
+            dataset_name,
+            self._data_columns,
+            self._ws,
+            reduction_timestamp,
+            creator_name,
+            creator_affiliation,
+            enable_instrument_settings=False,
         )
 
         orso_dataset = dataset.dataset
@@ -363,7 +369,7 @@ def test_add_multiple_additional_files_to_mantid_orso_dataset(self):
         self._check_files_are_created(dataset, filenames, 0, len(filenames), False)
 
     def _create_test_dataset(self, polarized=False):
-        return MantidORSODataset("Test dataset", self._data_columns, self._ws, datetime.now(), "", "", is_polarized_dataset=polarized)
+        return MantidORSODataset("Test dataset", self._data_columns, self._ws, datetime.now(), "", "", enable_instrument_settings=polarized)
 
     def _check_mantid_default_header(self, orso_dataset, dataset_name, ws, reduction_timestamp, creator_name, creator_affiliation):
         """Check that the default header contains only the information that can be shared