Add ground and airborne synthetic surveys #120

santisoler · 2019-11-06T17:21:56Z

Add functions to create synthetic ground and airborne surveys based on the
gravity dataset from South Africa and the total-field magnetic anomaly dataset
from Great Britain. The synthetic surveys are samples from the original
datasets that are rescaled to the desired region defined in geodetic
coordinates.

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 the docstring, gallery, and/or tutorials.

Add functions to create synthetic ground and airborne surveys based on the gravity dataset from South Africa and the total-field magnetic anomaly dataset from Great Britain. The synthetic surveys are samples from the original datasets that are projected on Cartesian coordinates and then rescaled to the desired region.

santisoler · 2019-11-06T17:24:59Z

@leouieda I'm thinking I can extend the functionalities of these two functions in order to return the synthetic surveys on either Cartesian or geodetic coordinate systems. It wouldn't be hard to implement because the original surveys are already given in geodetic. I'm thinking to add a coordinate_system argument to each function through which the user can change the desired coordinate system. What do you think?

harmonica/synthetic/surveys.py

leouieda

Thanks, @santisoler! These are going to be really useful. I remember that @birocoles did this in the past as well.

doc/api/index.rst

harmonica/synthetic/surveys.py

Co-Authored-By: Leonardo Uieda <[email protected]>

The synthetic surveys will be defined on geodetic coordinates as the original datasets are.

Match the altitude of the survey points to the standard name for the geodetic heights used on Harmonica. Move the ditch of the data columns inside each survey function.

If region is None, then the synthetic survey won't be scaled.

When using the pandas.DataFrame.rename() method, a new DataFrame is returned with the renamed columns. The original one remains intact. Fixed wrong usage of the rename() method and merged it with the filter() method on a single line.

harmonica/tests/test_synthetic_surveys.py

Split the first tests functions in two: one that uses the default values for region and subsection and another one that tests if scaling the survey works as expected.

santisoler · 2019-11-07T13:57:04Z

@leouieda I think I've solved all the issues.
Instead of setting the region equal to the subsection if it's None, I decided it would be better to don't scale the survey. What do you think about this?

Left some answers on the inline comments.

leouieda

👍 great stuff! Left a few more suggestions (mostly docs).

doc/api/index.rst

harmonica/synthetic/surveys.py

Co-Authored-By: Leonardo Uieda <[email protected]>

leouieda

👍 looks good! Just a few more comments about the docstring formats. Also, could you make two gallery examples in a separate examples/synthetic folder? Could be in a separate PR if you prefer.

leouieda · 2019-11-08T18:03:57Z

harmonica/synthetic/surveys.py

+ The observation points are sampled from the Great Britain total-field magnetic
+ anomaly dataset (see :func:`harmonica.datasets.fetch_britain_magnetic`).
+ A portion of the original survey is cut (*data_region*) and the coordinates may be
+ scaled to the given *region*.


One thing to remember now is to crop these lines at 79 characters.

You're right. I added it to my TODO list, but forgot to do so.

By the way, is there a quick way to do this in vim? If it is, we should include it on the Contributing Guidelines. It's not an automatic way to do so, but at least it's better than nothing.
For example, I managed to do it by entering into VISUAL mode, select the lines I wanted to shrink and used gq. Nevertheless, I needed to select each block of the docstring separately instead of selecting the entire docstring and doing it only once.

Good question. I did it the same way you did. You could write a macro but it might be more work than doing it manually.

I think we will have to do it manually then. Another option is to propose this kind of automation on Black.

The problem then would be to have black use different widths for docstrings and code. Which I doubt they would allow :(

leouieda · 2019-11-08T18:04:44Z

harmonica/synthetic/surveys.py

+ The boundaries must be passed in the following order:
+ (``east``, ``west``, ``south``, ``north``, ...), defined on a geodetic
+ coordinate system and in degrees.
+ All subsequent boundaries will be ignored.


Same change as the above docstring.

Also remove unwanted dots at the end of the first line of docstrings.

harmonica/synthetic/surveys.py

Co-Authored-By: Leonardo Uieda <[email protected]>

leouieda · 2019-11-13T10:52:48Z

This looks good to me 👍 Feel free to merge away when ready 🚀

santisoler requested a review from leouieda November 6, 2019 17:22

santisoler commented Nov 6, 2019

View reviewed changes

harmonica/synthetic/surveys.py Show resolved Hide resolved

leouieda requested changes Nov 7, 2019

View reviewed changes

santisoler and others added 9 commits November 7, 2019 09:22

Change docstring of ground survey

8f0110b

Co-Authored-By: Leonardo Uieda <[email protected]>

Rename _adecuate_survey to _cut_and_scale

3b009af

Don't project coordinates of synthetic survey

f8d1bed

The synthetic surveys will be defined on geodetic coordinates as the original datasets are.

Rename elevation to height and ditch other columns

9bb7f75

Match the altitude of the survey points to the standard name for the geodetic heights used on Harmonica. Move the ditch of the data columns inside each survey function.

Rename cut_region to subsection

a2f4cb2

Set default region to None

ff272a2

If region is None, then the synthetic survey won't be scaled.

Update docstrings and some comments

271ead2

Fix renaming of elevation columns

1d802a9

When using the pandas.DataFrame.rename() method, a new DataFrame is returned with the renamed columns. The original one remains intact. Fixed wrong usage of the rename() method and merged it with the filter() method on a single line.

Update test functions for synthetic surveys

470c24c

stickler-ci reviewed Nov 7, 2019

View reviewed changes

harmonica/tests/test_synthetic_surveys.py Outdated Show resolved Hide resolved

harmonica/tests/test_synthetic_surveys.py Outdated Show resolved Hide resolved

santisoler added 3 commits November 7, 2019 10:33

Remove unused subsection argument on test function

5b7657a

Create specific test functions for survey scaling

8b981d1

Split the first tests functions in two: one that uses the default values for region and subsection and another one that tests if scaling the survey works as expected.

Merge branch 'master' into synthetic-surveys

7ea3e6f

leouieda requested changes Nov 7, 2019

View reviewed changes

santisoler and others added 10 commits November 7, 2019 13:29

Improve docstring for gound survey

cd2af16

Co-Authored-By: Leonardo Uieda <[email protected]>

Improve docstring

b2e8264

Co-Authored-By: Leonardo Uieda <[email protected]>

Improve docstring

9798972

Co-Authored-By: Leonardo Uieda <[email protected]>

Improve docstring

8f80937

Co-Authored-By: Leonardo Uieda <[email protected]>

Improve docstring

f5afb76

Co-Authored-By: Leonardo Uieda <[email protected]>

Improve docstring

743349b

Co-Authored-By: Leonardo Uieda <[email protected]>

Improve docstring

21434be

Co-Authored-By: Leonardo Uieda <[email protected]>

Improve docstring

bd453e3

Co-Authored-By: Leonardo Uieda <[email protected]>

Rename subsection to data_region

65d3313

Specify DataFrame columns on the docstring

74f8dc7

Specify DataFrame columns on the docstring

58cc992

santisoler requested a review from leouieda November 7, 2019 18:44

leouieda requested changes Nov 8, 2019

View reviewed changes

santisoler added 2 commits November 8, 2019 15:23

Shrink docstrings to 79 characters

be52bb6

Also remove unwanted dots at the end of the first line of docstrings.

Fix lines that were still larger than 79 chars

cfc881b

leouieda reviewed Nov 11, 2019

View reviewed changes

harmonica/synthetic/surveys.py Outdated Show resolved Hide resolved

santisoler and others added 2 commits November 12, 2019 09:03

Improve ground survey docstring

367db7f

Co-Authored-By: Leonardo Uieda <[email protected]>

Merge branch 'master' into synthetic-surveys

e0f98a5

leouieda approved these changes Nov 13, 2019

View reviewed changes

santisoler merged commit 4460807 into master Nov 13, 2019

santisoler deleted the synthetic-surveys branch November 13, 2019 12:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add ground and airborne synthetic surveys #120

Add ground and airborne synthetic surveys #120

santisoler commented Nov 6, 2019 •

edited

Loading

santisoler commented Nov 6, 2019

leouieda left a comment

santisoler commented Nov 7, 2019

leouieda left a comment

leouieda left a comment

leouieda Nov 8, 2019

santisoler Nov 8, 2019

santisoler Nov 8, 2019

leouieda Nov 11, 2019

santisoler Nov 12, 2019

leouieda Nov 13, 2019

leouieda Nov 8, 2019

leouieda commented Nov 13, 2019

Add ground and airborne synthetic surveys #120

Add ground and airborne synthetic surveys #120

Conversation

santisoler commented Nov 6, 2019 • edited Loading

santisoler commented Nov 6, 2019

leouieda left a comment

Choose a reason for hiding this comment

santisoler commented Nov 7, 2019

leouieda left a comment

Choose a reason for hiding this comment

leouieda left a comment

Choose a reason for hiding this comment

leouieda Nov 8, 2019

Choose a reason for hiding this comment

santisoler Nov 8, 2019

Choose a reason for hiding this comment

santisoler Nov 8, 2019

Choose a reason for hiding this comment

leouieda Nov 11, 2019

Choose a reason for hiding this comment

santisoler Nov 12, 2019

Choose a reason for hiding this comment

leouieda Nov 13, 2019

Choose a reason for hiding this comment

leouieda Nov 8, 2019

Choose a reason for hiding this comment

leouieda commented Nov 13, 2019

santisoler commented Nov 6, 2019 •

edited

Loading