Improve name of helper function

Author: SimonHeybrock

docs/api-reference/index.md

@@ -10,6 +10,7 @@
    :toctree: ../generated/attributes
 
    providers
+   with_pixel_mask_filenames
 ```
 
 ### Submodules

docs/user-guide/dream/dream-data-reduction.ipynb

@@ -94,7 +94,7 @@
     ")\n",
     "\n",
     "pipeline = sciline.Pipeline(providers, params=params)\n",
-    "pipeline = powder.set_pixel_mask_filenames(pipeline, [])"
+    "pipeline = powder.with_pixel_mask_filenames(pipeline, [])"
    ]
   },
   {

docs/user-guide/sns-instruments/POWGEN_data_reduction.ipynb

@@ -86,7 +86,7 @@
    "source": [
     "providers = [*powder.providers, *powgen.providers]\n",
     "pipeline = sciline.Pipeline(providers, params=params)\n",
-    "pipeline = powder.set_pixel_mask_filenames(pipeline, [])"
+    "pipeline = powder.with_pixel_mask_filenames(pipeline, [])"
    ]
   },
   {

src/ess/powder/__init__.py

@@ -15,7 +15,7 @@
     smoothing,
     uncertainty,
 )
-from .masking import set_pixel_mask_filenames
+from .masking import with_pixel_mask_filenames
 
 try:
     __version__ = importlib.metadata.version(__package__ or __name__)
@@ -43,5 +43,5 @@
     "providers",
     "smoothing",
     "uncertainty",
-    "set_pixel_mask_filenames",
+    "with_pixel_mask_filenames",
 ]

src/ess/powder/masking.py

@@ -73,7 +73,7 @@ def _merge(*dicts: dict) -> dict:
     return {key: value for d in dicts for key, value in d.items()}
 
 
-def set_pixel_mask_filenames(
+def with_pixel_mask_filenames(
     workflow: sciline.Pipeline, masks: Iterable[str]
 ) -> sciline.Pipeline:
     """

tests/dream/geant4_reduction_test.py

@@ -70,7 +70,7 @@ def test_can_create_pipeline(providers, params):
 
 def test_pipeline_can_compute_dspacing_result(providers, params):
     pipeline = sciline.Pipeline(providers, params=params)
-    pipeline = powder.set_pixel_mask_filenames(pipeline, [])
+    pipeline = powder.with_pixel_mask_filenames(pipeline, [])
     result = pipeline.compute(IofDspacing)
     assert result.sizes == {
         'dspacing': len(params[DspacingBins]) - 1,
@@ -80,7 +80,7 @@ def test_pipeline_can_compute_dspacing_result(providers, params):
 
 def test_workflow_is_deterministic(providers, params):
     pipeline = sciline.Pipeline(providers, params=params)
-    pipeline = powder.set_pixel_mask_filenames(pipeline, [])
+    pipeline = powder.with_pixel_mask_filenames(pipeline, [])
     # This is Sciline's default scheduler, but we want to be explicit here
     scheduler = sciline.scheduler.DaskScheduler()
     graph = pipeline.get(IofDspacing, scheduler=scheduler)
@@ -91,7 +91,7 @@ def test_workflow_is_deterministic(providers, params):
 
 def test_pipeline_can_compute_intermediate_results(providers, params):
     pipeline = sciline.Pipeline(providers, params=params)
-    pipeline = powder.set_pixel_mask_filenames(pipeline, [])
+    pipeline = powder.with_pixel_mask_filenames(pipeline, [])
     result = pipeline.compute(NormalizedByProtonCharge[SampleRun])
     assert set(result.dims) == {'segment', 'wire', 'counter', 'strip', 'module'}
 
@@ -101,7 +101,7 @@ def test_pipeline_group_by_two_theta(providers, params):
         dim='two_theta', unit='rad', start=0.8, stop=2.4, num=17
     )
     pipeline = sciline.Pipeline(providers, params=params)
-    pipeline = powder.set_pixel_mask_filenames(pipeline, [])
+    pipeline = powder.with_pixel_mask_filenames(pipeline, [])
     result = pipeline.compute(IofDspacingTwoTheta)
     assert result.sizes == {
         'two_theta': 16,
@@ -116,7 +116,7 @@ def test_pipeline_wavelength_masking(providers, params):
     wmax = sc.scalar(0.21, unit="angstrom")
     params[WavelengthMask] = lambda x: (x > wmin) & (x < wmax)
     pipeline = sciline.Pipeline(providers, params=params)
-    pipeline = powder.set_pixel_mask_filenames(pipeline, [])
+    pipeline = powder.with_pixel_mask_filenames(pipeline, [])
     masked_sample = pipeline.compute(MaskedData[SampleRun])
     assert 'wavelength' in masked_sample.bins.masks
     sum_in_masked_region = (
@@ -135,7 +135,7 @@ def test_pipeline_two_theta_masking(providers, params):
     tmax = sc.scalar(1.2, unit="rad")
     params[TwoThetaMask] = lambda x: (x > tmin) & (x < tmax)
     pipeline = sciline.Pipeline(providers, params=params)
-    pipeline = powder.set_pixel_mask_filenames(pipeline, [])
+    pipeline = powder.with_pixel_mask_filenames(pipeline, [])
     masked_sample = pipeline.compute(MaskedData[SampleRun])
     assert 'two_theta' in masked_sample.bins.masks
     sum_in_masked_region = (

tests/powder/external/powgen/powgen_reduction_test.py

@@ -56,7 +56,7 @@ def test_can_create_pipeline(providers, params):
 
 def test_pipeline_can_compute_dspacing_result(providers, params):
     pipeline = sciline.Pipeline(providers, params=params)
-    pipeline = powder.set_pixel_mask_filenames(pipeline, [])
+    pipeline = powder.with_pixel_mask_filenames(pipeline, [])
     result = pipeline.compute(IofDspacing)
     assert result.sizes == {
         'dspacing': len(params[DspacingBins]) - 1,
@@ -66,7 +66,7 @@ def test_pipeline_can_compute_dspacing_result(providers, params):
 
 def test_workflow_is_deterministic(providers, params):
     pipeline = sciline.Pipeline(providers, params=params)
-    pipeline = powder.set_pixel_mask_filenames(pipeline, [])
+    pipeline = powder.with_pixel_mask_filenames(pipeline, [])
     # This is Sciline's default scheduler, but we want to be explicit here
     scheduler = sciline.scheduler.DaskScheduler()
     graph = pipeline.get(IofDspacing, scheduler=scheduler)
@@ -77,7 +77,7 @@ def test_workflow_is_deterministic(providers, params):
 
 def test_pipeline_can_compute_intermediate_results(providers, params):
     pipeline = sciline.Pipeline(providers, params=params)
-    pipeline = powder.set_pixel_mask_filenames(pipeline, [])
+    pipeline = powder.with_pixel_mask_filenames(pipeline, [])
     result = pipeline.compute(NormalizedByProtonCharge[SampleRun])
     assert set(result.dims) == {'bank', 'column', 'row'}
 
@@ -87,7 +87,7 @@ def test_pipeline_group_by_two_theta(providers, params):
         dim='two_theta', unit='deg', start=25.0, stop=90.0, num=16
     ).to(unit='rad')
     pipeline = sciline.Pipeline(providers, params=params)
-    pipeline = powder.set_pixel_mask_filenames(pipeline, [])
+    pipeline = powder.with_pixel_mask_filenames(pipeline, [])
     result = pipeline.compute(IofDspacingTwoTheta)
     assert result.sizes == {
         'two_theta': 15,
@@ -102,7 +102,7 @@ def test_pipeline_wavelength_masking(providers, params):
     wmax = sc.scalar(0.21, unit="angstrom")
     params[WavelengthMask] = lambda x: (x > wmin) & (x < wmax)
     pipeline = sciline.Pipeline(providers, params=params)
-    pipeline = powder.set_pixel_mask_filenames(pipeline, [])
+    pipeline = powder.with_pixel_mask_filenames(pipeline, [])
     masked_sample = pipeline.compute(MaskedData[SampleRun])
     assert 'wavelength' in masked_sample.bins.masks
     sum_in_masked_region = (
@@ -121,7 +121,7 @@ def test_pipeline_two_theta_masking(providers, params):
     tmax = sc.scalar(1.0, unit="rad")
     params[TwoThetaMask] = lambda x: (x > tmin) & (x < tmax)
     pipeline = sciline.Pipeline(providers, params=params)
-    pipeline = powder.set_pixel_mask_filenames(pipeline, [])
+    pipeline = powder.with_pixel_mask_filenames(pipeline, [])
     masked_sample = pipeline.compute(MaskedData[SampleRun])
     assert 'two_theta' in masked_sample.masks
     sum_in_masked_region = (