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

Trigger Readout Window #763

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

Conversation

cg-laser
Copy link
Collaborator

the trace_start_time will include the (channel-specific) trigger time delays at the end of a NuRadioMC simulation.
For a clean implementation and to avoid bugs in old code, a new module channelReadoutWindowCutter was written. The previous triggerTimeAdjuster module will be deprecated in a future release.

@fschlueter
Copy link
Collaborator

Do we want to move the deprecated modules into a folder deprecated (still allowing to import them from NuRadioReco.modules ofc?

@cg-laser
Copy link
Collaborator Author

Do we want to move the deprecated modules into a folder deprecated (still allowing to import them from NuRadioReco.modules ofc?

no, because then the usercode will fail and they won't get the deprecation message ;-)
for the next release, I would just delete them.

Copy link
Collaborator

@sjoerd-bouma sjoerd-bouma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks fine to me - as far as I can tell it really only changes the trace start times back to how they were pre-2.2.0.

I just have some nitpicky comments about multiline strings and a request to use the warnings module for DeprecationWarnings as this will make it easier to catch this stuff in the tests in the future.

NuRadioReco/modules/triggerTimeAdjuster.py Outdated Show resolved Hide resolved
NuRadioReco/modules/triggerTimeAdjuster.py Outdated Show resolved Hide resolved
NuRadioReco/modules/channelLengthAdjuster.py Outdated Show resolved Hide resolved
@sjoerd-bouma
Copy link
Collaborator

Do we want to move the deprecated modules into a folder deprecated (still allowing to import them from NuRadioReco.modules ofc?

no, because then the usercode will fail and they won't get the deprecation message ;-) for the next release, I would just delete them.

I think Felix's suggestion was to move the modules to a deprecated folder, and change the original module to from deprecated import *. You keep the functionality but move deprecated code away. I don't have strong feelings about this either way (though maybe we would want to name the module _deprecated to avoid it showing up as a suggestion for users).

@fschlueter
Copy link
Collaborator

Do we want to move the deprecated modules into a folder deprecated (still allowing to import them from NuRadioReco.modules ofc?

no, because then the usercode will fail and they won't get the deprecation message ;-) for the next release, I would just delete them.

I think Felix's suggestion was to move the modules to a deprecated folder, and change the original module to from deprecated import *. You keep the functionality but move deprecated code away. I don't have strong feelings about this either way (though maybe we would want to name the module _deprecated to avoid it showing up as a suggestion for users).

I would have added to the __init__.py something like:

from deprecated import *

which should avoid that user code fails.

@cg-laser
Copy link
Collaborator Author

thanks for the comments! I fixed them. We still need to update the tests once we agree on the implementation

@fschlueter
Copy link
Collaborator

What is with the channelLengthAdjuster do we still need this module?

@fschlueter
Copy link
Collaborator

What is with the channelLengthAdjuster do we still need this module?

Probably we can keep it because it is a simple module which one can use in reconstruction pipelines?

@cg-laser
Copy link
Collaborator Author

yes, this module might be useful for some studies where running a trigger module would be overkill

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