Filtering Peaks by multiple properties

[d-lowl]

Is there a way to filter peaks by multiple properties (as done in scipy)?

Example in scipy:

find_peaks(x, distance=20, height=(50, None)

jDSP currently allows filtering by only one metric (i.e. find* methods return int[], and they cannot be filtered further). Unless I'm missing something

[psambit9791]

At the moment, the Peak class only allows filtering by one metric at a time.
I am planning to add the functionality of filtering by multiple parameters using a piping structure and this should be available in the next release.

[psambit9791]

This functionality has been added in commit f6e0abb

The process to do this as of now is as follows:

FindPeak fp = new FindPeak(signal);
Peak out = fp.detectPeaks();
int[] peaks = out.getPeaks();
int[] filteredPeaks = out.filterByHeight(peaks, 0.5, "lower");
filteredPeaks = out.filterByPeakDistance(filteredPeaks, 150);
filteredPeaks = out.filterByWidth(filteredPeaks, 20 ,"lower");

The output peaks can now be passed into the <filterByProperty()> functions alongside the arguments.
Calling the functions without peaks will return the result of filtering on all the detected peaks.

This will be released as PATCH release - v0.5.1 accounting for the fact that this is an essential feature for Peak Filtering

---

The pipelining of filtering properties will be added in next release. (v0.6.0)

[psambit9791]

Update to filtering method in v0.5.1

With the addition of the feature of filtering from a specific list of peaks, some new updates have also been made in the way the functions are called.

Unlike before, filtering for a lower or upper threshold does not require passing "lower" or "upper" as argument. In stead you can now pass null. All the filterBy*() methods are now structured as filterBy*(peaks, lower_threshold, upper_threshold) and you can pass null as an argument to ignore it.

So, code from #8 (comment) will now be written as follows:

FindPeak fp = new FindPeak(signal);
Peak out = fp.detectPeaks();
int[] peaks = out.getPeaks();
int[] filteredPeaks = out.filterByHeight(peaks, 0.5, null);
filteredPeaks = out.filterByPeakDistance(filteredPeaks, 150);
filteredPeaks = out.filterByWidth(filteredPeaks, 20.0 , null);

[d-lowl]

Awesome. Cheers! I'll have a look.