Add support for selecting R-peak segmenter in ecg() via string parameter#61
Merged
sofia3ms merged 2 commits intoscientisst:mainfrom Jun 26, 2025
Merged
Conversation
…s segmenter-specific parameters (such as 'Pth' in ASI_segmenter) through **kwargs. Created if-check to ensure only viable kwargs are allowed and a helper function 'call_segmenter' to control which kwargs are passed to the segmenter. In case of invalid segmenter name, default (hamilton) will be used.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR introduces support for selecting the signal segmentation algorithm used in
ecg()via a string parametersegmenter. Users can now specify algorithms like"hamilton","ASI","engzee", etc.Additionally, segmenter-specific parameters (e.g.
"threshold","before","tol") can be passed via**kwargs. A whitelist (ALLOWED_KWARGS) ensures only allowed keys are accepted. Invalid arguments raise an exception to prevent accidental or malicious misuse.The logic is handled by a helper function
call_segmenter()which performs argument filtering using Python’sinspectmodule.Fallback to default (
hamilton_segmenter) is provided if an unknown segmenter name is passed.