surface_functionms and transformation

Author: boriskaus

docs/src/man/Tutorial_Basic.md

@@ -262,10 +262,10 @@ This can be achieved in a relatively straightforward manner, by creating a new 3
 Tomo_rect = CartData(xyzGrid(-550.0:10:600, -500.0:10:700, -600.0:5:-17));
 ```
 
-the routine `projectCartData` will then project the data from the geographic coordinates to the new rectilinear grid:
+the routine `project_CartData` will then project the data from the geographic coordinates to the new rectilinear grid:
 
 ```julia
-Tomo_rect = projectCartData(Tomo_rect, Tomo_Alps, proj)
+Tomo_rect = project_CartData(Tomo_rect, Tomo_Alps, proj)
 ```
 
 ````
@@ -282,7 +282,7 @@ we can do the same with topography:
 
 ```julia
 Topo_rect = CartData(xyzGrid(-550.0:1:600, -500.0:1:700, 0))
-Topo_rect = projectCartData(Topo_rect, Topo_Alps, proj)
+Topo_rect = project_CartData(Topo_rect, Topo_Alps, proj)
 ```
 
 ````

docs/src/man/Tutorial_Jura.md

@@ -77,7 +77,7 @@ Basement = importGeoTIFF("BMes_Spline_longlat.tif", fieldname=:Basement, removeN
 ```
 
 the `removeNaN_z` option removes `NaN` values from the dataset and instead uses the z-value of the nearest point.
-That is important if you want to use this surface to generate a 3D model setup (using `belowSurface`, for example).
+That is important if you want to use this surface to generate a 3D model setup (using `below_surface`, for example).
 
 The thesis also provides a few interpreted vertical cross-sections. As before, we import them as a screenshot and estimate the lower-left and upper right corners.
 In this particular case, we are lucky that the `lon/lat` values are indicated on the cross-section.
@@ -123,7 +123,7 @@ CartData
 
 The problem is that the result is not strictly orthogonal, but instead slightly curved.
 That causes issues later on when we want to intersect the surface with a 3D box.
-It is therefore better to use the `projectCartData` to project the `GeoData` structure to a `CartData` struct.
+It is therefore better to use the `project_CartData` to project the `GeoData` structure to a `CartData` struct.
 Let's first create this structure by using `x`,`y` coordinates that are slightly within the ranges given above:
 
 ```julia
@@ -142,7 +142,7 @@ CartData
 Next, we project the data with:
 
 ```julia
-TopoGeology_cart = projectCartData(TopoGeology_cart, TopoGeology, proj)
+TopoGeology_cart = project_CartData(TopoGeology_cart, TopoGeology, proj)
 ```
 
 ```julia
@@ -157,7 +157,7 @@ CartData
 And we can do the same with the basement topography
 
 ```julia
-Basement_cart = projectCartData(TopoGeology_cart, Basement, proj)
+Basement_cart = project_CartData(TopoGeology_cart, Basement, proj)
 ```
 
 ```julia
@@ -177,10 +177,10 @@ CrossSection_1_cart = convert2CartData(CrossSection_1,proj)
 ```
 
 for visualization, it is nice if we can remove the part of the cross-section that is above the topography.
-We can do that with the `belowSurface` routine which returns a Boolean to indicate whether points are below or above the surface
+We can do that with the `below_surface` routine which returns a Boolean to indicate whether points are below or above the surface
 
 ```julia
-below = belowSurface(CrossSection_1_cart, TopoGeology_cart)
+below = below_surface(CrossSection_1_cart, TopoGeology_cart)
 ```
 
 We can add that to the cross-section with:
@@ -240,14 +240,14 @@ Phases = zeros(Int8,size(ComputationalGrid.x)) #Define rock types
 Set everything below the topography to 1
 
 ```julia
-id = belowSurface(ComputationalGrid, GeologyTopo_comp_surf)
+id = below_surface(ComputationalGrid, GeologyTopo_comp_surf)
 Phases[id] .= 1
 ```
 
 The basement is set to 2
 
 ```julia
-id = belowSurface(ComputationalGrid, Basement_comp_surf)
+id = below_surface(ComputationalGrid, Basement_comp_surf)
 Phases[id] .= 2
 ```
 

docs/src/man/Tutorial_LaPalma.md

@@ -84,10 +84,10 @@ Topo_model = CartData(xyzGrid(-35:.1:30,-15:.2:45,0));
 nothing #hide
 ```
 
-In a next step, the routine `projectCartData` projects a `GeoData` structure to a `CartData` struct
+In a next step, the routine `project_CartData` projects a `GeoData` structure to a `CartData` struct
 
 ```julia
-Topo_model = projectCartData(Topo_model, Topo, proj)
+Topo_model = project_CartData(Topo_model, Topo, proj)
 ```
 
 Let's have a look at the data:
@@ -120,7 +120,7 @@ Phases = zeros(Int64,size(Grid_3D.x))
 Points that are below the surface are set to one:
 
 ```julia
-Below = belowSurface(Grid_3D, Topo_model);
+Below = below_surface(Grid_3D, Topo_model);
 Phases[Below] .= 1
 ```
 

docs/src/man/Tutorial_NumericalModel_2D.md

@@ -351,7 +351,7 @@ We have a number of other functions to help create a geometry, specifically:
 - `AddCylinder!`
 
 The help functions are quite self-explanatory, so we won't show it in detail here.
-If you have a topography surface or any other horizontal surface, you can surface with the cartesian grid with `aboveSurface` or `belowSurface`.
+If you have a topography surface or any other horizontal surface, you can surface with the cartesian grid with `above_surface` or `below_surface`.
 
 Also, if you wish to take a seismic tomography as inspiration to set a slab geometry, you can interpolate it to a `CartGrid` with the same dimensions and use that with the julia `findall` function.
 

docs/src/man/projection.md

@@ -87,7 +87,7 @@ CartData
 ```
 Next, we can project the topographic data (in `GeoData` format) on this orthogonal grid
 ```julia
-julia> Topo_Cart_orth  = projectCartData(Topo_Cart_orth, Topo, p)
+julia> Topo_Cart_orth  = project_CartData(Topo_Cart_orth, Topo, p)
 CartData 
     size   : (201, 101, 1)
     x      ϵ [ -2000.0 km : 2000.0 km]
@@ -105,6 +105,6 @@ You can do similar projections with full 3D data sets or pointwise data.
 
 ```@docs
 GeophysicalModelGenerator.convert2CartData
-GeophysicalModelGenerator.projectCartData
+GeophysicalModelGenerator.project_CartData
 GeophysicalModelGenerator.convert2UTMzone
 ```

docs/src/man/surfaces.md

@@ -7,9 +7,9 @@ Surfaces can be added and subtracted.
 ```@docs
 drape_on_topo
 fit_surface_to_points
-aboveSurface
-belowSurface
-interpolateDataOnSurface
+above_surface
+below_surface
+interpolate_data_surface
 is_surface
-remove_NaN_Surface!
+remove_NaN_surface!
 ```

docs/src/man/tools.md

@@ -8,16 +8,16 @@ extract_subvolume
 interpolate_datafields
 votemap
 subtract_horizontalmean
-aboveSurface
-belowSurface
-interpolateDataOnSurface
+above_surface
+below_surface
+interpolate_data_surface
 interpolate_topography_plane
 parse_columns_CSV
 rotate_translate_scale!
 pointData2NearestGrid
 convert2UTMzone
 convert2CartData
-projectCartData
+project_CartData
 drape_on_topo
 lithostatic_pressure!
 countmap

docs/src/man/visualise.md

@@ -40,15 +40,15 @@ julia> p=projectionPoint(Lon=10, Lat=45)
 projectionPoint(45.0, 10.0, 578815.302916711, 4.983436768349297e6, 32, true)
 julia> Data_Cart  = CartData(xyzGrid(-600:10:600,-600:10:600,-1000:10:-1));
 julia> Topo_Cart  = CartData(xyzGrid(-600:10:600,-600:10:600,0));
-julia> Topo_Cart  = projectCartData(Topo_Cart, Topo, p)
+julia> Topo_Cart  = project_CartData(Topo_Cart, Topo, p)
 CartData 
     size    : (121, 121, 1)
     x       ϵ [ -600.0 : 600.0]
     y       ϵ [ -600.0 : 600.0]
     z       ϵ [ -3.6270262031545473 : 3.654942280296281]
     fields  : (:Topography,)
   attributes: ["note"]
-julia> Data_Cart  = projectCartData(Data_Cart, Data, p)
+julia> Data_Cart  = project_CartData(Data_Cart, Data, p)
 CartData 
     size    : (121, 121, 100)
     x       ϵ [ -600.0 : 600.0]

ext/GLMakie_Visualisation.jl

@@ -25,7 +25,7 @@ This starts an interactive widget that allows you to explore a 3D data set `Data
 All fields in the dataset can be explored, and if the optional parameter `Topography` is provided, the topography will be drawn on top.
 
 Note that this requires orthogonal grids, so it will work with a `GeoData` set, or with an orthogonal `CartData` set.
-Note that you may have to use `projectCartData` to project it to orthogonal cartesian coordinates.
+Note that you may have to use `project_CartData` to project it to orthogonal cartesian coordinates.
 """
 function visualise(Data::AbstractGeneralGrid; Topography=nothing, Topo_range=nothing)
 

ext/GMT_utils.jl

@@ -12,7 +12,7 @@ else
   using ..GMT
 end
 
-using GeophysicalModelGenerator: lonlatdepthGrid, GeoData, UTMData, km, remove_NaN_Surface!
+using GeophysicalModelGenerator: lonlatdepthGrid, GeoData, UTMData, km, remove_NaN_surface!
 
 println("Loading GMT routines within GMG")
 
@@ -167,10 +167,10 @@ function importGeoTIFF(fname::String; fieldname=:layer1, negative=false, iskm=tr
   end
 
   if removeNaN_z
-    remove_NaN_Surface!(Depth, Lon, Lat)
+    remove_NaN_surface!(Depth, Lon, Lat)
   end
   if removeNaN_field
-    remove_NaN_Surface!(data, Lon, Lat)
+    remove_NaN_surface!(data, Lon, Lat)
   end
   data_field  = NamedTuple{(fieldname,)}((data,));