Wrap filter1d #1512

willschlitzer · 2021-09-15T21:26:38Z

This pull request wraps filter1d.

Reminders

Run make format and make check to make sure the code follows the style guide.
Add tests for new features or tests that would have caught the bug that you're fixing.
Add new public functions/methods/classes to doc/api/index.rst.
Write detailed docstrings for all functions/methods.
If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

/format: automatically format and lint the code
/test-gmt-dev: run full tests on the latest GMT development version

willschlitzer · 2021-11-06T08:03:28Z

The style checks are getting stuck on the argument ("\s+") passed to the sep= parameter for pd.read_csv. As far as I can tell, that is the correct way to be importing the MaunaLoa_CO2.txt data file and reading it into a dataframe. Is there a way to get this style check to pass?

pygmt/tests/test_filter1d.py

Co-authored-by: Wei Ji <[email protected]>

pygmt/src/filter1d.py

Co-authored-by: Dongdong Tian <[email protected]>

seisman

Looks good to me except for a typo.

pygmt/src/filter1d.py

Co-authored-by: Dongdong Tian <[email protected]>

seisman · 2022-05-03T01:49:49Z

Hopefully at least one of @michaelgrund and @weiji14 can give this PR a final review.

weiji14 · 2022-05-03T03:36:56Z

pygmt/src/filter1d.py

+@fmt_docstring
+@use_alias(
+    E="end",
+    F="filter",


filter is a built-in function in Python, see https://docs.python.org/3/library/functions.html#filter. Sure we want to use this? Or use a parameter name like filter_type instead?

Agree with @weiji14.

That makes sense to me; I'll make the change

weiji14 · 2022-05-03T03:42:03Z

pygmt/src/filter1d.py

+        Include Ends of time series in output. The default [False] loses
+        half the filter-width of data at each end.
+
+    time_col : int or str


Is a str allowed for time_col (-N)? As in users can pass in the name of the time column in the pandas.DataFrame table input?

I am under the impression that GMT reads a string containing an integer or floating point number as the same value as if it was passed as a number instead. I don't know why a Python user would ever pass a number as a string, so it may just be easier to leave it as int.

I'll see if I can try and test it, but filter1d is one (of the many) module that I don't understand its application and just wrapped using the provided GMT example and dataset.

As in users can pass in the name of the time column in the pandas.DataFrame table input?

I think this is a nice feature and can be implemented in a separate PR. In this initial wrapper, a time_col as int should be good.

pygmt/src/filter1d.py

michaelgrund · 2022-05-03T06:21:46Z

pygmt/src/filter1d.py

+@fmt_docstring
+@use_alias(
+    E="end",
+    F="filter",


Agree with @weiji14.

pygmt/src/filter1d.py

Co-authored-by: Wei Ji <[email protected]> Co-authored-by: Dongdong Tian <[email protected]>

weiji14

🚀

Co-authored-by: Wei Ji <[email protected]> Co-authored-by: Michael Grund <[email protected]> Co-authored-by: Dongdong Tian <[email protected]>

add and import filter1d.py

c8800b7

willschlitzer added the feature Brand new feature label Sep 15, 2021

willschlitzer added this to the 0.5.0 milestone Sep 15, 2021

willschlitzer self-assigned this Sep 15, 2021

willschlitzer added 2 commits September 20, 2021 17:45

run make format

a0e0db3

add test_filter1d

054022c

vercel bot temporarily deployed to Preview September 20, 2021 21:46 Inactive

willschlitzer added 4 commits September 23, 2021 09:37

change "table" to "data"

6e62ec0

raise error if filter not provided

690fec3

add tests

5e26c22

add tests

4c55308

vercel bot temporarily deployed to Preview September 23, 2021 09:33 Inactive

willschlitzer added 2 commits September 23, 2021 10:34

add filter1d to index

90867e1

Merge branch 'main' into wrap-filter1d

b73f6d8

willschlitzer changed the title ~~WIP: Wrap filter1d~~ Wrap filter1d Sep 23, 2021

vercel bot temporarily deployed to Preview September 23, 2021 09:42 Inactive

add test_filter1d_no_outfile_specified

ad21607

vercel bot temporarily deployed to Preview September 25, 2021 07:28 Inactive

update docstring

78cea4f

vercel bot temporarily deployed to Preview September 29, 2021 06:38 Inactive

willschlitzer modified the milestones: 0.5.0, 0.6.0 Oct 7, 2021

willschlitzer marked this pull request as ready for review November 6, 2021 07:27

weiji14 reviewed Nov 6, 2021

View reviewed changes

pygmt/tests/test_filter1d.py Outdated Show resolved Hide resolved

pygmt/tests/test_filter1d.py Show resolved Hide resolved

Update pygmt/tests/test_filter1d.py

7b6c00f

Co-authored-by: Wei Ji <[email protected]>

vercel bot temporarily deployed to Preview November 7, 2021 13:11 Inactive

willschlitzer mentioned this pull request Nov 7, 2021

Add MaunaLoa_CO2.txt to cached files #1615

Merged

5 tasks

remove unused imports

f755d2a

vercel bot temporarily deployed to Preview November 9, 2021 07:08 Inactive

seisman reviewed Apr 24, 2022

View reviewed changes

pygmt/src/filter1d.py Outdated Show resolved Hide resolved

willschlitzer and others added 4 commits May 2, 2022 07:10

Apply suggestions from code review

1290fbd

Co-authored-by: Dongdong Tian <[email protected]>

Merge branch 'main' into wrap-filter1d

c675c5c

format fix

a2b52be

add time_col docstring

4058b4a

seisman approved these changes May 2, 2022

View reviewed changes

pygmt/src/filter1d.py Outdated Show resolved Hide resolved

seisman added the final review call This PR requires final review and approval from a second reviewer label May 2, 2022

vercel bot temporarily deployed to Preview May 2, 2022 06:48 Inactive

Update pygmt/src/filter1d.py

fea0d1a

Co-authored-by: Dongdong Tian <[email protected]>

vercel bot temporarily deployed to Preview May 2, 2022 13:46 Inactive

seisman requested review from michaelgrund and weiji14 May 3, 2022 01:49

Merge branch 'main' into wrap-filter1d

215b59b

vercel bot temporarily deployed to Preview May 3, 2022 03:19 Inactive

weiji14 reviewed May 3, 2022

View reviewed changes

michaelgrund approved these changes May 3, 2022

View reviewed changes

pygmt/src/filter1d.py Outdated

@fmt_docstring

@use_alias(

E="end",

F="filter",

Copy link

Member

michaelgrund May 3, 2022

Choose a reason for hiding this comment

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

Agree with @weiji14.

seisman reviewed May 3, 2022

View reviewed changes

pygmt/src/filter1d.py Outdated Show resolved Hide resolved

Apply suggestions from code review

ac5de72

Co-authored-by: Wei Ji <[email protected]> Co-authored-by: Dongdong Tian <[email protected]>

vercel bot temporarily deployed to Preview May 3, 2022 15:09 Inactive

willschlitzer added 4 commits May 5, 2022 09:30

change filter parameter to filter_type

0e88c2a

reduce time_col parameters to only int

01b8252

fix filter1d tests

d677629

Merge branch 'main' into wrap-filter1d

a0ada18

vercel bot temporarily deployed to Preview May 5, 2022 08:56 Inactive

weiji14 approved these changes May 5, 2022

View reviewed changes

seisman merged commit 2a3e2bc into main May 5, 2022

seisman deleted the wrap-filter1d branch May 5, 2022 11:49

seisman removed the final review call This PR requires final review and approval from a second reviewer label May 5, 2022

sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022

Wrap filter1d (GenericMappingTools#1512)

5127a89

Co-authored-by: Wei Ji <[email protected]> Co-authored-by: Michael Grund <[email protected]> Co-authored-by: Dongdong Tian <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Wrap filter1d #1512

Wrap filter1d #1512

Uh oh!

willschlitzer commented Sep 15, 2021 •

edited

Loading

Uh oh!

willschlitzer commented Nov 6, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

seisman left a comment

Uh oh!

Uh oh!

seisman commented May 3, 2022

Uh oh!

weiji14 May 3, 2022

Uh oh!

michaelgrund May 3, 2022

Uh oh!

willschlitzer May 3, 2022

Uh oh!

weiji14 May 3, 2022

Uh oh!

willschlitzer May 3, 2022

Uh oh!

seisman May 4, 2022

Uh oh!

Uh oh!

michaelgrund May 3, 2022

Uh oh!

Uh oh!

weiji14 left a comment

Uh oh!

Uh oh!

Wrap filter1d #1512

Wrap filter1d #1512

Uh oh!

Conversation

willschlitzer commented Sep 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

willschlitzer commented Nov 6, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

seisman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

seisman commented May 3, 2022

Uh oh!

weiji14 May 3, 2022

Choose a reason for hiding this comment

Uh oh!

michaelgrund May 3, 2022

Choose a reason for hiding this comment

Uh oh!

willschlitzer May 3, 2022

Choose a reason for hiding this comment

Uh oh!

weiji14 May 3, 2022

Choose a reason for hiding this comment

Uh oh!

willschlitzer May 3, 2022

Choose a reason for hiding this comment

Uh oh!

seisman May 4, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

michaelgrund May 3, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

weiji14 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

willschlitzer commented Sep 15, 2021 •

edited

Loading