Use same code style for inverse_distance_weighted.py and nearest_neighbor.py

[ahijevyc]

Under uxarray.remap, inverse_distance_weighted.py and nearest_neighbor.py have a lot of the same code but have different documentation style. Their formatting styles should probably be brought back into agreement.

There is a lot of repeated code also. Perhaps that can be just in one place and reused.

I put in a pull request #923 for a neighborhood filter apply_func that started with the code in these functions as a template, so there was a lot of copying and pasting. If the shared code was in one place it could serve 3 different functions, inverse_distance_weighted.py and nearest_neighbor.py and the potential new function apply_func.

[aaronzedwick]

I like this idea a lot, especially coming up with a condensed version of the reused functions. I can tackle this most likely this week.

[aaronzedwick]

Thinking about this more, I don't know what code we could reuse as a function. Although similar, the nearest neighbor and inverse distance functions use completely different parameters for calculating things. So the things we could reuse would only save a few extra lines, and just add an extra file to the code base without too much reason.

[ahijevyc]

Thanks for looking at this. I was thinking of the similarity of lines 63-138 in inverse_distance_weighted.py and lines 45-128 in nearest_neighbor.py. There are differences in the order of elif-clauses and the names of some variables, but otherwise, they are functionally equivalent. In nearest_neighbor.py the variables are named cart_x, cart_y, cart_z while in inverse_distance_weighted.py they are named x, y, z.

Plus, there a lot of similarities in the function descriptions but one has argument type hints (nearest_neighbor.py) and the other has no type hints inverse_distance_weighted.py. The Parameters: sections also have single-character or whitespace differences at the end of lines.

I found this comparison was easy using gvim -d or gvimdiff.

[aaronzedwick]

Thanks for looking at this. I was thinking of the similarity of lines 63-138 in inverse_distance_weighted.py and lines 45-128 in nearest_neighbor.py. There differences in the order of elif-clauses and the names of some variables, but otherwise, they are functionally equivalent. In nearest_neighbor.py the variables are named cart_x, cart_y, cart_z while in inverse_distance_weighted.py they are named x, y, z.

Plus, there a lot of similarities in the function descriptions but one has argument type hints (nearest_neighbor.py) and the other has no type hints inverse_distance_weighted.py. The Parameters: sections also have single-character or whitespace differences at the end of lines.

I found this comparison was easy using gvim -d or gvimdiff.

Gotcha, yeah I can make a function out of those specific lines. I have a PR up, I'll tag you for a review once it's ready.

[aaronzedwick]

Completed in PR #974