Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use SOM peaklets classification by default #1471

Merged
merged 7 commits into from
Nov 16, 2024
Merged

Use SOM peaklets classification by default #1471

merged 7 commits into from
Nov 16, 2024

Conversation

dachengx
Copy link
Collaborator

@dachengx dachengx commented Nov 15, 2024

Before you submit this PR: make sure to put all operations-related information in a wiki-note, a PR should be about code and is publicly accessible

Depends on #1472

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

SIGNIFICANT CHANGE
BREAKING CHANGE

Can you briefly describe how it works?

Use SOM classification (https://xe1t-wiki.lngs.infn.it/doku.php?id=xenon:xenonnt:lsanchez:som_summary_note) by default.

Following #1269 and #1300.

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

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?

Notes on testing

  • Until the automated tests pass, please mark the PR as a draft.
  • On the XENONnT fork we test with database access, on private forks there is no database access for security considerations.

All italic comments can be removed from this template.

@sebvetter
Copy link

sebvetter commented Nov 15, 2024

Do we want the default plugins to be called pluginSOM? E.g. straxen.PeaksSOM, straxen.PeakBasicsSOM,

@dachengx
Copy link
Collaborator Author

Do we want the default plugins to be called pluginSOM? E.g. straxen.PeaksSOM, straxen.PeakBasicsSOM,

I do not like it, either. Any suggestions? :)

@sebvetter
Copy link

What is the problem with simply naming the class Peaks, or rather overwriting the old Peaks plugin with the contents of the PeaksSOM plugin? The old code will be preserved in older straxen versions. Will there still be some plugins after this PR that use the non-SOM versions?

@dachengx
Copy link
Collaborator Author

What is the problem with simply naming the class Peaks, or rather overwriting the old Peaks plugin with the contents of the PeaksSOM plugin? The old code will be preserved in older straxen versions. Will there still be some plugins after this PR that use the non-SOM versions?

E.g, PeakletClassificationSOM is inherited from PeakletClassification so we have to keep PeakletClassification.

But maybe rename PeakletClassification to something else?

@coveralls
Copy link

Coverage Status

coverage: 89.792% (+1.1%) from 88.685%
when pulling 2bb7e68 on som_default
into 28240ff on master.

@dachengx dachengx merged commit 6838d38 into master Nov 16, 2024
8 checks passed
@dachengx dachengx deleted the som_default branch November 16, 2024 03:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants