[Term Entry] Python Scipy Function: find_peaks() #5895

naajiha · 2024-12-26T01:22:44Z

Description

-Added the find_peaks() term for python from the scipy package
-Closes #5853

Issue Solved

Type of Change

Adding a new entry

Checklist

All writings are my own.
My entry follows the Codecademy Docs style guide.
My changes generate no new warnings.
I have performed a self-review of my own writing and code.
I have checked my entry and corrected any misspellings.
I have made corresponding changes to the documentation if needed.
I have confirmed my changes are not being pushed from my forked main branch.
I have confirmed that I'm pushing from a new branch named after the changes I'm making.
I have linked any issues that are relevant to this PR in the Issues Solved section.

CLAassistant · 2024-12-26T01:22:50Z

All committers have signed the CLA.

mamtawardhani · 2024-12-26T03:56:31Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.You have signed the CLA already but the status is still pending? Let us recheck it.

Hey @naajiha please sign the CLA

naajiha · 2024-12-26T04:00:11Z

signed

mamtawardhani

Hey @naajiha , thank you for contributing to Codecademy Docs, the entry is nicely written! 😄

I've suggested a few changes, could you please review and modify those at your earliest convenience? Thank you! 😃

content/scipy/concepts/scipy-signal/terms/find-peaks/find-peaks.md

mamtawardhani · 2024-12-30T10:51:01Z

content/scipy/concepts/scipy-signal/terms/find-peaks/find-peaks.md

+## Syntax
+
+```pseudo
+find_peaks(signal);


Please correct the syntax. Here is the reference documentation: https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.find_peaks.html

mamtawardhani · 2024-12-30T10:52:16Z

content/scipy/concepts/scipy-signal/terms/find-peaks/find-peaks.md

+The `signal` parameter is an array of numbers.
+
+The default height of the peaks is defined by the height parameter. If the parameter is unspecified, the height is set to 0. The width parameter is used to filter out peaks that have a width less than the specified width. The rel_height parameter is used to filter out peaks that have a relative height less than the specified relative height. The threshold parameter is used to filter out peaks that have a value less than the specified threshold. The distance parameter is used to filter out peaks that have a distance between peaks less than the specified distance. The prominence parameter is used to filter out peaks that have a prominence less than the specified prominence. The wlen parameter is used to filter out peaks that have a width less than the specified width. The plateau_size parameter is used to filter out peaks that have a plateau size less than the specified plateau size.


All the parameters should be in bullet points, an example could be:

x: The input 1D array or signal in which peaks are to be identified.

height: Specifies the required height of peaks. A tuple can set minimum and maximum peak heights.

threshold: Specifies the required threshold for the vertical distance between a peak and its neighbors.

.

.

.

mamtawardhani · 2024-12-30T10:53:41Z

content/scipy/concepts/scipy-signal/terms/find-peaks/find-peaks.md

+print(peaks)
+```
+
+The above code creates a signal with some peaks, finds the peaks in the signal, and prints the indices of the peaks.


Showcase the output of this code using a shell block

mamtawardhani · 2025-01-08T05:10:28Z

Hey @naajiha are you still working on this?

naajiha · 2025-01-10T01:43:35Z

yes, sorry, my computer was getting fixed, it was broken

…s.md Co-authored-by: Mamta Wardhani <[email protected]>

naajiha · 2025-01-10T05:06:20Z

I pushed the changes, let me know if you are able to see them

MINOR FIXES

mamtawardhani

Thank you for contributing to Codecademy Docs @naajiha 😄

The entry looks good for a second round of review! 🚀

Sriparno08

Looks good, @naajiha!

github-actions · 2025-01-18T06:35:22Z

👋 @naajiha
You have contributed to Codecademy Docs, and we would like to know more about you and your experience.
Please take a minute to fill out this four question survey to help us better understand Docs contributions and how we can improve the experience for you and our learners.
Thank you for your help!

🎉 Your contribution(s) can be seen here:

https://www.codecademy.com/resources/docs/scipy/scipy-signal/find-peaks

Please note it may take a little while for changes to become visible.
If you're appearing as anonymous and want to be credited, visit the linked accounts page and ensure that your GitHub account is linked.

here is the scipy documentation

d938e1b

mamtawardhani self-assigned this Dec 26, 2024

mamtawardhani added new entry New entry or entries status: under review Issue or PR is currently being reviewed scipy Python scipy enteries labels Dec 26, 2024

mamtawardhani requested changes Dec 30, 2024

View reviewed changes

mamtawardhani added status: review 1️⃣ completed status: waiting for author and removed status: under review Issue or PR is currently being reviewed labels Dec 30, 2024

naajiha and others added 4 commits January 9, 2025 17:44

Update content/scipy/concepts/scipy-signal/terms/find-peaks/find-peak…

f7e719c

…s.md Co-authored-by: Mamta Wardhani <[email protected]>

Update content/scipy/concepts/scipy-signal/terms/find-peaks/find-peak…

dca5cd8

…s.md Co-authored-by: Mamta Wardhani <[email protected]>

updated example code block

1663dc7

done maybe

39f0659

Update find-peaks.md

56c261c

MINOR FIXES

mamtawardhani approved these changes Jan 15, 2025

View reviewed changes

Merge branch 'main' into topic-content-term

4138f4e

mamtawardhani added status: ready for next review and removed status: waiting for author labels Jan 15, 2025

Sriparno08 self-assigned this Jan 15, 2025

Sriparno08 added status: under review Issue or PR is currently being reviewed and removed status: ready for next review labels Jan 15, 2025

Merge branch 'main' into topic-content-term

f18713b

Sriparno08 approved these changes Jan 18, 2025

View reviewed changes

Sriparno08 merged commit a3cd90c into Codecademy:main Jan 18, 2025
6 checks passed

Sriparno08 added status: review 2️⃣ completed and removed status: under review Issue or PR is currently being reviewed labels Jan 18, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Term Entry] Python Scipy Function: find_peaks() #5895

[Term Entry] Python Scipy Function: find_peaks() #5895

Uh oh!

naajiha commented Dec 26, 2024 •

edited by Sriparno08

Loading

Uh oh!

CLAassistant commented Dec 26, 2024 •

edited

Loading

Uh oh!

mamtawardhani commented Dec 26, 2024

Uh oh!

naajiha commented Dec 26, 2024

Uh oh!

mamtawardhani left a comment

Uh oh!

Uh oh!

Uh oh!

mamtawardhani Dec 30, 2024

Uh oh!

mamtawardhani Dec 30, 2024

Uh oh!

mamtawardhani Dec 30, 2024

Uh oh!

mamtawardhani commented Jan 8, 2025

Uh oh!

naajiha commented Jan 10, 2025

Uh oh!

naajiha commented Jan 10, 2025

Uh oh!

mamtawardhani left a comment

Uh oh!

Sriparno08 left a comment

Uh oh!

Uh oh!

github-actions bot commented Jan 18, 2025

Uh oh!

Uh oh!

		The `signal` parameter is an array of numbers.

		The default height of the peaks is defined by the height parameter. If the parameter is unspecified, the height is set to 0. The width parameter is used to filter out peaks that have a width less than the specified width. The rel_height parameter is used to filter out peaks that have a relative height less than the specified relative height. The threshold parameter is used to filter out peaks that have a value less than the specified threshold. The distance parameter is used to filter out peaks that have a distance between peaks less than the specified distance. The prominence parameter is used to filter out peaks that have a prominence less than the specified prominence. The wlen parameter is used to filter out peaks that have a width less than the specified width. The plateau_size parameter is used to filter out peaks that have a plateau size less than the specified plateau size.

[Term Entry] Python Scipy Function: find_peaks() #5895

[Term Entry] Python Scipy Function: find_peaks() #5895

Uh oh!

Conversation

naajiha commented Dec 26, 2024 • edited by Sriparno08 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issue Solved

Type of Change

Checklist

Uh oh!

CLAassistant commented Dec 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mamtawardhani commented Dec 26, 2024

Uh oh!

naajiha commented Dec 26, 2024

Uh oh!

mamtawardhani left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mamtawardhani Dec 30, 2024

Choose a reason for hiding this comment

Uh oh!

mamtawardhani Dec 30, 2024

Choose a reason for hiding this comment

Uh oh!

mamtawardhani Dec 30, 2024

Choose a reason for hiding this comment

Uh oh!

mamtawardhani commented Jan 8, 2025

Uh oh!

naajiha commented Jan 10, 2025

Uh oh!

naajiha commented Jan 10, 2025

Uh oh!

mamtawardhani left a comment

Choose a reason for hiding this comment

Uh oh!

Sriparno08 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Jan 18, 2025

Uh oh!

Uh oh!

naajiha commented Dec 26, 2024 •

edited by Sriparno08

Loading

CLAassistant commented Dec 26, 2024 •

edited

Loading