create the class PointMesh and its tests #410
Conversation
There was a problem hiding this comment.
@birocoles thanks for implementing this. I left a few comments about how you could make the code a bit simpler.
The codacy and codeclimate errors mostly come from code duplication between PointMesh and PointGrid. You can ignore them for now because I haven't configured them correctly.
fatiando/mesher/mesh.py
Outdated
| @@ -388,6 +388,117 @@ def copy(self): | |||
| return cp.deepcopy(self) | |||
|
|
|||
|
|
|||
| class PointMesh(object): | |||
There was a problem hiding this comment.
Perhaps a better name would be IrregularPointMesh because we could also have a PointMesh that is like the PrismMesh.
There was a problem hiding this comment.
This class is actually a more generic version of PointGrid and could be used as its base class. The PointGrid would need to generate the x, y, z arrays and pass to this classes __init__ method. This would remove all the duplicated code in __getitem__ etc.
There was a problem hiding this comment.
I tried to create the class IrregularPointMesh as the base of PointGrid.
|
|
||
| Grid points are ordered like a C matrix, first each row in a column, then | ||
| change columns. In this case, the x direction (North-South) are the rows | ||
| and y (East-West) are the columns. |
There was a problem hiding this comment.
This paragraph doesn't really make sense anymore for this mesh type.
fatiando/mesher/mesh.py
Outdated
|
|
||
| * x, y, z : 1d-arrays | ||
| The x, y, and z coordinates of each point in the mesh | ||
| (remember, z is positive downward). |
There was a problem hiding this comment.
Please include a note reminding that x points North and y points East.
| @@ -71,6 +71,7 @@ Meshes and collections | |||
| TesseroidMesh | |||
| PrismRelief | |||
| PointGrid | |||
| PointMesh | |||
There was a problem hiding this comment.
This needs to be updated to the new name.
| x, y = gridder.regular(area, shape) | ||
| # The spacing between points | ||
| self.dx, self.dy = gridder.spacing(area, shape) | ||
| super().__init__(x, y, z, props) |
There was a problem hiding this comment.
Any attributes set by IrregularPointMesh don't need to be set here as well (props, radius, size).
Fixes #210
For some applications (e.g., Equivalent Layer), we need to generate a grid of point sources (spheres of unit volume). In the current version of Fatiando, we can only create regular or scatter grids of point sources. This PR proposes a new class (PointMesh) to define a set of point sources. In this class, the source locations are defined directly by using numpy arrays of the Cartesian coordinates x, y and z.
Checklist:
doc/install.rst,environment.yml,ci/requirements.txt.cd doc; makelocally)doc/contributors.rst(leave for last to avoid conflicts)