write_parameters -> write_dl1_parameters

examples/tutorials/tableloader_and_eventsources.py

@@ -138,7 +138,7 @@
 with DataWriter(
     event_source=source,
     output_path="events.dl1.h5",
-    write_parameters=False,
+    write_dl1_parameters=False,
     overwrite=True,
     write_dl1_images=True,
 ) as write_data:

src/ctapipe/conftest.py

@@ -415,7 +415,7 @@ def dl1_image_file(dl1_tmp_path, prod5_gamma_simtel_path):
             f"--input={prod5_gamma_simtel_path}",
             f"--output={output}",
             "--write-images",
-            "--DataWriter.write_parameters=False",
+            "--DataWriter.write_dl1_parameters=False",
             "--max-events=20",
             "--DataWriter.Contact.name=αℓℓ the äüöß",
         ]

src/ctapipe/io/datawriter.py

@@ -195,7 +195,7 @@ class DataWriter(Component):
         help="Store DL1 Images if available", default_value=False
     ).tag(config=True)
 
-    write_parameters = Bool(
+    write_dl1_parameters = Bool(
         help="Store DL1 image parameters if available", default_value=True
     ).tag(config=True)
 
@@ -394,7 +394,7 @@ def datalevels(self):
         data_levels = []
         if self.write_dl1_images:
             data_levels.append(DataLevel.DL1_IMAGES)
-        if self.write_parameters:
+        if self.write_dl1_parameters:
             data_levels.append(DataLevel.DL1_PARAMETERS)
         if self.write_muon_parameters:
             data_levels.append(DataLevel.DL1_MUON)
@@ -435,7 +435,7 @@ def _setup_output_path(self):
 
         # check that options make sense
         writable_things = [
-            self.write_parameters,
+            self.write_dl1_parameters,
             self.write_dl1_images,
             self.write_dl2,
             self.write_r1_waveforms,
@@ -475,7 +475,7 @@ def _setup_writer(self):
         if not self.write_dl1_images:
             writer.exclude("/simulation/event/telescope/images/.*", "true_image")
 
-        if not self.write_parameters:
+        if not self.write_dl1_parameters:
             writer.exclude("/dl1/event/telescope/images/.*", "image_mask")
 
         # Set up transforms
@@ -671,7 +671,7 @@ def _write_dl1_telescope_events(self, event: ArrayEventContainer):
 
             table_name = self.table_name(tel_id)
 
-            if self.write_parameters:
+            if self.write_dl1_parameters:
                 self._writer.write(
                     table_name=f"dl1/event/telescope/parameters/{table_name}",
                     containers=[tel_index, *dl1_camera.parameters.values()],
@@ -699,7 +699,7 @@ def _write_dl1_telescope_events(self, event: ArrayEventContainer):
                     tel_id in event.simulation.tel
                     and event.simulation.tel[tel_id].true_image is not None
                 )
-                if self.write_parameters and has_sim_image:
+                if self.write_dl1_parameters and has_sim_image:
                     true_parameters = event.simulation.tel[tel_id].true_parameters
                     # only write the available containers, no peak time related
                     # features for true image available.
@@ -791,7 +791,7 @@ def _generate_indices(self):
                 self._generate_table_indices(
                     self._writer.h5file, "/simulation/event/telescope/images"
                 )
-        if self.write_parameters:
+        if self.write_dl1_parameters:
             self._generate_table_indices(
                 self._writer.h5file, "/dl1/event/telescope/parameters"
             )

src/ctapipe/io/tests/conftest.py

@@ -20,7 +20,7 @@ def r1_hdf5_file(prod5_proton_simtel_path, r1_path):
     writer = DataWriter(
         event_source=source,
         output_path=path,
-        write_parameters=False,
+        write_dl1_parameters=False,
         write_dl1_images=False,
         write_dl2=False,
         write_r0_waveforms=False,

src/ctapipe/io/tests/test_datawriter.py

@@ -80,7 +80,7 @@ def test_write(tmpdir: Path):
     with DataWriter(
         event_source=source,
         output_path=output_path,
-        write_parameters=False,
+        write_dl1_parameters=False,
         write_dl1_images=True,
         write_dl2=True,
         write_r0_waveforms=True,
@@ -158,7 +158,7 @@ def test_roundtrip(tmpdir: Path):
     with DataWriter(
         event_source=source,
         output_path=output_path,
-        write_parameters=False,
+        write_dl1_parameters=False,
         write_dl1_images=True,
         transform_image=True,
         image_dtype="int32",
@@ -229,7 +229,7 @@ def test_dl1writer_no_events(tmpdir: Path):
     with DataWriter(
         event_source=source,
         output_path=output_path,
-        write_parameters=True,
+        write_dl1_parameters=True,
         write_dl1_images=True,
     ) as writer:
         writer.log.level = logging.DEBUG
@@ -269,7 +269,7 @@ def test_metadata(tmpdir: Path):
         with DataWriter(
             event_source=source,
             output_path=output_path,
-            write_parameters=True,
+            write_dl1_parameters=True,
             write_dl1_images=True,
             config=config,
         ):

src/ctapipe/resources/base_config.yaml

@@ -22,7 +22,7 @@ DataWriter:
   # files)
   overwrite: false # do not overwrite existing files
   write_dl1_images: false # store DL1 images
-  write_parameters: false # store DL1 parameters
+  write_dl1_parameters: false # store DL1 parameters
   write_dl2: false # store DL2 stereo geometry
   write_r0_waveforms: false # write R0 waveforms
   write_r1_waveforms: false # write R1 waveforms

src/ctapipe/resources/image_modification_config.json

@@ -7,7 +7,7 @@
         },
         "overwrite": false,
         "write_dl1_images": true,
-        "write_parameters": true,
+        "write_dl1_parameters": true,
         "write_dl2": false,
         "transform_image": true,
         "transform_peak_time": true

src/ctapipe/resources/ml_preprocessing_config.json

@@ -7,7 +7,7 @@
         },
         "overwrite": false,
         "write_dl1_images": false,
-        "write_parameters": true,
+        "write_dl1_parameters": true,
         "write_dl2": true,
         "transform_image": true,
         "transform_peak_time": true

src/ctapipe/resources/ml_preprocessing_config.yaml

@@ -13,5 +13,5 @@
 
 DataWriter:
   write_dl1_images: false
-  write_parameters: true
+  write_dl1_parameters: true
   write_dl2: true

src/ctapipe/resources/stage1_config.json

@@ -7,7 +7,7 @@
         },
         "overwrite": false,
         "write_dl1_images": true,
-        "write_parameters": true,
+        "write_dl1_parameters": true,
         "write_dl2": false,
         "transform_image": true,
         "transform_peak_time": true

src/ctapipe/resources/stage1_config.toml

@@ -9,7 +9,7 @@ organization = "YOUR-ORGANIZATION"
 # options that control what is stored in the output file
 overwrite = false
 write_dl1_images = true
-write_parameters = true
+write_dl1_parameters = true
 write_dl2 = false
 transform_image = true
 transform_peak_time = true

src/ctapipe/resources/stage1_config.yaml

@@ -11,5 +11,5 @@
 
 DataWriter:
   write_dl1_images: true
-  write_parameters: true
+  write_dl1_parameters: true
   write_dl2: false

src/ctapipe/resources/stage2_config.json

@@ -7,7 +7,7 @@
         },
         "overwrite": false,
         "write_dl1_images": false,
-        "write_parameters": false,
+        "write_dl1_parameters": false,
         "write_dl2": true,
         "transform_image": true,
         "transform_peak_time": true

src/ctapipe/resources/stage2_config.yaml

@@ -12,5 +12,5 @@
 
 DataWriter:
   write_dl1_images: false
-  write_parameters: false
+  write_dl1_parameters: false
   write_dl2: true

src/ctapipe/tools/process.py

@@ -43,7 +43,7 @@ class ProcessorTool(Tool):
 
     Note that the muon analysis and shower reconstruction both depend on
     parametrized images and therefore compute image parameters even if
-    DataWriter.write_parameters=False in case these are not already present
+    DataWriter.write_dl1_parameters=False in case these are not already present
     in the input file.
     """
 
@@ -116,7 +116,7 @@ class ProcessorTool(Tool):
         ),
         **flag(
             "write-parameters",
-            "DataWriter.write_parameters",
+            "DataWriter.write_dl1_parameters",
             "store DL1/Event/Telescope parameters in output",
             "don't store DL1/Event/Telescope parameters in output",
         ),
@@ -221,7 +221,7 @@ def should_compute_dl1(self):
             return False
 
         return (
-            self.write.write_parameters
+            self.write.write_dl1_parameters
             or self.should_compute_dl2
             or self.should_compute_muon_parameters
         )