Add additional automatic detection of the trigger based on time-domain analysis

[drombas]

Related to #204 and #386.

This implements a time-domain detection of the trigger when the text-matching detection fails.

Proposed Changes

• Added a time-domain detection of the trigger
  The implementation computes a metric measuring how much each channel differs from a binary signal. The metric is computed as the average distance from each point to the closest limit of the signal (min or max).
  More "binary-like" signals like the trigger should have most of the points closer to either signal limit resulting on a smaller metric. Assuming this, the trigger is detected as the channel that minimizes the metric.

Changes regarding the chtrig=0 are part of #390 (hope it is not confusing).

Change Type

• bugfix (+0.0.1)
• minor (+0.1.0)
• major (+1.0.0)
• refactoring (no version update)
• test (no version update)
• infrastructure (no version update)
• documentation (no version update)
• other

Checklist before review

• I added everything I wanted to add to this PR.
• [Code or tests only] I wrote/updated the necessary docstrings.
• [Code or tests only] I ran and passed tests locally.
• [Documentation only] I built the docs locally.
• My contribution is harmonious with the rest of the code: I'm not introducing repetitions.
• My code respects the adopted style, especially linting conventions.
• The title of this PR is explanatory on its own, enough to be understood as part of a changelog.
• I added or indicated the right labels.

• I added information regarding the timeline of completion for this PR.

• Please, comment on my PR while it's a draft and give me feedback on the development!

[codecov]

Codecov Report

Merging #391 (e860c5d) into master (3b4ec90) will increase coverage by 0.03%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #391      +/-   ##
==========================================
+ Coverage   94.77%   94.81%   +0.03%     
==========================================
  Files           8        8              
  Lines         862      868       +6     
==========================================
+ Hits          817      823       +6     
  Misses         45       45              

Impacted Files	Coverage Δ
phys2bids/phys2bids.py	88.13% <100.00%> (ø)
phys2bids/physio_obj.py	93.92% <100.00%> (+0.17%)	⬆️

[eurunuela]

Thank you @drombas ! This is great and definitely makes phys2bids more robust.

I would like to have a couple of tiny changes made before approving this PR though.

[eurunuela]

That looks great. Thanks @drombas !

[rzlim08]

This looks great!

[eurunuela]

LGTM! Hopefully the failing test will pass when merged into master.

[smoia]

LGTM! Hopefully the failing test will pass when merged into master.

But please check them out before merging!

[eurunuela]

But please check them out before merging!

I will! I'm reading the guidelines too because I have completely forgotten about how we name PRs lol.

[smoia]

But please check them out before merging!

I will! I'm reading the guidelines too because I have completely forgotten about how we name PRs lol.

Is it ok?

[eurunuela]

Is it ok?

Yeah, that looks good. Thanks!

[smoia]

Ok, apparently the readthedocs fail is not related to the PR (other PR have the same issue and none of them is touching documentation). We'll need to have a look at readthedocs and understand what changed.

[eurunuela]

Ok, apparently the readthedocs fail is not related to the PR (other PR have the same issue and none of them is touching documentation). We'll need to have a look at readthedocs and understand what changed.

Thanks for looking into it. I'm really busy today. I'll merge then.

[smoia]

🚀 PR was released in 2.5.0 🚀