Veto monitor

[tuankhaibui]

What does the code in this PR do / what does it improve?

I add data types for monitoring neutron Veto and muon Veto.

Can you briefly describe how it works?

It produces:

• online_monitor_nv based on hitlets_nv and events_nv
• online_monitor_mv based on hitlets_mv and events_mv

Can you give a minimal working example (or illustrate with a figure)?

The online monitor will be similar to this figure (muon Veto is being updated).
https://xenonnt.slack.com/files/U01T382KYHL/F02LFQGC7DE/image.png

Please include the following if applicable:

• Update the docstring(s)
• Update the documentation
• Tests to check the (new) code is working as desired.
• Does it solve one of the open issues on github?

[github-actions]

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

pep8

straxen/plugins/online_monitor.py|378 col 50| E127 continuation line over-indented for visual indent
straxen/plugins/online_monitor.py|378 col 79| W291 trailing whitespace
straxen/plugins/online_monitor.py|380 col 1| W293 blank line contains whitespace
straxen/plugins/online_monitor.py|396 col 1| W293 blank line contains whitespace
straxen/plugins/online_monitor.py|398 col 9| WPS414 Found incorrect unpacking target
straxen/plugins/online_monitor.py|398 col 9| WPS221 Found line with high Jones Complexity: 17 > 14
straxen/plugins/online_monitor.py|398 col 101| E501 line too long (104 > 100 characters)
straxen/plugins/online_monitor.py|399 col 101| E501 line too long (128 > 100 characters)

[github-actions]

[pep8] _{reported by reviewdog 🐶}
C812 missing trailing comma

[WenzDaniel]

In units of?

[tuankhaibui]

this is not needed and is removed in the new version.

[github-actions]

[pep8] _{reported by reviewdog 🐶}
WPS221 Found line with high Jones Complexity: 15 > 14

[github-actions]

[pep8] _{reported by reviewdog 🐶}
C812 missing trailing comma

[github-actions]

[pep8] _{reported by reviewdog 🐶}
W291 trailing whitespace

[github-actions]

[pep8] _{reported by reviewdog 🐶}
D102 Missing docstring in public method

[github-actions]

[pep8] _{reported by reviewdog 🐶}
E231 missing whitespace after ','

[github-actions]

[pep8] _{reported by reviewdog 🐶}
E231 missing whitespace after ','

[github-actions]

[pep8] _{reported by reviewdog 🐶}
W293 blank line contains whitespace

[github-actions]

[pep8] _{reported by reviewdog 🐶}
D102 Missing docstring in public method

[github-actions]

[pep8] _{reported by reviewdog 🐶}
E127 continuation line over-indented for visual indent

[WenzDaniel]

Hej @tuankhaibui I just noticed at the very end that the second plugin mv plugin is identical to the first one. In that case I would suggest to use a child plugin instead like we use for all other muon-veto plugins. You can see for example:

straxen/straxen/plugins/veto_events.py

Lines 438 to 475 in b20449a

	@strax.takes_config(
	strax.Option('event_left_extension_mv', default=0,
	child_option=True, parent_option_name='event_left_extension_nv',
	help="Extends events this many ns to the left"),
	strax.Option('event_resolving_time_mv', default=300,
	child_option=True, parent_option_name='event_resolving_time_nv',
	help="Resolving time for fixed window coincidence [ns]."),
	strax.Option('event_min_hits_mv', default=3,
	child_option=True, parent_option_name='event_min_hits_nv',
	help="Minimum number of fully confined hitlets to define an event."),
	)
	class muVETOEvents(nVETOEvents):
	"""Plugin which computes the boundaries of veto events.
	"""
	depends_on = 'hitlets_mv'
	provides = 'events_mv'
	data_kind = 'events_mv'
	compressor = 'zstd'
	# Needed in case we make again an muVETO child.
	ends_with = '_mv'
	child_plugin = True
	__version__ = '0.0.1'
	events_seen = 0
	def infer_dtype(self):
	self.name_event_number = 'event_number_mv'
	self.channel_range = self.config['channel_map']['mv']
	self.n_channel = (self.channel_range[1] - self.channel_range[0]) + 1
	return veto_event_dtype(self.name_event_number, self.n_channel)
	def get_window_size(self):
	return self.config['event_left_extension_mv'] + self.config['event_resolving_time_mv'] + 1
	def compute(self, hitlets_mv, start, end):
	return super().compute(hitlets_mv, start, end)

[WenzDaniel]

What happened here? Is not the old comment the correct one?

[tuankhaibui]

I made a mistake when copy and paste.
I will revert to the old comment.

[WenzDaniel]

In units of?

[WenzDaniel]

Suggested change

	sel = events_nv['n_contributing_pmt'] >= 4
	data = events_nv[sel]
	res['events_nv_4coinc_per_chunk'] = len(data)
	sel = events_nv['n_contributing_pmt'] >= 4
	res['events_nv_4coinc_per_chunk'] = np.sum(sel)

Is shorter. If you sum over your boolean array (zeros and ones) you will get the number of rows which were evaluated true. Is a bit shorter.

[tuankhaibui]

nice suggestion! thanks

[JoranAngevaare]

I was about to write the same suggestion 😂 , good job guys!

[WenzDaniel]

Suggested change

	sel = events_nv['n_contributing_pmt'] >= 10
	data = events_nv[sel]
	res['events_nv_10coinc_per_chunk'] = len(data)
	sel = events_nv['n_contributing_pmt'] >= 10
	res['events_nv_10coinc_per_chunk'] = np.sum(sel)

[tuankhaibui]

thanks. changed as you suggested

[WenzDaniel]

You can remove those kind of comments as they are redundant. You should only put comments if the code cannot be easily understood otherwise.

[tuankhaibui]

I removed these comments in the new version

[WenzDaniel]

This one looks a bit complicated, but I am not sure if another solution with if/else would be simpler.

[WenzDaniel]

Btw this stuff I would probably put into def setup(): As it is some handy information one may need later again during compute

[WenzDaniel]

Like self.n_bins = .... and then you can call here self.n_bins.

[WenzDaniel]

See my comments above

[tuankhaibui]

thanks. redundant comments are removed.

[WenzDaniel]

One additional thing. Many of the comments by reviewdog are rather simple to solve. Would you mind to correct those tailing comma missing and additional whitespace issues.

[JoranAngevaare]

Thanks @tuankhaibui , looks good, can you re-request my review after finishing Daniels thorough comments?

Could you by the way explain a bit the events_nv_area_per_chunk and events_nv_area_resolution I don't think I fully get what it's supposed to do.

[JoranAngevaare]

Suggested change

	'online_monitor_nv',
	'online_monitor_mv'))]
	'online_monitor_nv',
	'online_monitor_mv',
	))]

[tuankhaibui]

Thanks @tuankhaibui , looks good, can you re-request my review after finishing Daniels thorough comments?

Could you by the way explain a bit the events_nv_area_per_chunk and events_nv_area_resolution I don't think I fully get what it's supposed to do.

Hi @JoranAngevaare
events_nv_area_per_chunk is used to make the histogram of events_nv['area'], this histogram is similar to the events_background (plotted in orange) in this notebook
events_nv_area_resolution this is a mistake. it should not exist in the code. I forgot to remove it.

I am brushing up the code.
and I will make a new request when everything is ready.

[JoranAngevaare]

I was about to write the same suggestion 😂 , good job guys!

[tuankhaibui]

One additional thing. Many of the comments by reviewdog are rather simple to solve. Would you mind to correct those tailing comma missing and additional whitespace issues.

I am cleaning up. sorry about that

[WenzDaniel]

Hi Khai, I just could one last comment, see below. Other than that it looks fine to me.

[WenzDaniel]

Why do we need this guy?

[tuankhaibui]

@WenzDaniel
Uhm… this was a bit confusing for me yesterday night.
We need an conversion factor from ADC to PE for mVeto.
For nVeto, we don’t need.
Then I think how to use it in child plugin, I considered to use if else but it looks long.
So I make another factor for nVeto. So code a bit shorter.

[WenzDaniel]

You can do something like:

def compute(self, events_mv):
    events_mv = np.copy(events_mv)
    events_mv['area'] *= conversion_factor
    return super().compute(events_mv)

The copy step is necessary since otherwise the array is not writable.

[WenzDaniel]

So this means that for the muon-veto the gains are not set properly yet. So in the future you should not need this factor anylonger.

[tuankhaibui]

right. okay, I updated online_monitor.py
there is no problem when I checked in my notebook.
running tests on github again, but it should be fine.

[tuankhaibui]

    def compute(self, hitlets_mv, events_mv, start, end):
        events_mv = np.copy(events_mv)
        events_mv['area'] *= 1./self.config['adc_to_pe_mv']
        return super().compute(hitlets_mv, events_mv, start, end)

[tuankhaibui]

Thanks @tuankhaibui , looks good, can you re-request my review after finishing Daniels thorough comments?

Could you by the way explain a bit the events_nv_area_per_chunk and events_nv_area_resolution I don't think I fully get what it's supposed to do.

@JoranAngevaare
yeah, the online_monitor.py and contexts.py are both updated.
waiting for your comments :)

[WenzDaniel]

Have you added the online monitor already to the init.py inside the plugins directory? If not could you please add it. I think then it is fine.

[JoranAngevaare]

Thanks @tuankhaibui , looks good!