Added peak tagging plugin #487

WenzDaniel · 2021-05-12T14:31:05Z

What is the problem / what does the code in this PR do
In this PR we add the Peak counterpart for the veto regions plugins which are added in #465. The working principle is simple. We tag all S1 peaks which touch one of the veto regions. The tag is cumulative in case both veto systems issued a veto signal. In addition we are computing the time difference to the closest veto interval.

Merge Veto plugins #465
Add a new event level plugin above event_info.
Add tests.

Proposed Dependency structure:
To minimize the interference with TPC processing two new data_types are introduced. One at the peak level and one above event_info. They are shown in the subsequent figure.

In this way we can process the TPC up to event_info without the need of having the data of the vetos already processed. Both data types are only save when asked, e.g. for dedicated studies about the optimization of the veto interval length. Computational wise are both plugins very light weighted.

straxen/plugins/peak_processing.py

github-actions · 2021-05-12T14:37:16Z

straxen/plugins/peak_processing.py

+
+
+class PeakVetoTagging(strax.Plugin):
+    """Plugin which tags S1 peaks according to the muon and neutron-veto.


[pep8] _{reported by reviewdog 🐶}
D204 1 blank line required after class docstring

github-actions · 2021-05-12T14:37:17Z

straxen/plugins/peak_processing.py

+
+
+class PeakVetoTagging(strax.Plugin):
+    """Plugin which tags S1 peaks according to the muon and neutron-veto.


[pep8] _{reported by reviewdog 🐶}
D208 Docstring is over-indented

github-actions · 2021-05-13T07:56:36Z

straxen/plugins/peak_processing.py

+def tag_peaks(tags, touching_windows, tag_number):
+    pre_tags = np.zeros(len(tags), dtype=np.int8)
+    for start, end in touching_windows:
+        pre_tags[start:end] = tag_number


[pep8] _{reported by reviewdog 🐶}
WPS362 Found assignment to a subscript slice

into peak_tagging_plugin

JoranAngevaare

I thought you requested my review but it appears to be still a draft. Here some minor comments/suggestions but I'll re-review after it's undrafted

JoranAngevaare · 2021-08-02T07:54:13Z

straxen/plugins/event_info.py

-    """
-    depends_on = ['events',
-                  'event_basics',
-                  'event_positions',
-                  'corrected_areas',
-                  'energy_estimates',
-                  # 'event_pattern_fit', <- this will be added soon
-                  ]
-    save_when = strax.SaveWhen.ALWAYS
-    provides = 'event_info'
-    __version__ = '0.0.1'
-
-    def compute(self, **kwargs):
-        event_info_function = self.config['event_info_function']
-        event_info = super().compute(**kwargs)
-        if event_info_function != 'disabled':
-            event_info = pre_apply_function(event_info,
-                                            self.run_id,
-                                            self.provides,
-                                            event_info_function,
-                                            )
-        return event_info
-
-
-@export
-class EventInfo1T(strax.MergeOnlyPlugin):
-    """
-    Plugin which merges the information of all event data_kinds into a
-    single data_type.
-
-    This only uses 1T data-types as several event-plugins are nT only
-    """
-    depends_on = ['events',
-                  'event_basics',
-                  'event_positions',
-                  'corrected_areas',
-                  'energy_estimates']
-    provides = 'event_info'
-    save_when = strax.SaveWhen.ALWAYS
-    __version__ = '0.0.0'
+import strax
+from straxen import pre_apply_function
+
+import numpy as np
+import numba
+export, __all__ = strax.exporter()
+
+
+@export
+@strax.takes_config(
+    strax.Option(
+        name='event_info_function',
+        default='pre_apply_function',
+        help="Function that must be applied to all event_info data. Do not change.",
+    )
+)
+class EventInfo(strax.MergeOnlyPlugin):
+    """
+    Plugin which merges the information of all event data_kinds into a
+    single data_type.
+    """
+    depends_on = ['events',
+                  'event_basics',
+                  'event_positions',
+                  'corrected_areas',
+                  'energy_estimates',
+                  # 'event_pattern_fit', <- this will be added soon
+                  ]
+    save_when = strax.SaveWhen.ALWAYS
+    provides = 'event_info'
+    __version__ = '0.0.1'
+
+    def compute(self, **kwargs):
+        event_info_function = self.config['event_info_function']
+        event_info = super().compute(**kwargs)
+        if event_info_function != 'disabled':
+            event_info = pre_apply_function(event_info,
+                                            self.run_id,
+                                            self.provides,
+                                            event_info_function,
+                                            )
+        return event_info
+
+
+@export
+class EventInfo1T(strax.MergeOnlyPlugin):
+    """
+    Plugin which merges the information of all event data_kinds into a
+    single data_type.
+
+    This only uses 1T data-types as several event-plugins are nT only
+    """
+    depends_on = ['events',
+                  'event_basics',
+                  'event_positions',
+                  'corrected_areas',
+                  'energy_estimates']
+    provides = 'event_info'
+    save_when = strax.SaveWhen.ALWAYS
+    __version__ = '0.0.0'


Would it be possible to revert this to conserve the git history?

Ups yes, for sure.

Hmm somehow it is not revertible. I guess I will have to make a new branch....

straxen/plugins/event_info.py

straxen/plugins/peak_processing.py

JoranAngevaare · 2021-08-02T08:20:44Z

straxen/plugins/peak_processing.py

+    """
+    vetos = np.zeros(len(veto_intervals)+2, np.int64)
+    vetos[1:-1] = veto_intervals['time']
+    vetos[-1] = 9223372036854775807  # 64 bit infinity


perhaps we could re-use https://github.com/XENONnT/straxen/blob/master/straxen/plugins/acqmon_processing.py#L10

Sure, but I would put also "infinity" there. @AlexElykov do you see any problem if we replace the 1h in T_NO_VETO_FOUND by a 64 bit infinity? 1 h is a bit arbitrary.

Co-authored-by: Joran Angevaare <jorana@nikhef.nl>

into peak_tagging_plugin

This reverts commit 4f09bdf.

* Modificatons of nT simulation context * Throwing some whitespae bones to the doggy * some changes to make Daniel a bit happier, but still leeping shorter lines * Changes to error and docstring * actually, there should be break here * Small modification in the loop * Empty line to redo codefactor * Hopefully, this is the correct way to fix codefactor complain Co-authored-by: Daniel Wenz <43881800+WenzDaniel@users.noreply.github.com>

* Increase buffer size * Please review dog Co-authored-by: Joran Angevaare <jorana@nikhef.nl>

Bumps [tqdm](https://github.com/tqdm/tqdm) from 4.61.1 to 4.62.0. - [Release notes](https://github.com/tqdm/tqdm/releases) - [Commits](tqdm/tqdm@v4.61.1...v4.62.0) --- updated-dependencies: - dependency-name: tqdm dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [utilix](https://github.com/XENONnT/utilix) from 0.6.0 to 0.6.1. - [Release notes](https://github.com/XENONnT/utilix/releases) - [Changelog](https://github.com/XENONnT/utilix/blob/master/HISTORY.md) - [Commits](XENONnT/utilix@v0.6.0...v0.6.1) --- updated-dependencies: - dependency-name: utilix dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Joran Angevaare <jorana@nikhef.nl>

Bumps [coveralls](https://github.com/TheKevJames/coveralls-python) from 3.1.0 to 3.2.0. - [Release notes](https://github.com/TheKevJames/coveralls-python/releases) - [Changelog](https://github.com/TheKevJames/coveralls-python/blob/master/CHANGELOG.md) - [Commits](TheKevJames/coveralls-python@3.1.0...3.2.0) --- updated-dependencies: - dependency-name: coveralls dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Joran Angevaare <jorana@nikhef.nl>

Bumps [holoviews](https://github.com/holoviz/holoviews) from 1.14.4 to 1.14.5. - [Release notes](https://github.com/holoviz/holoviews/releases) - [Changelog](https://github.com/holoviz/holoviews/blob/master/CHANGELOG.md) - [Commits](holoviz/holoviews@v1.14.4...v1.14.5) --- updated-dependencies: - dependency-name: holoviews dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Joran Angevaare <jorana@nikhef.nl>

…nts (#609) Updates the requirements on [dask](https://github.com/dask/dask) to permit the latest version. - [Release notes](https://github.com/dask/dask/releases) - [Changelog](https://github.com/dask/dask/blob/main/docs/release-procedure.md) - [Commits](dask/dask@2021.06.0...2021.07.2) --- updated-dependencies: - dependency-name: dask dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Joran Angevaare <jorana@nikhef.nl>

Bumps [hypothesis](https://github.com/HypothesisWorks/hypothesis) from 6.14.0 to 6.14.5. - [Release notes](https://github.com/HypothesisWorks/hypothesis/releases) - [Commits](HypothesisWorks/hypothesis@hypothesis-python-6.14.0...hypothesis-python-6.14.5) --- updated-dependencies: - dependency-name: hypothesis dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Joran Angevaare <jorana@nikhef.nl>

* Bump xarray from 0.16.2 to 0.19.0 in /extra_requirements Bumps [xarray](https://github.com/pydata/xarray) from 0.16.2 to 0.19.0. - [Release notes](https://github.com/pydata/xarray/releases) - [Changelog](https://github.com/pydata/xarray/blob/main/HOW_TO_RELEASE.md) - [Commits](pydata/xarray@v0.16.2...v0.19.0) --- updated-dependencies: - dependency-name: xarray dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * Update requirements-tests.txt Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Joran Angevaare <jorana@nikhef.nl>

) Bumps [importlib-metadata](https://github.com/python/importlib_metadata) from 4.6.0 to 4.6.3. - [Release notes](https://github.com/python/importlib_metadata/releases) - [Changelog](https://github.com/python/importlib_metadata/blob/main/CHANGES.rst) - [Commits](python/importlib_metadata@v4.6.0...v4.6.3) --- updated-dependencies: - dependency-name: importlib-metadata dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Joran Angevaare <jorana@nikhef.nl>

Co-authored-by: Joran Angevaare <jorana@nikhef.nl>

This reverts commit 4f09bdf.

into peak_tagging_plugin

WenzDaniel · 2021-08-03T07:28:37Z

Somehow it is not possible to clean the git history. I made a new branch.

See #618

Added peak tagging plugin

0e2bc3d

github-actions bot reviewed May 12, 2021

View reviewed changes

Adressed some of dog comments

6233da5

github-actions bot reviewed May 12, 2021

View reviewed changes

Fixed double tagging by the same veto

5a3a152

github-actions bot reviewed May 13, 2021

View reviewed changes

JoranAngevaare added enhancement New feature or request good first issue Good for newcomers labels May 28, 2021

JoranAngevaare and others added 13 commits June 15, 2021 09:59

Merge branch 'master' into peak_tagging_plugin

d8d235e

Merge branch 'master' into peak_tagging_plugin

ccdd999

Added function to compute time to closest veto interval

f5a05f6

Fixed a few bugs

bf77026

Merge branch 'master' into peak_tagging_plugin

5d10f6a

Removed additional end line

8c7d1cf

Merge branch 'peak_tagging_plugin' of https://github.com/XENONnT/straxen

5fdbd2e

into peak_tagging_plugin

Add event level plugin for tagging events

f7b9ba2

Change to save when target

241add2

Add event tagging plugin

4f09bdf

Rename loop variable

4900b62

Update docs.

3f8fb48

Merge branch 'master' into peak_tagging_plugin

6fd1621

JoranAngevaare reviewed Aug 2, 2021

View reviewed changes

WenzDaniel and others added 7 commits August 2, 2021 10:31

Update straxen/plugins/event_info.py

fc242dc

Co-authored-by: Joran Angevaare <jorana@nikhef.nl>

Update straxen/plugins/event_info.py

c4593a5

Co-authored-by: Joran Angevaare <jorana@nikhef.nl>

Update straxen/plugins/event_info.py

6ec31c1

Co-authored-by: Joran Angevaare <jorana@nikhef.nl>

Use IntEnum for tags

d8e142b

Merge branch 'peak_tagging_plugin' of https://github.com/XENONnT/straxen

6834957

into peak_tagging_plugin

Update loops

f9c5085

Revert "Add event tagging plugin"

27ae556

This reverts commit 4f09bdf.

WenzDaniel and others added 18 commits August 3, 2021 02:00

Remove empty last line

c06d96f

Increase buffer size (#604)

8d9f7e9

* Increase buffer size * Please review dog Co-authored-by: Joran Angevaare <jorana@nikhef.nl>

Update straxen/plugins/event_info.py

704738e

Co-authored-by: Joran Angevaare <jorana@nikhef.nl>

Update straxen/plugins/event_info.py

14b2af4

Co-authored-by: Joran Angevaare <jorana@nikhef.nl>

Update straxen/plugins/event_info.py

594408a

Co-authored-by: Joran Angevaare <jorana@nikhef.nl>

Update loops

23c210d

Revert "Add event tagging plugin"

245c715

This reverts commit 4f09bdf.

Remove empty last line

81b314f

Merge branch 'peak_tagging_plugin' of https://github.com/XENONnT/straxen

9d6c8aa

into peak_tagging_plugin

WenzDaniel closed this Aug 3, 2021

WenzDaniel deleted the peak_tagging_plugin branch August 3, 2021 09:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added peak tagging plugin #487

Added peak tagging plugin #487

WenzDaniel commented May 12, 2021 •

edited

Loading

github-actions bot May 12, 2021

github-actions bot May 12, 2021

github-actions bot May 13, 2021

JoranAngevaare left a comment •

edited

Loading

JoranAngevaare Aug 2, 2021

WenzDaniel Aug 2, 2021

WenzDaniel Aug 3, 2021

JoranAngevaare Aug 2, 2021

WenzDaniel Aug 3, 2021

WenzDaniel commented Aug 3, 2021 •

edited

Loading



		class PeakVetoTagging(strax.Plugin):
		"""Plugin which tags S1 peaks according to the muon and neutron-veto.

Added peak tagging plugin #487

Added peak tagging plugin #487

Conversation

WenzDaniel commented May 12, 2021 • edited Loading

github-actions bot May 12, 2021

Choose a reason for hiding this comment

github-actions bot May 12, 2021

Choose a reason for hiding this comment

github-actions bot May 13, 2021

Choose a reason for hiding this comment

JoranAngevaare left a comment • edited Loading

Choose a reason for hiding this comment

JoranAngevaare Aug 2, 2021

Choose a reason for hiding this comment

WenzDaniel Aug 2, 2021

Choose a reason for hiding this comment

WenzDaniel Aug 3, 2021

Choose a reason for hiding this comment

JoranAngevaare Aug 2, 2021

Choose a reason for hiding this comment

WenzDaniel Aug 3, 2021

Choose a reason for hiding this comment

WenzDaniel commented Aug 3, 2021 • edited Loading

WenzDaniel commented May 12, 2021 •

edited

Loading

JoranAngevaare left a comment •

edited

Loading

WenzDaniel commented Aug 3, 2021 •

edited

Loading